Method: answerQuery

Отвечает на запрос, используя метод обоснованного генерирования.

HTTP-запрос

POST https://developerknowledge.googleapis.com/v1alpha:answerQuery

В URL-адресе используется синтаксис транскодирования gRPC .

Текст запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "query": string,
  "filter": string
}
Поля
query

string

Обязательно. Запрос, на который необходимо ответить.

filter

string

Необязательный параметр. Применяет строгий фильтр к результатам поиска, используемый для определения ответа. Выражение поддерживает подмножество синтаксиса, описанного по адресу https://google.aip.dev/160 .

Поддерживаемые поля для фильтрации:

  • contentLengthBytes (INTEGER): Длина поля Document.content в байтах.
  • dataSource (STRING): Источник документа, например, docs.cloud.google.com . Полный список источников данных в корпусе см. на странице https://developers.google.com/knowledge/reference/corpus-reference .
  • updateTime (TIMESTAMP): Отметка времени последнего значимого обновления документа. Значимое обновление — это обновление, изменяющее содержимое документа в формате Markdown или метаданные.
  • uri (STRING): URI документа, например, https://docs.cloud.google.com/bigquery/docs/tables .

Поля типа INTEGER поддерживают операторы = , < , <= , > и >= .

Поля типа STRING поддерживают операторы = (равно) и != (не равно) для точного совпадения со всей строкой. Частичное совпадение, префиксное совпадение и совпадение по регулярному выражению не поддерживаются.

Поля TIMESTAMP поддерживают операторы = , < , <= , > и >= . Временные метки должны быть в формате RFC-3339, например, "2025-01-01T00:00:00Z" .

Выражения можно комбинировать с помощью логических операторов AND , OR и NOT (или - ). OR имеет более высокий приоритет, чем AND . Для явной группировки приоритетов используйте скобки.

Примеры:

  • Фильтрация по Document.content_length_bytes : contentLengthBytes < 50000
  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

Строка filter не должна превышать 500 символов; значения длиннее 500 символов приведут к ошибке INVALID_ARGUMENT .

Ответный текст

Ответное сообщение для DeveloperKnowledge.AnswerQuery .

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "answer": {
    object (Answer)
  }
}
Поля
answer

object ( Answer )

Ответ на вопрос.

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

Для получения более подробной информации см.OAuth 2.0 Overview .

Отвечать

Ответ на вопрос.

JSON-представление 
{
  "answerText": string,
  "citations": [
    {
      object (AnswerCitation)
    }
  ],
  "references": [
    {
      object (AnswerReference)
    }
  ]
}
Поля
answerText

string

Содержит текст ответа.

citations[]

object ( AnswerCitation )

Только вывод. Содержит ссылки на источники ответа.

references[]

object ( AnswerReference )

Только вывод. Содержит ссылки на источник ответа.

ОтветСсылка

Информация об источнике для данного фрагмента.

JSON-представление 
{
  "startIndex": integer,
  "endIndex": integer,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Поля
startIndex

integer

Только для вывода. Указывает начало сегмента, измеряемое в байтах (UTF-8 Unicode), включительно. Если присутствуют многобайтовые символы, такие как символы, не относящиеся к ASCII, длина индекса превышает длину строки.

endIndex

integer

Только для вывода. Указывает конец сегмента, измеряемый в байтах (UTF-8 Unicode), без учета дополнительных байтов. Если присутствуют многобайтовые символы, например, символы, отличные от ASCII, длина индекса превышает длину строки.

sources[]

object ( CitationSource )

Только для вывода. Содержит источники цитирования для атрибутированного сегмента.

Источник цитаты

Источник цитирования.

JSON-представление 
{
  "referenceIndex": integer
}
Поля
referenceIndex

integer

Только для вывода. Содержит индекс объекта Answer.AnswerReference в повторяющемся поле references .

ОтветReference

Представляет собой ссылку на источник.

JSON-представление 
{

  // Union field content can be only one of the following:
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field content.
}
Поля
content поля объединения. Содержит содержимое ссылки. content может принимать только одно из следующих значений:
documentReference

object ( DocumentReference )

Только для вывода. Справочный документ.

Ссылка на документ

Представляет собой ссылку на документ.

JSON-представление 
{
  "documentChunk": {
    object (DocumentChunk)
  }
}
Поля
documentChunk

object ( DocumentChunk )

Только для вывода. Содержит фрагмент документа. Поле documentChunk.id не задано и будет пустым.