start-targeted-sentiment-detection-job

Описание

Запускает асинхронную задачу обнаружения целевой эмоциональной окраски для набора документов. Используйте операцию DescribeTargetedSentimentDetectionJob для отслеживания состояния задачи.

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

Синтаксис

  start-targeted-sentiment-detection-job
--input-data-config <value>
--output-data-config <value>
--data-access-role-arn <value>
[--job-name <value>]
--language-code <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 (структура)

Свойства входных данных для задачи вывода. Поле document reader 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 использует операцию API DetectDocumentText.
TEXTRACT_ANALYZE_DOCUMENT - Сервис Amazon Comprehend использует операцию API AnalyzeDocument.

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 - Возвращает дополнительную информацию о любых формах, обнаруженных в входном документе.

(строка)

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

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

S3Uri=string,KmsKeyId=string

Синтаксис JSON:

{
  "S3Uri": "string",
  "KmsKeyId": "string"
}

--data-access-role-arn (строка)

Amazon Resource Name (ARN) роли IAM, которая предоставляет Amazon Comprehend доступ для чтения к вашим входным данным. Дополнительная информация — в разделе Права доступа на основе ролей.

--job-name (строка)

Идентификатор задачи.

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

Язык входных документов. В настоящее время поддерживается только английский язык.

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

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

--client-request-token (строка)

Уникальный идентификатор запроса. Если вы не зададите маркер запроса клиента, Amazon Comprehend сгенерирует его.

--volume-kms-key-id (строка)

Идентификатор ключа 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 -> (список)

Идентификатор группы безопасности на экземпляре вашей частной VPC. Группы безопасности вашей VPC выполняют роль виртуального брандмауэра для управления входящим и исходящим трафиком и обеспечивают безопасность ресурсов, к которым вы будете получать доступ в VPC. Этот идентификатор начинается с «sg-», например: «sg-03b388029b0a285ea». Дополнительная информация — в разделе Группы безопасности вашей VPC.

(строка)

Subnets -> (список)

Идентификатор каждого подсети, используемой в вашей частной VPC. Эта подсеть является подмножеством диапазона адресов IPv4, используемых VPC, и относится к определенной зоне доступности в области VPC. Этот идентификатор начинается с «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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок 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-targeted-sentiment-detection-job пример запускает асинхронную задачу обнаружения целевого анализа настроения для всех файлов, расположенных по адресу, указанному в теге --input-data-config. Папка в ведре S3 в этом примере содержит SampleMovieReview1.txt, SampleMovieReview2.txt и SampleMovieReview3.txt. После завершения работы задачи output.tar.gz размещается в месте, указанном тегом --output-data-config. output.tar.gz содержит файлы SampleMovieReview1.txt.out, SampleMovieReview2.txt.out и SampleMovieReview3.txt.out, каждый из которых содержит все именованные сущности и соответствующие настроения для одного входного текстового файла.

aws comprehend start-targeted-sentiment-detection-job \
    --job-name targeted_movie_review_analysis1 \
    --language-code en \
    --input-data-config "S3Uri=s3://amzn-s3-demo-bucket/MovieData" \
    --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

Содержание SampleMovieReview1.txt:

"The film, AnyMovie, is fairly predictable and just okay."

Содержание SampleMovieReview2.txt:

"AnyMovie is the essential sci-fi film that I grew up watching when I was a kid. I highly recommend this movie."

Содержание SampleMovieReview3.txt:

"Don't get fooled by the 'awards' for AnyMovie. All parts of the film were poorly stolen from other modern directors."

Вывод:

{
    "JobId": "0b5001e25f62ebb40631a9a1a7fde7b3",
    "JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/0b5001e25f62ebb40631a9a1a7fde7b3",
    "JobStatus": "SUBMITTED"
}

Содержание SampleMovieReview1.txt.out с отступами строк для читабельности:

{
    "Entities": [
        {
        "DescriptiveMentionIndex": [
            0
        ],
        "Mentions": [
            {
            "BeginOffset": 4,
            "EndOffset": 8,
            "Score": 0.994972,
            "GroupScore": 1,
            "Text": "film",
            "Type": "MOVIE",
            "MentionSentiment": {
                "Sentiment": "NEUTRAL",
                "SentimentScore": {
                "Mixed": 0,
                "Negative": 0,
                "Neutral": 1,
                "Positive": 0
                }
            }
            }
        ]
        },
        {
        "DescriptiveMentionIndex": [
            0
        ],
        "Mentions": [
            {
            "BeginOffset": 10,
            "EndOffset": 18,
            "Score": 0.631368,
            "GroupScore": 1,
            "Text": "AnyMovie",
            "Type": "ORGANIZATION",
            "MentionSentiment": {
                "Sentiment": "POSITIVE",
                "SentimentScore": {
                "Mixed": 0.001729,
                "Negative": 0.000001,
                "Neutral": 0.000318,
                "Positive": 0.997952
                }
            }
            }
        ]
        }
    ],
    "File": "SampleMovieReview1.txt",
    "Line": 0
}

Содержание SampleMovieReview2.txt.out с отступами строк для читабельности:

