start-lending-analysis
Описание
Запускает классификацию и анализ входного документа. StartLendingAnalysis инициирует классификацию и анализ пакета документов по кредитованию. StartLendingAnalysis работает с файлом документа, расположенным в ведре Amazon S3.
StartLendingAnalysis может анализировать текст в документах следующих форматов: JPEG, PNG, TIFF, PDF. Используйте DocumentLocation для указания имени ведра и имени файла документа.
StartLendingAnalysis возвращает идентификатор задания (JobId ), который используется для получения результатов операции. После завершения анализа текста Amazon Textract публикует состояние завершения в тему Amazon Simple Notification Service (Amazon SNS), которую вы указываете в NotificationChannel. Чтобы получить результаты операции анализа текста, сначала проверьте, что значение статуса, опубликованное в теме Amazon SNS, равно SUCCEEDED. Если статус равен SUCCEEDED, вы можете вызвать либо GetLendingAnalysis, либо GetLendingAnalysisSummary и предоставить JobId для получения результатов анализа.
Если использовать OutputConfig для указания ведра Amazon S3, вывод будет содержаться внутри указанного префикса в каталоге, помеченном идентификатором задания. В каталоге есть 3 подкаталога:
- detailedResponse (содержит ответ GetLendingAnalysis)
- summaryResponse (для ответа GetLendingAnalysisSummary)
- splitDocuments (документы, разделенные по логическим границам)
См. также: Документация API AWS
Синтаксис
start-lending-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 (структура)
Ведро Amazon S3, содержащее документ, который необходимо обработать. Используется асинхронными операциями.
Входной документ может быть файлом изображения в формате JPEG или PNG. Он также может быть файлом в формате PDF.
S3Object -> (структура)
Ведро Amazon S3, содержащее входной документ.
Bucket -> (строка)
Name -> (строка)
Version -> (строка)
Сокращенный синтаксис:
S3Object={Bucket=string,Name=string,Version=string}
Синтаксис JSON:
{
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
--client-request-token (строка)
StartLendingAnalysis, возвращается то же самое JobId. Используйте ClientRequestToken для предотвращения случайного запуска одной и той же работы более одного раза. Дополнительную информацию см. в разделе Выполнение асинхронных операций Amazon Textract.--job-tag (строка)
JobTag для идентификации типа документа, которому соответствует уведомление о завершении (например, налоговая декларация или квитанция).--notification-channel (структура)
Тема Amazon Simple Notification Service (Amazon SNS), в которую Amazon Textract публикует состояние завершения асинхронной операции с документом.
SNSTopicArn -> (строка)
RoleArn -> (строка)
Сокращенный синтаксис:
SNSTopicArn=string,RoleArn=string
Синтаксис JSON:
{
"SNSTopicArn": "string",
"RoleArn": "string"
}
--output-config (структура)
Устанавливает, будет ли ваш вывод отправлен в ведро, созданное пользователем. Используется для установки имени ведра и префикса файла вывода.
OutputConfig — это необязательный параметр, который позволяет настроить место расположения вашего вывода. По умолчанию Amazon Textract будет хранить результаты внутри и к ним можно будет получить доступ только с помощью операций API Get. При включенном OutputConfig вы можете задать имя ведра, в которое будет отправлен вывод, и префикс результатов, где вы можете загрузить свои результаты. Кроме того, вы можете установить параметр KMSKeyID в ключевого главного мастера (CMK) для шифрования вашего вывода. Без этого параметра Amazon Textract будет шифровать на стороне сервера с помощью управляемого AWS CMK для Amazon S3.Расшифровка содержимого клиента необходима для обработки документов Amazon Textract. Если ваша учетная запись исключена по политике отказа от услуг ИИ, всё нешифрованное содержимое клиента немедленно и навсегда удаляется после обработки содержимого клиента службой. Копия вывода не сохраняется Amazon Textract. Дополнительную информацию о том, как отказаться от услуг, см. в разделе Управление политикой отказа от услуг ИИ.
Дополнительную информацию о конфиденциальности данных см. в разделе FAQ по конфиденциальности данных.
S3Bucket -> (строка)
S3Prefix -> (строка)
Сокращенный синтаксис:
S3Bucket=string,S3Prefix=string
Синтаксис JSON:
{
"S3Bucket": "string",
"S3Prefix": "string"
}
--kms-key-id (строка)
--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.
Вывод
JobId -> (строка)
JobId возвращается из StartLendingAnalysis. Значение JobId действует только 7 дней.
© Copyright 2025, Amazon Web Services. Created using Sphinx.