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:
SearchDocumentChunkspara encontrar URIs de páginas y fragmentos de contenido relevantes según una búsqueda.GetDocumentoBatchGetDocumentspara recuperar el contenido completo de los resultados de la búsqueda.AnswerQuerypara obtener respuestas a las preguntas 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 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 para tu proyecto de Google Cloud.
- Abre la página de la API de Developer Knowledge en la biblioteca de APIs de Google.
- Verifica que hayas seleccionado el proyecto correcto en el que deseas usar la API.
- Haz clic en Habilitar. No se requieren roles de IAM específicos para habilitar o usar la API.
Autenticación
Se requiere una clave de la API de Developer Knowledge para usarla. Para crear uno, sigue estos pasos:
- En la consola de Google Cloud del proyecto en el que habilitaste la API, ve a la página Credenciales.
- Haz clic en Crear credenciales y, luego, selecciona Clave de API en el menú.
- En el campo Nombre, proporciona un nombre para la clave.
-
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.
Notas:
- 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.
-
Si planeas usar la misma clave para las llamadas al modelo general de tu cliente de IA (por ejemplo,
GEMINI_API_KEY), también debes seleccionar la API de Generative Language. De lo contrario, se bloquearán esas llamadas.
- Haz clic en Crear.
Incluye esta clave de la API de Developer Knowledge en tus solicitudes. Por ejemplo, las llamadas a REST deben incluirlo 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 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.