{
    "Entities": [
        {
        "DescriptiveMentionIndex": [
            0
        ],
        "Mentions": [
            {
            "BeginOffset": 0,
            "EndOffset": 8,
            "Score": 0.854024,
            "GroupScore": 1,
            "Text": "AnyMovie",
            "Type": "MOVIE",
            "MentionSentiment": {
                "Sentiment": "POSITIVE",
                "SentimentScore": {
                "Mixed": 0,
                "Negative": 0,
                "Neutral": 0.000007,
                "Positive": 0.999993
                }
            }
            },
            {
            "BeginOffset": 104,
            "EndOffset": 109,
            "Score": 0.999129,
            "GroupScore": 0.502937,
            "Text": "movie",
            "Type": "MOVIE",
            "MentionSentiment": {
                "Sentiment": "POSITIVE",
                "SentimentScore": {
                "Mixed": 0,
                "Negative": 0,
                "Neutral": 0,
                "Positive": 1
                }
            }
            },
            {
            "BeginOffset": 33,
            "EndOffset": 37,
            "Score": 0.999823,
            "GroupScore": 0.999252,
            "Text": "film",
            "Type": "MOVIE",
            "MentionSentiment": {
                "Sentiment": "POSITIVE",
                "SentimentScore": {
                "Mixed": 0,
                "Negative": 0,
                "Neutral": 0.000001,
                "Positive": 0.999999
                }
            }
            }
        ]
        },
        {
        "DescriptiveMentionIndex": [
            0,
            1,
            2
        ],
        "Mentions": [
            {
            "BeginOffset": 43,
            "EndOffset": 44,
            "Score": 0.999997,
            "GroupScore": 1,
            "Text": "I",
            "Type": "PERSON",
            "MentionSentiment": {
                "Sentiment": "NEUTRAL",
                "SentimentScore": {
                "Mixed": 0,
                "Negative": 0,
                "Neutral": 1,
                "Positive": 0
                }
            }
            },
            {
            "BeginOffset": 80,
            "EndOffset": 81,
            "Score": 0.999996,
            "GroupScore": 0.52523,
            "Text": "I",
            "Type": "PERSON",
            "MentionSentiment": {
                "Sentiment": "NEUTRAL",
                "SentimentScore": {
                "Mixed": 0,
                "Negative": 0,
                "Neutral": 1,
                "Positive": 0
                }
            }
            },
            {
            "BeginOffset": 67,
            "EndOffset": 68,
            "Score": 0.999994,
            "GroupScore": 0.999499,
            "Text": "I",
            "Type": "PERSON",
            "MentionSentiment": {
                "Sentiment": "NEUTRAL",
                "SentimentScore": {
                "Mixed": 0,
                "Negative": 0,
                "Neutral": 1,
                "Positive": 0
                }
            }
            }
        ]
        },
        {
        "DescriptiveMentionIndex": [
            0
        ],
        "Mentions": [
            {
            "BeginOffset": 75,
            "EndOffset": 78,
            "Score": 0.999978,
            "GroupScore": 1,
            "Text": "kid",
            "Type": "PERSON",
            "MentionSentiment": {
                "Sentiment": "NEUTRAL",
                "SentimentScore": {
                "Mixed": 0,
                "Negative": 0,
                "Neutral": 1,
                "Positive": 0
                }
            }
            }
        ]
        }
    ],
    "File": "SampleMovieReview2.txt",
    "Line": 0
}

Содержание SampleMovieReview3.txt.out с отступами строк для читабельности:

{
    "Entities": [
        {
        "DescriptiveMentionIndex": [
            1
        ],
        "Mentions": [
            {
            "BeginOffset": 64,
            "EndOffset": 68,
            "Score": 0.992953,
            "GroupScore": 0.999814,
            "Text": "film",
            "Type": "MOVIE",
            "MentionSentiment": {
                "Sentiment": "NEUTRAL",
                "SentimentScore": {
                "Mixed": 0.000004,
                "Negative": 0.010425,
                "Neutral": 0.989543,
                "Positive": 0.000027
                }
            }
            },
            {
            "BeginOffset": 37,
            "EndOffset": 45,
            "Score": 0.999782,
            "GroupScore": 1,
            "Text": "AnyMovie",
            "Type": "ORGANIZATION",
            "MentionSentiment": {
                "Sentiment": "POSITIVE",
                "SentimentScore": {
                "Mixed": 0.000095,
                "Negative": 0.039847,
                "Neutral": 0.000673,
                "Positive": 0.959384
                }
            }
            }
        ]
        },
        {
        "DescriptiveMentionIndex": [
            0
        ],
        "Mentions": [
            {
            "BeginOffset": 47,
            "EndOffset": 50,
            "Score": 0.999991,
            "GroupScore": 1,
            "Text": "All",
            "Type": "QUANTITY",
            "MentionSentiment": {
                "Sentiment": "NEUTRAL",
                "SentimentScore": {
                "Mixed": 0.000001,
                "Negative": 0.000001,
                "Neutral": 0.999998,
                "Positive": 0
                }
            }
            }
        ]
        },
        {
        "DescriptiveMentionIndex": [
            0
        ],
        "Mentions": [
            {
            "BeginOffset": 106,
            "EndOffset": 115,
            "Score": 0.542083,
            "GroupScore": 1,
            "Text": "directors",
            "Type": "PERSON",
            "MentionSentiment": {
                "Sentiment": "NEUTRAL",
                "SentimentScore": {
                "Mixed": 0,
                "Negative": 0,
                "Neutral": 1,
                "Positive": 0
                }
            }
            }
        ]
        }
    ],
    "File": "SampleMovieReview3.txt",
    "Line": 0
}

Дополнительную информацию см. в разделе Асинхронный анализ для Amazon Comprehend insights в Руководстве разработчика Amazon Comprehend.

Вывод

JobId -> (строка)

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

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/1234abcd12ab34cd56ef1234567890ab

JobStatus -> (строка)

Статус задачи.

SUBMITTED - Задача получена и поставлена в очередь на обработку.
IN_PROGRESS - Amazon Comprehend обрабатывает задачу.
COMPLETED - Задача успешно завершена, и вывод доступен.
FAILED - Задача не была завершена. Чтобы получить подробности, используйте операцию DescribeTargetedSentimentDetectionJob.