Kurzanleitung: gcloud CLI mit der Developer Knowledge API verwenden

In dieser Kurzanleitung erfahren Sie, wie Sie mit der Google Cloud CLI Fragen beantworten sowie Entwicklerdokumentation suchen und abrufen.

Hinweis

Bevor Sie die Developer Knowledge API mit der gcloud CLI verwenden können, müssen Sie die folgenden Schritte ausführen.

gcloud CLI installieren und konfigurieren

Führen Sie die folgenden Schritte aus, um die gcloud CLI zu installieren und zu konfigurieren:

  1. Wenn Sie die gcloud CLI noch nicht installiert haben, installieren Sie sie jetzt.

  2. Führen Sie den gcloud components update-Befehl aus, um sicherzustellen, dass Sie die neueste Version haben:

    gcloud components update

  3. Melden Sie sich mit dem gcloud auth login-Befehl in Ihrem Google Cloud-Konto an:

    gcloud auth login

  4. Legen Sie Ihr aktives Google Cloud-Projekt mit dem Befehl gcloud config set fest:

    gcloud config set project PROJECT_ID

    Ersetzen Sie PROJECT_ID durch die ID Ihres Google Cloud-Projekts.

API aktivieren

So aktivieren Sie die Developer Knowledge API:

  1. Aktivieren Sie die Developer Knowledge API in Ihrem Google Cloud-Projekt, indem Sie den gcloud services enable-Befehl ausführen:

    gcloud services enable developerknowledge.googleapis.com

    Sie benötigen keine bestimmten IAM-Rollen (Identity and Access Management), um die API zu aktivieren oder zu verwenden.

  2. Prüfen Sie, ob die API für Ihr Projekt aktiviert ist, indem Sie den gcloud services list-Befehl ausführen:

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

    In der Ausgabe werden der API-Name und ‑Titel aufgeführt:

    NAME                                     TITLE
developerknowledge.googleapis.com  Developer Knowledge API

Antworten aus der Dokumentation generieren

Mit dem Befehl gcloud developer-knowledge answer-query können Sie Fragen zu Google-Produkten stellen und erhalten direkte Antworten in natürlicher Sprache. Der Befehl ruft Informationen aus offiziellen Dokumentationsquellen ab und gibt Zitate für die referenzierten Seiten an.

So stellen Sie eine Frage und lassen eine Antwort generieren:

  1. Führen Sie den folgenden Befehl aus, um zu fragen, wie Sie einen Cloud Storage-Bucket erstellen:

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

  2. Prüfen Sie, ob der Befehl eine generierte Antwort und Quellenangaben im YAML-Format zurückgibt:

    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

    Das answer-Objekt in der Ausgabe enthält die folgenden Felder:

    • answerText: Die generierte Antwort in natürlicher Sprache auf Ihre Anfrage.
    • citations: Byte-Offset-Bereiche, startIndex und endIndex, in answerText, die über referenceIndex unterstützenden Einträgen in references zugeordnet werden.
    • references: Die Quellendokumentationsblöcke und ‑metadaten, einschließlich document und parent, die zum Generieren der Antwort verwendet wurden.

Nach Dokumentblöcken suchen

Wenn Sie in der Entwicklerdokumentation von Google nach bestimmten Textausschnitten suchen möchten, anstatt eine generierte Antwort zu erhalten, verwenden Sie den Befehl gcloud developer-knowledge documents search-chunks. Mit diesem Befehl wird das Dokumentations-Corpus durchsucht und es werden passende Inhaltsblöcke zusammen mit den Ressourcennamen der übergeordneten Dokumente zurückgegeben.

So suchen Sie nach Dokumentblöcken:

  1. Führen Sie den folgenden Befehl aus, um nach Dokumentation zum Erstellen von Cloud Storage-Buckets zu suchen:

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

  2. Prüfen Sie, ob der Befehl eine Liste übereinstimmender Dokumentblöcke im YAML-Format zurückgibt:

    ---
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

    Jeder Chunks in der Ausgabe enthält die folgenden Felder:

    • content: Das übereinstimmende Text-Snippet aus der Dokumentation.
    • document: Metadaten zum Quelldokument, einschließlich title, description, uri, dataSource und updateTime.
    • id: die Kennung des Blocks im Dokument
    • parent: Der Ressourcenname des übergeordneten Dokuments. Sie können diesen Wert an den describe-Befehl übergeben, um das vollständige Dokument abzurufen.
    • relevanceScore: Der Relevanzwert des Chunks für die Suchanfrage.

Dokument abrufen

Nachdem Sie einen relevanten Dokumentblock gefunden haben, verwenden Sie das Feld parent aus diesen Suchergebnissen, um den vollständigen Markdown-Inhalt des Dokuments abzurufen.

Führen Sie den Befehl gcloud developer-knowledge documents describe mit dem Ressourcennamen des Dokuments aus. Wenn Sie beispielsweise das Dokument zum Erstellen von Cloud Storage-Buckets abrufen möchten, führen Sie die folgenden Schritte aus:

  1. Führen Sie dazu diesen Befehl aus:

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

  2. Prüfen Sie, ob der Befehl die Metadaten und den vollständigen Markdown-Inhalt des Dokuments zurückgibt:

    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

    Die Ausgabe enthält die folgenden Felder:

    • content: Der vollständige Markdown-Text des Dokuments.
    • contentLengthBytes: die Gesamtgröße des Dokumentinhalts in Byte.
    • dataSource: die Dokumentationsdomain, auf der das Dokument gehostet wird.
    • description: eine kurze Zusammenfassung des Dokuments.
    • name: Der eindeutige Ressourcenname des Dokuments.
    • title: Der Titel des Dokuments.
    • updateTime: Der Zeitstempel, der angibt, wann das Dokument zuletzt aktualisiert wurde.
    • uri: Die öffentliche URL der Dokumentationsseite.
    • view: Die zurückgegebene Dokumentansicht (DOCUMENT_VIEW_CONTENT, DOCUMENT_VIEW_BASIC oder DOCUMENT_VIEW_FULL).

Nächste Schritte