classify-document

Описание

Создаёт запрос на классификацию одного документа в реальном времени. ClassifyDocument поддерживает следующие типы моделей:

• Пользовательский классификатор — настраиваемая модель, которую вы создали и обучили. В качестве входных данных можно предоставить обычный текст, одностраничный документ (PDF, Word или изображение) или вывод API Amazon Textract. Дополнительную информацию см. в разделе Пользовательская классификация в руководстве разработчика Amazon Comprehend.
• Классификатор безопасности подсказок — Amazon Comprehend предоставляет предварительно обученную модель для классификации входных подсказок для приложений с генеративным ИИ. В качестве входных данных используется английский обычный текст. Для классификации безопасности подсказок ответ включает только поле Classes. Дополнительную информацию о классификаторах безопасности подсказок см. в разделе Классификация безопасности подсказок в руководстве разработчика Amazon Comprehend.

Если система обнаруживает ошибки при обработке страницы во входном документе, ответ API включает поле Errors, которое описывает эти ошибки.

Если система обнаруживает ошибку уровня документа во входном документе, API возвращает ошибочный ответ InvalidRequestException. Подробности об этом исключении см. в руководстве разработчика Comprehend в разделе Ошибки в полуструктурированных документах.

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

Синтаксис

  classify-document
[--text <value>]
--endpoint-arn <value>
[--bytes <value>]
[--document-reader-config <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]

Параметры

--text (строка)

--endpoint-arn (строка)

--bytes (бинарный массив)

--document-reader-config (структура)

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

DocumentReadAction=string,DocumentReadMode=string,FeatureTypes=string,string

Синтаксис JSON:

{
  "DocumentReadAction": "TEXTRACT_DETECT_DOCUMENT_TEXT"|"TEXTRACT_ANALYZE_DOCUMENT",
  "DocumentReadMode": "SERVICE_DEFAULT"|"FORCE_DOCUMENT_READ_ACTION",
  "FeatureTypes": ["TABLES"|"FORMS", ...]
}

--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
• таблица
• 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-auto-prompt (булево значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево значение)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Для классификации документа с помощью конечной точки, специфичной для модели

В следующем classify-document примере классифицируется документ с помощью конечной точки настраиваемой модели. В данном примере модель была обучена на наборе данных, содержащем сообщения SMS, помеченные как спам или не спам («ham»).

aws comprehend classify-document \
    --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint \
    --text "CONGRATULATIONS! TXT 1235550100 to win $5000"

Вывод:

{
    "Classes": [
        {
            "Name": "spam",
            "Score": 0.9998599290847778
        },
        {
            "Name": "ham",
            "Score": 0.00014001205272506922
        }
    ]
}

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

Вывод

Классы -> (список)

Метки -> (список)

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

DocumentType -> (список)

Ошибки -> (список)

Предупреждения -> (список)