[ aws . bedrock-agent ]
get-flow
Описание
Получает информацию о потоке. Для получения дополнительной информации см. Управление потоком в Amazon Bedrock в Руководстве пользователя Amazon Bedrock.
См. также: Документацию API AWS
get-flow использует значения типов документов. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, логические значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо указать JSON. Краткая синтаксическая запись не поддерживает типы документов.
Синтаксис
get-flow
--flow-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--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]
Параметры
--flow-identifier (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, заданному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.
--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.
Вывод
arn -> (строка)
createdAt -> (метка времени)
customerEncryptionKeyArn -> (строка)
definition -> (структура)
Определение узлов и соединений между узлами в потоке.
connections -> (список)
Массив определений соединений в потоке.
(структура)
Содержит информацию о соединении между двумя узлами в потоке.
configuration -> (структура помеченного объединения)
Конфигурация соединения.
Примечание
Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан:conditional, data.conditional -> (структура)
Конфигурация соединения, исходящего от узла Условия.
condition -> (строка)
data -> (структура)
Конфигурация соединения, исходящего от узла, который не является узлом Условия.
sourceOutput -> (строка)
targetInput -> (строка)
name -> (строка)
source -> (строка)
target -> (строка)
type -> (строка)
Conditional ) или нет (Data ).nodes -> (список)
Массив определений узлов в потоке.
(структура)
Содержит настройки узла в потоке.
конфигурация -> (структура помеченного объединения)
Содержит настройки для узла.
Примечание
Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан:agent, collector, condition, inlineCode, input, iterator, knowledgeBase, lambdaFunction, lex, loop, loopController, loopInput, output, prompt, retrieval, storage.агент -> (структура)
Содержит настройки для узла агента в вашем потоке. Вызывает псевдоним агента и возвращает ответ.
agentAliasArn -> (строка)
коллектор -> (структура)
условие -> (структура)
Содержит настройки для узла условия в вашем потоке. Определяет условия, которые ведут к разным ветвям потока.
условия -> (список)
Массив условий. Каждый член содержит имя условия и выражение, которое определяет условие.
(структура)
Определяет условие в узле условия.
выражение -> (строка)
имя -> (строка)
inlineCode -> (структура)
Содержит настройки для узла встроенного кода в вашем потоке. Узлы встроенного кода позволяют писать и выполнять код непосредственно в вашем потоке, обеспечивая преобразования данных, пользовательскую логику и интеграции без необходимости внешней функции Lambda.
код -> (строка)
Код, который выполняется в узле встроенного кода. Код может получать доступ к входным данным из предыдущих узлов в потоке, выполнять операции с этими данными и генерировать выходные данные, которые могут быть использованы другими узлами в вашем потоке.
Код должен быть валиден в языке программирования language, который вы указали.
язык -> (строка)
Язык программирования, используемый узлом встроенного кода.
Код должен быть валиден в языке программирования language, который вы указали. В настоящее время поддерживается только Python 3 (Python_3).
вход -> (структура)
inputs не может быть указан для этого узла.итератор -> (структура)
Содержит настройки для узла итератора в вашем потоке. Принимает вход, который является массивом, и итеративно отправляет каждый элемент массива в качестве вывода следующему узлу. Размер массива также возвращается в выводе.
Узел выходного потока в конце итерации потока вернёт ответ для каждого элемента массива. Чтобы вернуть только один ответ, вы можете включить узел коллектора вниз по течению от узла итератора.
база_знаний -> (структура)
Содержит настройки для узла базы знаний в вашем потоке. Запрашивает базу знаний и возвращает полученные результаты или сгенерированный ответ.
настройки_защиты -> (структура)
Содержит настройки для защиты, применяемой при запросе и генерации ответов для базы знаний в этих настройках.
идентификатор_защиты -> (строка)
версия_защиты -> (строка)
настройки_вывода -> (структура помеченного объединения)
Содержит настройки вывода для подсказки.
Примечание
Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан:text.текст -> (структура)
Содержит настройки вывода для текстовой подсказки.
макс_токены -> (целое число)
последовательности_остановки -> (список)
Список строк, которые определяют последовательности, после которых модель прекратит генерацию.
(строка)
температура -> (число с плавающей точкой)
верхняя_доля -> (число с плавающей точкой)
идентификатор_базы_знаний -> (строка)
идентификатор_модели -> (строка)
количество_результатов -> (целое число)
настройки_оркестрации -> (структура)
Настройки для оркестрации процесса извлечения и генерации в узле базы знаний.
дополнительные_параметры_запроса_модели -> (карта)
Дополнительные параметры запроса, специфичные для модели, в виде пар «ключ-значение», которые нужно включить в запрос к основной модели.
ключ -> (строка)
значение -> (документ)
настройки_вывода -> (структура помеченного объединения)
Содержит настройки вывода для подсказки.
Примечание
Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан:text.текст -> (структура)
Содержит настройки вывода для текстовой подсказки.
макс_токены -> (целое число)
последовательности_остановки -> (список)
Список строк, которые определяют последовательности, после которых модель прекратит генерацию.
(строка)
температура -> (число с плавающей точкой)
верхняя_доля -> (число с плавающей точкой)
настройки_производительности -> (структура)
Настройки производительности для процесса извлечения и генерации из базы знаний.
задержка -> (строка)
шаблон_подсказки -> (структура)
Пользовательский шаблон подсказки для оркестрации процесса извлечения и генерации.
текстовый_шаблон_подсказки -> (строка)
шаблон_подсказки -> (структура)
Пользовательский шаблон подсказки для использования с базой знаний для генерации ответов.
текстовый_шаблон_подсказки -> (строка)
настройки_переранжирования -> (структура)
Настройки для переранжирования полученных результатов из базы знаний для повышения релевантности.
настройки_переранжирования_bedrock -> (структура)
Определяет настройки для использования модели переранжирования Amazon Bedrock для переранжирования полученных результатов.
настройки_метаданных -> (структура)
Определяет, как должны обрабатываться поля метаданных во время процесса переранжирования.
режим_выбора -> (строка)
настройки_селективного_режима -> (структура помеченного объединения)
Настройки для включения или исключения полей метаданных во время переранжирования.
Примечание
Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть задан:fieldsToExclude, fieldsToInclude.исключённые_поля -> (список)
Указывает поля метаданных, которые следует исключить из процесса переранжирования.
(структура)
Указывает поле метаданных для включения или исключения во время переранжирования.
имя_поля -> (строка)
включённые_поля -> (список)
Указывает поля метаданных, которые следует включить в процесс переранжирования.
(структура)
Указывает поле метаданных для включения или исключения во время переранжирования.
имя_поля -> (строка)
настройки_модели -> (структура)
Определяет настройки для модели переранжирования Amazon Bedrock.
дополнительные_параметры_запроса_модели -> (карта)
Указывает дополнительные параметры запроса, специфичные для модели, в виде пар «ключ-значение», которые включаются в запрос к модели переранжирования Amazon Bedrock.
ключ -> (строка)
значение -> (документ)
modelArn -> (строка)
количество_переранжированных_результатов -> (целое число)
тип -> (строка)
BEDROCK_RERANKING_MODEL.функция_lambda -> (структура)
Содержит настройки для узла функции Lambda в вашем потоке. Вызывает функцию Lambda.
lambdaArn -> (строка)
lex -> (структура)
Содержит настройки для узла Lex в вашем потоке. Вызывает бота Amazon Lex, чтобы определить намерение ввода и вернуть намерение в качестве вывода.
botAliasArn -> (строка)
localeId -> (строка)
цикл -> (структура)
Содержит настройки цикла DoWhile в вашем потоке.
definition -> (структура)
Определение узлов цикла DoWhile и соединений между узлами в потоке.
connections -> (список)
Массив определений соединений в потоке.
(структура)
Содержит информацию о соединении между двумя узлами в потоке.
configuration -> (структура помеченных объединений)
Настройка соединения.
Примечание
Это структура помеченных объединений. Только один из следующих верхнеуровневых ключей может быть задан:conditional, data.conditional -> (структура)
Настройка соединения, исходящего из узла Условия.
condition -> (строка)
data -> (структура)
Настройка соединения, исходящего из узла, который не является узлом Условия.
sourceOutput -> (строка)
targetInput -> (строка)
name -> (строка)
source -> (строка)
target -> (строка)
type -> (строка)
Conditional ) или нет (Data ).nodes -> (список)
Массив определений узлов в потоке.
(структура)
Содержит настройки узла в потоке.
configuration -> (структура помеченных объединений)
Содержит конфигурации для узла.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:agent, collector, condition, inlineCode, input, iterator, knowledgeBase, lambdaFunction, lex, loop, loopController, loopInput, output, prompt, retrieval, storage.agent -> (структура)
Содержит конфигурации для узла агента в вашем потоке. Вызывает псевдоним агента и возвращает ответ.
agentAliasArn -> (строка)
collector -> (структура)
condition -> (структура)
Содержит конфигурации для узла условия в вашем потоке. Определяет условия, которые ведут к различным ветвям потока.
conditions -> (список)
Массив условий. Каждый элемент содержит имя условия и выражение, определяющее условие.
(структура)
Определяет условие в узле условия.
expression -> (строка)
name -> (строка)
inlineCode -> (структура)
Содержит конфигурации для узла встроенного кода в вашем потоке. Узлы встроенного кода позволяют писать и выполнять код непосредственно в вашем потоке, обеспечивая преобразование данных, пользовательскую логику и интеграции без необходимости внешней функции Lambda.
code -> (строка)
Код, который выполняется в узле встроенного кода. Код может получать доступ к входным данным из предыдущих узлов в потоке, выполнять операции с этими данными и создавать выходные данные, которые могут использоваться другими узлами в вашем потоке.
Код должен быть корректным на языке программирования language, который вы указали.
language -> (строка)
Язык программирования, используемый узлом встроенного кода.
Код должен быть корректным на языке программирования language, который вы указали. В настоящее время поддерживается только Python 3 (Python_3).
input -> (структура)
inputs не может быть указан для этого узла.iterator -> (структура)
Содержит конфигурации для узла итератора в вашем потоке. Принимает входные данные в виде массива и итеративно отправляет каждый элемент массива в качестве выходных данных следующему узлу. Размер массива также возвращается в выходных данных.
Узел выходного потока в конце итерации потока вернет ответ для каждого члена массива. Чтобы вернуть только один ответ, вы можете включить узел коллектора вниз по течению от узла итератора.
knowledgeBase -> (структура)
Содержит конфигурации для узла базы знаний в вашем потоке. Запрашивает базу знаний и возвращает полученные результаты или сгенерированный ответ.
guardrailConfiguration -> (структура)
Содержит конфигурации для ограждения, которое применяется во время запроса и генерации ответа для базы знаний в этой конфигурации.
guardrailIdentifier -> (строка)
guardrailVersion -> (строка)
inferenceConfiguration -> (структура помеченного объединения)
Содержит конфигурации вывода для запроса.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:text.text -> (структура)
Содержит конфигурации вывода для текстового запроса.
maxTokens -> (целое число)
stopSequences -> (список)
Список строк, которые определяют последовательности, после которых модель прекратит генерацию.
(строка)
temperature -> (вещественное число)
topP -> (вещественное число)
knowledgeBaseId -> (строка)
modelId -> (строка)
numberOfResults -> (целое число)
orchestrationConfiguration -> (структура)
Конфигурация для организации процесса извлечения и генерации в узле базы знаний.
additionalModelRequestFields -> (словарь)
Дополнительные параметры запроса, специфичные для модели, в виде пар ключ-значение, которые следует включить в запрос к основной модели.
key -> (строка)
value -> (документ)
inferenceConfig -> (структура помеченного объединения)
Содержит конфигурации вывода для запроса.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:text.text -> (структура)
Содержит конфигурации вывода для текстового запроса.
maxTokens -> (целое число)
stopSequences -> (список)
Список строк, которые определяют последовательности, после которых модель прекратит генерацию.
(строка)
temperature -> (вещественное число)
topP -> (вещественное число)
performanceConfig -> (структура)
Параметры конфигурации производительности для процесса извлечения и генерации в базе знаний.
latency -> (строка)
promptTemplate -> (структура)
Пользовательский шаблон запроса для организации процесса извлечения и генерации.
textPromptTemplate -> (строка)
promptTemplate -> (структура)
Пользовательский шаблон запроса для использования с базой знаний для генерации ответов.
textPromptTemplate -> (строка)
rerankingConfiguration -> (структура)
Конфигурация для переупорядочивания полученных результатов из базы знаний для повышения релевантности.
bedrockRerankingConfiguration -> (структура)
Определяет конфигурацию для использования модели переупорядочивания Amazon Bedrock для переупорядочивания полученных результатов.
metadataConfiguration -> (структура)
Указывает, как должны обрабатываться поля метаданных во время процесса переупорядочивания.
selectionMode -> (строка)
selectiveModeConfiguration -> (структура помеченного объединения)
Конфигурация для включения или исключения полей метаданных при переупорядочивании.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:fieldsToExclude, fieldsToInclude.fieldsToExclude -> (список)
Указывает поля метаданных, которые следует исключить из процесса переупорядочивания.
(структура)
Указывает поле метаданных для включения или исключения во время переупорядочивания.
fieldName -> (строка)
fieldsToInclude -> (список)
Указывает поля метаданных, которые следует включить в процесс переупорядочивания.
(структура)
Указывает поле метаданных для включения или исключения во время переупорядочивания.
fieldName -> (строка)
modelConfiguration -> (структура)
Указывает конфигурацию для модели переупорядочивания Amazon Bedrock.
additionalModelRequestFields -> (словарь)
Указывает дополнительные параметры запроса, специфичные для модели, в виде пар ключ-значение, которые включаются в запрос к модели переупорядочивания Amazon Bedrock.
key -> (строка)
value -> (документ)
modelArn -> (строка)
numberOfRerankedResults -> (целое число)
type -> (строка)
BEDROCK_RERANKING_MODEL.lambdaFunction -> (структура)
Содержит конфигурации для узла функции Lambda в вашем потоке. Вызывает функцию Lambda.
lambdaArn -> (строка)
lex -> (структура)
Содержит конфигурации для узла Lex в вашем потоке. Вызывает бота Amazon Lex для определения намерения ввода и возвращает намерение в качестве выходных данных.
botAliasArn -> (строка)
localeId -> (строка)
loop -> (структура)
Содержит конфигурации для цикла DoWhile в вашем потоке.
(… рекурсивно …)
loopController -> (структура)
Содержит конфигурации контроллера узла для цикла DoWhile в вашем потоке.
continueCondition -> (структура)
Определяет условие, которое определяет, когда поток выходит из цикла DoWhile. Цикл выполняется до тех пор, пока это условие не будет истинным.
expression -> (строка)
name -> (строка)
maxIterations -> (целое число)
loopInput -> (структура)
output -> (структура)
outputs не может быть указан для этого узла.prompt -> (структура)
Содержит конфигурации для узла запроса в вашем потоке. Выполняет запрос и генерирует ответ модели в качестве выходных данных. Вы можете использовать запрос из управления запросами или настроить его в этом узле.
guardrailConfiguration -> (структура)
Содержит конфигурации для барьера, который нужно применить к запросу в этом узле и ответу, сгенерированному на основе него.
guardrailIdentifier -> (строка)
guardrailVersion -> (строка)
sourceConfiguration -> (структура помеченных союзов)
Указывает, получен ли запрос из управления запросами или определен в строке.
Примечание
Это структура помеченных союзов. Только один из следующих верхних ключей может быть задан:inline, resource.inline -> (структура)
Содержит конфигурации для запроса, определенного в строке.
additionalModelRequestFields -> (документ)
inferenceConfiguration -> (структура помеченных союзов)
Содержит конфигурации вывода для запроса.
Примечание
Это структура помеченных союзов. Только один из следующих верхних ключей может быть задан:text.text -> (структура)
Содержит конфигурации вывода для текстового запроса.
maxTokens -> (целое число)
stopSequences -> (список)
Список строк, определяющих последовательности, после которых модель прекратит генерирование.
(строка)
temperature -> (вещественное число)
topP -> (вещественное число)
modelId -> (строка)
templateConfiguration -> (структура помеченных союзов)
Содержит запрос и переменные в запросе, которые можно заменить значениями во время выполнения.
Примечание
Это структура помеченных союзов. Только один из следующих верхних ключей может быть задан:chat, text.chat -> (структура)
Содержит конфигурации для использования запроса в диалоговом формате.
inputVariables -> (список)
Массив переменных в шаблоне запроса.
(структура)
Содержит информацию о переменной в запросе.
name -> (строка)
messages -> (список)
Содержит сообщения в чате для запроса.
(структура)
Входное или ответное сообщение от модели. Для получения дополнительной информации см. Создание запроса с помощью управления запросами.
content -> (список)
Содержимое сообщения.
(структура помеченных союзов)
Содержит содержимое сообщения, которое вы передаете модели или получаете от нее. Для получения дополнительной информации см. Создание запроса с помощью управления запросами.
Примечание
Это структура помеченных союзов. Только один из следующих верхних ключей может быть задан:cachePoint, text.cachePoint -> (структура)
Создает контрольную точку кэша внутри сообщения.
type -> (строка)
text -> (строка)
role -> (строка)
system -> (список)
Содержит системные запросы, чтобы предоставить контекст модели или описать, как она должна вести себя.
(структура помеченных союзов)
Содержит системный запрос, чтобы предоставить контекст модели или описать, как она должна вести себя. Для получения дополнительной информации см. Создание запроса с помощью управления запросами.
Примечание
Это структура помеченных союзов. Только один из следующих верхних ключей может быть задан:cachePoint, text.cachePoint -> (структура)
Создает контрольную точку кэша в обозначении инструмента
type -> (строка)
text -> (строка)
toolConfiguration -> (структура)
Конфигурационная информация для инструментов, которые модель может использовать при генерировании ответа.
toolChoice -> (структура помеченных союзов)
Определяет, какие инструменты модель должна запросить при вызове.
Примечание
Это структура помеченных союзов. Только один из следующих верхних ключей может быть задан:any, auto, tool.any -> (структура)
auto -> (структура)
tool -> (структура)
Определяет конкретный инструмент, который модель должна запросить. Текст не генерируется, но результаты использования инструмента отправляются модели, чтобы помочь сгенерировать ответ.
name -> (строка)
tools -> (список)
Массив инструментов, которые нужно передать модели.
(структура помеченных союзов)
Содержит конфигурации для инструмента, который модель может использовать при генерации ответа. Для получения дополнительной информации см. Использование инструмента для завершения ответа модели Amazon Bedrock.
Примечание
Это структура помеченных союзов. Только один из следующих верхних ключей может быть задан:cachePoint, toolSpec.cachePoint -> (структура)
Создает контрольную точку кэша внутри обозначения инструмента
type -> (строка)
toolSpec -> (структура)
Спецификация инструмента.
description -> (строка)
inputSchema -> (структура помеченных союзов)
Схема входных данных для инструмента.
Примечание
Это структура помеченных союзов. Только один из следующих верхних ключей может быть задан:json.json -> (документ)
name -> (строка)
text -> (структура)
Содержит конфигурации для текста в сообщении для запроса.
cachePoint -> (структура)
Контрольная точка кэша внутри конфигурации шаблона.
type -> (строка)
inputVariables -> (список)
Массив переменных в шаблоне запроса.
(структура)
Содержит информацию о переменной в запросе.
name -> (строка)
text -> (строка)
templateType -> (строка)
resource -> (структура)
Содержит конфигурации для запроса из управления запросами.
promptArn -> (строка)
retrieval -> (структура)
Содержит конфигурации для узла извлечения в вашем потоке. Извлекает данные из расположения Amazon S3 и возвращает их в качестве выходных данных.
serviceConfiguration -> (структура помеченных союзов)
Содержит конфигурации для службы, которую нужно использовать для извлечения данных для возврата в качестве выходных данных из узла.
Примечание
Это структура помеченных союзов. Только один из следующих верхних ключей может быть задан:s3.s3 -> (структура)
Содержит конфигурации для расположения Amazon S3, из которого необходимо извлечь данные для возврата в качестве выходных данных из узла.
bucketName -> (строка)
storage -> (структура)
Содержит конфигурации для узла хранения в вашем потоке. Хранит входные данные в расположении Amazon S3.
serviceConfiguration -> (структура помеченных союзов)
Содержит конфигурации для службы, которую нужно использовать для хранения входных данных в узел.
Примечание
Это структура помеченных союзов. Только один из следующих верхних ключей может быть задан:s3.s3 -> (структура)
Содержит конфигурации для расположения Amazon S3, в котором необходимо сохранить входные данные в узел.
bucketName -> (строка)
inputs -> (список)
Массив объектов, каждый из которых содержит информацию об входных данных в узел.
(структура)
Содержит конфигурации для входных данных в узле Amazon Bedrock Flows.
category -> (строка)
Указывает, как данные входных данных передаются между итерациями в цикле DoWhile.
-
LoopCondition- Управляет продолжением цикла путем оценки выражений условий относительно входных данных. Используйте эту категорию для определения условия, которое определяет, следует ли продолжать цикл. -
ReturnValueToLoopStart- Определяет данные, которые нужно передать обратно в начало следующей итерации цикла. Используйте эту категорию для переменных, которые вы хотите обновить для каждой итерации цикла. -
ExitLoop- Определяет значение, доступное после завершения цикла. Используйте эту категорию, чтобы экспонировать результаты цикла узлам вне цикла.
expression -> (строка)
name -> (строка)
type -> (строка)
name -> (строка)
outputs -> (список)
Список объектов, каждый из которых содержит информацию об выходных данных из узла.
(структура)
Содержит конфигурации для выходных данных из узла.
name -> (строка)
type -> (строка)
type -> (строка)
FlowNodeConfiguration.loopController -> (структура)
Содержит конфигурации узлов-контроллеров для цикла DoWhile в вашем потоке.
continueCondition -> (структура)
Указывает условие, определяющее, когда поток выходит из цикла DoWhile. Цикл выполняется до тех пор, пока это условие не примет значение true.
expression -> (строка)
name -> (строка)
maxIterations -> (целое число)
loopInput -> (структура)
output -> (структура)
outputs для этого узла нельзя указать.prompt -> (структура)
Содержит конфигурации для узла запроса в вашем потоке. Выполняет запрос и генерирует ответ модели в качестве вывода. Вы можете использовать запрос из Управления запросами или настроить его в этом узле.
guardrailConfiguration -> (структура)
Содержит конфигурации для ограничения, применяемого к запросу в этом узле и генерируемому из него ответу.
guardrailIdentifier -> (строка)
guardrailVersion -> (строка)
sourceConfiguration -> (меченый союз структур)
Указывает, получен ли запрос из Управления запросами или определен в строке.
Примечание
Это меченый союз структур. Только один из следующих верхних ключей может быть установлен:inline, resource.inline -> (структура)
Содержит конфигурации для запроса, определенного в строке
additionalModelRequestFields -> (документ)
inferenceConfiguration -> (меченый союз структур)
Содержит конфигурации вывода для запроса.
Примечание
Это меченый союз структур. Только один из следующих верхних ключей может быть установлен:text.text -> (структура)
Содержит конфигурации вывода для текстового запроса.
maxTokens -> (целое число)
stopSequences -> (список)
Список строк, которые определяют последовательности, после которых модель прекратит генерацию.
(строка)
temperature -> (число с плавающей запятой)
topP -> (число с плавающей запятой)
modelId -> (строка)
templateConfiguration -> (меченый союз структур)
Содержит запрос и переменные в запросе, которые можно заменить значениями во время выполнения.
Примечание
Это меченый союз структур. Только один из следующих верхних ключей может быть установлен:chat, text.chat -> (структура)
Содержит конфигурации для использования запроса в диалоговом формате.
inputVariables -> (список)
Массив переменных в шаблоне запроса.
(структура)
Содержит информацию о переменной в запросе.
name -> (строка)
messages -> (список)
Содержит сообщения в чате для запроса.
(структура)
Ввод сообщения или ответ от модели. Для получения дополнительной информации см. Создание запроса с помощью Управления запросами.
content -> (список)
Содержание сообщения.
(меченый союз структур)
Содержит контент для сообщения, которое вы передаете модели или получаете от нее. Для получения дополнительной информации см. Создание запроса с помощью Управления запросами.
Примечание
Это меченый союз структур. Только один из следующих верхних ключей может быть установлен:cachePoint, text.cachePoint -> (структура)
Создает контрольную точку кэша в сообщении.
type -> (строка)
text -> (строка)
role -> (строка)
system -> (список)
Содержит системные запросы для предоставления контекста модели или описания того, как она должна себя вести.
(меченый союз структур)
Содержит системный запрос для предоставления контекста модели или описания того, как она должна себя вести. Для получения дополнительной информации см. Создание запроса с помощью Управления запросами.
Примечание
Это меченый союз структур. Только один из следующих верхних ключей может быть установлен:cachePoint, text.cachePoint -> (структура)
Создает контрольную точку кэша в обозначении инструмента
type -> (строка)
text -> (строка)
toolConfiguration -> (структура)
Информация о конфигурации инструментов, которые модель может использовать при генерации ответа.
toolChoice -> (меченый союз структур)
Определяет инструменты, которые модель должна запросить при вызове.
Примечание
Это меченый союз структур. Только один из следующих верхних ключей может быть установлен:any, auto, tool.any -> (структура)
auto -> (структура)
tool -> (структура)
Определяет конкретный инструмент, который модель должна запросить. Текст не генерируется, но результаты использования инструмента отправляются обратно модели, чтобы помочь сгенерировать ответ.
name -> (строка)
tools -> (список)
Массив инструментов, которые следует передать модели.
(меченый союз структур)
Содержит конфигурации для инструмента, который модель может использовать при генерации ответа. Для получения дополнительной информации см. Использование инструмента для завершения ответа модели Amazon Bedrock.
Примечание
Это меченый союз структур. Только один из следующих верхних ключей может быть установлен:cachePoint, toolSpec.cachePoint -> (структура)
Создает контрольную точку кэша в обозначении инструмента
type -> (строка)
toolSpec -> (структура)
Спецификация инструмента.
description -> (строка)
inputSchema -> (меченый союз структур)
Схема ввода инструмента.
Примечание
Это меченый союз структур. Только один из следующих верхних ключей может быть установлен:json.json -> (документ)
name -> (строка)
text -> (структура)
Содержит конфигурации для текста в сообщении для запроса.
cachePoint -> (структура)
Контрольная точка кэша в конфигурации шаблона.
type -> (строка)
inputVariables -> (список)
Массив переменных в шаблоне запроса.
(структура)
Содержит информацию о переменной в запросе.
name -> (строка)
text -> (строка)
templateType -> (строка)
resource -> (структура)
Содержит конфигурации для запроса из Управления запросами.
promptArn -> (строка)
retrieval -> (структура)
Содержит конфигурации для узла извлечения в вашем потоке. Извлекает данные из расположения Amazon S3 и возвращает их в качестве вывода.
serviceConfiguration -> (меченый союз структур)
Содержит конфигурации для службы, используемой для извлечения данных, которые должны быть возвращены в качестве вывода от узла.
Примечание
Это меченый союз структур. Только один из следующих верхних ключей может быть установлен:s3.s3 -> (структура)
Содержит конфигурации для расположения Amazon S3, из которого извлекаются данные, которые должны быть возвращены в качестве вывода от узла.
bucketName -> (строка)
storage -> (структура)
Содержит конфигурации для узла хранения в вашем потоке. Хранит входное значение в расположении Amazon S3.
serviceConfiguration -> (меченый союз структур)
Содержит конфигурации для службы, используемой для хранения входного значения в узел.
Примечание
Это меченый союз структур. Только один из следующих верхних ключей может быть установлен:s3.s3 -> (структура)
Содержит конфигурации для расположения Amazon S3, в котором хранится входное значение в узел.
bucketName -> (строка)
inputs -> (список)
Массив объектов, каждый из которых содержит информацию об входных данных в узел.
(структура)
Содержит конфигурацию для ввода в узел Amazon Bedrock Flows.
category -> (строка)
Указывает, как входные данные передаются между итерациями в цикле DoWhile.
-
LoopCondition- Управляет продолжением цикла путем оценки выражений условия относительно входных данных. Используйте эту категорию для определения условия, определяющего, следует ли продолжать цикл. -
ReturnValueToLoopStart- Определяет данные, которые необходимо передать в начало следующей итерации цикла. Используйте эту категорию для переменных, которые вы хотите обновлять для каждой итерации цикла. -
ExitLoop- Определяет значение, доступное после завершения цикла. Используйте эту категорию, чтобы экспонировать результаты цикла узлам за пределами цикла.
expression -> (строка)
name -> (строка)
type -> (строка)
name -> (строка)
outputs -> (список)
Список объектов, каждый из которых содержит информацию об выходе из узла.
(структура)
Содержит конфигурации для выхода из узла.
name -> (строка)
type -> (строка)
type -> (строка)
FlowNodeConfiguration.description -> (строка)
executionRoleArn -> (строка)
id -> (строка)
name -> (строка)
status -> (строка)
Состояние потока. Возможны следующие состояния:
- NotPrepared – Поток был создан или обновлён, но не был подготовлен. Если вы только что создали поток, вы не можете его протестировать. Если вы обновили поток, версия
DRAFTне будет содержать последних изменений для тестирования. Отправьте запрос PrepareFlow, чтобы упаковать последние изменения в версиюDRAFT. - Preparing – Поток готовится к тому, чтобы версия
DRAFTсодержала последние изменения для тестирования. - Prepared – Поток подготовлен, и версия
DRAFTсодержит последние изменения для тестирования. - Failed – Последняя операция API, которую вы выполнили с потоком, завершилась ошибкой. Отправьте запрос GetFlow и проверьте сообщение об ошибке в поле
validations.
updatedAt -> (временная метка)
validations -> (список)
Список сообщений об ошибках валидации, связанных с последней неудачной операцией в потоке.
(структура)
Содержит информацию о валидации потока.
Этот тип данных используется в следующих операциях API:
- Ответ GetFlow
- Ответ GetFlowVersion
details -> (структура помеченных объединений)
Подробная информация о проблеме валидации, обнаруженной в потоке.
Примечание
Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть задан:cyclicConnection, duplicateConditionExpression, duplicateConnections, incompatibleConnectionDataType, invalidLoopBoundary, loopIncompatibleNodeType, malformedConditionExpression, malformedNodeInputExpression, mismatchedNodeInputType, mismatchedNodeOutputType, missingConnectionConfiguration, missingDefaultCondition, missingEndingNodes, missingLoopControllerNode, missingLoopInputNode, missingNodeConfiguration, missingNodeInput, missingNodeOutput, missingStartingNodes, multipleLoopControllerNodes, multipleLoopInputNodes, multipleNodeInputConnections, unfulfilledNodeInput, unknownConnectionCondition, unknownConnectionSource, unknownConnectionSourceOutput, unknownConnectionTarget, unknownConnectionTargetInput, unknownNodeInput, unknownNodeOutput, unreachableNode, unsatisfiedConnectionConditions, unspecified.cyclicConnection -> (структура)
Подробности о циклическом соединении в потоке.
connection -> (строка)
duplicateConditionExpression -> (структура)
Подробности о дублированных выражениях условия в узле.
expression -> (строка)
node -> (строка)
duplicateConnections -> (структура)
Подробности о дублированных соединениях между узлами.
source -> (строка)
target -> (строка)
incompatibleConnectionDataType -> (структура)
Подробности о несовместимых типах данных в соединении.
connection -> (строка)
invalidLoopBoundary -> (структура)
Подробности о потоке, включающем соединения, нарушающие правила границ цикла.
connection -> (строка)
source -> (строка)
target -> (строка)
loopIncompatibleNodeType -> (структура)
Подробности о потоке, включающем несовместимые типы узлов в цикле DoWhile.
incompatibleNodeName -> (строка)
incompatibleNodeType -> (строка)
node -> (строка)
Loop, содержащий несовместимый узел.malformedConditionExpression -> (структура)
Подробности о некорректном выражении условия в узле.
cause -> (строка)
condition -> (строка)
node -> (строка)
malformedNodeInputExpression -> (структура)
Подробности о некорректном выражении входных данных в узле.
cause -> (строка)
input -> (строка)
node -> (строка)
mismatchedNodeInputType -> (структура)
Подробности о несоответствии типов входных данных в узле.
expectedType -> (строка)
input -> (строка)
node -> (строка)
mismatchedNodeOutputType -> (структура)
Подробности о несоответствии типов выходных данных в узле.
expectedType -> (строка)
node -> (строка)
output -> (строка)
missingConnectionConfiguration -> (структура)
Подробности об отсутствии конфигурации для соединения.
connection -> (строка)
missingDefaultCondition -> (структура)
Подробности об отсутствии условия по умолчанию в узле с условием.
node -> (строка)
missingEndingNodes -> (структура)
missingLoopControllerNode -> (структура)
Подробности о потоке, в котором отсутствует необходимый узел LoopController в цикле DoWhile.
loopNode -> (строка)
LoopController.missingLoopInputNode -> (структура)
Подробности о потоке, в котором отсутствует необходимый узел LoopInput в цикле DoWhile.
loopNode -> (строка)
LoopInput.missingNodeConfiguration -> (структура)
Подробности об отсутствии конфигурации для узла.
node -> (строка)
missingNodeInput -> (структура)
Подробности об отсутствующем необходимом входе в узел.
input -> (строка)
node -> (строка)
missingNodeOutput -> (структура)
Подробности об отсутствующем необходимом выходе из узла.
node -> (строка)
output -> (строка)
missingStartingNodes -> (структура)
multipleLoopControllerNodes -> (структура)
Подробности о потоке, содержащем несколько узлов LoopController в цикле DoWhile.
loopNode -> (строка)
LoopController.multipleLoopInputNodes -> (структура)
Подробности о потоке, содержащем несколько узлов LoopInput в цикле DoWhile.
loopNode -> (строка)
LoopInput.multipleNodeInputConnections -> (структура)
Подробности о нескольких соединениях с одним входом узла.
input -> (строка)
node -> (строка)
unfulfilledNodeInput -> (структура)
Подробности об отсутствующем входе узла, у которого нет допустимых соединений.
input -> (строка)
node -> (строка)
unknownConnectionCondition -> (структура)
Подробности об неизвестном условии для соединения.
connection -> (строка)
unknownConnectionSource -> (структура)
Подробности об неизвестном исходном узле для соединения.
connection -> (строка)
unknownConnectionSourceOutput -> (структура)
Подробности об неизвестном выходном значении источника для соединения.
connection -> (строка)
unknownConnectionTarget -> (структура)
Подробности об неизвестном целевом узле для соединения.
connection -> (строка)
unknownConnectionTargetInput -> (структура)
Подробности об неизвестном целевом входе для соединения.
connection -> (строка)
unknownNodeInput -> (структура)
Подробности об неизвестном входе для узла.
input -> (строка)
node -> (строка)
unknownNodeOutput -> (структура)
Подробности об неизвестном выходе для узла.
node -> (строка)
output -> (строка)
unreachableNode -> (структура)
Подробности об недоступном узле в потоке.
node -> (строка)
unsatisfiedConnectionConditions -> (структура)
Подробности о невыполненных условиях для соединения.
connection -> (строка)
unspecified -> (структура)
message -> (строка)
severity -> (строка)
type -> (строка)
version -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.