Быстрый старт: используйте интерфейс командной строки gcloud с API базы знаний для разработчиков.

В этом кратком руководстве показано, как отвечать на запросы, а также искать и получать документацию для разработчиков с помощью API знаний разработчиков, используя интерфейс командной строки Google Cloud.

Прежде чем начать

Прежде чем начать использовать API базы знаний для разработчиков с помощью CLI gcloud, выполните следующие шаги.

Установите и настройте интерфейс командной строки gcloud.

Для установки и настройки интерфейса командной строки gcloud выполните следующие шаги:

  1. Если у вас еще не установлен интерфейс командной строки gcloud, установите его .

  2. Выполните команду gcloud components update , чтобы убедиться, что у вас установлена ​​последняя версия:

    gcloud components update

  3. Войдите в свою учетную запись Google Cloud, выполнив команду gcloud auth login :

    gcloud auth login

  4. Для активации проекта Google Cloud выполните команду gcloud config set :

    gcloud config set project PROJECT_ID

    Замените PROJECT_ID на идентификатор вашего проекта в Google Cloud.

Включить API

Чтобы активировать API базы знаний для разработчиков, выполните следующие шаги:

  1. Включите API базы знаний для разработчиков в своем проекте Google Cloud, выполнив команду gcloud services enable :

    gcloud services enable developerknowledge.googleapis.com

    Для включения или использования API не требуются специальные роли в системе управления идентификацией и доступом (IAM).

  2. Убедитесь, что API включен для вашего проекта, выполнив команду gcloud services list :

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

    В выходных данных отображается название и заголовок API:

    NAME                                     TITLE
developerknowledge.googleapis.com  Developer Knowledge API

Сгенерируйте ответы на основе документации.

Команда gcloud developer-knowledge answer-query позволяет задавать вопросы о продуктах Google и получать прямые ответы на естественном языке. Команда извлекает информацию из официальных источников документации и предоставляет ссылки на соответствующие страницы.

Чтобы задать вопрос и получить ответ, выполните следующие шаги:

  1. Выполните следующую команду, чтобы узнать, как создать сегмент Cloud Storage:

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

  2. Убедитесь, что команда возвращает сгенерированный ответ и ссылки на исходный код в формате 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

    В выходных данных объект answer содержит следующие поля:

    • answerText : сгенерированный ответ на ваш запрос на естественном языке.
    • citations : диапазоны смещения в байтах, startIndex и endIndex , в answerText , которые соответствуют вспомогательным записям в references по referenceIndex .
    • references : фрагменты исходной документации и метаданные, включая document и parent , использованные для генерации ответа.

Поиск фрагментов документа

Чтобы найти конкретные фрагменты текста в документации для разработчиков Google, а не сгенерированный ответ, используйте команду gcloud developer-knowledge documents search-chunks . Эта команда сканирует корпус документации и возвращает соответствующие фрагменты контента вместе с именами ресурсов их родительских документов.

Для поиска фрагментов документа выполните следующие шаги:

  1. Выполните следующую команду, чтобы найти документацию по созданию сегментов Cloud Storage:

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

  2. Убедитесь, что команда возвращает список соответствующих фрагментов документа в формате 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

    Каждый фрагмент выходных данных содержит следующие поля:

    • content : соответствующий фрагмент текста из документации.
    • document : метаданные об исходном документе, включая его title , description , uri , dataSource и updateTime .
    • id : идентификатор фрагмента текста в документе.
    • parent : имя ресурса родительского документа. Вы можете передать это значение команде describe , чтобы получить полный документ.
    • relevanceScore : показатель релевантности фрагмента поисковому запросу.

Получить документ

После того как вы найдете подходящий фрагмент документа, используйте поле parent из результатов поиска, чтобы получить полное содержимое документа в формате Markdown.

Выполните команду gcloud developer-knowledge documents describe указав имя ресурса документа. Например, чтобы получить документ о создании сегментов Cloud Storage, выполните следующие шаги:

  1. Выполните следующую команду: 

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

  2. Убедитесь, что команда возвращает метаданные и полное содержимое документа в формате 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

    В выходные данные входят следующие поля:

    • content : полный текст документа в формате Markdown.
    • contentLengthBytes : общий размер содержимого документа в байтах.
    • dataSource : домен документации, на котором размещен документ.
    • description : краткое изложение документа.
    • name : уникальное имя ресурса документа.
    • title : заголовок документа.
    • updateTime : метка времени последнего обновления документа.
    • uri : публичный URL страницы документации.
    • view : возвращаемое представление документа ( DOCUMENT_VIEW_CONTENT , DOCUMENT_VIEW_BASIC или DOCUMENT_VIEW_FULL ).

Что дальше?