Spec-Zone.ru › AWS CLI v2

[ aws . textract ]

Анализ расходов

Описание

Начинает асинхронный анализ счетов-фактур или квитанций для извлечения данных, таких как контактная информация, купленные товары и наименования поставщиков.

StartExpenseAnalysis может анализировать текст в документах форматов JPEG, PNG и PDF. Документы должны храниться в ведре Amazon S3. Используйте параметр DocumentLocation для указания имени вашего ведра S3 и имени документа в этом ведре.

StartExpenseAnalysis возвращает идентификатор задачи (JobId), который вы будете использовать для GetExpenseAnalysis, чтобы получить результаты операции. Когда анализ входных счетов-фактур/квитанций завершен, Amazon Textract публикует статус завершения в тему Amazon Simple Notification Service (Amazon SNS), которую вы предоставили в NotificationChannel. Чтобы получить результаты операции анализа счетов-фактур и квитанций, убедитесь, что значение статуса, опубликованное в теме Amazon SNS, равно SUCCEEDED. В этом случае вызовите GetExpenseAnalysis и передайте идентификатор задачи (JobId), возвращенный вашим вызовом к StartExpenseAnalysis.

Дополнительную информацию см. в разделе Анализ счетов-фактур и квитанций.

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

Синтаксис

  start-expense-analysis
--document-location <value>
[--client-request-token <value>]
[--job-tag <value>]
[--notification-channel <value>]
[--output-config <value>]
[--kms-key-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]

Параметры

--document-location (структура)

Расположение обрабатываемого документа.

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

Ведро Amazon S3, содержащее входной документ.

Bucket -> (строка)

Имя ведра S3. Обратите внимание, что символ # недопустим в имени файла.

Name -> (строка)

Имя файла входного документа. Синхронные операции могут использовать файлы изображений форматов JPEG или PNG. Асинхронные операции также поддерживают файлы форматов PDF и TIFF.

Version -> (строка)

Если для ведра включена версия, вы можете указать версию объекта.

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

S3Object={Bucket=string,Name=string,Version=string}

Синтаксис JSON:

{
  "S3Object": {
    "Bucket": "string",
    "Name": "string",
    "Version": "string"
  }
}

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

Идемпотентный маркер, используемый для идентификации запроса запуска. Если вы используете один и тот же маркер с несколькими запросами StartDocumentTextDetection, возвращается та же задача JobId. Используйте ClientRequestToken, чтобы предотвратить случайное запуск одной и той же задачи более одного раза. Дополнительную информацию см. в разделе Вызов асинхронных операций Amazon Textract

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

Указанный вами идентификатор, включенный в уведомление о завершении, опубликованное в теме Amazon SNS. Например, вы можете использовать JobTag для идентификации типа документа, которому соответствует уведомление о завершении (например, налоговая форма или квитанция).

--notification-channel (структура)

ARN темы Amazon SNS, в которую Amazon Textract хочет опубликовать статус завершения операции.

SNSTopicArn -> (строка)

Тема Amazon SNS, в которую Amazon Textract публикует статус завершения.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, предоставляющей Amazon Textract разрешения на публикацию в тему Amazon SNS.

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

SNSTopicArn=string,RoleArn=string

Синтаксис JSON:

{
  "SNSTopicArn": "string",
  "RoleArn": "string"
}

--output-config (структура)

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

S3Bucket -> (строка)

Имя ведра, куда будет отправлен вывод.

S3Prefix -> (строка)

Префикс ключа объекта, в котором будут сохранены результаты. Если параметр не задан, префикс будет «textract_output».

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

S3Bucket=string,S3Prefix=string

Синтаксис JSON:

{
  "S3Bucket": "string",
  "S3Prefix": "string"
}

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

Ключ KMS, используемый для шифрования результатов вывода. Может быть в формате идентификатора ключа или псевдонима ключа. Когда ключ KMS указан, он будет использоваться для шифрования объектов в ведре клиента на стороне сервера. Если этот параметр не указан, результат будет зашифрован на стороне сервера с использованием SSE-S3.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, сопоставленного с двоичным блоком, 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.

Вывод

JobId -> (строка)

Уникальный идентификатор задачи обнаружения текста. JobId возвращается из StartExpenseAnalysis. Значение JobId действует только в течение 7 дней.

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

Spec-Zone.ru

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