Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

обновить-конфигурацию-управления-чатом

Описание

Обновляет набор настроек управления чатом, настроенных для существующего приложения Amazon Q Business.

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

Синтаксис

  update-chat-controls-configuration
--application-id <value>
[--client-token <value>]
[--response-scope <value>]
[--orchestration-configuration <value>]
[--blocked-phrases-configuration-update <value>]
[--topic-configurations-to-create-or-update <value>]
[--topic-configurations-to-delete <value>]
[--creator-mode-configuration <value>]
[--hallucination-reduction-configuration <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]

Параметры

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

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

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

Токен, который вы предоставляете для идентификации запроса на обновление конфигурации чата приложения Amazon Q Business.

--response-scope (строка)

Область отклика, настроенная для вашего приложения. Она определяет, использует ли ваше приложение свою систему извлечения и расширенного генерирования (RAG) для генерации ответов только из ваших корпоративных данных или также использует знания больших языковых моделей (LLM) для ответа на вопросы конечных пользователей в чате.

Возможные значения:

  • ENTERPRISE_CONTENT_ONLY
  • EXTENDED_KNOWLEDGE_ENABLED

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

Настройки организации ответа в чате для вашего приложения.

control -> (строка)

Информация о статусе активации или деактивации организации чата для вашего приложения Amazon Q Business.

Синтаксис сокращенного формата:

control=string

Синтаксис JSON:

{
  "control": "ENABLED"|"DISABLED"
}

--blocked-phrases-configuration-update (структура)

Фразы, заблокированные в чате вашей конфигурацией управления чатом.

blockedPhrasesToCreateOrUpdate -> (список)

Создает или обновляет конфигурацию заблокированных фраз в вашем приложении Amazon Q Business.

(строка)

blockedPhrasesToDelete -> (список)

Удаляет конфигурацию заблокированных фраз в вашем приложении Amazon Q Business.

(строка)

systemMessageOverride -> (строка)

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

Синтаксис сокращенного формата:

blockedPhrasesToCreateOrUpdate=string,string,blockedPhrasesToDelete=string,string,systemMessageOverride=string

Синтаксис JSON:

{
  "blockedPhrasesToCreateOrUpdate": ["string", ...],
  "blockedPhrasesToDelete": ["string", ...],
  "systemMessageOverride": "string"
}

--topic-configurations-to-create-or-update (список)

Настроенные настройки управления чатом по конкретным темам, которые вы хотите обновить.

(структура)

Настройки управления конкретной темой, настроенные для приложения Amazon Q Business.

name -> (строка)

Имя вашей конфигурации управления темой.

description -> (строка)

Описание вашей конфигурации управления темой. Используйте его для описания того, как большая языковая модель (LLM) должна использовать эту конфигурацию управления темой.

exampleChatMessages -> (список)

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

(строка)

rules -> (список)

Правила, определенные для конфигурации темы.

(структура)

Правила для ограждения для приложения Amazon Q Business. Amazon Q Business поддерживает только одно правило за раз.

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

Пользователи и группы, которые должны быть включены в правило.

userIds -> (список)

Идентификаторы пользователей, связанные с правилом управления темой.

(строка)

userGroups -> (список)

Имена пользовательских групп, связанные с правилом управления темой.

(строка)

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

Пользователи и группы, которые должны быть исключены из правила.

userIds -> (список)

Идентификаторы пользователей, связанные с правилом управления темой.

(строка)

userGroups -> (список)

Имена пользовательских групп, связанные с правилом управления темой.

(строка)

ruleType -> (строка)

Тип правила.

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

Информация о конфигурации правила.

Примечание

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

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

Правило для настройки того, как Amazon Q Business отвечает, когда встречает заблокированную тему.

systemMessageOverride -> (строка)

Настроенное пользовательское сообщение, отображаемое конечному пользователю, информирующее его о том, что он использовал заблокированную фразу во время чата.

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

Правила для извлечения содержимого из источников данных, подключенных к приложению Amazon Q Business для конкретной конфигурации управления темой.

eligibleDataSources -> (список)

Указывает источники данных в приложении Amazon Q Business для использования в генерации содержимого.

(структура)

Идентификатор источника данных, из которого Amazon Q Business сгенерирует ответы.

indexId -> (строка)

Идентификатор индекса, к которому прикреплен источник данных.

dataSourceId -> (строка)

Идентификатор источника данных.

Синтаксис JSON:

