[ aws . bedrock-agent-runtime ]
rerank
Описание
Переупорядочивает релевантность источников на основе запросов. Дополнительную информацию см. в разделе Улучшение релевантности ответов на запросы с помощью модели переупорядочивания.
См. также: Документация API AWS
rerank использует значения типа документа. Типы документов следуют модели данных JSON, где допустимыми значениями являются: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо указать JSON. Краткая синтаксическая форма не поддерживает типы документов.
rerank — это страничная операция. Для получения всего набора данных результатов может потребоваться несколько вызовов API. Вы можете отключить страничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе со страничной обработкой аргумент --query должен извлекать данные из результатов следующих выражений запроса: results
Синтаксис
rerank
--queries <value>
--reranking-configuration <value>
--sources <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]
Параметры
--queries (список)
Массив объектов, каждый из которых содержит информацию о запросе, который необходимо отправить модели переупорядочивания.
(структура)
Содержит информацию о запросе, который необходимо отправить модели переупорядочивания.
textQuery -> (структура)
Содержит информацию о текстовом запросе.
text -> (строка)
type -> (строка)
Краткая синтаксическая форма:
textQuery={text=string},type=string ...
Синтаксис JSON:
[
{
"textQuery": {
"text": "string"
},
"type": "TEXT"
}
...
]
--reranking-configuration (структура)
Содержит конфигурации для переупорядочивания.
bedrockRerankingConfiguration -> (структура)
Содержит конфигурации для модели переупорядочивания Amazon Bedrock.
modelConfiguration -> (структура)
Содержит конфигурации для модели переупорядочивания.
additionalModelRequestFields -> (карта)
Объект JSON, ключами которого являются поля запроса для модели, а значениями — значения для этих полей.
key -> (строка)
value -> (документ)
modelArn -> (строка)
numberOfResults -> (целое число)
type -> (строка)
Краткая синтаксическая форма:
bedrockRerankingConfiguration={modelConfiguration={modelArn=string},numberOfResults=integer},type=string
Синтаксис JSON:
{
"bedrockRerankingConfiguration": {
"modelConfiguration": {
"additionalModelRequestFields": {"string": {...}
...},
"modelArn": "string"
},
"numberOfResults": integer
},
"type": "BEDROCK_RERANKING_MODEL"
}
--sources (список)
Массив объектов, каждый из которых содержит информацию о источниках для переупорядочивания.
(структура)
Содержит информацию об источнике для переупорядочивания.
inlineDocumentSource -> (структура)
Содержит встроенное определение источника для переупорядочивания.
jsonDocument -> (документ)
textDocument -> (структура)
Содержит информацию о текстовом документе для переупорядочивания.
text -> (строка)
type -> (строка)
type -> (строка)
Краткая синтаксическая форма:
inlineDocumentSource={textDocument={text=string},type=string},type=string ...
Синтаксис JSON:
[
{
"inlineDocumentSource": {
"jsonDocument": {...},
"textDocument": {
"text": "string"
},
"type": "TEXT"|"JSON"
},
"type": "INLINE"
}
...
]
--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
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- включено
- выключено
- автоматически
--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.
Вывод
nextToken -> (строка)
nextToken при отправке другого запроса для возвращения следующей группы результатов.results -> (список)
Массив объектов, каждый из которых содержит информацию о результатах переупорядочивания.
(структура)
Содержит информацию о документе, который был переупорядочен.
document -> (структура)
Содержит информацию о документе.
jsonDocument -> (документ)
textDocument -> (структура)
Содержит информацию о текстовом документе для переупорядочивания.
text -> (строка)
type -> (строка)
index -> (целое число)
relevanceScore -> (число с плавающей запятой)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|