Generare risposte dalla documentazione

L'API Developer Knowledge consente di porre domande sui prodotti per sviluppatori Google e ricevere risposte dirette in linguaggio naturale. Per ogni query, l'API compone una risposta tratta dal corpus di Developer Knowledge (denominata nel riferimento API generazione basata su dati reali) e include citazioni delle pagine di documentazione pertinenti.

Prima di iniziare

Configura l'ambiente per lo strumento che preferisci:

gcloud

Installa e configura gcloud CLI e abilita l'API Developer Knowledge.

REST

Abilita l'API e genera una chiave API Developer Knowledge. Poi, salva la chiave in una variabile di ambiente:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

Sostituisci YOUR_API_KEY con la chiave API Developer Knowledge.

Rispondi a una query

Utilizza il gcloud developer-knowledge answer-query comando o il answerQuery metodo REST per porre una domanda.

L'esempio seguente invia una query che chiede come creare un set di dati 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?"}'

La risposta contiene il testo della risposta nel campo answer.answerText, insieme a citations e references nell' answer oggetto:

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

Filtra le origini della documentazione

Per limitare le origini della documentazione utilizzate per generare la risposta, trasmetti un'espressione di filtro utilizzando il flag --query-filter in gcloud CLI o il filter campo nel corpo della richiesta REST. Per i dettagli sui campi di filtro supportati e gli operatori, consulta Filtra i risultati di ricerca.

L'esempio seguente limita le origini della documentazione a 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\""
  }'

Scegli tra AnswerQuery e SearchDocumentChunks

Quando utilizzi l'API o il server MCP Developer Knowledge, scegli il metodo più adatto a ciò che stai cercando:

  • AnswerQuery (o lo strumento MCP answer_query): ideale per domande generali di tipo "Istruzioni", per confrontare i prodotti e per le guide passo passo in cui vuoi un riepilogo completo con link ai documenti di origine.
  • SearchDocumentChunks (o lo strumento MCP search_documents): ideale per cercare flag CLI esatti, sintassi del codice, nomi dei parametri o autorizzazioni IAM (ad esempio service.resource.verb). Utilizza da due a cinque parole chiave specifiche anziché una domanda completa.

Passaggi successivi