get-guardrail

Описание

Получает подробности о защитном механизме. Если вы не укажете версию, ответ вернёт подробности для версии DRAFT.

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

Синтаксис

  get-guardrail
--guardrail-identifier <value>
[--guardrail-version <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]

Параметры

--guardrail-identifier (строка)

Уникальный идентификатор защитного механизма, для которого требуется получить подробности. Может быть ID или ARN.

--guardrail-version (строка)

Версия защитного механизма, для которой требуется получить подробности. Если вы не укажете версию, ответ вернёт подробности для версии DRAFT.

--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 (строка)

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

--version (строка)

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

--color (строка)

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

включено
выключено
авто

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

Вывод

name -> (строка)

Название ограждения.

description -> (строка)

Описание ограждения.

guardrailId -> (строка)

Уникальный идентификатор ограждения.

guardrailArn -> (строка)

ARN ограждения.

version -> (строка)

Версия ограждения.

status -> (строка)

Статус ограждения.

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

Политика тем, настроенная для ограждения.

topics -> (список)

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

(структура)

Подробности о темах для идентификации и отклонения ограждением.

Этот тип данных используется в следующих операциях API:

Ответ тела GetGuardrail

name -> (строка)

Имя темы для отклонения.

definition -> (строка)

Описание темы для отклонения.

examples -> (список)

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

(строка)

type -> (строка)

Указывает на отклонение темы.

inputAction -> (строка)

Действие, которое следует предпринять при обнаружении вредного содержимого в вводе. Допустимые значения:

BLOCK – заблокировать содержимое и заменить его сообщением о блокировке.
NONE – не предпринимать никаких действий, но вернуть информацию об обнаружении в ответе трассировки.

outputAction -> (строка)

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

BLOCK – заблокировать содержимое и заменить его сообщением о блокировке.
NONE – не предпринимать никаких действий, но вернуть информацию об обнаружении в ответе трассировки.

inputEnabled -> (булево)

Указывает, включена ли оценка ограждения для входных данных. При отключении за оценка не взимается. Оценка не отображается в ответе.

outputEnabled -> (булево)

Указывает, включена ли оценка ограждения для выходных данных. При отключении за оценка не взимается. Оценка не отображается в ответе.

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

Политика содержимого, настроенная для ограждения.

filters -> (список)

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

(структура)

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

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

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

Дополнительные сведения см. в разделе Фильтры содержимого ограждений.

Этот тип данных используется в следующих операциях API:

Ответ тела GetGuardrail

type -> (строка)

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

inputStrength -> (строка)

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

outputStrength -> (строка)

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

inputModalities -> (список)

Выбранные входные модальные параметры для фильтра содержимого ограждения.

(строка)

outputModalities -> (список)

Выбранные выходные модальные параметры для фильтра содержимого ограждения.

(строка)

inputAction -> (строка)

Действие, которое следует предпринять при обнаружении вредного содержимого в вводе. Допустимые значения:

BLOCK – заблокировать содержимое и заменить его сообщением о блокировке.
NONE – не предпринимать никаких действий, но вернуть информацию об обнаружении в ответе трассировки.

outputAction -> (строка)

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

BLOCK – заблокировать содержимое и заменить его сообщением о блокировке.
NONE – не предпринимать никаких действий, но вернуть информацию об обнаружении в ответе трассировки.

inputEnabled -> (булево)

outputEnabled -> (булево)

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

Политика слов, настроенная для ограждения.

words -> (список)

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

(структура)

Слово, настроенное для ограждения.

text -> (строка)

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

inputAction -> (строка)

Действие, которое следует предпринять при обнаружении вредного содержимого в вводе. Допустимые значения:

BLOCK – заблокировать содержимое и заменить его сообщением о блокировке.
NONE – не предпринимать никаких действий, но вернуть информацию об обнаружении в ответе трассировки.

outputAction -> (строка)

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

BLOCK – заблокировать содержимое и заменить его сообщением о блокировке.
NONE – не предпринимать никаких действий, но вернуть информацию об обнаружении в ответе трассировки.

inputEnabled -> (булево)

outputEnabled -> (булево)

managedWordLists -> (список)

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

(структура)

