create-agent

Описание

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

• Для обеспечения безопасности укажите следующие поля.
  • agentResourceRoleArn – Имя ресурса Amazon (ARN) роли с разрешениями на вызов операций API для агента.
  • (Необязательно) customerEncryptionKeyArn – Имя ресурса Amazon (ARN) ключа KMS для шифрования создания агента.
  • (Необязательно) idleSessionTTLinSeconds – Укажите количество секунд, в течение которого агент должен сохранять информацию о сеансе. После истечения этого времени последующий запрос InvokeAgent запускает новый сеанс.
• Чтобы агент мог сохранять контекст разговора в нескольких сеансах, включите объект memoryConfiguration. Для получения дополнительной информации см. Настройка памяти.
• Чтобы переопределить поведение по умолчанию для подсказок при организации агента и использовать расширенные подсказки, включите объект promptOverrideConfiguration. Для получения дополнительной информации см. Расширенные подсказки.
• Если агент не создан, ответ возвращает список failureReasons вместе со списком recommendedActions для устранения неполадок.
• Инструкции агента не будут выполнены, если у агента есть только одна база знаний, используются подсказки по умолчанию, нет группы действий и ввод пользователя отключён.

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

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

Синтаксис

  create-agent
[--agent-collaboration <value>]
--agent-name <value>
[--agent-resource-role-arn <value>]
[--client-token <value>]
[--custom-orchestration <value>]
[--customer-encryption-key-arn <value>]
[--description <value>]
[--foundation-model <value>]
[--guardrail-configuration <value>]
[--idle-session-ttl-in-seconds <value>]
[--instruction <value>]
[--memory-configuration <value>]
[--orchestration-type <value>]
[--prompt-override-configuration <value>]
[--tags <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]

Параметры

--agent-collaboration (строка)

--agent-name (строка)

--agent-resource-role-arn (строка)

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

--custom-orchestration (структура)

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

executor={lambda=string}

Синтаксис JSON:

{
  "executor": {
    "lambda": "string"
  }
}

--customer-encryption-key-arn (строка)

--description (строка)

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

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

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

guardrailIdentifier=string,guardrailVersion=string

Синтаксис JSON:

{
  "guardrailIdentifier": "string",
  "guardrailVersion": "string"
}

--idle-session-ttl-in-seconds (целое число)

--instruction (строка)

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

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

enabledMemoryTypes=string,string,sessionSummaryConfiguration={maxRecentSessions=integer},storageDays=integer

Синтаксис JSON:

{
  "enabledMemoryTypes": ["SESSION_SUMMARY", ...],
  "sessionSummaryConfiguration": {
    "maxRecentSessions": integer
  },
  "storageDays": integer
}

--orchestration-type (строка)

--prompt-override-configuration (структура)

Синтаксис JSON:

{
  "overrideLambda": "string",
  "promptConfigurations": [
    {
      "additionalModelRequestFields": {...},
      "basePromptTemplate": "string",
      "foundationModel": "string",
      "inferenceConfiguration": {
        "maximumLength": integer,
        "stopSequences": ["string", ...],
        "temperature": float,
        "topK": integer,
        "topP": float
      },
      "parserMode": "DEFAULT"|"OVERRIDDEN",
      "promptCreationMode": "DEFAULT"|"OVERRIDDEN",
      "promptState": "ENABLED"|"DISABLED",
      "promptType": "PRE_PROCESSING"|"ORCHESTRATION"|"POST_PROCESSING"|"KNOWLEDGE_BASE_RESPONSE_GENERATION"|"MEMORY_SUMMARIZATION"
    }
    ...
  ]
}

--tags (карта)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--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.

Вывод

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