Как получать ответы на основе документации

Developer Knowledge API позволяет задавать вопросы о продуктах Google для разработчиков и получать прямые ответы на естественном языке. На каждый запрос API составляет ответ на основе корпуса знаний для разработчиков (в документации по API он называется обоснованной генерацией) и включает ссылки на соответствующие страницы документации.

Подготовка

Настройте среду для выбранного инструмента:

gcloud

Установите и настройте gcloud CLI и включите Developer Knowledge API.

REST

Включите API и сгенерируйте ключ Developer Knowledge API. Затем сохраните ключ в переменной среды:

export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

Замените YOUR_API_KEY ключом Developer Knowledge API.

Ответить на запрос

Чтобы задать вопрос, используйте команду gcloud developer-knowledge answer-query или метод REST answerQuery.

В примере ниже отправляется запрос о том, как создать набор данных BigQuery.

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?"

REST

curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Ответ содержит текстовый ответ в поле answer.answerText, а также citations и references в объекте answer:

{
  "answer": {
    "answerText": "To create a BigQuery dataset, you can use the Google Cloud Console, the bq command-line tool, or the BigQuery client libraries.",
    "citations": [
      {
        "startIndex": 0,
        "endIndex": 123,
        "sources": [
          {
            "referenceIndex": 0
          }
        ]
      }
    ],
    "references": [
      {
        "documentReference": {
          "documentChunk": {
            "parent": "documents/docs.cloud.google.com/bigquery/docs/datasets",
            "content": "This page explains how to create BigQuery datasets...",
            "document": {
              "name": "documents/docs.cloud.google.com/bigquery/docs/datasets",
              "title": "Introduction to datasets",
              "uri": "https://docs.cloud.google.com/bigquery/docs/datasets"
            }
          }
        }
      }
    ]
  }
}

Фильтровать источники документации

Чтобы ограничить источники документации, используемые для генерации ответа, передайте выражение фильтра с помощью флага --query-filter в gcloud CLI или поля filter в теле запроса REST. Подробнее о поддерживаемых полях фильтра и операторах можно узнать в статье Как фильтровать результаты поиска.

В следующем примере источники документации ограничены значением docs.cloud.google.com:

gcloud

gcloud developer-knowledge answer-query \
  --query="How do I create a BigQuery dataset?" \
  --query-filter='data_source = "docs.cloud.google.com"'

REST

curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "How do I create a BigQuery dataset?",
    "filter": "data_source = \"docs.cloud.google.com\""
  }'

Выберите значение от AnswerQuery до SearchDocumentChunks.

При использовании API или MCP-сервера Developer Knowledge выберите наиболее подходящий метод:

  • AnswerQuery (или инструмент answer_query MCP) – лучше всего подходит для общих вопросов, сравнения продуктов и пошаговых руководств, когда вам нужно полное резюме со ссылками на исходные документы.
  • SearchDocumentChunks (или search_documents MCP tool) – лучше всего подходит для поиска точных флагов CLI, синтаксиса кода, названий параметров или разрешений IAM (например, service.resource.verb). Используйте от двух до пяти ключевых слов вместо полного вопроса.

Дальнейшие действия