Cette page explique comment débuter avec les bibliothèques clientes Cloud pour l'API Developer Knowledge. Au lieu de créer des requêtes HTTP brutes, les bibliothèques clientes fournissent des types idiomatiques, une authentification intégrée, une pagination automatique et une gestion des nouvelles tentatives qui réduisent la quantité de code à écrire.
Pour en savoir plus sur les bibliothèques clientes des API Google, consultez Présentation des bibliothèques clientes.
Installer la bibliothèque cliente
Sélectionnez votre langage de programmation pour installer la bibliothèque cliente officielle de l'API Developer Knowledge :
Go
Ajoutez le module à votre projet Go :
go get cloud.google.com/go/developerknowledge/apiv1
Pour en savoir plus, consultez Configurer un environnement de développement Go.
Java
Si vous utilisez Maven, ajoutez la dépendance suivante à votre fichier pom.xml :
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-developer-knowledge</artifactId>
<version>0.6.0</version>
</dependency>
Si vous utilisez Gradle, ajoutez la dépendance suivante à votre fichier build.gradle :
implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'
Pour en savoir plus, consultez Configurer un environnement de développement Java.
Node.js et TypeScript
Installez le package à l'aide de npm :
npm install @google/developer-knowledge
Pour en savoir plus, consultez Configurer un environnement de développement Node.js.
PHP
Installez le package à l'aide de Composer :
composer require google/developer-knowledge
Pour en savoir plus, consultez Utiliser PHP sur Google Cloud.
Python
Installez le package à l'aide de pip :
pip install --upgrade google-developer-knowledge
Pour en savoir plus, consultez Configurer un environnement de développement Python.
Ruby
Installez le gem :
gem install google-developers-developer_knowledge
Pour en savoir plus, consultez Configurer un environnement de développement Ruby.
Configurer l'authentification
Avant d'envoyer des requêtes d'API, assurez-vous d'avoir activé l'API Developer Knowledge dans votre projet Google Cloud.
Pour authentifier les appels à l'API Developer Knowledge, les bibliothèques clientes sont compatibles avec les identifiants par défaut de l'application (ADC). Les bibliothèques recherchent les identifiants dans un ensemble d'emplacements définis et les utilisent pour authentifier les requêtes adressées à l'API. Le service ADC vous permet de mettre des identifiants à disposition de votre application dans divers environnements, tels que le développement local ou de production, sans avoir à modifier le code de votre application.
Pour les environnements de production, la façon de configurer ADC dépend du service et du contexte :
- Environnements Google Cloud : lorsque votre application s'exécute sur Cloud Run, Google Kubernetes Engine, Compute Engine ou Cloud Run Functions, ADC utilise automatiquement le compte de service associé à la ressource de calcul.
- Environnements externes ou sur site : utilisez la fédération d'identité de charge de travail ou définissez la variable d'environnement
GOOGLE_APPLICATION_CREDENTIALSsur le chemin d'accès d'un fichier de configuration d'identifiants.
Pour en savoir plus sur les options d'identifiants de production, consultez Configurer les identifiants par défaut de l'application.
Pour un environnement de développement local, vous pouvez configurer ADC avec les identifiants associés à votre compte Google :
- Installez et initialisez la gcloud CLI.
Créez des identifiants d'authentification locaux pour votre compte Google :
gcloud auth application-default loginUn écran de connexion s'affiche. Une fois que vous êtes connecté, vos identifiants sont stockés dans le fichier d'identifiants local utilisé par ADC.
Ressources supplémentaires
Sélectionnez un onglet de langue pour trouver des liens vers la documentation de référence de l'API, des exemples de code, des bonnes pratiques, des outils de suivi des problèmes et des dépôts de code source pour chaque bibliothèque cliente :
Go
La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Go :
Java
La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Java :
Node.js et TypeScript
La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Node.js et TypeScript :
PHP
La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour PHP :
Python
La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Python :
Ruby
La liste suivante contient des liens vers d'autres ressources liées à la bibliothèque cliente pour Ruby :
Étape suivante
- Suivez le guide de démarrage rapide des bibliothèques clientes pour afficher et exécuter des exemples de code pour
AnswerQuery,SearchDocumentChunks,GetDocumentetBatchGetDocuments. - Pour en savoir plus sur les filtres de requête, la pagination et les masques de champ, consultez Rechercher et récupérer des documents.
- Utilisez la génération ancrée avec Générer des réponses à partir de la documentation.
- Consultez les stratégies de réessai et les codes d'état dans Gestion des erreurs, limitation du débit et gestion des quotas.
- Parcourez la référence du corpus pour afficher tous les domaines de documentation acceptés.