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

La API de Developer Knowledge admite la búsqueda y recuperación de páginas de documentación como contenido de Markdown no estructurado. El corpus de contenido apto para búsquedas se enumera en la Referencia del corpus.

Formas de usar Developer Knowledge

Puedes acceder a Developer Knowledge a través de las siguientes plataformas, según tu flujo de trabajo:

• API de REST y API de RPC: Llama a los extremos de HTTP o gRPC directamente. Consulta la referencia de REST y la referencia de RPC para conocer las especificaciones de los métodos.
• Bibliotecas cliente: Integra la API de Developer Knowledge en tus aplicaciones con las bibliotecas cliente oficiales para Python, Node.js y TypeScript, Go, Java, PHP y Ruby.
• Google Cloud CLI (gcloud): Ejecuta comandos de gcloud developer-knowledge desde tu terminal para buscar fragmentos de documentos, recuperar contenido en Markdown y generar respuestas.
• Servidor de MCP de Developer Knowledge: Conecta tu asistente o agente de programación con IA a la documentación de Google con las herramientas del Protocolo de contexto del modelo (MCP) (search_documents, get_documents y answer_query). Consulta la referencia de MCP.

Nota: Si usas un asistente de programación de IA, instala la habilidad del agente retrieving-developer-knowledge ejecutando npx skills add google/skills --skill retrieving-developer-knowledge. Esta habilidad le brinda a tu asistente instrucciones integradas sobre qué herramienta del servidor de MCP de Developer Knowledge elegir, cómo controlar los errores y cómo llamar a la API de REST con curl si el servidor de MCP no está disponible. Para obtener más información, consulta Cómo usar la habilidad del agente de conocimiento para desarrolladores.

Elige entre la API y el servidor de MCP

La API de Developer Knowledge y el servidor de MCP de Developer Knowledge están diseñados para diferentes necesidades de integración:

• Usa la API de Developer Knowledge, las bibliotecas cliente o la CLI de gcloud en los siguientes casos:
  • Tu proyecto no usa un agente de IA.
  • Quieres definir herramientas o conjuntos de herramientas personalizados para tu agente.
  • Deseas procesar o combinar resultados antes de pasarlos a un modelo (por ejemplo, verificar la longitud en bytes del documento antes de recuperar el contenido completo).
  • Debes filtrar los resultados de la búsqueda (por ejemplo, por data_source o update_time) o aplicar máscaras de campos.
• Usa el servidor de MCP de Developer Knowledge y la habilidad del agente en los siguientes casos:
  • Quieres conectar un asistente o agente de programación con IA sin escribir definiciones ni descripciones de herramientas personalizadas.
  • Quieres actualizaciones automáticas a medida que el servidor de MCP de Developer Knowledge agrega nuevas capacidades.
  • No necesitas un filtro de metadatos personalizado en los resultados de la búsqueda.

Habilita la API

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

Nota: Si no tienes un proyecto de Google Cloud, crea uno siguiendo las instrucciones de Google Cloud o Firebase.

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 las solicitudes de REST directas o el servidor de MCP de Developer Knowledge con el parámetro de consulta key o el encabezado X-Goog-Api-Key.
• 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.
• Credenciales de usuario (CLI de gcloud): Autentica las solicitudes de la CLI accediendo a tu cuenta de Google Cloud con gcloud auth login. Consulta la guía de inicio rápido de gcloud CLI para obtener instrucciones de configuració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.