Ce guide fournit des exemples d'utilisation des 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 key, puis enregistrez votre clé dans une variable d'environnement :
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
Rechercher des documents avec SearchDocumentChunks
Utilisez la documents.searchDocumentChunks
méthode pour trouver des blocs de documents 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/v1/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.
Filtrer les résultats de recherche
Utilisez le paramètre filter pour appliquer un filtre strict aux résultats de recherche. Le filtre est appliqué aux métadonnées des documents associés aux blocs de résultats de recherche.
Champs compatibles pour le filtrage :
data_source(STRING) : source du document, par exemple,docs.cloud.google.com.update_time(TIMESTAMP) : code temporel de la dernière mise à jour du document.uri(STRING) : URI du document, par exemple,https://docs.cloud.google.com/bigquery/docs/tables.
Opérateurs compatibles :
- Les champs STRING sont compatibles avec
=(égal à) et!=(différent de) pour les correspondances exactes sur l'ensemble de la chaîne. - Les champs TIMESTAMP sont compatibles avec
=,<,<=,>, et>=. Les codes temporels doivent être au format RFC-3339 (par exemple,"2025-01-01T00:00:00Z").
Vous pouvez combiner des expressions à l'aide des opérateurs logiques AND, OR et NOT (ou -). Notez que OR est prioritaire par rapport à AND.
L'exemple suivant recherche les documents correspondant à "BigQuery" et limite les résultats à ceux provenant de docs.cloud.google.com :
curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&filter=data_source%3D%22docs.cloud.google.com%22&key=$DEVELOPERKNOWLEDGE_API_KEY"
Récupérer un document avec GetDocument
Utilisez la documents.get
méthode pour récupérer l'intégralité du contenu d'un seul document.
L'exemple suivant récupère un document nommé documents/DOCUMENT_ID :
curl "https://developerknowledge.googleapis.com/v1/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 documents.batchGet
méthode 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 nom :
curl "https://developerknowledge.googleapis.com/v1/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
La réponse contient une liste des ressources demandées
Document.