สร้างคำตอบจากเอกสารประกอบ

Developer Knowledge API ช่วยให้คุณถามคำถามเกี่ยวกับผลิตภัณฑ์สำหรับนักพัฒนาซอฟต์แวร์ของ Google และรับคำตอบเป็นภาษาธรรมชาติได้โดยตรง โดย API จะสร้าง คำตอบจากการรวบรวมข้อมูล Developer Knowledge (เรียกว่าใน เอกสารอ้างอิง API ว่า การสร้างคำตอบโดยอิงตามข้อมูลที่มี) และใส่ข้อมูลอ้างอิงไปยังหน้าเอกสารประกอบที่เกี่ยวข้องสำหรับการค้นหาแต่ละครั้ง

ก่อนเริ่มต้น

ตั้งค่าสภาพแวดล้อมสำหรับเครื่องมือที่ต้องการดังนี้

gcloud

ติดตั้งและกำหนดค่า gcloud CLI แล้วเปิดใช้ 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คำสั่ง หรือ 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 หรือเซิร์ฟเวอร์ Developer Knowledge MCP ให้เลือกเมธอดที่เหมาะกับสิ่งที่คุณต้องการมากที่สุด

  • AnswerQuery (หรือเครื่องมือ answer_query MCP): เหมาะที่สุดสำหรับคำถาม "วิธีการ" ทั่วไป การเปรียบเทียบผลิตภัณฑ์ และคำแนะนำทีละขั้นตอนที่คุณต้องการสรุปที่สมบูรณ์พร้อมลิงก์ไปยังเอกสารต้นฉบับ
  • SearchDocumentChunks (หรือเครื่องมือ search_documents MCP): เหมาะที่สุดสำหรับการค้นหาแฟล็ก CLI, ไวยากรณ์ของโค้ด, ชื่อพารามิเตอร์ หรือสิทธิ์ IAM ที่แน่นอน (เช่น service.resource.verb) ให้ใช้คีย์เวิร์ดเฉพาะ 2-5 คำแทนคำถามแบบเต็ม

ขั้นตอนถัดไป