شروع سریع: شروع به کار با Developer Knowledge API

این راهنما نحوه شروع کار با «میانای برنامه‌سازی کاربردی دانش توسعه‌دهندگان» را به شما نشان می‌دهد. یاد خواهید گرفت که چگونه Developer Knowledge API را فعال کنید، کلید میانای برنامه‌سازی کاربردی دریافت کنید، و اولین فراخوانی‌های میانای برنامه‌سازی کاربردی را برای جستجو و بازیابی مستندات توسعه‌دهنده انجام دهید.

قبل‌از شروع

قبل‌از شروع استفاده از Developer Knowledge API، حتماً مراحل زیر را تکمیل کنید.

فعال کردن میانای برنامه‌سازی کاربردی

  1. صفحه Developer Knowledge API را در کتابخانه Google APIs باز کنید.
  2. بررسی کنید پروژه صحیح را انتخاب کرده باشید که قصد دارید در آن از API استفاده کنید.
  3. روی فعال کردن کلیک کنید. برای فعال کردن یا استفاده از API، به نقش‌های IAM خاصی نیاز نیست.

ایجاد و ایمن کردن کلید میانای API

  1. در کنسول Google Cloud برای پروژه‌ای که در آن میانای برنامه‌سازی کاربردی را فعال کرده‌اید، به صفحه اطلاعات اعتباری بروید.
  2. روی ایجاد اطلاعات کاربری کلیک کنید، و سپس کلید میانای API را از منو انتخاب کنید.
  3. در فیلد نام، نامی برای کلید ارائه دهید.

  4. روی منو کرکره‌ای انتخاب محدودیت‌های API کلیک کنید، سپس Developer Knowledge API را تایپ کنید. روی نتیجه کلیک کنید، و سپس روی تأیید کلیک کنید.

    نکته‌ها:

    • اگر Developer Knowledge API را به‌تازگی فعال کرده‌اید، ممکن است مدتی طول بکشد تا در فهرست ظاهر شود. چند دقیقه صبر کنید و دوباره امتحان کنید.
    • اگر قصد دارید از همین کلید برای فراخوانی‌های مدل عمومی مشتری هوش مصنوعی‌تان (برای مثال، GEMINI_API_KEY) استفاده کنید، باید Generative Language API را نیز انتخاب کنید. درغیراین‌صورت، آن تماس‌ها مسدود خواهند شد.
  5. روی ایجاد کردن کلیک کنید.

تولید پاسخ از اسناد

وقتی کلید Developer Knowledge API را دریافت کردید، می‌توانید استفاده از API را شروع کنید. مثال زیر نشان می‌دهد که چگونه می‌توان یک پُرسمان را پرسید و پاسخی را که از اسناد استخراج شده است تولید کرد:

  1. کلید Developer Knowledge API را در متغیر محیطی ذخیره کنید:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    YOUR_API_KEY را با کلید میانای API که تولید کرده‌اید جایگزین کنید.

  2. از curl برای فراخوانی نقطه پایان AnswerQuery استفاده کنید:

    curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

این فرمان پاسخی به پُرسمان شما براساس اسناد برمی‌گرداند.

جستجوی بخش‌های سند

اگر می‌خواهید به‌جای پاسخ تولیدشده، گزیده‌های مستندات خاصی را پیدا کنید، می‌توانید مستقیماً بخش‌های سند را جستجو کنید.

از curl برای فراخوانی نقطه پایانی SearchDocumentChunks استفاده کنید:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

پاسخ شامل بخش‌های منطبق محتوا از اسناد و ارجاع به اسناد اصلی است.

بازیابی سند

پاسخ searchDocumentChunks حاوی فهرستی از تکه‌های سند است. هر بخش سند دارای فیلد parent حاوی نام منبع سند است که می‌توانید با GetDocument از آن برای بازیابی محتوای کامل سند استفاده کنید.

برای بازیابی سند، فیلد parent را از یکی از بخش‌های برگردانده‌شده توسط searchDocumentChunks کپی کنید و آن را در متغیر محیطی ذخیره کنید، سپس از curl برای فراخوانی نقطه پایانی GetDocument استفاده کنید:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

این کار محتوای کامل Markdown سند مشخص‌شده را برمی‌گرداند.

قدم بعدی چیست