[ aws . comprehend ]
describe-targeted-sentiment-detection-job
Описание
Получает свойства задания обнаружения целевой эмоциональной окраски. Используйте эту операцию для получения статуса задания.
См. также: Документация API AWS
Синтаксис
describe-targeted-sentiment-detection-job
--job-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]
Параметры
--job-id (строка)
StartTargetedSentimentDetectionJob в ответе.--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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.
Если не указано иное, во всех примерах используются правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для описания задания обнаружения целевой эмоциональной окраски
Следующий пример describe-targeted-sentiment-detection-job получает свойства асинхронного задания обнаружения целевой эмоциональной окраски.
aws comprehend describe-targeted-sentiment-detection-job \
--job-id 123456abcdeb0e11022f22a11EXAMPLE
Вывод:
{
"TargetedSentimentDetectionJobProperties": {
"JobId": "123456abcdeb0e11022f22a11EXAMPLE",
"JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/123456abcdeb0e11022f22a11EXAMPLE",
"JobName": "movie_review_analysis",
"JobStatus": "IN_PROGRESS",
"SubmitTime": "2023-06-09T23:16:15.956000+00:00",
"InputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-bucket/MovieData",
"InputFormat": "ONE_DOC_PER_LINE"
},
"OutputDataConfig": {
"S3Uri": "s3://amzn-s3-demo-destination-bucket/testfolder/111122223333-TS-123456abcdeb0e11022f22a11EXAMPLE/output/output.tar.gz"
},
"LanguageCode": "en",
"DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-servicerole"
}
}
Для получения дополнительной информации см. Асинхронный анализ для Amazon Comprehend Insights в Руководстве разработчика Amazon Comprehend.
Вывод
TargetedSentimentDetectionJobProperties -> (структура)
Объект, содержащий свойства задания по обнаружению целевой направленности мнения.
JobId -> (строка)
JobArn -> (строка)
Amazon Resource Name (ARN) задания по обнаружению целевой направленности мнения. Это уникальный, полностью квалифицированный идентификатор задания. Он включает учетную запись Amazon Web Services, регион Amazon Web Services и идентификатор задания. Формат ARN выглядит следующим образом:
arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>Пример ARN задания:
arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890abJobName -> (строка)
JobStatus -> (строка)
FAILED, поле Messages показывает причину ошибки.Message -> (строка)
SubmitTime -> (метка времени)
EndTime -> (метка времени)
InputDataConfig -> (структура)
Свойства входных данных для задания вывода. Поле конфигурации читателя документов применяется только к входным данным, не являющимся текстом, для пользовательского анализа.
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- Возвращает дополнительную информацию о любых формах, обнаруженных в входном документе.
(строка)
OutputDataConfig -> (структура)
Предоставляет параметры конфигурации для вывода результатов заданий вывода.
S3Uri -> (строка)
При использовании объекта OutputDataConfig с асинхронными операциями вы указываете расположение Amazon S3, в котором хотите записать выходные данные. URI должен находиться в том же регионе, что и конечная точка API, к которой вы обращаетесь. Расположение используется в качестве префикса для фактического расположения выходного файла.
После завершения задания по обнаружению темы сервис создает выходной файл в каталоге, специфичном для задания. Поле S3Uri содержит расположение выходного файла, называемого output.tar.gz. Это сжатый архив, содержащий вывод операции.
Для задания по обнаружению сущностей PII выходной файл представляет собой обычный текст, а не сжатый архив. Имя выходного файла такое же, как имя входного файла, с .out в конце.
KmsKeyId -> (строка)
Идентификатор ключа Amazon Web Services Key Management Service (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"
LanguageCode -> (строка)
DataAccessRoleArn -> (строка)
VolumeKmsKeyId -> (строка)
Идентификатор ключа 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"
VpcConfig -> (структура)
Параметры конфигурации для необязательной виртуальной частной сети (VPC), содержащей ресурсы, которые вы используете для задания. Дополнительная информация приведена в Amazon VPC.
SecurityGroupIds -> (список)
Идентификатор группы безопасности на экземпляре вашей частной VPC. Группы безопасности вашей VPC выполняют функцию виртуального брандмауэра, контролируя входящий и исходящий трафик и обеспечивают безопасность ресурсов, к которым вы будете обращаться в VPC. Этот идентификатор имеет префикс «sg-», например: «sg-03b388029b0a285ea». Дополнительная информация приведена в Группы безопасности для вашей VPC.
(строка)
Subnets -> (список)
Идентификатор каждого подсети, используемого в вашей частной VPC. Эта подсеть является подмножеством диапазона IPv4-адресов, используемых VPC, и специфична для определенной зоны доступности в регионе VPC. Этот идентификатор имеет префикс «subnet-», например: «subnet-04ccf456919e69055». Дополнительная информация приведена в VPC и подсети.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.