Управляемый список слов, настроенный для ограждения. (Это список слов, предварительно определенных и управляемых только ограждениями.)

type -> (строка)

ManagedWords$type Тип управляемого списка слов, настроенный для ограждения. (Пока мы предлагаем только список нецензурных слов)

inputAction -> (строка)

Действие, которое следует предпринять при обнаружении вредного содержимого в вводе. Допустимые значения:

BLOCK – заблокировать содержимое и заменить его сообщением о блокировке.
NONE – не предпринимать никаких действий, но вернуть информацию об обнаружении в ответе трассировки.

outputAction -> (строка)

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

BLOCK – заблокировать содержимое и заменить его сообщением о блокировке.
NONE – не предпринимать никаких действий, но вернуть информацию об обнаружении в ответе трассировки.

inputEnabled -> (булево)

outputEnabled -> (булево)

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

Политика конфиденциальности чувствительной информации, настроенная для барьера.

piiEntities -> (список)

Список сущностей PII, настроенных для барьера.

(структура)

Сущность PII, настроенная для барьера.

type -> (строка)

Тип сущности PII. Например, номер социального страхования.

action -> (строка)

Настроенное действие барьера при обнаружении сущности PII.

inputAction -> (строка)

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

BLOCK – Заблокировать содержимое и заменить его сообщением о блокировке.
ANONYMIZE – Маскировать содержимое и заменить его тегами идентификаторов.
NONE – Не выполнять никаких действий, но возвращать информацию об обнаружении в ответ с отслеживанием.

outputAction -> (строка)

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

BLOCK – Заблокировать содержимое и заменить его сообщением о блокировке.
ANONYMIZE – Маскировать содержимое и заменить его тегами идентификаторов.
NONE – Не выполнять никаких действий, но возвращать информацию об обнаружении в ответ с отслеживанием.

inputEnabled -> (булево)

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

outputEnabled -> (булево)

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

regexes -> (список)

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

(структура)

Регулярное выражение, настроенное для барьера.

name -> (строка)

Имя регулярного выражения для барьера.

description -> (строка)

Описание регулярного выражения для барьера.

pattern -> (строка)

Шаблон настроенного регулярного выражения для барьера.

action -> (строка)

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

inputAction -> (строка)

BLOCK – Заблокировать содержимое и заменить его сообщением о блокировке.
NONE – Не выполнять никаких действий, но возвращать информацию об обнаружении в ответ с отслеживанием.

outputAction -> (строка)

BLOCK – Заблокировать содержимое и заменить его сообщением о блокировке.
NONE – Не выполнять никаких действий, но возвращать информацию об обнаружении в ответ с отслеживанием.

inputEnabled -> (булево)

outputEnabled -> (булево)

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

Политика контекстуального обоснования, используемая в барьере.

filters -> (список)

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

(структура)

Подробности фильтра контекстуального обоснования барьеров.

type -> (строка)

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

threshold -> (вещественное)

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

action -> (строка)

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

BLOCK – Заблокировать содержимое и заменить его сообщением о блокировке.
NONE – Не выполнять никаких действий, но возвращать информацию об обнаружении в ответ с отслеживанием.

enabled -> (булево)

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

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

Подробности о системном профиле барьера, который вы используете со своим барьером, включая идентификатор профиля барьера и Amazon Resource Name (ARN).

guardrailProfileId -> (строка)

Идентификатор профиля барьера, который использует ваш барьер. Доступность профиля зависит от вашего текущего региона Amazon Web Services. Дополнительную информацию см. в руководстве пользователя Amazon Bedrock.

guardrailProfileArn -> (строка)

Amazon Resource Name (ARN) профиля барьера, который вы используете со своим барьером.

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

Дата и время создания барьера.

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

Дата и время обновления барьера.

statusReasons -> (список)

Отображается, если status является FAILED. Список причин, по которым барьер не был создан, обновлен, с новой версией или удален.

(строка)

failureRecommendations -> (список)

Отображается, если status барьера является FAILED. Список рекомендаций для выполнения перед повторной отправкой запроса.

(строка)

blockedInputMessaging -> (строка)

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

blockedOutputsMessaging -> (строка)

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

kmsKeyArn -> (строка)

ARN ключа KMS, который шифрует барьер.