get-ai-guardrail

Описание

Получает Amazon Q в Connect AI Guardrail.

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

Синтаксис

  get-ai-guardrail
--assistant-id <value>
--ai-guardrail-id <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]

Параметры

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

Идентификатор помощника Amazon Q в Connect. Может быть либо ID, либо ARN. URL-адреса не могут содержать ARN.

--ai-guardrail-id (строка)

Идентификатор Amazon Q в Connect AI Guardrail.

--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
текст
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки config/env.

--version (строка)

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

--color (строка)

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

включить
выключить
автоматически

--no-sign-request (булево)

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

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки config/env.

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

Вывод

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

Данные AI Guardrail.

assistantId -> (строка)

Идентификатор помощника Amazon Q в Connect. Может быть либо ID, либо ARN. URL-адреса не могут содержать ARN.

assistantArn -> (строка)

Amazon Resource Name (ARN) помощника Amazon Q в Connect.

aiGuardrailArn -> (строка)

Amazon Resource Name (ARN) AI Guardrail.

aiGuardrailId -> (строка)

Идентификатор Amazon Q в Connect AI Guardrail.

name -> (строка)

Название AI Guardrail.

visibilityStatus -> (строка)

Статус видимости AI Guardrail.

blockedInputMessaging -> (строка)

Сообщение, возвращаемое, когда AI Guardrail блокирует запрос.

blockedOutputsMessaging -> (строка)

Сообщение, возвращаемое, когда AI Guardrail блокирует ответ модели.

description -> (строка)

Описание AI Guardrail.

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

Содержит данные о темах, которые AI Guardrail должен определять и запрещать.

topicsConfig -> (список)

Список правил, связанных с темами, которые AI Guardrail должен запретить.

(структура)

Подробности о темах, которые AI Guardrail должен определять и запрещать.

name -> (строка)

Название темы для запрета.

definition -> (строка)

Определение темы для запрета.

examples -> (список)

Список запросов, каждый из которых является примером запроса, который можно отнести к теме.

(строка)

Пример текста в политике темы

type -> (строка)

Указывает на запрет темы.

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

Содержит данные о том, как обрабатывать вредное содержимое.

filtersConfig -> (список)

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

(структура)

Содержит уровни силы фильтров для вредного содержимого. AI Guardrail поддерживает следующие фильтры содержимого для обнаружения и фильтрации вредных входных данных пользователя и выходных данных FM.

Ненависть : описывает входные запросы и ответы модели, которые дискриминируют, критикуют, оскорбляют, осуждают или обесчеловечивают человека или группу на основе идентичности (такой как раса, этническая принадлежность, пол, религия, сексуальная ориентация, способность и национальность).
Оскорбления : описывает входные запросы и ответы модели, которые включают уничижительный, унижающий, насмешливый, оскорбительный или презрительный язык. Этот тип языка также маркируется как издевательство.
Сексуальный : описывает входные запросы и ответы модели, которые указывают сексуальный интерес, деятельность или возбуждение с использованием прямых или косвенных ссылок на части тела, физические черты или пол.
Насилие : описывает входные запросы и ответы модели, которые включают восхваление или угрозу причинения физической боли, вреда или травм человеку, группе или предмету.

Фильтрация содержимого зависит от классификации уверенности входных данных пользователя и ответов FM по каждой из четырех категорий вредного содержимого. Все входные и выходные заявления классифицируются по одному из четырех уровней уверенности (НЕТ, НИЗКИЙ, СРЕДНИЙ, ВЫСОКИЙ) для каждой категории вредного содержимого. Например, если утверждение классифицируется как Ненависть с высокой уверенностью, вероятность того, что утверждение представляет ненавистное содержимое, высока. Одно утверждение может быть классифицировано по нескольким категориям с различными уровнями уверенности. Например, одно утверждение может быть классифицировано как Ненависть с высокой уверенностью, Оскорбления со средней уверенностью, Сексуальный с низкой уверенностью и Насилие со средней уверенностью.

type -> (строка)

Категория вредного содержимого, к которому применяется фильтр содержимого.

inputStrength -> (строка)

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

outputStrength -> (строка)

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

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

Содержит данные о политике слов, настроенной для AI Guardrail.

wordsConfig -> (список)

Список слов для настройки AI Guardrail.

(структура)

Слово для настройки AI Guardrail.

text -> (строка)

Текст слова, настроенного для блокирования AI Guardrail.

managedWordListsConfig -> (список)

