Krótkie wprowadzenie: korzystanie z gcloud CLI z Developer Knowledge API

Ten przewodnik Szybki start pokazuje, jak odpowiadać na zapytania oraz wyszukiwać i pobierać dokumentację dla deweloperów za pomocą interfejsu Developer Knowledge API przy użyciu Google Cloud CLI.

Zanim zaczniesz

Zanim zaczniesz korzystać z interfejsu Developer Knowledge API za pomocą gcloud CLI, wykonaj te czynności.

Instalowanie i konfigurowanie gcloud CLI

Aby zainstalować i skonfigurować gcloud CLI, wykonaj te czynności:

  1. Jeśli nie masz zainstalowanego interfejsu wiersza poleceń gcloud, zainstaluj go.

  2. Uruchom gcloud components update polecenie, aby sprawdzić, czy masz najnowszą wersję:

    gcloud components update

  3. Zaloguj się na konto Google Cloud, uruchamiając gcloud auth loginpolecenie:

    gcloud auth login

  4. Ustaw aktywny projekt w chmurze Google Cloud, uruchamiając gcloud config set polecenie:

    gcloud config set project PROJECT_ID

    Zastąp PROJECT_ID identyfikatorem Twojego projektu Google Cloud.

Włącz API

Aby włączyć interfejs Developer Knowledge API, wykonaj te czynności:

  1. Włącz interfejs Developer Knowledge API w projekcie Google Cloud, uruchamiając gcloud services enableto polecenie:

    gcloud services enable developerknowledge.googleapis.com

    Aby włączyć interfejs API lub z niego korzystać, nie musisz mieć określonych ról Identity and Access Management (IAM).

  2. Sprawdź, czy interfejs API jest włączony w projekcie, uruchamiając gcloud services listpolecenie:

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

    W danych wyjściowych zobaczysz nazwę i tytuł interfejsu API:

    NAME                                     TITLE
developerknowledge.googleapis.com  Developer Knowledge API

Generowanie odpowiedzi na podstawie dokumentacji

gcloud developer-knowledge answer-queryPolecenie umożliwia zadawanie pytań o usługi Google i otrzymywanie bezpośrednich odpowiedzi w języku naturalnym. Polecenie pobiera informacje z oficjalnych źródeł dokumentacji i zawiera cytowania stron, do których się odwołuje.

Aby zadać pytanie i wygenerować odpowiedź, wykonaj te czynności:

  1. Aby zapytać, jak utworzyć zasobnik Cloud Storage, uruchom to polecenie:

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

  2. Sprawdź, czy polecenie zwraca wygenerowaną odpowiedź i odniesienia do źródeł w formacie 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

    Obiekt answer w danych wyjściowych zawiera te pola:

    • answerText: wygenerowaną odpowiedź w języku naturalnym na Twoje zapytanie.
    • citations: zakresy przesunięć bajtów, startIndex i endIndex, w answerText, które są mapowane na obsługiwane wpisy w references przez referenceIndex.
    • references: fragmenty dokumentacji źródłowej i metadane, w tym document i parent, użyte do wygenerowania odpowiedzi.

Wyszukiwanie fragmentów dokumentów

Aby znaleźć konkretne fragmenty tekstu w dokumentacji dla deweloperów Google zamiast wygenerowanej odpowiedzi, użyj gcloud developer-knowledge documents search-chunks polecenia. To polecenie skanuje korpus dokumentacji i zwraca pasujące fragmenty treści wraz z nazwami zasobów dokumentów nadrzędnych.

Aby wyszukać fragmenty dokumentu, wykonaj te czynności:

  1. Aby wyszukać dokumentację dotyczącą tworzenia zasobników Cloud Storage, uruchom to polecenie:

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

  2. Sprawdź, czy polecenie zwraca listę pasujących fragmentów dokumentu w formacie 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

    Każdy fragment w danych wyjściowych zawiera te pola:

    • content: dopasowany fragment tekstu z dokumentacji;
    • document: metadane dokumentu źródłowego, w tym title, description, uri, dataSource i updateTime.
    • id: identyfikator fragmentu w dokumencie.
    • parent: nazwa zasobu dokumentu nadrzędnego. Możesz przekazać tę wartość do describe polecenia, aby pobrać pełny dokument.
    • relevanceScore: ocena trafności fragmentu w odniesieniu do zapytania.

Pobieranie dokumentu

Po znalezieniu odpowiedniego fragmentu dokumentu użyj pola parent z wyników wyszukiwania, aby pobrać pełną zawartość dokumentu w formacie Markdown.

Uruchom polecenie gcloud developer-knowledge documents describe z nazwą zasobu dokumentu. Aby na przykład wyświetlić dokument dotyczący tworzenia zasobników Cloud Storage, wykonaj te czynności:

  1. Uruchom to polecenie:

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

  2. Sprawdź, czy polecenie zwraca metadane i pełną zawartość dokumentu w formacie Markdown:

    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

    Dane wyjściowe zawierają te pola:

    • content: pełny tekst dokumentu w formacie Markdown.
    • contentLengthBytes: całkowity rozmiar treści dokumentu w bajtach.
    • dataSource: domena dokumentacji, w której znajduje się dokument;
    • description: krótkie podsumowanie dokumentu;
    • name: unikalna nazwa zasobu dokumentu.
    • title: tytuł dokumentu;
    • updateTime: sygnatura czasowa ostatniej aktualizacji dokumentu.
    • uri: publiczny adres URL strony dokumentacji.
    • view: zwrócony widok dokumentu (DOCUMENT_VIEW_CONTENT, DOCUMENT_VIEW_BASIC lub DOCUMENT_VIEW_FULL).

Co dalej?