En esta guía se ofrecen ejemplos de cómo usar las funciones principales de la API Developer Knowledge: buscar documentos, obtener un solo documento y obtener varios documentos en un lote.
Antes de empezar, asegúrate de haber habilitado la API y generado una clave de API Developer Knowledge, y guarda la clave en una variable de entorno:
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
Buscar documentos con SearchDocumentChunks
Usa el método documents.searchDocumentChunks
para buscar fragmentos de documentos que coincidan con una cadena de consulta. Los resultados incluyen fragmentos de contenido del documento y una parentreferencia que puedes usar para obtener el contenido completo del documento.
En el siguiente ejemplo se buscan documentos que coincidan con "BigQuery":
curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
Puedes acotar los resultados de búsqueda con parámetros como
pageSize
para limitar el número de resultados por página y
pageToken
para obtener las páginas siguientes.
Recuperar un documento con GetDocument
Usa el método documents.get para obtener el contenido completo de un solo documento. Para ello, utiliza el DocumentChunk.parent devuelto por una llamada SearchDocumentChunks.
En el siguiente ejemplo se obtiene un documento con el nombre documents/DOCUMENT_ID:
curl "https://developerknowledge.googleapis.com/v1alpha/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"
La respuesta es el recurso Document completo, incluido el campo content.
Recuperar varios documentos con BatchGetDocuments
Usa el método documents.batchGet para recuperar hasta 100 documentos por nombre en una sola llamada a la API. Es más eficiente que hacer varias solicitudes GetDocument.
En el siguiente ejemplo se obtienen dos documentos por su nombre:
curl "https://developerknowledge.googleapis.com/v1alpha/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
La respuesta contiene una lista de los recursos Document
solicitados.