analyze-expense
Описание
AnalyzeExpense синхронно анализирует входной документ для поиска финансовых взаимосвязей между текстами.Информация возвращается в виде ExpenseDocuments и разделяется следующим образом:
-
LineItemGroups- набор данных, содержащийLineItems, хранящие информацию о строках текста, таких как приобретённый товар и его цена на чеке. -
SummaryFields- содержит всю остальную информацию о чеке, например, заголовок или название поставщика.
См. также: Документацию API AWS
Синтаксис
analyze-expense
--document <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 (структура)
Входной документ, представленный в виде байтов или объекта S3.
Вы передаёте байты изображения в операцию API Amazon Textract, используя свойство Bytes. Например, вы можете использовать свойство Bytes для передачи документа, загруженного из локальной файловой системы. Байты изображения, передаваемые с помощью свойства Bytes, должны быть закодированы в base64. Возможно, ваш код не потребует кодирования байтов файла документа, если вы используете AWS SDK для вызова операций API Amazon Textract.
Вы передаёте изображения, хранящиеся в ведре S3, в операцию API Amazon Textract, используя свойство S3Object. Документы, хранящиеся в ведре S3, не нуждаются в кодировании в base64.
AWS-регион для ведра S3, содержащего объект S3, должен совпадать с AWS-регионом, который вы используете для операций Amazon Textract.
Если вы используете AWS CLI для вызова операций Amazon Textract, передача байтов изображения с помощью свойства Bytes не поддерживается. Вам необходимо сначала загрузить документ в ведро Amazon S3, а затем вызвать операцию с помощью свойства S3Object.
Для обработки Amazon Textract объекта S3, пользователь должен иметь разрешения на доступ к объекту S3.
Bytes -> (blob)
Блок base64-закодированных байтов документа. Максимальный размер документа, предоставляемого в виде блока байтов, составляет 5 МБ. Байты документа должны быть в формате PNG или JPEG.
Если вы используете AWS SDK для вызова Amazon Textract, вам, возможно, не нужно будет кодировать байты изображения в base64, используя поле Bytes.
S3Object -> (структура)
Идентифицирует объект S3 как источник документа. Максимальный размер документа, хранящегося в ведре S3, составляет 5 МБ.
Bucket -> (строка)
Name -> (строка)
Version -> (строка)
Сокращённый синтаксис:
Bytes=blob,S3Object={Bucket=string,Name=string,Version=string}
Синтаксис JSON:
{
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
--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.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров входных данных CLI.
Вывод
DocumentMetadata -> (структура)
Информация об входном документе.
Pages -> (целое число)
ExpenseDocuments -> (список)
Расходы, обнаруженные Amazon Textract.
(структура)
Структура, содержащая всю информацию, возвращаемую AnalyzeExpense
ExpenseIndex -> (целое число)
SummaryFields -> (список)
Любая информация, найденная Amazon Textract за пределами таблицы.
(структура)
Подробное описание обнаруженной информации, разделенной по категориям Тип, Обнаружение метки и Обнаружение значения
Type -> (структура)
Подразумеваемая метка обнаруженного элемента. Присутствует вместе с LabelDetection для явных элементов.
Text -> (строка)
Confidence -> (вещественное число)
LabelDetection -> (структура)
Явно указанная метка обнаруженного элемента.
Text -> (строка)
Geometry -> (структура)
Информация о расположении следующих элементов на странице документа: обнаруженная страница, текст, пары ключ-значение, таблицы, ячейки таблицы и элементы выбора.
BoundingBox -> (структура)
Ось-выровненное грубое представление расположения распознанного элемента на странице документа.
Width -> (вещественное число)
Height -> (вещественное число)
Left -> (вещественное число)
Top -> (вещественное число)
Polygon -> (список)
В пределах области размещения - точный многоугольник вокруг распознанного элемента.
(структура)
Координаты X и Y точки на странице документа. Значения X и Y, которые возвращаются, являются соотношениями к общему размеру страницы документа. Например, если входной документ имеет размер 700x200, а операция возвращает X=0,5 и Y=0,25, то точка находится в пиксельной координате (350,50) на странице документа.
Массив объектов Point, Polygon, возвращаемых DetectDocumentText. Polygon представляет собой точный многоугольник вокруг обнаруженного текста. Более подробную информацию см. в разделе «Геометрия» руководства разработчика Amazon Textract.
X -> (вещественное число)
Polygon.Y -> (вещественное число)
Polygon.Confidence -> (вещественное число)
ValueDetection -> (структура)
Значение обнаруженного элемента. Присутствует в явных и неявных элементах.
Text -> (строка)
Geometry -> (структура)
Информация о расположении следующих элементов на странице документа: обнаруженная страница, текст, пары ключ-значение, таблицы, ячейки таблицы и элементы выбора.
BoundingBox -> (структура)
Ось-выровненное грубое представление расположения распознанного элемента на странице документа.
Width -> (вещественное число)
Height -> (вещественное число)
Left -> (вещественное число)
Top -> (вещественное число)
Polygon -> (список)
В пределах области размещения - точный многоугольник вокруг распознанного элемента.
(структура)
Координаты X и Y точки на странице документа. Значения X и Y, которые возвращаются, являются соотношениями к общему размеру страницы документа. Например, если входной документ имеет размер 700x200, а операция возвращает X=0,5 и Y=0,25, то точка находится в пиксельной координате (350,50) на странице документа.
Массив объектов Point, Polygon, возвращаемых DetectDocumentText. Polygon представляет собой точный многоугольник вокруг обнаруженного текста. Более подробную информацию см. в разделе «Геометрия» руководства разработчика Amazon Textract.
X -> (вещественное число)
Polygon.Y -> (вещественное число)
Polygon.Confidence -> (вещественное число)
PageNumber -> (целое число)
Currency -> (структура)
Показывает тип валюты, а также код и уверенность, связанные с обнаруженной денежной суммой.
Code -> (строка)
Код валюты для обнаруженной валюты. Поддерживаемые коды:
- USD
- EUR
- GBP
- CAD
- INR
- JPY
- CHF
- AUD
- CNY
- BZR
- SEK
- HKD
Confidence -> (вещественное число)
GroupProperties -> (список)
Показывает, к какой группе принадлежит объект ответа, например, относится ли строка адреса к адресу поставщика или получателя.
(структура)
Показывает группу, к которой принадлежит определенный ключ. Это помогает отличить имена и адреса разных организаций, что может быть сложно определить по ответу JSON.
Types -> (список)
Указывает, является ли группа расходов именем или адресом.
(строка)
Id -> (строка)
LineItemGroups -> (список)
Информация, обнаруженная в каждой таблице документа, разделена на LineItems.
(структура)
Группа таблиц, содержащих LineItems, каждая таблица идентифицируется по LineItemGroupIndex таблицы.
LineItemGroupIndex -> (целое число)
LineItems -> (список)
Детализация информации по конкретной строке таблицы.
(структура)
Структура, содержащая информацию о различных строках, найденных в таблицах документа.
LineItemExpenseFields -> (список)
Поля ExpenseFields, используемые для отображения информации из обнаруженных строк таблицы.
(структура)
Детализация обнаруженной информации, разделенная на категории Type, LabelDetection и ValueDetection
Type -> (структура)
Подразумеваемое обозначение обнаруженного элемента. Присутствует вместе с LabelDetection для явных элементов.
Text -> (строка)
Confidence -> (вещественное число)
LabelDetection -> (структура)
Явно указанное обозначение обнаруженного элемента.
Text -> (строка)
Geometry -> (структура)
Информация о расположении следующих элементов на странице документа: обнаруженная страница, текст, пары «ключ-значение», таблицы, ячейки таблиц и элементы выбора.
BoundingBox -> (структура)
Осесимметричное грубое представление местоположения распознанного элемента на странице документа.
Width -> (вещественное число)
Height -> (вещественное число)
Left -> (вещественное число)
Top -> (вещественное число)
Polygon -> (список)
Внутри рамки – точная полилиния вокруг распознанного элемента.
(структура)
Координаты X и Y точки на странице документа. Значения X и Y, которые возвращаются, являются отношениями к общему размеру страницы документа. Например, если входной документ имеет размер 700x200, и операция возвращает X=0,5 и Y=0,25, то точка находится в пиксельной координате (350,50) на странице документа.
Массив объектов Point, Polygon, возвращается функцией DetectDocumentText. Polygon представляет точную полилинию вокруг распознанного текста. Более подробную информацию см. в руководстве разработчика Amazon Textract в разделе Geometry.
X -> (вещественное число)
Polygon.Y -> (вещественное число)
Polygon.Confidence -> (вещественное число)
ValueDetection -> (структура)
Значение обнаруженного элемента. Присутствует в явных и неявных элементах.
Text -> (строка)
Geometry -> (структура)
Информация о расположении следующих элементов на странице документа: обнаруженная страница, текст, пары «ключ-значение», таблицы, ячейки таблиц и элементы выбора.
BoundingBox -> (структура)
Осесимметричное грубое представление местоположения распознанного элемента на странице документа.
Width -> (вещественное число)
Height -> (вещественное число)
Left -> (вещественное число)
Top -> (вещественное число)
Polygon -> (список)
Внутри рамки – точная полилиния вокруг распознанного элемента.
(структура)
Координаты X и Y точки на странице документа. Значения X и Y, которые возвращаются, являются отношениями к общему размеру страницы документа. Например, если входной документ имеет размер 700x200, и операция возвращает X=0,5 и Y=0,25, то точка находится в пиксельной координате (350,50) на странице документа.
Массив объектов Point, Polygon, возвращается функцией DetectDocumentText. Polygon представляет точную полилинию вокруг распознанного текста. Более подробную информацию см. в руководстве разработчика Amazon Textract в разделе Geometry.
X -> (вещественное число)
Polygon.Y -> (вещественное число)
Polygon.Confidence -> (вещественное число)
PageNumber -> (целое число)
Currency -> (структура)
Показывает тип валюты, включая код и уверенность в обнаруженной денежной величине.
Code -> (строка)
Код валюты для обнаруженной валюты. Поддерживаемые коды:
- USD
- EUR
- GBP
- CAD
- INR
- JPY
- CHF
- AUD
- CNY
- BZR
- SEK
- HKD
Confidence -> (вещественное число)
GroupProperties -> (список)
Показывает, к какой группе относится объект ответа, например, принадлежит ли строка адреса к адресу поставщика или получателя.
(структура)
Показывает группу, к которой принадлежит определённый ключ. Это помогает отличить имена и адреса различных организаций, что может быть сложно определить из ответа JSON.
Types -> (список)
Указывает, является ли группа расходов именем или адресом.
(строка)
Id -> (строка)
Blocks -> (список)
Это объект блока, такой же, как и при выполнении DetectDocumentText на документе. Он обеспечивает распознавание текста на уровне слов.
(структура)
Block представляет элементы, распознанные в документе в группе пикселей, расположенных близко друг к другу. Информация, возвращаемая в объекте Block, зависит от типа операции. При распознавании текста в документах (например, DetectDocumentText) вы получаете информацию о распознанных словах и строках текста. При анализе текста (например, AnalyzeDocument) вы также можете получить информацию о найденных полях, таблицах и элементах выбора в документе.
Массив объектов Block возвращается как синхронными, так и асинхронными операциями. В синхронных операциях, таких как DetectDocumentText, массив объектов Block представляет собой весь набор результатов. В асинхронных операциях, таких как GetDocumentAnalysis, массив возвращается в одном или нескольких ответах.
Для получения дополнительной информации см. Как работает Amazon Textract.
BlockType -> (строка)
Тип распознанного элемента текста. В операциях распознавания текста возвращаются следующие типы:
-
PAGE - Содержит список объектов LINE
Block, распознанных на странице документа. - WORD - Слово, распознанное на странице документа. Слово — это одна или несколько букв базовой латинской кодировки ISO, не разделенные пробелами.
- LINE - Строка табулированных, смежных слов, распознанных на странице документа.
В операциях анализа текста возвращаются следующие типы:
-
PAGE - Содержит список дочерних объектов
Block, распознанных на странице документа. -
KEY_VALUE_SET - Хранит объекты KEY и VALUE
Blockдля связанного текста, распознанного на странице документа. Используйте полеEntityType, чтобы определить, является ли объект KEY_VALUE_SET объектом KEYBlockили объектом VALUEBlock. - WORD - Слово, распознанное на странице документа. Слово — это одна или несколько букв базовой латинской кодировки ISO, не разделенные пробелами.
- LINE - Строка табулированных, смежных слов, распознанных на странице документа.
- TABLE - Таблица, распознанная на странице документа. Таблица — это информация на основе сетки с двумя или более строками или столбцами, с размахом ячейки по одной строке и одному столбцу.
- TABLE_TITLE - Заголовок таблицы. Заголовок обычно представляет собой строку текста над или под таблицей или вставлен в первую строку таблицы.
- TABLE_FOOTER - Подвал, связанный с таблицей. Подвал обычно представляет собой строку или строки текста под таблицей или вставлен в последнюю строку таблицы.
- CELL - Ячейка в распознанной таблице. Ячейка является родителем блока, содержащего текст в ячейке.
-
MERGED_CELL - Ячейка в таблице, содержимое которой занимает более одной строки или столбца. Массив
Relationshipsдля этой ячейки содержит данные из отдельных ячеек. -
SELECTION_ELEMENT - Элемент выбора, такой как кнопка выбора (кнопка радио) или флажок, распознанный на странице документа. Используйте значение
SelectionStatus, чтобы определить состояние элемента выбора. - SIGNATURE - Местоположение и оценка достоверности подписи, распознанной на странице документа. Может возвращаться как часть пары «ключ-значение» или распознанной ячейки.
- QUERY - Вопрос, заданный во время вызова AnalyzeDocument. Содержит псевдоним и идентификатор, привязывающий его к ответу.
- QUERY_RESULT - Ответ на вопрос, заданный во время вызова analyze document. Имеется псевдоним и ID для удобства поиска в ответе. Также содержит местоположение и оценку достоверности.
Следующие типы BlockTypes возвращаются только для Amazon Textract Layout.
-
LAYOUT_TITLE- Основной заголовок документа. -
LAYOUT_HEADER- Текст, расположенный в верхней части документа. -
LAYOUT_FOOTER- Текст, расположенный в нижней части документа. -
LAYOUT_SECTION_HEADER- Заголовки разделов в документе. -
LAYOUT_PAGE_NUMBER- Номер страницы документа. -
LAYOUT_LIST- Любая информация, сгруппированная в виде списка. -
LAYOUT_FIGURE- Указывает местоположение изображения в документе. -
LAYOUT_TABLE- Указывает местоположение таблицы в документе. -
LAYOUT_KEY_VALUE- Указывает местоположение форм «ключ-значение» в документе. -
LAYOUT_TEXT- Текст, обычно присутствующий в виде абзацев в документах.
Confidence -> (число с плавающей точкой)
Text -> (строка)
TextType -> (строка)
RowIndex -> (целое число)
RowIndex не возвращается DetectDocumentText и GetDocumentTextDetection.ColumnIndex -> (целое число)
ColumnIndex не возвращается DetectDocumentText и GetDocumentTextDetection.RowSpan -> (целое число)
RowSpan не возвращается DetectDocumentText и GetDocumentTextDetection.ColumnSpan -> (целое число)
ColumnSpan не возвращается DetectDocumentText и GetDocumentTextDetection.Geometry -> (структура)
Местоположение распознанного текста на изображении. Он включает осью выровненную грубую рамку, которая окружает текст, и более тонкую полилинию для более точной пространственной информации.
BoundingBox -> (структура)
Осью выровненное грубое представление местоположения распознанного элемента на странице документа.
Width -> (число с плавающей точкой)
Height -> (число с плавающей точкой)
Left -> (число с плавающей точкой)
Top -> (число с плавающей точкой)
Polygon -> (список)
В пределах ограничивающей рамки, тонкая полилиния вокруг распознанного элемента.
(структура)
Координаты X и Y точки на странице документа. Значения X и Y, которые возвращаются, представляют собой отношения к общему размеру страницы документа. Например, если входной документ имеет размер 700 x 200, и операция возвращает X=0,5 и Y=0,25, то точка находится в координатах пикселей (350,50) на странице документа.
Массив объектов Point, Polygon, возвращается DetectDocumentText. Polygon представляет тонкую полилинию вокруг распознанного текста. Для получения дополнительной информации см. Геометрия в руководстве разработчика Amazon Textract.
X -> (число с плавающей точкой)
Polygon.Y -> (число с плавающей точкой)
Polygon.Id -> (строка)
Relationships -> (список)
Список объектов отношений, описывающих, как блоки связаны друг с другом. Например, объект блока LINE содержит тип отношения CHILD с блоками WORD, которые составляют строку текста. Объектов Relationship в списке нет для отношений, которые не существуют, например, когда у текущего блока нет дочерних блоков.
(структура)
Информация о том, как блоки связаны друг с другом. Объект Block содержит 0 или более объектов Relation в списке, Relationships. Для получения дополнительной информации см. Блок.
Элемент Type предоставляет тип отношения для всех блоков в массиве IDs.
Type -> (строка)
Тип отношения между блоками в массиве ID и текущим блоком. Следующий список описывает типы отношений, которые могут быть возвращены.
- VALUE - Список, содержащий ID блока VALUE, связанного с ключом пары «ключ-значение».
- CHILD - Список ID, идентифицирующих блоки, найденные внутри текущего объекта блока. Например, блоки WORD имеют отношение CHILD к блоку типа LINE.
- MERGED_CELL - Список ID, идентифицирующих каждый из блоков типа MERGED_CELL в таблице.
- ANSWER - Список, содержащий ID блока QUERY_RESULT, связанного с соответствующим блоком QUERY.
- TABLE - Список ID, идентифицирующих связанные блоки типа TABLE.
- TABLE_TITLE - Список, содержащий ID блока типа TABLE_TITLE в таблице.
- TABLE_FOOTER - Список ID, идентифицирующих блоки типа TABLE_FOOTER в таблице.
Ids -> (список)
Массив ID связанных блоков. Тип отношения можно получить из элемента Type.
(строка)
EntityTypes -> (список)
Тип сущности.
Следующие типы сущностей могут быть возвращены анализом форм:
- KEY - Идентификатор поля в документе.
- VALUE - Текст поля.
Следующие типы сущностей могут быть возвращены анализом таблиц:
- COLUMN_HEADER - Идентифицирует ячейку, которая является заголовком столбца.
- TABLE_TITLE - Идентифицирует ячейку, которая является заголовком в таблице.
- TABLE_SECTION_TITLE - Идентифицирует ячейку, которая является заголовком раздела в таблице. Заголовок раздела — это ячейка, которая обычно занимает всю строку над разделом.
- TABLE_FOOTER - Идентифицирует ячейку, которая является подвалом таблицы.
- TABLE_SUMMARY - Идентифицирует ячейку сводки таблицы. Ячейка сводки может быть строкой таблицы или дополнительной, меньшей таблицей, содержащей сводную информацию для другой таблицы.
- STRUCTURED_TABLE - Идентифицирует таблицу с заголовками столбцов, где содержимое каждой строки соответствует заголовкам.
- SEMI_STRUCTURED_TABLE - Идентифицирует неструктурированную таблицу.
EntityTypes не возвращается DetectDocumentText и GetDocumentTextDetection.(строка)
SelectionStatus -> (строка)
Page -> (целое число)
Page возвращается синхронными и асинхронными операциями. Значения страницы, большие 1, возвращаются только для многостраничных документов в формате PDF или TIFF. Скан-изображение (JPEG/PNG), предоставленное асинхронной операции, даже если оно содержит несколько страниц документа, считается одностраничным документом. Это означает, что для отсканированных изображений значение Page всегда равно 1.Запрос -> (структура)
Текст -> (строка)
Псевдоним -> (строка)
Страницы -> (список)
Параметр Страницы позволяет пользователю указать, к каким страницам применить запрос. Ниже приведены правила использования этого параметра.
- Если страница не указана, она по умолчанию устанавливается в
["1"]. - В строке параметра разрешены следующие символы:
0 1 2 3 4 5 6 7 8 9 - *. Пробелы не допускаются. - При использовании * для указания всех страниц, оно должно быть единственным элементом в списке.
- Можно использовать интервалы страниц, например,
[“1-3”, “1-1”, “4-*”]. Где*указывает последнюю страницу документа. - Указанные страницы должны быть больше 0 и меньше или равны количеству страниц в документе.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.