Spec-Zone.ru › AWS CLI v2

[ aws . comprehend ]

describe-entity-recognizer

Описание

Предоставляет подробные сведения об идентификаторе сущностей, включая состояние, корзины S3, содержащие обучающие данные, метаданные идентификатора, метрики и так далее.

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

Синтаксис

  describe-entity-recognizer
--entity-recognizer-arn <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]

Параметры

--entity-recognizer-arn (строка)

Идентификатор Amazon Resource Name (ARN) распознавателя сущностей.

--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-entity-recognizer пример получает свойства модели распознавания пользовательских сущностей.

aws comprehend describe-entity-recognizer \
    entity-recognizer-arn arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/business-recongizer-1/version/1

Вывод:

{
    "EntityRecognizerProperties": {
        "EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/business-recongizer-1/version/1",
        "LanguageCode": "en",
        "Status": "TRAINED",
        "SubmitTime": "2023-06-14T20:44:59.631000+00:00",
        "EndTime": "2023-06-14T20:59:19.532000+00:00",
        "TrainingStartTime": "2023-06-14T20:48:52.811000+00:00",
        "TrainingEndTime": "2023-06-14T20:58:11.473000+00:00",
        "InputDataConfig": {
            "DataFormat": "COMPREHEND_CSV",
            "EntityTypes": [
                {
                    "Type": "BUSINESS"
                }
            ],
            "Documents": {
                "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/dataset/",
                "InputFormat": "ONE_DOC_PER_LINE"
            },
            "EntityList": {
                "S3Uri": "s3://amzn-s3-demo-bucket/trainingdata/entity.csv"
            }
        },
        "RecognizerMetadata": {
            "NumberOfTrainedDocuments": 1814,
            "NumberOfTestDocuments": 486,
            "EvaluationMetrics": {
                "Precision": 100.0,
                "Recall": 100.0,
                "F1Score": 100.0
            },
            "EntityTypes": [
                {
                    "Type": "BUSINESS",
                    "EvaluationMetrics": {
                        "Precision": 100.0,
                        "Recall": 100.0,
                        "F1Score": 100.0
                    },
                    "NumberOfTrainMentions": 1520
                }
            ]
        },
        "DataAccessRoleArn": "arn:aws:iam::111122223333:role/service-role/AmazonComprehendServiceRole-example-role",
        "VersionName": "1"
    }
}

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

Вывод

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

Описание информации, связанной с распознавателем сущностей.

EntityRecognizerArn -> (строка)

Идентификатор Amazon Resource Name (ARN) распознавателя сущностей.

LanguageCode -> (строка)

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

Status -> (строка)

Статус распознавателя сущностей.

Message -> (строка)

Описание статуса распознавателя.

SubmitTime -> (временная метка)

Время отправки распознавателя на обработку.

EndTime -> (временная метка)

Время завершения создания распознавателя.

TrainingStartTime -> (временная метка)

Время начала обучения распознавателя сущностей.

TrainingEndTime -> (временная метка)

Время завершения обучения распознавателя сущностей.

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

Свойства входных данных распознавателя сущностей.

DataFormat -> (строка)

Формат ваших обучающих данных:

  • COMPREHEND_CSV : Файл CSV, дополняющий ваши обучающие документы. Файл CSV содержит информацию о пользовательских сущностях, которые будет определять обученная модель. Требуемый формат файла зависит от того, предоставляете ли вы аннотации или список сущностей. Если вы используете это значение, вы должны предоставить свой файл CSV, используя параметры Annotations или EntityList. Обучающие документы необходимо предоставить, используя параметр Documents.
  • AUGMENTED_MANIFEST : Метка данных, созданная Amazon SageMaker Ground Truth. Этот файл имеет формат JSON в строках. Каждая строка представляет собой полный JSON-объект, содержащий обучающий документ и его метки. Каждая метка аннотирует именованную сущность в обучающем документе. Если вы используете это значение, вы должны указать параметр AugmentedManifests в своем запросе.

Если вы не укажете значение, Amazon Comprehend использует значение COMPREHEND_CSV по умолчанию.

EntityTypes -> (список)

