Method: corpora.query

Выполняет семантический поиск по Corpus .

HTTP-запрос

POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

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

Параметры пути

Параметры
name

string

Необходимый. Имя Corpus для запроса. Пример: corpora/my-corpus-123

Тело запроса

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

JSON-представление
{
  "query": string,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ],
  "resultsCount": integer
}
Поля
query

string

Необходимый. Строка запроса для выполнения семантического поиска.

metadataFilters[]

object ( MetadataFilter )

Необязательный. Фильтрация метаданных Chunk и Document . Каждый объект MetadataFilter должен соответствовать уникальному ключу. Несколько объектов MetadataFilter соединяются логическими операторами «И».

Пример запроса на уровне документа: (год >= 2020 ИЛИ год < 2010) И (жанр = драма ИЛИ жанр = боевик)

Список объектов MetadataFilter : MetadataFilters = [ {key = "document.custom_metadata.year" условия = [{int_value = 2020, Operation = GREATER_EQUAL}, {int_value = 2010, Operation = LESS}]}, {key = "document.custom_metadata. год" условия = [{int_value = 2020, операция = GREATER_EQUAL}, {int_value = 2010, операция = МЕНЬШЕ}]}, {key = "document.custom_metadata.genre" условия = [{stringValue = "драма", операция = EQUAL }, {stringValue = "действие", операция = EQUAL}]}]

Пример запроса на уровне блока для числового диапазона значений: (год > 2015 И год <= 2020)

Список объектов MetadataFilter : MetadataFilters = [ {key = "chunk.custom_metadata.year" условия = [{int_value = 2015, Operation = GREATER}]}, {key = "chunk.custom_metadata.year" условия = [{int_value = 2020, операция = LESS_EQUAL}]}]

Примечание. Операторы «И» для одного и того же ключа поддерживаются только для числовых значений. Строковые значения поддерживают только операторы «ИЛИ» для одного и того же ключа.

resultsCount

integer

Необязательный. Максимальное количество возвращаемых Chunk . Служба может возвращать меньшее количество Chunk .

Если не указано, будет возвращено не более 10 Chunk . Максимальное указанное количество результатов — 100.

Тело ответа

Ответ от corpora.query , содержащий список соответствующих фрагментов.

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

JSON-представление
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}
Поля
relevantChunks[]

object ( RelevantChunk )

Соответствующие куски.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Для получения дополнительной информации см. Обзор аутентификации .