Tạo câu trả lời từ tài liệu

Developer Knowledge API cho phép bạn đặt câu hỏi về các sản phẩm dành cho nhà phát triển của Google và nhận câu trả lời trực tiếp bằng ngôn ngữ tự nhiên. Đối với mỗi truy vấn, API sẽ tạo một phản hồi lấy từ tập hợp Kiến thức dành cho nhà phát triển (được gọi trong tài liệu tham khảo API là thế hệ có cơ sở) và bao gồm các trích dẫn đến các trang tài liệu có liên quan.

Trước khi bắt đầu

Thiết lập môi trường cho công cụ bạn muốn:

gcloud

Cài đặt và định cấu hình gcloud CLI, đồng thời bật Developer Knowledge API.

REST

Bật API và tạo khoá Developer Knowledge API. Sau đó, hãy lưu khoá vào một biến môi trường:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

Thay thế YOUR_API_KEY bằng khoá Developer Knowledge API của bạn.

Trả lời câu hỏi

Sử dụng lệnh gcloud developer-knowledge answer-query hoặc phương thức answerQuery REST để đặt câu hỏi.

Ví dụ sau đây gửi một truy vấn hỏi cách tạo tập dữ liệu 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?"}'

Phản hồi chứa câu trả lời bằng văn bản trong trường answer.answerText, cùng với citations và references trong đối tượng 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"
            }
          }
        }
      }
    ]
  }
}

Lọc nguồn tài liệu

Để hạn chế các nguồn tài liệu được dùng để tạo câu trả lời, hãy truyền một biểu thức bộ lọc bằng cách dùng cờ --query-filter trong gcloud CLI hoặc trường filter trong nội dung yêu cầu REST. Để biết thông tin chi tiết về các trường và toán tử bộ lọc được hỗ trợ, hãy xem phần Lọc kết quả tìm kiếm.

Ví dụ sau đây hạn chế các nguồn tài liệu ở 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\""
  }'

Chọn giữa AnswerQuery và SearchDocumentChunks

Khi bạn sử dụng API hoặc máy chủ MCP Kiến thức cho nhà phát triển, hãy chọn phương thức phù hợp nhất với nội dung bạn đang tìm kiếm:

  • AnswerQuery (hoặc công cụ answer_query MCP): phù hợp nhất cho các câu hỏi chung về "cách làm", so sánh sản phẩm và hướng dẫn từng bước khi bạn muốn có bản tóm tắt đầy đủ kèm theo đường liên kết đến tài liệu nguồn.
  • SearchDocumentChunks (hoặc công cụ MCP search_documents): phù hợp nhất để tra cứu chính xác cờ CLI, cú pháp mã, tên tham số hoặc quyền IAM (chẳng hạn như service.resource.verb). Hãy sử dụng từ 2 đến 5 từ khoá cụ thể thay vì một câu hỏi đầy đủ.

Bước tiếp theo