Список управляемых списков слов для настройки AI Guardrail.

(структура)

Управляемый список слов для настройки AI Guardrail.

type -> (строка)

Тип управляемого списка слов для настройки AI Guardrail.

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

Содержит сведения о сущностях ПII и регулярных выражениях для настройки AI Guardrail.

piiEntitiesConfig -> (список)

Список сущностей ПII для настройки AI Guardrail.

(структура)

Сущность ПII для настройки AI Guardrail.

type -> (строка)

Настройка типа AI Guardrail при обнаружении сущности ПII.

Следующие ПII используются для блокирования или маскирования конфиденциальной информации:

Общие
- ADDRESS Физический адрес, например, «100 Main Street, Anytown, USA» или «Suite #12, Building 123». Адрес может включать информацию, такую как улица, дом, местоположение, город, штат, страна, округ, почтовый индекс, участок и район.
- AGE Возраст человека, включая количество и единицу измерения времени. Например, в фразе «Мне 40 лет», Guarrails распознает «40 лет» как возраст.
- NAME Имя человека. Этот тип сущности не включает звания, такие как доктор, мистер, миссис или мисс. AI Guardrail не применяет этот тип сущности к именам, которые являются частью организаций или адресов. Например, AI Guardrail распознает «John Doe Organization» как организацию, а «Jane Doe Street» — как адрес.
- EMAIL Электронный адрес, например, marymajor@email.com.
- PHONE Номер телефона. Этот тип сущности также включает факсы и номера пейджеров.
- USERNAME Имя пользователя, которое идентифицирует учетную запись, например, имя входа, имя пользователя, никнейм или псевдоним.
- PASSWORD Алфавитно-цифровая строка, используемая в качестве пароля, например, «very20special#pass».
- DRIVER_ID Номер, присвоенный водительскому удостоверению, которое является официальным документом, разрешающим физическому лицу управлять одним или несколькими транспортными средствами с двигателем на общественной дороге. Номер водительского удостоверения состоит из буквенно-цифровых символов.
- LICENSE_PLATE Номер государственного или национального регистрационного знака транспортного средства. Формат для легковых автомобилей обычно составляет от пяти до восьми цифр, состоящих из заглавных букв и цифр. Формат варьируется в зависимости от места выдачи документа.
- VEHICLE_IDENTIFICATION_NUMBER Идентификационный номер транспортного средства (VIN) однозначно идентифицирует транспортное средство. Содержание и формат VIN определены в спецификации ISO 3779. Каждая страна имеет собственные коды и форматы для VIN.
Финансы
- CREDIT_DEBIT_CARD_CVV Трехзначный код проверки карты (CVV), который присутствует на кредитных и дебетовых картах VISA, MasterCard и Discover. Для кредитных или дебетовых карт American Express CVV представляет собой четырехзначный числовой код.
- CREDIT_DEBIT_CARD_EXPIRY Дата истечения срока действия кредитной или дебетовой карты. Это число обычно имеет длину четыре цифры и часто форматируется как месяц/год или MM/YY. AI Guardrail распознает даты истечения срока действия, такие как 01/21, 01/2021 и Январь 2021.
- CREDIT_DEBIT_CARD_NUMBER Номер кредитной или дебетовой карты. Эти номера могут иметь длину от 13 до 16 цифр. Тем не менее, Amazon Comprehend также распознает номера кредитных или дебетовых карт, когда присутствуют только последние четыре цифры.
- PIN Четырехзначный персональный идентификационный номер (PIN), с помощью которого вы можете получить доступ к своему банковскому счету.
- INTERNATIONAL_BANK_ACCOUNT_NUMBER Международный банковский счет имеет определенные форматы в каждой стране. Для получения дополнительной информации см. www.iban.com/structure.
- SWIFT_CODE SWIFT-код — это стандартный формат банковского идентификационного кода (BIC), используемый для указания конкретного банка или филиала. Банки используют эти коды для денежных переводов, таких как международные банковские переводы. SWIFT-коды состоят из 8 или 11 символов. 11-значные коды относятся к конкретным филиалам, а 8-значные коды (или 11-значные коды, заканчивающиеся на «XXX») — к головному или основному офису.
IT
- IP_ADDRESS IPv4-адрес, например, 198.51.100.0.
- MAC_ADDRESS Media access control (MAC)-адрес — это уникальный идентификатор, назначенный контроллеру сетевого интерфейса (NIC).
- URL Веб-адрес, например, www.example.com.
- AWS_ACCESS_KEY Уникальный идентификатор, связанный с секретным ключом доступа; для криптографического подписания запросов Amazon Web Services программно вы используете идентификатор ключа доступа и секретный ключ доступа.
- AWS_SECRET_KEY Уникальный идентификатор, связанный с ключом доступа. Для криптографического подписания запросов Amazon Web Services программно вы используете идентификатор ключа доступа и секретный ключ доступа.
Конкретно для США
- US_BANK_ACCOUNT_NUMBER Номер счета в американском банке, который обычно имеет длину от 10 до 12 цифр.
- US_BANK_ROUTING_NUMBER Номер маршрутизации счета в американском банке. Обычно они имеют длину 9 цифр.
- US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER Номер индивидуального налогоплательщика США (ITIN) — это девятизначное число, начинающееся с «9» и содержащее «7» или «8» в качестве четвертой цифры. ITIN может быть отформатирован с пробелом или дефисом после третьей и четвертой цифр.
- US_PASSPORT_NUMBER Номер паспорта США. Номера паспортов имеют длину от шести до девяти буквенно-цифровых символов.
- US_SOCIAL_SECURITY_NUMBER Номер социального страхования США (SSN) — это девятизначное число, выдаваемое гражданам США, постоянным и временным резидентам.
Конкретно для Канады
- CA_HEALTH_NUMBER Канадский номер медицинского обслуживания — это уникальный 10-значный идентификатор, необходимый для получения медицинских льгот.
- CA_SOCIAL_INSURANCE_NUMBER Канадский номер социального страхования (SIN) — это уникальный девятизначный идентификатор, необходимый для получения доступа к государственным программам и льготам. SIN форматируется как три группы из трех цифр, например, 123-456-789. SIN можно проверить с помощью простого процесса проверки цифр, называемого алгоритмом Луна.
Конкретно для Великобритании
- UK_NATIONAL_HEALTH_SERVICE_NUMBER Номер Национальной службы здравоохранения Великобритании — это число от 10 до 17 цифр, например, 485 555 3456. Текущая система форматирует 10-значное число с пробелами после третьей и шестой цифр. Последняя цифра — это контрольная сумма для выявления ошибок.
- UK_NATIONAL_INSURANCE_NUMBER Номер национального страхования Великобритании (NINO) предоставляет доступ к льготам по национальному страхованию (социальному обеспечению). Он также используется в некоторых целях в британской налоговой системе. Номер состоит из девяти цифр и начинается с двух букв, за которыми следуют шесть цифр и одна буква. NINO может быть отформатирован с пробелом или дефисом после двух букв и после второй, четвертой и шестой цифр.
- UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER Уникальный налоговый идентификатор Великобритании (UTR) — это 10-значное число, которое идентифицирует налогоплательщика или бизнес.
Пользовательский
- Фильтр регулярных выражений — Вы можете использовать регулярные выражения для определения шаблонов, которые AI Guardrail распознает и обрабатывает, например, серийные номера, идентификаторы бронирования и т. д.

