Dokümanlardan yanıt oluşturma

Developer Knowledge API, Google Developers ürünleri hakkında soru sormanıza ve doğrudan, doğal dilde yanıtlar almanıza olanak tanır. API, her sorgu için Developer Knowledge corpus'tan (API referansında temellendirilmiş oluşturma olarak adlandırılır) alınan bir yanıt oluşturur ve ilgili doküman sayfalarına alıntılar ekler.

Başlamadan önce

Tercih ettiğiniz araç için ortamınızı ayarlayın:

gcloud

gcloud CLI'yı yükleyip yapılandırın ve Developer Knowledge API'yi etkinleştirin.

REST

API'yi etkinleştirin ve Developer Knowledge API anahtarı oluşturun. Ardından anahtarınızı bir ortam değişkenine kaydedin:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

YOUR_API_KEY kısmını Developer Knowledge API anahtarınızla değiştirin.

Sorguyu yanıtlama

Soru sormak için gcloud developer-knowledge answer-query komutunu veya answerQuery REST yöntemini kullanın.

Aşağıdaki örnekte, BigQuery veri kümesinin nasıl oluşturulacağını soran bir sorgu gönderilmektedir:

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?"}'

Yanıtta, answer.answerText alanında metin yanıtı, answer nesnesinde ise citations ve references yer alır:

{
  "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"
            }
          }
        }
      }
    ]
  }
}

Belge kaynaklarını filtreleme

Yanıtı oluşturmak için kullanılan belge kaynaklarını kısıtlamak istiyorsanız gcloud CLI'da --query-filter işaretini veya REST istek gövdenizdeki filter alanını kullanarak bir filtre ifadesi iletin. Desteklenen filtre alanları ve operatörler hakkında ayrıntılı bilgi için Arama sonuçlarını filtreleme başlıklı makaleyi inceleyin.

Aşağıdaki örnekte, doküman kaynakları docs.cloud.google.com ile kısıtlanmıştır:

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 ile SearchDocumentChunks arasında seçim yapın.

API'yi veya Developer Knowledge MCP sunucusunu kullanırken aradığınız şeye en uygun yöntemi seçin:

  • AnswerQuery (veya answer_query MCP aracı): Genel "nasıl yapılır" soruları, ürün karşılaştırmaları ve kaynak belgelerin bağlantılarını içeren eksiksiz bir özet istediğiniz adım adım açıklamalı kılavuzlar için idealdir.
  • SearchDocumentChunks (veya search_documents MCP aracı): Tam CLI işaretlerini, kod söz dizimini, parametre adlarını veya IAM izinlerini (ör. service.resource.verb) aramak için idealdir. Tam bir soru yerine iki ila beş spesifik anahtar kelime kullanın.

Sırada ne var?