retrieve

Описание

Запрос к базе знаний и извлечение информации из неё.

См. также: Документацию API AWS

retrieve использует значения типов документов. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для ввода команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая синтаксическая запись не поддерживает типы документов.

retrieve — это оперируемая по страницам операция. Для получения всего набора результатов могут быть выпущены несколько API-запросов. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: retrievalResults

Синтаксис

  retrieve
[--guardrail-configuration <value>]
--knowledge-base-id <value>
[--retrieval-configuration <value>]
--retrieval-query <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--guardrail-configuration (структура)

Параметры настройки guardrail.

guardrailId -> (строка)

Уникальный идентификатор guardrail.

guardrailVersion -> (строка)

Версия guardrail.

Краткая синтаксическая запись:

guardrailId=string,guardrailVersion=string

Синтаксис JSON:

{
  "guardrailId": "string",
  "guardrailVersion": "string"
}

--knowledge-base-id (строка)

Уникальный идентификатор базы знаний для запроса.

--retrieval-configuration (структура)

Содержит конфигурации для запроса и извлечения данных из базы знаний. Для получения дополнительной информации см. Конфигурации запросов.

vectorSearchConfiguration -> (структура)

Содержит данные о том, как должны возвращаться результаты векторного поиска. Для получения дополнительной информации см. Конфигурации запросов.

filter -> (структура помеченного объединения)

Указывает фильтры, которые должны применяться к метаданным в источниках данных базы знаний перед возвратом результатов. Для получения дополнительной информации см. Конфигурации запросов.

Примечание

Это структура помеченного объединения. Можно задать только один из следующих ключей верхнего уровня: andAll, equals, greaterThan, greaterThanOrEquals, in, lessThan, lessThanOrEquals, listContains, notEquals, notIn, orAll, startsWith, stringContains.

andAll -> (список)

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

(структура помеченного объединения)

Указывает фильтры, которые должны применяться к атрибутам метаданных в источниках данных базы знаний перед возвратом результатов. Для получения дополнительной информации см. Конфигурации запросов. Примеры использования этих фильтров приведены ниже.

Этот тип данных используется в следующих операциях API:

Запрос на извлечение – в поле filter
Запрос на извлечение и генерацию – в поле filter

Примечание

andAll -> (список)

(… рекурсивно …)

equals -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует значению key, а значение которого соответствует значению value в этом объекте.

Следующий пример вернет источники данных с атрибутом animal, значение которого равно cat:

