Este guia mostra exemplos de como usar as principais funções da API Developer Knowledge: pesquisar documentos, recuperar um único documento e recuperar vários documentos em lote.
Antes de começar, verifique se você ativou a API e gerou uma chave da API Developer Knowledge. Salve a chave em uma variável de ambiente:
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
Pesquisar documentos com SearchDocumentChunks
Use o método documents.searchDocumentChunks
para encontrar partes de documentos que correspondam a uma string de consulta. Os resultados incluem
pedaços de conteúdo do documento e uma referência parent que você pode usar
para recuperar o conteúdo completo do documento.
O exemplo a seguir pesquisa documentos que correspondem a "BigQuery":
curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
É possível refinar os resultados da pesquisa usando parâmetros como
pageSize
para limitar o número de resultados por página e
pageToken
para recuperar páginas subsequentes.
Recuperar um documento com GetDocument
Use o método documents.get
para recuperar o conteúdo completo de um único documento usando o
DocumentChunk.parent retornado por uma chamada SearchDocumentChunks.
O exemplo a seguir recupera um documento com o nome
documents/DOCUMENT_ID:
curl "https://developerknowledge.googleapis.com/v1alpha/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"
A resposta é o recurso completo
Document, incluindo o campo content.
Recuperar vários documentos com BatchGetDocuments
Use o método documents.batchGet
para recuperar até 100 documentos por nome em uma única chamada de API. Isso é mais eficiente do que fazer várias solicitações GetDocument.
O exemplo a seguir recupera dois documentos por nome:
curl "https://developerknowledge.googleapis.com/v1alpha/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
A resposta contém uma lista dos recursos
Document
solicitados.