get-document-analysis

Описание

Получает результаты асинхронной операции Amazon Textract по анализу текста в документе.

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

• Данные формы (парные ключи-значения). Связанная информация возвращается в двух объектах Block, каждый из которых имеет тип KEY_VALUE_SET: объект KEY Block и объект VALUE Block. Например, Имя: Ана Сильва Каролина содержит ключ и значение. Имя: - это ключ. Ана Сильва Каролина - это значение.
• Данные таблиц и ячеек таблиц. Объект TABLE Block содержит информацию о распознанной таблице. Объект CELL Block возвращается для каждой ячейки в таблице.
• Строки и слова текста. Объект LINE Block содержит один или несколько объектов WORD Block. Возвращаются все строки и слова, обнаруженные в документе (включая текст, не имеющий отношения к значению параметра StartDocumentAnalysis FeatureTypes).
• Запрос. Объект блока QUERY содержит текст запроса, псевдоним и ссылку на связанный объект блока результатов запроса.
• Результаты запроса. Объект блока QUERY_RESULT содержит ответ на запрос и идентификатор, который связывает его с заданным запросом. Этот блок также содержит оценку уверенности.

Элементы выбора, такие как флажки и переключатели (кнопки радио), могут быть обнаружены в данных формы и таблицах. Объект SELECTION_ELEMENT Block содержит информацию об элементе выбора, включая состояние выбора.

Используйте параметр MaxResults, чтобы ограничить количество возвращаемых блоков. Если результатов больше, чем указано в MaxResults, значение NextToken в ответе операции содержит маркер пагинации для получения следующего набора результатов. Чтобы получить следующую страницу результатов, вызовите GetDocumentAnalysis и заполните параметр запроса NextToken значением маркера, возвращённым предыдущим вызовом GetDocumentAnalysis.

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

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

Синтаксис

  get-document-analysis
--job-id <value>
[--max-results <value>]
[--next-token <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 (строка)

--max-results (целое число)

--next-token (строка)

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

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

Примеры

Для получения результатов асинхронного анализа текста многостраничного документа

Следующий get-document-analysis пример показывает, как получить результаты асинхронного анализа текста многостраничного документа.

aws textract get-document-analysis \
    --job-id df7cf32ebbd2a5de113535fcf4d921926a701b09b4e7d089f3aebadb41e0712b \
    --max-results 1000

Вывод:

{
    "Blocks": [
        {
            "Geometry": {
                "BoundingBox": {
                    "Width": 1.0,
                    "Top": 0.0,
                    "Left": 0.0,
                    "Height": 1.0
                },
                "Polygon": [
                    {
                        "Y": 0.0,
                        "X": 0.0
                    },
                    {
                        "Y": 0.0,
                        "X": 1.0
                    },
                    {
                        "Y": 1.0,
                        "X": 1.0
                    },
                    {
                        "Y": 1.0,
                        "X": 0.0
                    }
                ]
            },
            "Relationships": [
                {
                    "Type": "CHILD",
                    "Ids": [
                        "75966e64-81c2-4540-9649-d66ec341cd8f",
                        "bb099c24-8282-464c-a179-8a9fa0a057f0",
                        "5ebf522d-f9e4-4dc7-bfae-a288dc094595"
                    ]
                }
            ],
            "BlockType": "PAGE",
            "Id": "247c28ee-b63d-4aeb-9af0-5f7ea8ba109e",
            "Page": 1
        }
    ],
    "NextToken": "cY1W3eTFvoB0cH7YrKVudI4Gb0H8J0xAYLo8xI/JunCIPWCthaKQ+07n/ElyutsSy0+1VOImoTRmP1zw4P0RFtaeV9Bzhnfedpx1YqwB4xaGDA==",
    "DocumentMetadata": {
        "Pages": 1
    },
    "JobStatus": "SUCCEEDED"
}

Дополнительную информацию см. в разделе Обнаружение и анализ текста в многостраничных документах в Руководстве разработчика Amazon Textract

Вывод

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

JobStatus -> (строка)

NextToken -> (строка)

Blocks -> (список)

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

Сообщение о состоянии -> (строка)

Версия модели AnalyzeDocument -> (строка)