إنشاء إجابات من المستندات

تتيح لك واجهة برمجة التطبيقات Developer Knowledge API طرح أسئلة حول منتجات Google للمطوّرين وتلقّي إجابات مباشرة بلغة طبيعية. بالنسبة إلى كل طلب بحث، تنشئ واجهة برمجة التطبيقات ردًا مستمدًا من مجموعة مستندات "معرفة المطوّرين" (المشار إليها في مرجع واجهة برمجة التطبيقات باسم الإنشاء المستند إلى مصادر) وتتضمّن اقتباسات من صفحات المستندات ذات الصلة.

قبل البدء

إعداد البيئة للأداة المفضّلة لديك:

gcloud

ثبِّت gcloud CLI واضبط إعداداته، وفعِّل Developer Knowledge API.

REST

فعِّل واجهة برمجة التطبيقات Developer Knowledge API وأنشئ مفتاح واجهة برمجة التطبيقات. بعد ذلك، احفظ مفتاحك في متغيّر بيئة:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

استبدِل YOUR_API_KEY بمفتاح Developer Knowledge API.

الإجابة عن طلب بحث

استخدِم الأمر gcloud developer-knowledge answer-query أو طريقة REST‏ answerQuery لطرح سؤال.

يرسل المثال التالي طلبًا يسأل عن كيفية إنشاء مجموعة بيانات 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

عند استخدام واجهة برمجة التطبيقات أو خادم MCP الخاص بـ Developer Knowledge، اختَر الطريقة التي تناسب احتياجاتك على أفضل وجه:

  • AnswerQuery (أو أداة answer_query MCP): الأنسب للأسئلة العامة حول "طريقة التنفيذ"، ومقارنة المنتجات، والأدلّة المفصّلة التي تريد فيها الحصول على ملخّص كامل يتضمّن روابط تؤدي إلى المستندات المصدر.
  • ‫SearchDocumentChunks (أو أداة search_documents MCP): يُفضَّل استخدامها للبحث عن علامات CLI أو بنية الرموز أو أسماء المَعلمات أو أذونات إدارة الهوية وإمكانية الوصول (مثل service.resource.verb). يُرجى استخدام كلمتين إلى خمس كلمات رئيسية محدّدة بدلاً من سؤال كامل.

الخطوات التالية