action -> (строка)

Настройка действия AI Guardrail при обнаружении сущности ПII.

regexesConfig -> (список)

Список регулярных выражений для настройки AI Guardrail.

(структура)

Регулярное выражение для настройки AI Guardrail.

name -> (строка)

Имя регулярного выражения для настройки AI Guardrail.

description -> (строка)

Описание регулярного выражения для настройки AI Guardrail.

pattern -> (строка)

Шаблон регулярного выражения для настройки AI Guardrail.

action -> (строка)

Действие AI Guardrail для настройки при обнаружении совпадения с регулярным выражением.

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

Детали конфигурации политики для политики контекстуального обоснования AI Guardrail.

filtersConfig -> (список)

Детали конфигурации фильтра для политики контекстуального обоснования AI Guardrail.

(структура)

Детали конфигурации фильтра для контекстуального фильтра обоснования AI Guardrail.

type -> (строка)

Тип фильтра для контекстуального фильтра обоснования AI Guardrail.

threshold -> (двойное)

Детали порога для контекстуального фильтра обоснования AI Guardrail.

tags -> (карта)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

status -> (строка)

Статус AI Guardrail.

modifiedTime -> (временная метка)

Время последней модификации AI Guardrail.

versionNumber -> (целое)

Номер версии AI Guardrail (возвращается, если версия AI Guardrail была указана с помощью квалификатора для aiGuardrailId в запросе).