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 de acceso legible por máquina a la documentación para desarrolladores de Google. Ofrece funciones para buscar y recuperar documentos, y responder preguntas:

• SearchDocumentChunks para encontrar URIs de páginas y fragmentos de contenido relevantes según una búsqueda.
• GetDocument o BatchGetDocuments para recuperar el contenido completo de los resultados de la búsqueda.
• AnswerQuery para generar respuestas a las búsquedas extraídas del corpus de documentación

Además de llamar directamente a la API de REST o a las bibliotecas cliente, puedes conectar Developer Knowledge a tu asistente de programación con IA con las siguientes herramientas:

• Servidor de MCP de Developer Knowledge: Permite que tu asistente de programación con IA busque y lea la documentación de Google con las herramientas del Protocolo de contexto del modelo (MCP) (search_documents, get_documents y answer_query).
• Habilidad del agente de retrieving-developer-knowledge: Le brinda a tu asistente de IA instrucciones integradas sobre cuándo usar cada herramienta del servidor de MCP de Developer Knowledge, además de cómo llamar a la API de REST con curl si el MCP no está disponible.

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

El corpus de contenido apto para la búsqueda se enumera en la 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 en 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 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.

Autenticación

Puedes autenticar solicitudes a la API de Developer Knowledge con uno de los siguientes métodos:

• Clave de API: Autentica solicitudes directas de REST con el parámetro de consulta key o el encabezado X-Goog-Api-Key. Consulta la guía de inicio rápido de REST para ver un ejemplo.
• Credenciales predeterminadas de la aplicación (ADC), OAuth 2.0 o cuentas de servicio: Autentica solicitudes cuando uses las bibliotecas cliente oficiales o los flujos de trabajo de producción. Para obtener más información sobre la configuración de credenciales, consulta la documentación de las credenciales predeterminadas de la aplicación.

Documentación incluida

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

El objetivo de la API de Developer Knowledge es proporcionar acceso a la documentación más reciente para desarrolladores de Google. Nuestro objetivo es volver a indexar el contenido en un plazo de 48 horas después de la publicación para que la documentación nueva o actualizada esté disponible en un plazo de 2 días hábiles.

Limitaciones conocidas

• Calidad de Markdown: El Markdown se genera a partir del código 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 el contenido de otras fuentes, como GitHub, sitios de OSS, blogs o YouTube.