API de Developer Knowledge

La API de Developer Knowledge proporciona acceso programático a la documentación pública para desarrolladores de Google, lo que te permite integrar esta base de conocimiento en tus propias aplicaciones y flujos de trabajo.

Descripción general

La API de Developer Knowledge está diseñada para ser la fuente canónica para el acceso legible por máquina a la documentación para desarrolladores de Google. Ofrece funciones para buscar y recuperar documentos, y responder consultas:

  • SearchDocumentChunks para encontrar URIs de páginas y fragmentos de contenido relevantes según una consulta.
  • GetDocument o BatchGetDocuments para recuperar el contenido completo de los resultados de la búsqueda.
  • AnswerQuery para obtener respuestas a consultas basadas en el corpus de documentación.

Para comenzar rápidamente, sigue la Guía de inicio rápido.

El corpus de contenido que se puede buscar se enumera en Referencia del corpus.

La API de Developer Knowledge admite la búsqueda y recuperación de páginas de documentación como contenido de Markdown no estructurado.

Habilita la API

Para usar la API de Developer Knowledge, primero debes habilitarla para tu proyecto de Google Cloud.

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

Autenticación

Se requiere una clave de API de Developer Knowledge para usar la API de Developer Knowledge. Para crear una, haz lo siguiente:

  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.

Incluye esta clave de API de Developer Knowledge en tus solicitudes. Por ejemplo, las llamadas a REST deben incluirla con el parámetro de consulta key. Consulta la Guía de inicio rápido para ver un ejemplo.

Documentación incluida

Consulta Referencia del corpus para obtener información sobre qué documentos busca la API.

Limitaciones conocidas

  • Calidad de Markdown: El Markdown se genera a partir del HTML fuente. Es posible que haya algunas discrepancias o problemas de formato.
  • Alcance del contenido: Solo se incluyen las páginas públicas en la Referencia del corpus. No se incluye contenido de otras fuentes, como GitHub, sitios de OSS, blogs o YouTube.