Guía de inicio rápido: Comienza a usar la API de Developer Knowledge

En esta guía, se muestra cómo comenzar a usar la API de Developer Knowledge. Aprenderás a habilitar la API de Developer Knowledge, obtener una clave de API y realizar tus primeras llamadas a la API para buscar y recuperar documentación para desarrolladores.

Antes de comenzar

Antes de comenzar a usar la API de Developer Knowledge, asegúrate de completar los siguientes pasos.

Habilita la API

  1. Abre la página de la API de Developer Knowledge en la biblioteca de APIs de Google.
  2. Verifica que hayas seleccionado el proyecto correcto en el que deseas usar la API.
  3. Haz clic en Habilitar. No se requieren roles de IAM específicos para habilitar o usar la API.

Crea y protege la clave de API

  1. En la consola de Google Cloud del proyecto en el que habilitaste la API, ve a la página Credenciales.
  2. Haz clic en Crear credenciales y, luego, selecciona Clave de API en el menú.
  3. En el campo Nombre, proporciona un nombre para la clave.
  4. Haz clic en el menú desplegable Seleccionar restricciones de API y, luego, escribe API de Developer Knowledge. Haz clic en el resultado y, luego, en Aceptar.
    • Nota: Si acabas de habilitar la API de Developer Knowledge, es posible que haya una demora antes de que aparezca en la lista. Espera unos minutos y vuelve a intentarlo.
  5. Haz clic en Crear.

Responde una búsqueda con generación fundamentada

Una vez que tengas tu clave de la API de Developer Knowledge, podrás comenzar a usar la API. En el siguiente ejemplo, se muestra cómo hacer una pregunta y obtener una respuesta basada en la documentación:

  1. Guarda tu clave de la API de Developer Knowledge en una variable de entorno:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Reemplaza YOUR_API_KEY por la clave de API que generaste.

  2. Usa curl para llamar al extremo AnswerQuery:

    curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Este comando devuelve una respuesta a tu consulta basada en la documentación.

Buscar fragmentos de documentos

Si quieres encontrar fragmentos de documentación específicos en lugar de una respuesta generada, puedes buscar directamente fragmentos de documentos.

Usa curl para llamar al extremo SearchDocumentChunks:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

La respuesta incluye fragmentos de contenido coincidentes de la documentación y referencias a los documentos principales.

Recupera un documento

La respuesta de searchDocumentChunks contiene una lista de fragmentos de documentos. Cada fragmento de documento tiene un campo parent que contiene el nombre del recurso del documento, que puedes usar con GetDocument para recuperar el contenido completo del documento.

Para recuperar un documento, copia el campo parent de uno de los fragmentos que devolvió searchDocumentChunks y guárdalo en una variable de entorno. Luego, usa curl para llamar al extremo GetDocument:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

Devuelve el contenido completo en Markdown del documento especificado.

¿Qué sigue?