Genera respuestas a partir de la documentación

La API de Developer Knowledge te permite hacer preguntas sobre los productos de Google Developers y recibir respuestas directas en lenguaje natural. Para cada consulta, la API compone una respuesta extraída del corpus de Developer Knowledge (al que se hace referencia en la referencia de la API como generación fundamentada) y, además, incluye citas a las páginas de documentación pertinentes.

Antes de comenzar

Configura tu entorno para la herramienta que prefieras:

gcloud

Instala y configura gcloud CLI, y habilita la API de Developer Knowledge.

REST

Habilita la API y genera una clave de API de Developer Knowledge. Luego, guarda la clave en una variable de entorno:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

Reemplaza YOUR_API_KEY por tu clave de API de Developer Knowledge.

Responde una consulta

Usa el gcloud developer-knowledge answer-query comando o el answerQuery método de REST para hacer una pregunta.

En el siguiente ejemplo, se envía una consulta en la que se pregunta cómo crear un conjunto de datos de 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 respuesta contiene la respuesta de texto en el answer.answerText campo, junto con citations y references en el answer objeto:

{
  "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 las fuentes de documentación

Para restringir las fuentes de documentación que se usan para generar la respuesta, pasa una expresión de filtro con la marca --query-filter en gcloud CLI o el filter campo en el cuerpo de la solicitud de REST. Para obtener detalles sobre los campos de filtro admitidos y los operadores, consulta Filtra los resultados de la búsqueda.

En el siguiente ejemplo, se restringen las fuentes de documentación 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\""
  }'

Elige entre AnswerQuery y SearchDocumentChunks

Cuando uses la API o el servidor de MCP de Developer Knowledge, elige el método que mejor se adapte a lo que buscas:

  • AnswerQuery (o la herramienta answer_query de MCP): Es la mejor opción para preguntas generales de "instructivo", comparar productos y guías paso a paso en las que deseas un resumen completo con vínculos a los documentos fuente.
  • SearchDocumentChunks (o la herramienta search_documents de MCP): Es la mejor opción para buscar marcas exactas de la CLI, sintaxis de código, nombres de parámetros o permisos de IAM (como service.resource.verb). Usa de dos a cinco palabras clave específicas en lugar de una pregunta completa.

¿Qué sigue?