יצירת תשובות מתוך תיעוד

‫Developer Knowledge API מאפשר לשאול שאלות על מוצרי Google למפתחים ולקבל תשובות ישירות בשפה טבעית. לכל שאילתה, ה-API יוצר תשובה שמבוססת על מאגר הידע למפתחים (שנקרא במסמכי העזר של ה-API יצירה מבוססת) וכולל ציטוטים של דפי התיעוד הרלוונטיים.

לפני שמתחילים

מגדירים את הסביבה לכלי המועדף:

gcloud

מתקינים ומגדירים את ה-CLI של gcloud ומפעילים את Developer Knowledge API.

REST

מפעילים את ה-API ויוצרים מפתח 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 ב-CLI של gcloud או השדה 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 של Developer Knowledge, בוחרים את השיטה שהכי מתאימה למה שמחפשים:

  • ‫AnswerQuery (או הכלי answer_query MCP): הכי מתאים לשאלות כלליות מסוג 'איך עושים', להשוואה בין מוצרים ולמדריכים מפורטים שבהם רוצים סיכום מלא עם קישורים למסמכי המקור.
  • ‫SearchDocumentChunks (או הכלי search_documents MCP): הכי מתאים לחיפוש דגלים מדויקים של CLI, תחביר קוד, שמות פרמטרים או הרשאות IAM (כמו service.resource.verb). מומלץ להשתמש בשניים עד חמישה מילות מפתח ספציפיות במקום בשאלה מלאה.

המאמרים הבאים