Spec-Zone.ru › AWS CLI v2

[ aws . bedrock-runtime ]

apply-guardrail

Описание

Действие по применению ограничителя.

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

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

Синтаксис

  apply-guardrail
--guardrail-identifier <value>
--guardrail-version <value>
--source <value>
--content <value>
[--output-scope <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 (строка)

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

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

Версия ограничителя, используемая в запросе для применения ограничителя.

--source (строка)

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

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

  • INPUT
  • OUTPUT

--content (список)

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

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

Блок содержимого, подлежащий оценке ограничителем.

Примечание

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

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

Текст в блоке содержимого, подлежащий оценке ограничителем.

text -> (строка)

Подробные сведения о текстовом вводе, подлежащем оценке ограничителем.

qualifiers -> (список)

Квалификаторы, описывающие текстовый блок.

(строка)

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

Изображение в блоке содержимого ограничителя, подлежащее оценке ограничителем.

format -> (строка)

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

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

Подробные сведения о источнике изображения (байты изображения), заблокированного ограничителем.

Примечание

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

bytes -> (двоичные данные)

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

Упрощенный синтаксис:

text={text=string,qualifiers=[string,string]},image={format=string,source={bytes=blob}} ...

Синтаксис JSON:

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

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

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

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

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

  • INTERVENTIONS
  • FULL

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

Вывод

использование -> (структура)

Подробности использования в ответе от системы контроля.

topicPolicyUnits -> (целое число)

Единицы политики тем, обработанные системой контроля.

contentPolicyUnits -> (целое число)

Единицы политики контента, обработанные системой контроля.

wordPolicyUnits -> (целое число)

Единицы политики слов, обработанные системой контроля.

sensitiveInformationPolicyUnits -> (целое число)

Единицы политики конфиденциальной информации, обработанные системой контроля.

sensitiveInformationPolicyFreeUnits -> (целое число)

Свободные единицы политики конфиденциальной информации, обработанные системой контроля.

contextualGroundingPolicyUnits -> (целое число)

Единицы политики контекстуального обоснования, обработанные системой контроля.

contentPolicyImageUnits -> (целое число)

Единицы политики контента изображений, обработанные системой контроля.

действие -> (строка)

Принятое действие в ответе от системы контроля.

причинаДействия -> (строка)

Причина принятия действия при обнаружении вредного контента.

выводы -> (список)

Подробности выводов в ответе от системы контроля.

(структура)

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

текст -> (строка)

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

оценки -> (список)

Подробности оценок в ответе от системы контроля.

(структура)

Оценка поведения используемых политик системы контроля в вызове API Converse.

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

Политика тем.

темы -> (список)

Темы в оценке.

(структура)

Информация о политике контроля тем.

название -> (строка)

Название политики контроля.

тип -> (строка)

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

действие -> (строка)

Действие, которое система контроля должна предпринять при вмешательстве в тему.

обнаружено -> (булево)

Указывает, обнаружен ли контент темы, нарушающий настройки политики контроля.

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

Политика контента.

фильтры -> (список)

Фильтры политики контента.

(структура)

Фильтр контента для системы контроля.

тип -> (строка)

Тип системы контроля.

уверенность -> (строка)

Уверенность системы контроля.

силаФильтра -> (строка)

Настройки силы фильтра для фильтра контента системы контроля.

действие -> (строка)

Действие системы контроля.

обнаружено -> (булево)

Указывает, обнаружен ли контент, нарушающий настройки системы контроля.

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

Политика слов.

customWords -> (список)

Пользовательские слова в оценке.

(структура)

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

соответствие -> (строка)

Соответствие для пользовательского слова.

действие -> (строка)

Действие для пользовательского слова.

обнаружено -> (булево)

Указывает, обнаружен ли пользовательский контент, нарушающий настройки системы контроля.

managedWordLists -> (список)

Управляемые списки слов в оценке.

(структура)

Управляемое слово, настроенное в системе контроля.

соответствие -> (строка)

Соответствие для управляемого слова.

тип -> (строка)

Тип для управляемого слова.

действие -> (строка)

Действие для управляемого слова.

обнаружено -> (булево)

Указывает, обнаружен ли управляемый контент, нарушающий настройки системы контроля.

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

Политика конфиденциальной информации.

piiEntities -> (список)

Сущности PII в оценке.

(структура)

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

соответствие -> (строка)

Соответствие фильтра сущностей PII.

тип -> (строка)

Тип фильтра сущностей PII.

действие -> (строка)

Действие фильтра сущностей PII.

обнаружено -> (булево)

Указывает, обнаружена ли конфиденциальная информация, нарушающая настройки системы контроля.

regexes -> (список)

Запросы regex в оценке.

(структура)

Фильтр regex, настроенный в системе контроля.

название -> (строка)

Название фильтра regex.

соответствие -> (строка)

Соответствие фильтра regex.

regex -> (строка)

Запрос regex.

действие -> (строка)

Действие фильтра regex.

обнаружено -> (булево)

Указывает, обнаружены ли сущности regex, нарушающие настройки системы контроля.

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

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

фильтры -> (список)

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

(структура)

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

тип -> (строка)

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

порог -> (вещественное число)

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

оценка -> (вещественное число)

Оценка, сгенерированная фильтром контекстуального обоснования.

действие -> (строка)

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

обнаружено -> (булево)

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

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

Метрики вызова для оценки системы контроля.

guardrailProcessingLatency -> (длинное целое число)

Подробности задержки обработки для метрик вызова системы контроля.

использование -> (структура)

Подробности использования для метрик вызова системы контроля.

topicPolicyUnits -> (целое число)

Единицы политики тем, обработанные системой контроля.

contentPolicyUnits -> (целое число)

Единицы политики контента, обработанные системой контроля.

wordPolicyUnits -> (целое число)

Единицы политики слов, обработанные системой контроля.

sensitiveInformationPolicyUnits -> (целое число)

Единицы политики конфиденциальной информации, обработанные системой контроля.

sensitiveInformationPolicyFreeUnits -> (целое число)

Свободные единицы политики конфиденциальной информации, обработанные системой контроля.

contextualGroundingPolicyUnits -> (целое число)

Единицы политики контекстуального обоснования, обработанные системой контроля.

contentPolicyImageUnits -> (целое число)

Единицы политики контента изображений, обработанные системой контроля.

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

Подробности покрытия для метрик вызова системы контроля.

символыТекста -> (структура)

Символы текста для подробностей покрытия системы контроля.

защищенные -> (целое число)

Символы текста, которые были защищены покрытием системы контроля.

всего -> (целое число)

Общее количество символов текста в покрытии системы контроля.

изображения -> (структура)

Покрытие системы контроля для изображений (количество изображений, защищённых системами контроля).

защищенные -> (целое число)

Количество (целое число) изображений, защищённых системами контроля.

всего -> (целое число)

Общее количество изображений (целое число), которые были в запросе (защищённые и незащищённые).

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

Подробности покрытия системы контроля в ответе на применение системы контроля.

символыТекста -> (структура)

Символы текста для подробностей покрытия системы контроля.

защищенные -> (целое число)

Символы текста, которые были защищены покрытием системы контроля.

всего -> (целое число)

Общее количество символов текста в покрытии системы контроля.

изображения -> (структура)

Покрытие системы контроля для изображений (количество изображений, защищённых системами контроля).

защищенные -> (целое число)

Количество (целое число) изображений, защищённых системами контроля.

всего -> (целое число)

Общее количество изображений (целое число), которые были в запросе (защищённые и незащищённые).

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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