Menghasilkan jawaban dari dokumentasi

Developer Knowledge API memungkinkan Anda mengajukan pertanyaan tentang produk developer Google dan menerima jawaban langsung dalam bahasa alami. Untuk setiap kueri, API menyusun respons yang diambil dari korpus Pengetahuan Developer (disebut dalam referensi API sebagai generasi berbasis) dan menyertakan kutipan ke halaman dokumentasi yang relevan.

Sebelum memulai

Siapkan lingkungan untuk alat pilihan Anda:

gcloud

Instal dan konfigurasi gcloud CLI, serta aktifkan Developer Knowledge API.

REST

Aktifkan API dan buat kunci Developer Knowledge API. Kemudian, simpan kunci Anda ke variabel lingkungan:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

Ganti YOUR_API_KEY dengan kunci API Developer Knowledge Anda.

Menjawab kueri

Gunakan perintah gcloud developer-knowledge answer-query atau metode REST answerQuery untuk mengajukan pertanyaan.

Contoh berikut mengirimkan kueri yang menanyakan cara membuat set data 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?"}'

Respons berisi jawaban teks di kolom answer.answerText, bersama dengan citations dan references di objek 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"
            }
          }
        }
      }
    ]
  }
}

Memfilter sumber dokumentasi

Untuk membatasi sumber dokumentasi yang digunakan untuk membuat jawaban, teruskan ekspresi filter menggunakan tanda --query-filter di gcloud CLI atau kolom filter di isi permintaan REST Anda. Untuk mengetahui detail tentang kolom dan operator filter yang didukung, lihat Memfilter hasil penelusuran.

Contoh berikut membatasi sumber dokumentasi ke 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\""
  }'

Pilih antara AnswerQuery dan SearchDocumentChunks

Saat Anda menggunakan API atau server MCP Pengetahuan Developer, pilih metode yang paling sesuai dengan yang Anda cari:

  • AnswerQuery (atau alat MCP answer_query): paling cocok untuk pertanyaan umum "Petunjuk", membandingkan produk, dan panduan langkah demi langkah saat Anda menginginkan ringkasan lengkap dengan link ke dokumen sumber.
  • SearchDocumentChunks (atau alat MCP search_documents): paling cocok untuk mencari flag CLI, sintaksis kode, nama parameter, atau izin IAM yang tepat (seperti service.resource.verb). Gunakan dua hingga lima kata kunci tertentu, bukan pertanyaan lengkap.

Langkah berikutnya