converse

Описание

Отправляет сообщения указанной модели Amazon Bedrock. Converse предоставляет согласованный интерфейс, работающий со всеми моделями, поддерживающими сообщения. Это позволяет вам написать код один раз и использовать его с различными моделями. Если у модели есть уникальные параметры вывода, вы также можете передать эти уникальные параметры модели.

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

Вы можете отправить запрос, включив его в поле messages, указав modelId модели или профиля вывода для выполнения вывода, и включив любые другие поля, относящиеся к вашему случаю использования.

Вы также можете отправить запрос из управления запросами, указав ARN версии запроса и включив карту переменных и значений в поле promptVariables. Вы можете добавить больше сообщений к запросу, используя поле messages. Если вы используете запрос из управления запросами, вы не можете включать следующие поля в запросе: additionalModelRequestFields , inferenceConfig , system или toolConfig . Вместо этого эти поля должны быть определены через управление запросами. Для получения дополнительной информации см. Использование запроса из управления запросами.

Сведения об API Converse см. в разделе Использование API Converse в Руководстве пользователя Amazon Bedrock. Для использования ограничения см. Использование ограничения с API Converse в Руководстве пользователя Amazon Bedrock. Для использования инструмента с моделью см. Использование инструмента (вызов функции) в Руководстве пользователя Amazon Bedrock.

Пример кода см. в разделе Примеры API Converse в Руководстве пользователя Amazon Bedrock.

Для этого действия требуется разрешение на выполнение действия bedrock:InvokeModel.

Для устранения неполадок некоторых распространённых ошибок, которые могут возникнуть при использовании API Converse, см. Устранение неполадок кодов ошибок API Amazon Bedrock в Руководстве пользователя Amazon Bedrock.

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

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

Резюме

  converse
--model-id <value>
[--messages <value>]
[--system <value>]
[--inference-config <value>]
[--tool-config <value>]
[--guardrail-config <value>]
[--additional-model-request-fields <value>]
[--prompt-variables <value>]
[--additional-model-response-field-paths <value>]
[--request-metadata <value>]
[--performance-config <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]

Параметры

--model-id (строка)

--messages (список)

[
  {
    "role": "user"|"assistant",
    "content": [
      {
        "text": "string",
        "image": {
          "format": "png"|"jpeg"|"gif"|"webp",
          "source": {
            "bytes": blob,
            "s3Location": {
              "uri": "string",
              "bucketOwner": "string"
            }
          }
        },
        "document": {
          "format": "pdf"|"csv"|"doc"|"docx"|"xls"|"xlsx"|"html"|"txt"|"md",
          "name": "string",
          "source": {
            "bytes": blob,
            "s3Location": {
              "uri": "string",
              "bucketOwner": "string"
            }
          }
        },
        "video": {
          "format": "mkv"|"mov"|"mp4"|"webm"|"flv"|"mpeg"|"mpg"|"wmv"|"three_gp",
          "source": {
            "bytes": blob,
            "s3Location": {
              "uri": "string",
              "bucketOwner": "string"
            }
          }
        },
        "toolUse": {
          "toolUseId": "string",
          "name": "string",
          "input": {...}
        },
        "toolResult": {
          "toolUseId": "string",
          "content": [
            {
              "json": {...},
              "text": "string",
              "image": {
                "format": "png"|"jpeg"|"gif"|"webp",
                "source": {
                  "bytes": blob,
                  "s3Location": {
                    "uri": "string",
                    "bucketOwner": "string"
                  }
                }
              },
              "document": {
                "format": "pdf"|"csv"|"doc"|"docx"|"xls"|"xlsx"|"html"|"txt"|"md",
                "name": "string",
                "source": {
                  "bytes": blob,
                  "s3Location": {
                    "uri": "string",
                    "bucketOwner": "string"
                  }
                }
              },
              "video": {
                "format": "mkv"|"mov"|"mp4"|"webm"|"flv"|"mpeg"|"mpg"|"wmv"|"three_gp",
                "source": {
                  "bytes": blob,
                  "s3Location": {
                    "uri": "string",
                    "bucketOwner": "string"
                  }
                }
              }
            }
            ...
          ],
          "status": "success"|"error"
        },
        "guardContent": {
          "text": {
            "text": "string",
            "qualifiers": ["grounding_source"|"query"|"guard_content", ...]
          },
          "image": {
            "format": "png"|"jpeg",
            "source": {
              "bytes": blob
            }
          }
        },
        "cachePoint": {
          "type": "default"
        },
        "reasoningContent": {
          "reasoningText": {
            "text": "string",
            "signature": "string"
          },
          "redactedContent": blob
        }
      }
      ...
    ]
  }
  ...
]

--system (список)

Синтаксис JSON:

[
  {
    "text": "string",
    "guardContent": {
      "text": {
        "text": "string",
        "qualifiers": ["grounding_source"|"query"|"guard_content", ...]
      },
      "image": {
        "format": "png"|"jpeg",
        "source": {
          "bytes": blob
        }
      }
    },
    "cachePoint": {
      "type": "default"
    }
  }
  ...
]

--inference-config (структура)

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

maxTokens=integer,temperature=float,topP=float,stopSequences=string,string

Синтаксис JSON:

{
  "maxTokens": integer,
  "temperature": float,
  "topP": float,
  "stopSequences": ["string", ...]
}

--tool-config (структура)

Синтаксис JSON:

{
  "tools": [
    {
      "toolSpec": {
        "name": "string",
        "description": "string",
        "inputSchema": {
          "json": {...}
        }
      },
      "cachePoint": {
        "type": "default"
      }
    }
    ...
  ],
  "toolChoice": {
    "auto": {

    },
    "any": {

    },
    "tool": {
      "name": "string"
    }
  }
}

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

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

guardrailIdentifier=string,guardrailVersion=string,trace=string

Синтаксис JSON:

{
  "guardrailIdentifier": "string",
  "guardrailVersion": "string",
  "trace": "enabled"|"disabled"|"enabled_full"
}

--additional-model-request-fields (документ)

Синтаксис JSON:

{...}

--prompt-variables (карта)

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

KeyName1=text=string,KeyName2=text=string

Синтаксис JSON:

{"string": {
      "text": "string"
    }
  ...}

--additional-model-response-field-paths (список)

Синтаксис:

"string" "string" ...

--request-metadata (карта)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--performance-config (структура)

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

latency=string

Синтаксис JSON:

{
  "latency": "standard"|"optimized"
}

--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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

• json
• text
• table
• yaml
• yaml-stream

--query (string)

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

--profile (string)

Использование определённого профиля из файла аутентификации.

--region (string)

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

--version (string)

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

--color (string)

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

• on
• off
• auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

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

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

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

stopReason -> (string)

usage -> (structure)

metrics -> (structure)

additionalModelResponseFields -> (document)

trace -> (structure)