Типы сущностей в помеченных обучающих данных, которые Amazon Comprehend использует для обучения пользовательскому распознавателю сущностей. Любые не указанные типы сущностей игнорируются.

Максимальное количество типов сущностей, которые можно использовать для обучения распознавателя сущностей, равно 25. Типы сущностей не должны содержать следующие недопустимые символы: n (перевод строки), \n (экранированный перевод строки), r (возврат каретки), \r (экранированный возврат каретки), t (табуляция), \t (экранированная табуляция), пробел и , (запятая).

(структура)

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

Type -> (строка)

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

Типы сущностей не должны содержать следующие недопустимые символы: n (перевод строки), \n (экранированный перевод строки), r (возврат каретки), \r (экранированный возврат каретки), t (табуляция), \t (экранированная табуляция) и , (запятая).

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

Расположение в S3 папки, содержащей обучающие документы для вашего пользовательского распознавателя сущностей.

Этот параметр требуется, если вы установите DataFormat в значение COMPREHEND_CSV .

S3Uri -> (строка)

Указывает расположение в Amazon S3, где находятся обучающие документы для распознавателя сущностей. URI должен находиться в том же регионе, что и вызываемый API-точку.

TestS3Uri -> (строка)

Указывает расположение в Amazon S3, где находятся тестовые документы для распознавателя сущностей. URI должен находиться в том же регионе Amazon Web Services, что и вызываемый API-точку.

InputFormat -> (строка)

Указывает, как текст в входном файле должен обрабатываться. Это необязательно, и по умолчанию используется значение ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Каждый файл рассматривается как отдельный документ. Используйте этот вариант при обработке больших документов, таких как газетные статьи или научные работы. ONE_DOC_PER_LINE - Каждая строка в файле рассматривается как отдельный документ. Используйте этот вариант при обработке множества коротких документов, таких как текстовые сообщения.

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

Расположение в S3 файла CSV, аннотирующего ваши обучающие документы.

S3Uri -> (строка)

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

TestS3Uri -> (строка)

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

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

Расположение в S3 файла CSV со списком сущностей для вашего пользовательского распознавателя сущностей.

S3Uri -> (строка)

Указывает расположение в Amazon S3, где находится список сущностей. URI должен находиться в том же регионе, что и вызываемый API-точку.

AugmentedManifests -> (список)

Список файлов расширенных манифестов, предоставляющих обучающие данные для вашей пользовательской модели. Файл расширенного манифеста — это набор помеченных данных, полученный с помощью Amazon SageMaker Ground Truth.

Этот параметр требуется, если вы установите DataFormat в значение AUGMENTED_MANIFEST .

(структура)

Файл расширенного манифеста, предоставляющий обучающие данные для вашей пользовательской модели. Файл расширенного манифеста — это набор помеченных данных, полученный с помощью Amazon SageMaker Ground Truth.

S3Uri -> (строка)

Расположение в Amazon S3 файла расширенного манифеста.

Split -> (строка)

Цель данных, предоставленных в расширенном манифесте. Вы можете использовать данные для обучения или тестирования. Если не указано, используется значение по умолчанию — train.

TRAIN - все документы в манифесте будут использоваться для обучения. Если тестовые документы не предоставлены, Amazon Comprehend автоматически зарезервирует часть обучающих документов для тестирования.

TEST - все документы в манифесте будут использоваться для тестирования.

AttributeNames -> (список)

JSON-атрибут, содержащий аннотации для ваших обучающих документов. Количество указанных имен атрибутов зависит от того, является ли ваш файл расширенного манифеста результатом одной задачи маркировки или цепочки задач маркировки.

Если ваш файл является результатом одной задачи маркировки, укажите ключ LabelAttributeName, используемый при создании задачи в Ground Truth.

Если ваш файл является результатом цепочки задач маркировки, укажите ключ LabelAttributeName для одной или нескольких задач в цепочке. Каждый ключ LabelAttributeName предоставляет аннотации из отдельной задачи.

(строка)

AnnotationDataS3Uri -> (строка)

Префикс S3 к файлам аннотаций, на которые ссылается файл расширенного манифеста.

SourceDocumentsS3Uri -> (строка)

