Démarrage rapide : utiliser la gcloud CLI avec l'API Developer Knowledge

Ce guide de démarrage rapide vous explique comment répondre à des requêtes, et rechercher et récupérer de la documentation pour les développeurs avec l'API Developer Knowledge à l'aide de Google Cloud CLI.

Avant de commencer

Avant de commencer à utiliser l'API Developer Knowledge avec la gcloud CLI, suivez les étapes ci-dessous.

Installer et configurer gcloud CLI

Pour installer et configurer la gcloud CLI, procédez comme suit :

  1. Si vous n'avez pas installé gcloud CLI, installez-le.

  2. Exécutez la commande gcloud components update pour vous assurer que vous disposez de la dernière version :

    gcloud components update

  3. Connectez-vous à votre compte Google Cloud en exécutant la commande gcloud auth login :

    gcloud auth login

  4. Définissez votre projet Google Cloud actif en exécutant la commande gcloud config set :

    gcloud config set project PROJECT_ID

    Remplacez PROJECT_ID par l'ID de votre projet Google Cloud.

Activer l'API

Pour activer l'API Developer Knowledge, procédez comme suit :

  1. Activez l'API Developer Knowledge dans votre projet Google Cloud en exécutant la commande gcloud services enable :

    gcloud services enable developerknowledge.googleapis.com

    Vous n'avez pas besoin de rôles Identity and Access Management (IAM) spécifiques pour activer ou utiliser l'API.

  2. Vérifiez que l'API est activée pour votre projet en exécutant la commande gcloud services list :

    gcloud services list --enabled \
    --filter="name:developerknowledge.googleapis.com"

    Le résultat liste le nom et le titre de l'API :

    NAME                                     TITLE
developerknowledge.googleapis.com  Developer Knowledge API

Générer des réponses à partir de la documentation

La commande gcloud developer-knowledge answer-query vous permet de poser des questions sur les produits Google et d'obtenir des réponses directes en langage naturel. La commande extrait des informations de sources de documentation officielles et fournit des citations vers les pages référencées.

Pour poser une question et générer une réponse :

  1. Exécutez la commande suivante pour demander comment créer un bucket Cloud Storage :

    gcloud developer-knowledge answer-query \
    --query="How do I create a Cloud Storage bucket?"

  2. Vérifiez que la commande renvoie une réponse générée et des références de sources au format YAML :

    answer:
  answerText: |-
    To create a Cloud Storage bucket, you can use the Google Cloud console,
    the gcloud CLI (`gcloud storage buckets create`), client libraries, or
    the REST API...
  citations:
  - endIndex: 158
    sources:
    - referenceIndex: 0
    startIndex: 0
  references:
  - documentReference:
      documentChunk:
        content: |-
          This document shows you how to create a Cloud Storage
          [bucket](https://docs.cloud.google.com/storage/docs/buckets)...
        document:
          dataSource: docs.cloud.google.com
          name: documents/docs.cloud.google.com/storage/docs/creating-buckets
          title: Create a bucket
          uri: https://docs.cloud.google.com/storage/docs/creating-buckets
        parent: documents/docs.cloud.google.com/storage/docs/creating-buckets

    L'objet answer dans le résultat inclut les champs suivants :

    • answerText : réponse en langage naturel générée à partir de votre requête.
    • citations : plages de décalage d'octets, startIndex et endIndex, dans answerText qui correspondent aux entrées de soutien dans references par referenceIndex.
    • references : blocs de documentation source et métadonnées, y compris document et parent, utilisés pour générer la réponse.

Rechercher des blocs de documents

Pour trouver des extraits de texte spécifiques dans la documentation pour les développeurs de Google plutôt qu'une réponse générée, utilisez la commande gcloud developer-knowledge documents search-chunks. Cette commande analyse le corpus de documentation et renvoie les blocs de contenu correspondants, ainsi que les noms de ressources de leurs documents parents.

Pour rechercher des blocs de documents, procédez comme suit :

  1. Exécutez la commande suivante pour rechercher de la documentation sur la création de buckets Cloud Storage :

    gcloud developer-knowledge documents search-chunks \
    --query="How do I create a Cloud Storage bucket?"

  2. Vérifiez que la commande renvoie une liste de blocs de documents correspondants au format YAML :

    ---
content: |-
  This document shows you how to create a Cloud Storage
  [bucket](https://docs.cloud.google.com/storage/docs/buckets). If not otherwise
  specified in your request, buckets are created in the
  [US multi-region](https://docs.cloud.google.com/storage/docs/locations)...
document:
  contentLengthBytes: 31842
  dataSource: docs.cloud.google.com
  description: World-wide storage and retrieval of data in Google Cloud.
  name: documents/docs.cloud.google.com/storage/docs/creating-buckets
  title: Create a bucket
  updateTime: '2026-09-10T20:05:41Z'
  uri: https://docs.cloud.google.com/storage/docs/creating-buckets
  view: DOCUMENT_VIEW_BASIC
id: c1
parent: documents/docs.cloud.google.com/storage/docs/creating-buckets
relevanceScore: 0.856608

    Chaque bloc de la sortie inclut les champs suivants :

    • content : extrait de texte correspondant de la documentation.
    • document : métadonnées sur le document source, y compris son title, description, uri, dataSource et updateTime.
    • id : identifiant du bloc dans le document.
    • parent : nom de ressource du document parent. Vous pouvez transmettre cette valeur à la commande describe pour récupérer le document complet.
    • relevanceScore : score de pertinence du bloc par rapport à la requête de recherche.

Récupérer un document

Une fois que vous avez trouvé un bloc de document pertinent, utilisez le champ parent de ces résultats de recherche pour récupérer le contenu Markdown complet du document.

Exécutez la commande gcloud developer-knowledge documents describe avec le nom de ressource du document. Par exemple, pour récupérer le document sur la création de buckets Cloud Storage, procédez comme suit :

  1. Exécutez la commande suivante :

    gcloud developer-knowledge documents describe \
  documents/docs.cloud.google.com/storage/docs/creating-buckets

  2. Vérifiez que la commande renvoie les métadonnées et le contenu Markdown complet du document :

    content: |
  This document shows you how to create a Cloud Storage [bucket](https://docs.cloud.google.com/storage/docs/buckets). If not otherwise specified in your request, buckets are
  created in the [`US` multi-region](https://docs.cloud.google.com/storage/docs/locations)
  with a default storage class of [Standard storage](https://docs.cloud.google.com/storage/docs/storage-classes)
  and have a seven-day [soft delete](https://docs.cloud.google.com/storage/docs/soft-delete)
  retention duration...
contentLengthBytes: 31842
dataSource: docs.cloud.google.com
description: World-wide storage and retrieval of data in Google Cloud.
name: documents/docs.cloud.google.com/storage/docs/creating-buckets
title: Create a bucket
updateTime: '2026-09-10T20:05:41Z'
uri: https://docs.cloud.google.com/storage/docs/creating-buckets
view: DOCUMENT_VIEW_CONTENT

    Le résultat inclut les champs suivants :

    • content : texte Markdown complet du document.
    • contentLengthBytes : taille totale du contenu du document en octets.
    • dataSource : domaine de documentation hébergeant le document.
    • description : un bref résumé du document.
    • name : nom de ressource unique du document.
    • title : titre du document.
    • updateTime : code temporel de la dernière mise à jour du document.
    • uri : URL publique de la page de documentation.
    • view : vue du document renvoyée (DOCUMENT_VIEW_CONTENT, DOCUMENT_VIEW_BASIC ou DOCUMENT_VIEW_FULL).

Étape suivante