API de Developer Knowledge

Vista previa

Este producto se encuentra sujeto a las "Condiciones de la Oferta de la Fase previa a la DG" en la sección Condiciones Generales del Servicio de las Condiciones Específicas del Servicio. Los productos de la fase previa a la DG están disponibles sin modificaciones y pueden tener asistencia limitada. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

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 dos funciones principales:

• SearchDocumentChunks para encontrar URIs de páginas y fragmentos de contenido relevantes en función de una consulta
• GetDocument o BatchGetDocuments para recuperar el contenido completo de los resultados de la búsqueda

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

El corpus de contenido que se puede buscar se muestra en la referencia del corpus.

Nota para la versión preliminar: Esta versión preliminar admite la búsqueda y la 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.

Sugerencia:Si no tienes un proyecto de Google Cloud, crea uno con 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 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ú. Se mostrará la cadena de la clave recién creada en el cuadro de diálogo Se creó la clave de API.
3. Haz clic en Editar clave de API.
4. En el campo Nombre, proporciona un nombre para la clave.
5. En Restricciones de API, selecciona Restringir clave.
6. En la lista Seleccionar APIs, habilita la API de Developer Knowledge y haz clic 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 Seleccionar APIs.
7. Haz clic en Guardar.

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 la 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.