Spec-Zone.ru › AWS CLI v2

[ aws . comprehend ]

start-sentiment-detection-job

Описание

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

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

Синтаксис

  start-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 (структура)

Указывает формат и расположение входных данных для задачи.

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 (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 (строка)

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

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

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

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

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

--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 -> (список)

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

aws comprehend start-sentiment-detection-job \
    --job-name example-sentiment-detection-job \
    --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, AnyMovie2, is fairly predictable and just okay."

Содержимое SampleMovieReview2.txt:

"AnyMovie2 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 AnyMovie2. All parts of the film were poorly stolen from other modern directors."

Вывод:

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

Содержимое output.txt с отступами для удобочитаемости:

{
    "File": "SampleMovieReview1.txt",
        "Line": 0,
        "Sentiment": "MIXED",
        "SentimentScore": {
            "Mixed": 0.6591159105300903,
            "Negative": 0.26492202281951904,
            "Neutral": 0.035430654883384705,
            "Positive": 0.04053137078881264
            }
        }
    {
    "File": "SampleMovieReview2.txt",
        "Line": 0,
        "Sentiment": "POSITIVE",
        "SentimentScore": {
            "Mixed": 0.000008718466233403888,
            "Negative": 0.00006134175055194646,
            "Neutral": 0.0002941041602753103,
            "Positive": 0.9996358156204224
            }
        }
    {
    "File": "SampleMovieReview3.txt",
        "Line": 0,
        "Sentiment": "NEGATIVE",
        "SentimentScore": {
            "Mixed": 0.004146667663007975,
            "Negative": 0.9645107984542847,
            "Neutral": 0.016559595242142677,
            "Positive": 0.014782938174903393
        }
    }
}

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

Вывод

JobId -> (string)

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

JobArn -> (string)

Amazon Resource Name (ARN) задания обнаружения настроения. Это уникальный, полностью квалифицированный идентификатор задания. Он включает учетную запись Amazon Web Services, регион Amazon Web Services и идентификатор задания. Формат ARN следующий:

arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>

Следующий пример ARN задания:

arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

JobStatus -> (string)

Статус задания.

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

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

Spec-Zone.ru

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