Префикс S3 к исходным файлам (PDF), на которые ссылается файл расширенного манифеста.

DocumentType -> (строка)

Тип расширенного манифеста. PlainTextDocument или SemiStructuredDocument. Если не указано, используется значение по умолчанию — PlainTextDocument.

  • PLAIN_TEXT_DOCUMENT Тип документа, представляющий любой текст Юникод, закодированный в UTF-8.
  • SEMI_STRUCTURED_DOCUMENT Тип документа с контекстом позиционирования и структуры, например, PDF. Для обучения с Amazon Comprehend поддерживаются только PDF-файлы. Для вывода Amazon Comprehend поддерживает PDF, DOCX и TXT.

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

Предоставляет информацию о распознавателе сущностей.

NumberOfTrainedDocuments -> (целое число)

Количество документов во входных данных, использованных для обучения распознавателя сущностей. Обычно это составляет от 80 до 90 процентов входных документов.

NumberOfTestDocuments -> (целое число)

Количество документов во входных данных, использованных для тестирования распознавателя сущностей. Обычно это составляет от 10 до 20 процентов входных документов.

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

Подробная информация о точности распознавателя сущностей.

Precision -> (двойное число)

Метрика полезности результатов распознавателя в тестовых данных. Высокая точность означает, что распознаватель вернул значительно больше релевантных результатов, чем нерелевантных.

Recall -> (двойное число)

Метрика полноты результатов распознавателя для тестовых данных. Высокий показатель отзыва означает, что распознаватель вернул большинство релевантных результатов.

F1Score -> (двойное число)

Метрика точности результатов распознавателя для тестовых данных. Она выводится из значений Precision и Recall. F1Score — гармоническое среднее из двух оценок. Для моделей распознавания сущностей для текстовых документов диапазон составляет от 0 до 100, где 100 — лучший результат. Для моделей распознавания сущностей для PDF/Word-файлов диапазон составляет от 0 до 1, где 1 — лучший результат.

EntityTypes -> (список)

Типы сущностей из метаданных распознавателя сущностей.

(структура)

Отдельный элемент из списка типов сущностей в метаданных распознавателя сущностей.

Type -> (строка)

Тип сущности из списка типов сущностей в метаданных распознавателя сущностей.

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

Подробная информация о точности распознавателя сущностей для конкретного элемента в списке типов сущностей.

Precision -> (двойное число)

Метрика полезности результатов распознавателя для определенного типа сущности в тестовых данных. Высокая точность означает, что распознаватель вернул значительно больше релевантных результатов, чем нерелевантных.

Recall -> (двойное число)

Метрика полноты результатов распознавателя для определенного типа сущности в тестовых данных. Высокий показатель отзыва означает, что распознаватель вернул большинство релевантных результатов.

F1Score -> (двойное число)

Метрика точности результатов распознавателя для определенного типа сущности в тестовых данных. Она выводится из значений Precision и Recall. F1Score — гармоническое среднее из двух оценок. Максимальная оценка — 1, минимальная — 0.

NumberOfTrainMentions -> (целое число)

Указывает количество упоминаний данного типа сущности в обучающих данных.

DataAccessRoleArn -> (строка)

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

VolumeKmsKeyId -> (строка)

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

(строка)

ModelKmsKeyId -> (строка)

Идентификатор ключа KMS, который Amazon Comprehend использует для шифрования обученных пользовательских моделей. ModelKmsKeyId может иметь один из следующих форматов:

  • Идентификатор ключа KMS: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Идентификатор ресурса Amazon (ARN) ключа KMS: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

VersionName -> (строка)

Название версии, которое вы присвоили распознавателю сущностей.

SourceModelArn -> (строка)

Идентификатор ресурса Amazon (ARN) исходной модели. Эта модель была импортирована из другого аккаунта Amazon Web Services для создания модели распознавателя сущностей в вашем аккаунте Amazon Web Services.

FlywheelArn -> (строка)

Идентификатор ресурса Amazon (ARN) флайвила

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

Конфигурация вывода данных.

FlywheelStatsS3Prefix -> (строка)

Префикс Amazon S3 для расположения озера данных статистики флайвила.

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

Spec-Zone.ru

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