Spec-Zone.ru › AWS CLI v2

[ aws . comprehend ]

batch-detect-entities

Описание

Проверяет текст пакета документов на именованные сущности и возвращает информацию о них. Дополнительную информацию об именованных сущностях см. в руководстве разработчика Comprehend в разделе Сущности.

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

Синтаксис

  batch-detect-entities
--text-list <value>
--language-code <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]

Параметры

--text-list (список)

Список, содержащий закодированный в UTF-8 текст входных документов. Список может содержать не более 25 документов. Максимальный размер каждого документа составляет 5 КБ.

(строка)

Синтаксис:

"string" "string" ...

--language-code (строка)

Язык входных документов. Вы можете указать любой из основных языков, поддерживаемых Amazon Comprehend. Все документы должны быть на одном языке.

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

  • en
  • es
  • fr
  • de
  • it
  • pt
  • ar
  • hi
  • ja
  • ko
  • zh
  • zh-TW

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

За исключением случаев, когда указано иное, во всех примерах используются правила цитирования Unix-подобных оболочек. Эти примеры нужно адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Чтобы обнаружить сущности из нескольких текстов

Следующий пример batch-detect-entities анализирует несколько текстов и возвращает именованные сущности каждого из них. Также выводится оценка достоверности модели предварительной обучения для каждого прогноза.

aws comprehend batch-detect-entities \
    --language-code en \
    --text-list "Dear Jane, Your AnyCompany Financial Services LLC credit card account 1111-XXXX-1111-XXXX has a minimum payment of $24.53 that is due by July 31st." "Please send customer feedback to Sunshine Spa, 123 Main St, Anywhere or to Alice at AnySpa@example.com."

Вывод:

{
    "ResultList": [
        {
            "Index": 0,
            "Entities": [
                {
                    "Score": 0.9985517859458923,
                    "Type": "PERSON",
                    "Text": "Jane",
                    "BeginOffset": 5,
                    "EndOffset": 9
                },
                {
                    "Score": 0.9767839312553406,
                    "Type": "ORGANIZATION",
                    "Text": "AnyCompany Financial Services, LLC",
                    "BeginOffset": 16,
                    "EndOffset": 50
                },
                {
                    "Score": 0.9856694936752319,
                    "Type": "OTHER",
                    "Text": "1111-XXXX-1111-XXXX",
                    "BeginOffset": 71,
                    "EndOffset": 90
                },
                {
                    "Score": 0.9652159810066223,
                    "Type": "QUANTITY",
                    "Text": ".53",
                    "BeginOffset": 116,
                    "EndOffset": 119
                },
                {
                    "Score": 0.9986667037010193,
                    "Type": "DATE",
                    "Text": "July 31st",
                    "BeginOffset": 135,
                    "EndOffset": 144
                }
            ]
        },
        {
            "Index": 1,
            "Entities": [
                {
                    "Score": 0.720084547996521,
                    "Type": "ORGANIZATION",
                    "Text": "Sunshine Spa",
                    "BeginOffset": 33,
                    "EndOffset": 45
                },
                {
                    "Score": 0.9865870475769043,
                    "Type": "LOCATION",
                    "Text": "123 Main St",
                    "BeginOffset": 47,
                    "EndOffset": 58
                },
                {
                    "Score": 0.5895616412162781,
                    "Type": "LOCATION",
                    "Text": "Anywhere",
                    "BeginOffset": 60,
                    "EndOffset": 68
                },
                {
                    "Score": 0.6809214353561401,
                    "Type": "PERSON",
                    "Text": "Alice",
                    "BeginOffset": 75,
                    "EndOffset": 80
                },
                {
                    "Score": 0.9979087114334106,
                    "Type": "OTHER",
                    "Text": "AnySpa@example.com",
                    "BeginOffset": 84,
                    "EndOffset": 99
                }
            ]
        }
    ],
    "ErrorList": []
}

Дополнительную информацию см. в руководстве разработчика Amazon Comprehend в разделе Сущности.

Вывод

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

Список объектов, содержащих результаты операции. Результаты отсортированы в порядке возрастания поля Index и соответствуют порядку документов во входном списке. Если все документы содержат ошибку, то ResultList пуст.

(структура)

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

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

Нулевой индекс документа во входном списке.

Сущности -> (список)

Один или несколько объектов Entity, один для каждой обнаруженной сущности в документе.

(структура)

Предоставляет информацию об именованной сущности.

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

Уровень уверенности Amazon Comprehend в точности обнаружения.

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

Тип сущности. При обнаружении сущностей с помощью встроенной модели это поле содержит один из стандартных типов сущностей, перечисленных ниже.

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

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

Текст сущности.

НачальныйОфсет -> (целое число)

Нулевой смещение от начала исходного текста до первого символа сущности.

Это поле пусто для входных данных, отличных от текста.

КонечныйОфсет -> (целое число)

Нулевой смещение от начала исходного текста до последнего символа сущности.

Это поле пусто для входных данных, отличных от текста.

СсылкиНаБлоки -> (список)

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

(структура)

Ссылка на блок.

ИдентификаторБлока -> (строка)

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

НачальныйОфсет -> (целое число)

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

КонечныйОфсет -> (целое число)

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

ПодчинённыеБлоки -> (список)

Список дочерних блоков внутри этого блока.

(структура)

Вложенный блок, содержащийся внутри блока.

ИдентификаторПодчинённогоБлока -> (строка)

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

НачальныйОфсет -> (целое число)

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

КонечныйОфсет -> (целое число)

Смещение конца дочернего блока внутри родительского блока.

СписокОшибок -> (список)

Список, содержащий один объект для каждого документа, содержащего ошибку. Результаты отсортированы в порядке возрастания поля Index и соответствуют порядку документов во входном списке. Если в пакете нет ошибок, то ErrorList пусто.

(структура)

Описание ошибки, возникшей при обработке документа в пакете. Операция возвращает один объект BatchItemError для каждого документа, содержащего ошибку.

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

Нулевой индекс документа во входном списке.

КодОшибки -> (строка)

Числовой код ошибки.

ТекстОшибки -> (строка)

Текстовое описание ошибки.

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

Spec-Zone.ru

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