[
  {
    "name": "string",
    "description": "string",
    "exampleChatMessages": ["string", ...],
    "rules": [
      {
        "includedUsersAndGroups": {
          "userIds": ["string", ...],
          "userGroups": ["string", ...]
        },
        "excludedUsersAndGroups": {
          "userIds": ["string", ...],
          "userGroups": ["string", ...]
        },
        "ruleType": "CONTENT_BLOCKER_RULE"|"CONTENT_RETRIEVAL_RULE",
        "ruleConfiguration": {
          "contentBlockerRule": {
            "systemMessageOverride": "string"
          },
          "contentRetrievalRule": {
            "eligibleDataSources": [
              {
                "indexId": "string",
                "dataSourceId": "string"
              }
              ...
            ]
          }
        }
      }
      ...
    ]
  }
  ...
]

--topic-configurations-to-delete (список)

Настроенные настройки управления чатом по конкретным темам, которые вы хотите удалить.

(структура)

Настройки управления конкретной темой, настроенные для приложения Amazon Q Business.

name -> (строка)

Имя вашей конфигурации управления темой.

description -> (строка)

Описание вашей конфигурации управления темой. Используйте его для описания того, как большая языковая модель (LLM) должна использовать эту конфигурацию управления темой.

exampleChatMessages -> (список)

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

(строка)

rules -> (список)

Правила, определенные для конфигурации темы.

(структура)

Правила для ограждения для приложения Amazon Q Business. Amazon Q Business поддерживает только одно правило за раз.

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

Пользователи и группы, которые должны быть включены в правило.

userIds -> (список)

Идентификаторы пользователей, связанные с правилом управления темой.

(строка)

userGroups -> (список)

Имена пользовательских групп, связанные с правилом управления темой.

(строка)

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

Пользователи и группы, которые должны быть исключены из правила.

userIds -> (список)

Идентификаторы пользователей, связанные с правилом управления темой.

(строка)

userGroups -> (список)

Имена пользовательских групп, связанные с правилом управления темой.

(строка)

ruleType -> (строка)

Тип правила.

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

Информация о конфигурации правила.

Примечание

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

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

Правило для настройки того, как Amazon Q Business отвечает, когда встречает заблокированную тему.

systemMessageOverride -> (строка)

Настроенное пользовательское сообщение, отображаемое конечному пользователю, информирующее его о том, что он использовал заблокированную фразу во время чата.

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

Правила для извлечения содержимого из источников данных, подключенных к приложению Amazon Q Business для конкретной конфигурации управления темой.

eligibleDataSources -> (список)

Указывает источники данных в приложении Amazon Q Business для использования в генерации содержимого.

(структура)

Идентификатор источника данных, из которого Amazon Q Business сгенерирует ответы.

indexId -> (строка)

Идентификатор индекса, к которому прикреплен источник данных.

dataSourceId -> (строка)

Идентификатор источника данных.

Синтаксис JSON:

[
  {
    "name": "string",
    "description": "string",
    "exampleChatMessages": ["string", ...],
    "rules": [
      {
        "includedUsersAndGroups": {
          "userIds": ["string", ...],
          "userGroups": ["string", ...]
        },
        "excludedUsersAndGroups": {
          "userIds": ["string", ...],
          "userGroups": ["string", ...]
        },
        "ruleType": "CONTENT_BLOCKER_RULE"|"CONTENT_RETRIEVAL_RULE",
        "ruleConfiguration": {
          "contentBlockerRule": {
            "systemMessageOverride": "string"
          },
          "contentRetrievalRule": {
            "eligibleDataSources": [
              {
                "indexId": "string",
                "dataSourceId": "string"
              }
              ...
            ]
          }
        }
      }
      ...
    ]
  }
  ...
]

--creator-mode-configuration (структура)

Подробные сведения о конфигурации CREATOR_MODE .

creatorModeControl -> (строка)

Информация о статусе активации или деактивации CREATOR_MODE. Значение по умолчанию - DISABLED.

Синтаксис сокращенного формата:

creatorModeControl=string

Синтаксис JSON:

{
  "creatorModeControl": "ENABLED"|"DISABLED"
}

--hallucination-reduction-configuration (структура)

Настройки уменьшения галлюцинаций для вашего приложения.

hallucinationReductionControl -> (строка)

Управление включением или отключением уменьшения галлюцинаций для вашего приложения. Значение по умолчанию - DISABLED.

Синтаксис сокращенного формата:

hallucinationReductionControl=string

Синтаксис JSON:

{
  "hallucinationReductionControl": "ENABLED"|"DISABLED"
}

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

Файл сертификатов CA для проверки 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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, сопоставленного с двоичным блоком fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

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

--cli-auto-prompt (boolean)

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

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

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

Вывод

Нет

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API