Ce guide fournit des exemples d'utilisation des principales fonctions de l'API Developer Knowledge : recherche de documents, récupération d'un seul document et récupération de plusieurs documents par lot.
Avant de commencer, assurez-vous d'avoir activé l'API et généré une clé API Developer Knowledge, puis enregistrez votre clé dans une variable d'environnement :
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
Rechercher des documents avec SearchDocumentChunks
Utilisez la méthode documents.searchDocumentChunks pour trouver les blocs de document correspondant à une chaîne de requête. Les résultats incluent des blocs de contenu du document et une référence parent que vous pouvez utiliser pour récupérer l'intégralité du contenu du document.
L'exemple suivant recherche les documents correspondant à "BigQuery" :
curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
Vous pouvez affiner les résultats de recherche à l'aide de paramètres tels que pageSize pour limiter le nombre de résultats par page et pageToken pour récupérer les pages suivantes.
Récupérer un document avec GetDocument
Utilisez la méthode documents.get pour récupérer l'intégralité du contenu d'un seul document, à l'aide du DocumentChunk.parent renvoyé par un appel SearchDocumentChunks.
L'exemple suivant récupère un document nommé documents/DOCUMENT_ID :
curl "https://developerknowledge.googleapis.com/v1alpha/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"
La réponse est la ressource Document complète, y compris le champ content.
Récupérer plusieurs documents avec BatchGetDocuments
Utilisez la méthode documents.batchGet pour récupérer jusqu'à 100 documents par nom en un seul appel d'API. Cette méthode est plus efficace que l'envoi de plusieurs requêtes GetDocument.
L'exemple suivant récupère deux documents par leur nom :
curl "https://developerknowledge.googleapis.com/v1alpha/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
La réponse contient une liste des ressources Document demandées.