Выполняет семантический поиск по Document
.
HTTP-запрос
POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
name | Необходимый. Имя |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{
"query": string,
"resultsCount": integer,
"metadataFilters": [
{
object ( |
Поля | |
---|---|
query | Необходимый. Строка запроса для выполнения семантического поиска. |
resultsCount | Необязательный. Максимальное количество возвращаемых Если не указано, будет возвращено не более 10 |
metadataFilters[] | Необязательный. Фильтровать метаданные Примечание. Фильтрация на уровне Пример запроса: (год >= 2020 ИЛИ год < 2010) И (жанр = драма ИЛИ жанр = боевик) Список объектов Пример запроса для числового диапазона значений: (год > 2015 И год <= 2020) Список объектов Примечание. Операторы «И» для одного и того же ключа поддерживаются только для числовых значений. Строковые значения поддерживают только операторы «ИЛИ» для одного и того же ключа. |
Тело ответа
Ответ от documents.query
, содержащий список соответствующих фрагментов.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"relevantChunks": [
{
object ( |
Поля | |
---|---|
relevantChunks[] | Возвращенные соответствующие фрагменты. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/generative-language.retriever
-
https://www.googleapis.com/auth/generative-language.retriever.readonly
Для получения дополнительной информации см. Обзор аутентификации .