"equals": { "key": "animal", "value": "cat" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

greaterThan -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует значению key, а значение которого больше значения value в этом объекте.

Следующий пример вернет источники данных с атрибутом year, значение которого больше, чем 1989:

"greaterThan": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

greaterThanOrEquals -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует значению key, а значение которого больше или равно значению value в этом объекте.

Следующий пример вернет источники данных с атрибутом year, значение которого больше или равно 1989:

"greaterThanOrEquals": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

in -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует значению key, а значение которого входит в список, указанный в значении value в этом объекте.

Следующий пример вернет источники данных с атрибутом animal, значение которого равно либо cat, либо dog:

"in": { "key": "animal", "value": ["cat", "dog"] }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

lessThan -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует значению key, а значение которого меньше значения value в этом объекте.

Следующий пример вернет источники данных с атрибутом year, значение которого меньше, чем 1989.

"lessThan": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

lessThanOrEquals -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует значению key, а значение которого меньше или равно значению value в этом объекте.

Следующий пример вернет источники данных с атрибутом year, значение которого меньше или равно 1989.

"lessThanOrEquals": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

listContains -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует значению key, а значение которого является списком, содержащим value в качестве одного из своих элементов.

Следующий пример вернет источники данных с атрибутом animals, который представляет собой список, содержащий элемент cat (например, ["dog", "cat"]).

"listContains": { "key": "animals", "value": "cat" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

notEquals -> (структура)

Источники данных базы знаний возвращаются, когда:

Они содержат атрибут метаданных, имя которого соответствует значению key, а значение которого не соответствует значению value в этом объекте.
Ключ отсутствует в документе.

Следующий пример вернет источники данных, не содержащие атрибута animal, значение которого равно cat.

"notEquals": { "key": "animal", "value": "cat" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

notIn -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует значению key, а значение которого не входит в список, указанный в значении value в этом объекте.

Следующий пример вернет источники данных, у которых атрибут animal не равен ни cat, ни dog.

"notIn": { "key": "animal", "value": ["cat", "dog"] }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

orAll -> (список)

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

(… рекурсивно …)

startsWith -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует значению key, а значение которого начинается со значения value в этом объекте. Этот фильтр в настоящее время поддерживается только для векторных хранилищ Amazon OpenSearch Serverless.

Следующий пример вернет источники данных с атрибутом animal, начинающимся со значения ca (например, cat или camel).

"startsWith": { "key": "animal", "value": "ca" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

stringContains -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует значению key, и значение которого является одним из следующих:

Строка, содержащая value в качестве подстроки. Следующий пример вернет источники данных с атрибутом animal, содержащим подстроку at (например, cat). "stringContains": { "key": "animal", "value": "at" }
Список с элементом, содержащим value в качестве подстроки. Следующий пример вернет источники данных с атрибутом animals, который представляет собой список, содержащий элемент, содержащий подстроку at (например, ["dog", "cat"]). "stringContains": { "key": "animals", "value": "at" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

equals -> (структура)

Следующий пример вернет источники данных с атрибутом animal, значение которого равно cat:

"equals": { "key": "animal", "value": "cat" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

greaterThan -> (структура)

Следующий пример вернет источники данных с атрибутом year, значение которого больше, чем 1989:

"greaterThan": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать.

value -> (документ)

Значение, с которым должно сравниваться значение атрибута метаданных.

greaterThanOrEquals -> (структура)

Данные источников базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого больше или равно значению value в этом объекте.

Следующий пример вернёт источники данных с атрибутом year, значение которого больше или равно 1989:

"greaterThanOrEquals": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать имя.

value -> (документ)

Значение для сравнения со значением атрибута метаданных.

in -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого находится в списке, указанном в value в этом объекте.

Следующий пример вернёт источники данных с атрибутом animal, который равен либо cat, либо dog:

"in": { "key": "animal", "value": ["cat", "dog"] }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать имя.

value -> (документ)

Значение для сравнения со значением атрибута метаданных.

lessThan -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого меньше значения value в этом объекте.

Следующий пример вернёт источники данных с атрибутом year, значение которого меньше 1989.

"lessThan": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать имя.

value -> (документ)

Значение для сравнения со значением атрибута метаданных.

lessThanOrEquals -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого меньше или равно значению value в этом объекте.

Следующий пример вернёт источники данных с атрибутом year, значение которого меньше или равно 1989.

"lessThanOrEquals": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать имя.

value -> (документ)

Значение для сравнения со значением атрибута метаданных.

listContains -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого является списком, содержащим value в качестве одного из своих членов.

Следующий пример вернёт источники данных с атрибутом animals, который является списком, содержащим член cat (например, ["dog", "cat"]).

"listContains": { "key": "animals", "value": "cat" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать имя.

value -> (документ)

Значение для сравнения со значением атрибута метаданных.

notEquals -> (структура)

Источники данных базы знаний возвращаются, когда:

Они содержат атрибут метаданных, имя которого соответствует key, а значение которого не совпадает со значением value в этом объекте.
Ключ отсутствует в документе.

Следующий пример вернёт источники данных, не содержащие атрибут animal со значением cat.

"notEquals": { "key": "animal", "value": "cat" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать имя.

value -> (документ)

Значение для сравнения со значением атрибута метаданных.

notIn -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого соответствует key, а значение которого не находится в списке, указанном в value в этом объекте.

Следующий пример вернёт источники данных, у которых атрибут animal не равен ни cat, ни dog.

"notIn": { "key": "animal", "value": ["cat", "dog"] }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать имя.

value -> (документ)

Значение для сравнения со значением атрибута метаданных.

orAll -> (список)

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

(Структура помеченного объединения)

Указывает фильтры, которые нужно применить к атрибутам метаданных в источниках данных базы знаний перед возвратом результатов. Дополнительную информацию см. в разделе Настройки запросов . Примеры использования этих фильтров см. ниже.

Этот тип данных используется в следующих операциях API:

Запрос извлечения – в поле filter
Запрос извлечения и генерации – в поле filter

Примечание

Это структура помеченного объединения. Может быть задан только один из следующих ключей верхнего уровня: andAll, equals, greaterThan, greaterThanOrEquals, in, lessThan, lessThanOrEquals, listContains, notEquals, notIn, orAll, startsWith, stringContains.

andAll -> (список)

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

(… рекурсивно …)

equals -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, и значение которого совпадает со значением value в этом объекте.

Следующий пример вернёт источники данных с атрибутом animal, значение которого равно cat :

"equals": { "key": "animal", "value": "cat" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

greaterThan -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, и значение которого больше, чем значение value в этом объекте.

Следующий пример вернёт источники данных с атрибутом year, значение которого больше, чем 1989 :

"greaterThan": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

greaterThanOrEquals -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, и значение которого больше или равно значению value в этом объекте.

Следующий пример вернёт источники данных с атрибутом year, значение которого больше или равно 1989 :

"greaterThanOrEquals": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

in -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, и значение которого содержится в списке, указанном в value в этом объекте.

Следующий пример вернёт источники данных с атрибутом animal, значение которого равно либо cat, либо dog :

"in": { "key": "animal", "value": ["cat", "dog"] }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

lessThan -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, и значение которого меньше, чем значение value в этом объекте.

Следующий пример вернёт источники данных с атрибутом year, значение которого меньше, чем 1989.

"lessThan": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

lessThanOrEquals -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, и значение которого меньше или равно значению value в этом объекте.

Следующий пример вернёт источники данных с атрибутом year, значение которого меньше или равно 1989.

"lessThanOrEquals": { "key": "year", "value": 1989 }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

listContains -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, и значение которого является списком, содержащим value в качестве одного из своих членов.

"listContains": { "key": "animals", "value": "cat" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

notEquals -> (структура)

Источники данных базы знаний возвращаются, когда:

Они содержат атрибут метаданных, имя которого совпадает с key, и значение которого не совпадает со значением value в этом объекте.
Ключа нет в документе.

Следующий пример вернёт источники данных, не содержащие атрибута animal со значением cat.

"notEquals": { "key": "animal", "value": "cat" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

notIn -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, и значение которого не содержится в списке, указанном в value в этом объекте.

Следующий пример вернёт источники данных, у которых атрибут animal не равен ни cat, ни dog.

"notIn": { "key": "animal", "value": ["cat", "dog"] }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

orAll -> (список)

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

(… рекурсивно …)

startsWith -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, и значение которого начинается с value в этом объекте. Этот фильтр в настоящее время поддерживается только для векторизованных хранилищ Amazon OpenSearch Serverless.

Следующий пример вернёт источники данных с атрибутом animal, начинающимся со значения ca (например, cat или camel).

"startsWith": { "key": "animal", "value": "ca" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

stringContains -> (структура)

Источники данных базы знаний возвращаются, если они содержат атрибут метаданных, имя которого совпадает с key, и значение которого является одним из следующих:

Строка, содержащая value в качестве подстроки. Следующий пример вернёт источники данных с атрибутом animal, содержащим подстроку at (например, cat). "stringContains": { "key": "animal", "value": "at" }
Список с членом, содержащим value в качестве подстроки. Следующий пример вернёт источники данных с атрибутом animals, который является списком, содержащим член, содержащий подстроку at (например, ["dog", "cat"]). "stringContains": { "key": "animals", "value": "at" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

startsWith -> (структура)

"startsWith": { "key": "animal", "value": "ca" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

stringContains -> (структура)

Строка, содержащая value в качестве подстроки. Следующий пример вернёт источники данных с атрибутом animal, содержащим подстроку at (например, cat). "stringContains": { "key": "animal", "value": "at" }
Список с членом, содержащим value в качестве подстроки. Следующий пример вернёт источники данных с атрибутом animals, который является списком, содержащим член, содержащий подстроку at (например, ["dog", "cat"]). "stringContains": { "key": "animals", "value": "at" }

key -> (строка)

Имя атрибута метаданных, которому должно соответствовать значение.

value -> (документ)

Значение, с которым нужно сравнить значение атрибута метаданных.

implicitFilterConfiguration -> (структура)

Настройки для неявного фильтра.

metadataAttributes -> (список)

Метаданные, которые можно использовать в фильтре.

(структура)

Подробности о атрибуте метаданных.

description -> (строка)

Описание атрибута.

key -> (строка)

Ключ атрибута.

type -> (строка)

Тип атрибута.

modelArn -> (строка)

Модель, которая генерирует фильтр.

numberOfResults -> (целое число)

Количество фрагментов источника для извлечения.

overrideSearchType -> (строка)

По умолчанию Amazon Bedrock выбирает стратегию поиска для вас. Если вы используете векторный хранилище Amazon OpenSearch Serverless, содержащий фильтруемое текстовое поле, вы можете указать, нужно ли запрашивать базу знаний с использованием поиска HYBRID, используя и векторные вложения, и обычный текст, или поиска SEMANTIC, используя только векторные вложения. Для других конфигураций векторного хранилища доступен только поиск SEMANTIC. Для получения дополнительной информации см. Тестирование базы знаний.

rerankingConfiguration -> (структура)

Содержит конфигурации для переупорядочивания полученных результатов. Для получения дополнительной информации см. Улучшение релевантности ответов на запросы с помощью модели переупорядочения.

bedrockRerankingConfiguration -> (структура)

Содержит конфигурации для модели переупорядочения Amazon Bedrock.

metadataConfiguration -> (структура)

Содержит конфигурации для метаданных, используемых при переупорядочении.

selectionMode -> (строка)

Указывает, нужно ли учитывать все метаданные при переупорядочении или только выбранные вами. Если вы указываете SELECTIVE, включите поле selectiveModeConfiguration.

selectiveModeConfiguration -> (структура со связанными типами)

Содержит конфигурации для полей метаданных, которые нужно включать или исключать при рассмотрении переупорядочения.

Примечание

Это структура со связанными типами. Можно установить только один из следующих ключей верхнего уровня: fieldsToExclude, fieldsToInclude.

fieldsToExclude -> (список)

Массив объектов, каждый из которых указывает поле метаданных, которое нужно исключить из рассмотрения при переупорядочении.

(структура)

Содержит информацию о поле метаданных, которое нужно включить или исключить из рассмотрения при переупорядочении.

fieldName -> (строка)

Имя поля метаданных, которое нужно включить или исключить из рассмотрения при переупорядочении.

fieldsToInclude -> (список)

Массив объектов, каждый из которых указывает поле метаданных, которое нужно включить в рассмотрение при переупорядочении. Остальные поля метаданных игнорируются.

(структура)

fieldName -> (строка)

Имя поля метаданных, которое нужно включить или исключить из рассмотрения при переупорядочении.

modelConfiguration -> (структура)

Содержит конфигурации для модели переупорядочения.

additionalModelRequestFields -> (карта)

Объект JSON, ключи которого — поля запроса для модели, а значения — значения этих полей.

key -> (строка)

value -> (документ)

modelArn -> (строка)

ARN модели переупорядочения, которую нужно использовать.

numberOfRerankedResults -> (целое число)

Количество результатов, которые нужно вернуть после переупорядочивания.

type -> (строка)

Тип модели переупорядочения.

Синтаксис JSON:

{
  "vectorSearchConfiguration": {
    "filter": {
      "andAll": [
        {
          "andAll": [
            { ... recursive ... }
            ...
          ],
          "equals": {
            "key": "string",
            "value": {...}
          },
          "greaterThan": {
            "key": "string",
            "value": {...}
          },
          "greaterThanOrEquals": {
            "key": "string",
            "value": {...}
          },
          "in": {
            "key": "string",
            "value": {...}
          },
          "lessThan": {
            "key": "string",
            "value": {...}
          },
          "lessThanOrEquals": {
            "key": "string",
            "value": {...}
          },
          "listContains": {
            "key": "string",
            "value": {...}
          },
          "notEquals": {
            "key": "string",
            "value": {...}
          },
          "notIn": {
            "key": "string",
            "value": {...}
          },
          "orAll": [
            { ... recursive ... }
            ...
          ],
          "startsWith": {
            "key": "string",
            "value": {...}
          },
          "stringContains": {
            "key": "string",
            "value": {...}
          }
        }
        ...
      ],
      "equals": {
        "key": "string",
        "value": {...}
      },
      "greaterThan": {
        "key": "string",
        "value": {...}
      },
      "greaterThanOrEquals": {
        "key": "string",
        "value": {...}
      },
      "in": {
        "key": "string",
        "value": {...}
      },
      "lessThan": {
        "key": "string",
        "value": {...}
      },
      "lessThanOrEquals": {
        "key": "string",
        "value": {...}
      },
      "listContains": {
        "key": "string",
        "value": {...}
      },
      "notEquals": {
        "key": "string",
        "value": {...}
      },
      "notIn": {
        "key": "string",
        "value": {...}
      },
      "orAll": [
        {
          "andAll": [
            { ... recursive ... }
            ...
          ],
          "equals": {
            "key": "string",
            "value": {...}
          },
          "greaterThan": {
            "key": "string",
            "value": {...}
          },
          "greaterThanOrEquals": {
            "key": "string",
            "value": {...}
          },
          "in": {
            "key": "string",
            "value": {...}
          },
          "lessThan": {
            "key": "string",
            "value": {...}
          },
          "lessThanOrEquals": {
            "key": "string",
            "value": {...}
          },
          "listContains": {
            "key": "string",
            "value": {...}
          },
          "notEquals": {
            "key": "string",
            "value": {...}
          },
          "notIn": {
            "key": "string",
            "value": {...}
          },
          "orAll": [
            { ... recursive ... }
            ...
          ],
          "startsWith": {
            "key": "string",
            "value": {...}
          },
          "stringContains": {
            "key": "string",
            "value": {...}
          }
        }
        ...
      ],
      "startsWith": {
        "key": "string",
        "value": {...}
      },
      "stringContains": {
        "key": "string",
        "value": {...}
      }
    },
    "implicitFilterConfiguration": {
      "metadataAttributes": [
        {
          "description": "string",
          "key": "string",
          "type": "STRING"|"NUMBER"|"BOOLEAN"|"STRING_LIST"
        }
        ...
      ],
      "modelArn": "string"
    },
    "numberOfResults": integer,
    "overrideSearchType": "HYBRID"|"SEMANTIC",
    "rerankingConfiguration": {
      "bedrockRerankingConfiguration": {
        "metadataConfiguration": {
          "selectionMode": "SELECTIVE"|"ALL",
          "selectiveModeConfiguration": {
            "fieldsToExclude": [
              {
                "fieldName": "string"
              }
              ...
            ],
            "fieldsToInclude": [
              {
                "fieldName": "string"
              }
              ...
            ]
          }
        },
        "modelConfiguration": {
          "additionalModelRequestFields": {"string": {...}
            ...},
          "modelArn": "string"
        },
        "numberOfRerankedResults": integer
      },
      "type": "BEDROCK_RERANKING_MODEL"
    }
  }
}

--retrieval-query (структура)

Содержит запрос, отправленный базе знаний.

text -> (строка)

Текст запроса, отправленного базе знаний.

Сокращенный синтаксис:

text=string

Синтаксис JSON:

{
  "text": "string"
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет интерпретироваться буквально. Это может не указываться вместе с --cli-input-yaml.

--starting-token (строка)

Токен, указывающий, с какой точки начать постраничный вывод. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничный вывод, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если указано без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, оно проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (булево)

Отключить автоматический постраничный вывод. Если автоматический постраничный вывод отключен, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

json
text
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет параметры конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

on
off
auto

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификата CA для проверки SSL-сертификатов. Переопределяет параметры конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь тайм-аута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь тайм-аута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла необходимо правильно отформатировать для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (булево)

Отключение постраничного вывода CLI для вывода.

--cli-auto-prompt (булево)

Автоматический запрос параметров ввода CLI.

--no-cli-auto-prompt (булево)

Отключение автоматического запроса параметров ввода CLI.

Вывод

guardrailAction -> (строка)

Указывает, есть ли вмешательство системы ограничений в ответе.

nextToken -> (строка)

Если результатов больше, чем может поместиться в ответе, ответ возвращает nextToken. Используйте этот маркер в поле nextToken другого запроса для получения следующей порции результатов.

retrievalResults -> (список)

Список результатов запроса к базе знаний.

(структура)

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

Этот тип данных используется в следующих операциях API:

Ответ на запрос – в поле retrievalResults

content -> (структура)

Содержит информацию о содержимом блока.

byteContent -> (строка)

URI данных с кодированным в base64 содержимым из источника данных. URI имеет следующий формат: возвращается в следующем формате: data:image/jpeg;base64,${base64-encoded string}.

row -> (список)

Указывает информацию о строках с ячейками, которые нужно вернуть в результате.

(структура)

Содержит информацию о столбце с ячейкой, которую нужно вернуть в результате.

columnName -> (строка)

Имя столбца.

columnValue -> (строка)

Значение в столбце.

type -> (строка)

Тип данных значения.

text -> (строка)

Цитируемый текст из источника данных.

type -> (строка)

Тип содержимого в результате поиска.

location -> (структура)

Содержит информацию о расположении источника данных.

confluenceLocation -> (структура)

Расположение источника данных Confluence.

url -> (строка)

URL хоста Confluence для расположения источника данных.

customDocumentLocation -> (структура)

Указывает расположение документа в пользовательском источнике данных.

id -> (строка)

Идентификатор документа.

kendraDocumentLocation -> (структура)

Расположение документа в Amazon Kendra.

uri -> (строка)

URI документа.

s3Location -> (структура)

Расположение источника данных S3.

uri -> (строка)

S3 URI для расположения источника данных.

salesforceLocation -> (структура)

Расположение источника данных Salesforce.

url -> (строка)

URL хоста Salesforce для расположения источника данных.

sharePointLocation -> (структура)

Расположение источника данных SharePoint.

url -> (строка)

URL сайта SharePoint для расположения источника данных.

sqlLocation -> (структура)

Содержит информацию о SQL-запросе, используемом для получения результата.

query -> (строка)

SQL-запрос, используемый для получения результата.

type -> (строка)

Тип расположения источника данных.

webLocation -> (структура)

Расположение источника данных – URL веб-сайта(ов).

url -> (строка)

URL веб-сайта(ов) для расположения источника данных.

metadata -> (карта)

Содержит атрибуты метаданных и их значения для файла в источнике данных. Дополнительную информацию см. в разделе Метаданные и фильтрация.

key -> (строка)

value -> (документ)

score -> (число с плавающей запятой)

Уровень релевантности результата запросу.

END_OF_DOCUMENT_MARKER