[ aws . comprehend ]
start-dominant-language-detection-job
Описание
Запускает асинхронную задачу обнаружения доминирующего языка для набора документов. Используйте операцию для отслеживания статуса задачи.
См. также: Документацию API AWS
Синтаксис
start-dominant-language-detection-job
--input-data-config <value>
--output-data-config <value>
--data-access-role-arn <value>
[--job-name <value>]
[--client-request-token <value>]
[--volume-kms-key-id <value>]
[--vpc-config <value>]
[--tags <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]
Параметры
--input-data-config (структура)
Указывает формат и расположение входных данных для задачи.
S3Uri -> (строка)
Amazon S3 URI для входных данных. URI должен находиться в том же регионе, что и конечная точка API, к которой вы обращаетесь. URI может указывать на один входной файл или префикс для набора файлов данных.
Например, если вы используете URI S3://bucketName/prefix , если префикс является одним файлом, Amazon Comprehend использует этот файл в качестве входных данных. Если более одного файла начинаются с префикса, Amazon Comprehend использует все их в качестве входных данных.
InputFormat -> (строка)
Указывает, как должен обрабатываться текст во входном файле:
-
ONE_DOC_PER_FILE- Каждый файл рассматривается как отдельный документ. Используйте этот параметр при обработке больших документов, таких как газетные статьи или научные статьи. -
ONE_DOC_PER_LINE- Каждая строка в файле рассматривается как отдельный документ. Используйте этот параметр при обработке многих коротких документов, таких как текстовые сообщения.
DocumentReaderConfig -> (структура)
Предоставляет параметры конфигурации для переопределения стандартных действий по извлечению текста из PDF-документов и файлов изображений.
DocumentReadAction -> (строка)
Это поле определяет операцию API Amazon Textract, которую Amazon Comprehend использует для извлечения текста из PDF-файлов и файлов изображений. Введите одно из следующих значений:
-
TEXTRACT_DETECT_DOCUMENT_TEXT- Сервис Amazon Comprehend использует операцию APIDetectDocumentText. -
TEXTRACT_ANALYZE_DOCUMENT- Сервис Amazon Comprehend использует операцию APIAnalyzeDocument.
DocumentReadMode -> (строка)
Определяет действия по извлечению текста для PDF-файлов. Введите одно из следующих значений:
-
SERVICE_DEFAULT- использовать значения по умолчанию Amazon Comprehend для PDF-файлов. -
FORCE_DOCUMENT_READ_ACTION- Amazon Comprehend использует API Textract, указанный в DocumentReadAction, для всех PDF-файлов, включая цифровые PDF-файлы.
FeatureTypes -> (список)
Указывает тип функций Amazon Textract, которые следует применить. Если вы выбрали TEXTRACT_ANALYZE_DOCUMENT в качестве действия чтения, вы должны указать одно или оба из следующих значений:
-
TABLES- Возвращает дополнительную информацию о любых таблицах, которые обнаружены в входном документе. -
FORMS- Возвращает дополнительную информацию о любых формах, которые обнаружены во входном документе.
(строка)
Сокращенный синтаксис:
S3Uri=string,InputFormat=string,DocumentReaderConfig={DocumentReadAction=string,DocumentReadMode=string,FeatureTypes=[string,string]}
JSON синтаксис:
{
"S3Uri": "string",
"InputFormat": "ONE_DOC_PER_FILE"|"ONE_DOC_PER_LINE",
"DocumentReaderConfig": {
"DocumentReadAction": "TEXTRACT_DETECT_DOCUMENT_TEXT"|"TEXTRACT_ANALYZE_DOCUMENT",
"DocumentReadMode": "SERVICE_DEFAULT"|"FORCE_DOCUMENT_READ_ACTION",
"FeatureTypes": ["TABLES"|"FORMS", ...]
}
}
--output-data-config (структура)
Указывает, куда отправлять выходные файлы.
S3Uri -> (строка)
Когда вы используете объект OutputDataConfig с асинхронными операциями, вы указываете расположение Amazon S3, где вы хотите записать выходные данные. URI должен находиться в том же регионе, что и конечная точка API, к которой вы обращаетесь. Расположение используется в качестве префикса для фактического расположения выходного файла.
После завершения задачи обнаружения темы сервис создает выходной файл в каталоге, специфичном для задачи. Поле S3Uri содержит расположение выходного файла, называемого output.tar.gz . Это сжатый архив, содержащий результаты операции.
Для задачи обнаружения сущностей PII выходной файл является текстовым, а не сжатым архивом. Имя выходного файла такое же, как у входного файла, с присоединенным .out в конце.
KmsKeyId -> (строка)
Идентификатор ключа службы управления ключами Amazon Web Services (KMS), который Amazon Comprehend использует для шифрования выходных результатов задачи анализа. Укажите идентификатор ключа симметричного ключа, так как асимметричный ключ не может быть использован для загрузки данных в S3.
KmsKeyId может быть одного из следующих форматов:
- Идентификатор ключа KMS:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) ключа KMS:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" - Алиас ключа KMS:
"alias/ExampleAlias" - ARN алиаса ключа KMS:
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
Сокращенный синтаксис:
S3Uri=string,KmsKeyId=string
JSON синтаксис:
{
"S3Uri": "string",
"KmsKeyId": "string"
}
--data-access-role-arn (строка)
--job-name (строка)
--client-request-token (строка)
--volume-kms-key-id (строка)
Идентификатор ключа службы управления ключами Amazon Web Services (KMS), который Amazon Comprehend использует для шифрования данных на томе хранилища, подключенном к экземплярам вычислительных ресурсов ML, которые обрабатывают задачу анализа. VolumeKmsKeyId может быть одного из следующих форматов:
- Идентификатор ключа KMS:
"1234abcd-12ab-34cd-56ef-1234567890ab" - Amazon Resource Name (ARN) ключа KMS:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
--vpc-config (структура)
Параметры конфигурации для необязательной частной виртуальной сети VPC, содержащей ресурсы, которые вы используете для задачи обнаружения доминирующего языка. Дополнительная информация см. в разделе Amazon VPC .
SecurityGroupIds -> (список)
Номер ID группы безопасности на экземпляре вашей частной VPC. Группы безопасности вашей VPC выполняют роль виртуального брандмауэра для управления входящим и исходящим трафиком и обеспечивают безопасность ресурсов, к которым вы будете обращаться в VPC. Этот номер ID предшествует «sg-», например: «sg-03b388029b0a285ea». Дополнительная информация см. в разделе Группы безопасности для вашей VPC .
(строка)
Subnets -> (список)
ID каждого подсети, используемого в вашей частной VPC. Эта подсеть является подмножеством диапазона адресов IPv4, используемого VPC, и специфична для конкретной зоны доступности в регионе VPC. Этот номер ID предшествует «subnet-», например: «subnet-04ccf456919e69055». Дополнительная информация см. в разделе VPC и подсети .
(строка)
Сокращенный синтаксис:
SecurityGroupIds=string,string,Subnets=string,string
JSON синтаксис:
{
"SecurityGroupIds": ["string", ...],
"Subnets": ["string", ...]
}
--tags (список)
Теги, которые нужно добавить к задаче обнаружения доминирующего языка. Тег — это пара ключ-значение, которая добавляет метаданные к ресурсу, используемому Amazon Comprehend. Например, тег с ключом «Продажи» может быть добавлен к ресурсу, чтобы указать его использование отделом продаж.
(структура)
Пара ключ-значение, которая добавляет метаданные к ресурсу, используемому Amazon Comprehend. Например, тег с парой ключ-значение «Отдел»:«Продажи» может быть добавлен к ресурсу, чтобы указать его использование конкретным отделом.
Key -> (строка)
Value -> (строка)
Сокращенный синтаксис:
Key=string,Value=string ...
JSON синтаксис:
[
{
"Key": "string",
"Value": "string"
}
...
]
--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.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Запуск асинхронной задачи определения языка
Следующий start-dominant-language-detection-job пример запускает асинхронную задачу определения языка для всех файлов, расположенных по адресу, указанному тегом --input-data-config. Ведро S3 в этом примере содержит Sampletext1.txt. После завершения задачи папка output помещается в место, указанное тегом --output-data-config. Папка содержит output.txt, содержащие преобладающий язык каждого текстового файла, а также оценку уверенности предварительно обученной модели для каждого прогноза.
aws comprehend start-dominant-language-detection-job \
--job-name example_language_analysis_job \
--language-code en \
--input-data-config "S3Uri=s3://amzn-s3-demo-bucket/" \
--output-data-config "S3Uri=s3://amzn-s3-demo-destination-bucket/testfolder/" \
--data-access-role-arn arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role \
--language-code en
Содержимое Sampletext1.txt:
"Physics is the natural science that involves the study of matter and its motion and behavior through space and time, along with related concepts such as energy and force."
Вывод:
{
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobStatus": "SUBMITTED"
}
Содержимое output.txt:
{"File": "Sampletext1.txt", "Languages": [{"LanguageCode": "en", "Score": 0.9913753867149353}], "Line": 0}
Дополнительную информацию см. в разделе Асинхронный анализ для Amazon Comprehend Insights в Руководстве разработчика Amazon Comprehend.
Вывод
JobId -> (строка)
JobArn -> (строка)
Amazon Resource Name (ARN) задачи определения преобладающего языка. Это уникальный, полностью квалифицированный идентификатор задачи. Он включает учетную запись Amazon Web Services, регион Amazon Web Services и идентификатор задачи. Формат ARN следующий:
arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>Следующий пример ARN задачи:
arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890abJobStatus -> (строка)
Статус задачи.
- SUBMITTED - Задача получена и помещена в очередь для обработки.
- IN_PROGRESS - Amazon Comprehend обрабатывает задачу.
- COMPLETED - Задача успешно завершена, и вывод доступен.
- FAILED - Задача не была завершена. Для получения подробностей воспользуйтесь операцией.
© Copyright 2025, Amazon Web Services. Created using Sphinx.