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

Developer Knowledge API به شما امکان می‌دهد درباره محصولات Google Developer سؤال بپرسید و پاسخ‌های مستقیم به زبان طبیعی دریافت کنید. برای هر پُرسمان، میانای برنامه‌سازی کاربردی پاسخی را که از مجموعه دانش توسعه‌دهنده (که در مرجع میانای برنامه‌سازی کاربردی به‌عنوان تولید پایه‌مند به آن اشاره شده است) گرفته شده است ترکیب می‌کند و شامل استنادهایی به صفحات مستندات مربوطه است.

قبل‌از شروع

محیط خود را برای ابزار ترجیحی‌تان راه‌اندازی کنید:

gcloud

gcloud CLI را نصب و پیکربندی کنید و Developer Knowledge API را فعال کنید.

REST

«میانای برنامه‌سازی کاربردی» را فعال کنید و کلید «میانای برنامه‌سازی کاربردی دانش توسعه‌دهنده» را تولید کنید. سپس، کلیدتان را در متغیر محیطی ذخیره کنید:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

‫YOUR_API_KEY را با کلید «میانای برنامه‌سازی کاربردی دانش توسعه‌دهنده» خود جایگزین کنید.

پاسخ دادن به پُرسمان

برای پرسیدن سؤال، از فرمان gcloud developer-knowledge answer-query یا روش answerQuery REST استفاده کنید.

مثال زیر پُرسمانی را ارسال می‌کند که نحوه ایجاد مجموعه داده BigQuery را می‌پرسد:

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?"

REST

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?"}'

پاسخ حاوی پاسخ نوشتاری در فیلد answer.answerText، به‌همراه citations و references در شیء answer است:

{
  "answer": {
    "answerText": "To create a BigQuery dataset, you can use the Google Cloud Console, the bq command-line tool, or the BigQuery client libraries.",
    "citations": [
      {
        "startIndex": 0,
        "endIndex": 123,
        "sources": [
          {
            "referenceIndex": 0
          }
        ]
      }
    ],
    "references": [
      {
        "documentReference": {
          "documentChunk": {
            "parent": "documents/docs.cloud.google.com/bigquery/docs/datasets",
            "content": "This page explains how to create BigQuery datasets...",
            "document": {
              "name": "documents/docs.cloud.google.com/bigquery/docs/datasets",
              "title": "Introduction to datasets",
              "uri": "https://docs.cloud.google.com/bigquery/docs/datasets"
            }
          }
        }
      }
    ]
  }
}

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

برای محدود کردن منابع مستندات مورداستفاده برای تولید پاسخ، عبارت فیلتری را بااستفاده از پرچم --query-filter در gcloud CLI یا فیلد filter در بدنه درخواست REST خود ارسال کنید. برای جزئیات مربوط به فیلدهای فیلتر و اپراتورهای پشتیبانی‌شده، به فیلتر کردن نتایج جستجو مراجعه کنید.

مثال زیر منابع مستندات را به docs.cloud.google.com محدود می‌کند:

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?" \
  --query-filter='data_source = "docs.cloud.google.com"'

REST

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?",
    "filter": "data_source = \"docs.cloud.google.com\""
  }'

بین AnswerQuery و SearchDocumentChunks انتخاب کنید

وقتی از API یا سرور MCP «دانش توسعه‌دهندگان» استفاده می‌کنید، روشی را انتخاب کنید که بهترین تناسب را با آنچه به‌دنبالش هستید داشته باشد:

  • AnswerQuery (یا ابزار answer_query MCP): بهترین گزینه برای پرسش‌های عمومی «چگونه»، مقایسه محصولات، و راهنمای گام‌به‌گام که در آن خلاصه‌ای کامل با پیوند به سندهای منبع می‌خواهید.
  • SearchDocumentChunks (یا ابزار search_documents MCP): بهترین گزینه برای جستجوی پرچم‌های دقیق CLI، نحو کد، نام‌های پارامتر، یا اجازه‌های IAM (مثل service.resource.verb). به‌جای پرسیدن سؤال کامل، از دو تا پنج کلیدواژه خاص استفاده کنید.

قدم بعدی چیست