Spec-Zone.ru › AWS CLI v2

[ aws . comprehend ]

описание-задания-обнаружения-настроения

Описание

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

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

Синтаксис

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

Идентификатор, сгенерированный Amazon Comprehend для задания. Операция возвращает этот идентификатор в ответе.

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

Для описания задания обнаружения настроения

В следующем describe-sentiment-detection-job примере получаются свойства асинхронного задания обнаружения настроения.

aws comprehend describe-sentiment-detection-job \
    --job-id 123456abcdeb0e11022f22a11EXAMPLE

Вывод:

{
    "SentimentDetectionJobProperties": {
        "JobId": "123456abcdeb0e11022f22a11EXAMPLE",
        "JobArn": "arn:aws:comprehend:us-west-2:111122223333: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.

Вывод

SentimentDetectionJobProperties -> (структура)

Объект, содержащий свойства, связанные с задачей обнаружения настроения.

JobId -> (строка)

Идентификатор, присвоенный задаче обнаружения настроения.

JobArn -> (строка)

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

JobName -> (строка)

Имя, присвоенное задаче обнаружения настроения.

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

Это поле определяет операцию Amazon Textract API, которую 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 использует Textract API, указанный в DocumentReadAction, для всех PDF-файлов, включая цифровые PDF-файлы.

FeatureTypes -> (список)

Указывает тип функций Amazon Textract, которые нужно применить. Если вы выбрали TEXTRACT_ANALYZE_DOCUMENT в качестве действия чтения, вы должны указать одно или оба из следующих значений:

  • TABLES — Возвращает дополнительную информацию о любых таблицах, обнаруженных в входном документе.
  • FORMS — Возвращает дополнительную информацию о любых формах, обнаруженных в входном документе.

(строка)

TABLES или FORMS

OutputDataConfig -> (структура)

Настройка выходных данных, предоставленная при создании задачи обнаружения настроения.

S3Uri -> (строка)

При использовании объекта OutputDataConfig с асинхронными операциями вы указываете расположение Amazon S3, куда хотите записать выходные данные. URI должен находиться в том же регионе, что и вызываемый API-точкой. Расположение используется в качестве префикса для фактического расположения выходного файла.

По завершении задачи определения темы служба создает выходной файл в каталоге, специфичном для задачи. Поле S3Uri содержит расположение выходного файла, который называется output.tar.gz. Это сжатый архив, содержащий результат операции.

Для задачи обнаружения сущностей PII выходной файл — это обычный текст, а не сжатый архив. Имя выходного файла такое же, как и входного файла, с добавленным .out в конце.

KmsKeyId -> (строка)

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

Amazon Resource Name (ARN) роли IAM, предоставляющей Amazon Comprehend доступ для чтения к вашим входным данным.

VolumeKmsKeyId -> (строка)

ID ключа Amazon Web Services Key Management Service (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.

Spec-Zone.ru

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