Поделиться через


@azure/ai-form-recognizer package

Классы

AzureKeyCredential

Учетные данные на основе статического ключа, поддерживающие обновление значения базового ключа.

DocumentAnalysisClient

Клиент для взаимодействия с функциями анализа службы Распознаватель документов.

Примеры:

Служба Распознаватель документов и клиенты поддерживают два способа проверки подлинности:

Azure Active Directory

import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new DocumentAnalysisClient(endpoint, credential);

Ключ API (ключ подписки)

import { DocumentAnalysisClient, AzureKeyCredential } from "@azure/ai-form-recognizer";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new DocumentAnalysisClient(endpoint, credential);
DocumentModelAdministrationClient

Клиент для взаимодействия с функциями управления моделями службы Распознаватель документов, такими как создание, чтение, перечисление, удаление и копирование моделей.

Примеры:

Azure Active Directory

import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new DocumentModelAdministrationClient(endpoint, credential);

Ключ API (ключ подписки)

import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new DocumentModelAdministrationClient(endpoint, credential);

Интерфейсы

AddressValue

Значение поля адреса.

AnalyzeDocumentOptions

Параметры для операции анализа документов.

AnalyzeResult

Результат операции анализа. Тип документа может определяться моделью, используемой для выполнения анализа.

AnalyzeResultCommon

Общие поля всех типов AnalyzeResult, таких как LayoutResult, ReadResult и GeneralDocumentResult.

AnalyzedDocument

Извлеченный объект документа.

AnalyzedDocument — это экземпляр одного из типов документов в модели. Его поля соответствуют схеме полей типа документа.

AzureBlobFileListSource

Источник данных для обучения, определенный контейнером BLOB-объектов Azure и списком файлов JSONL в контейнере.

AzureBlobFileListSourceDetails

Список файлов в Хранилище BLOB-объектов Azure.

AzureBlobSource

Источник данных для обучения, определенный контейнером BLOB-объектов Azure.

AzureBlobSourceDetails

Хранилище BLOB-объектов Azure содержимого.

BeginBuildDocumentClassifierOptions

Параметры для операции сборки классификатора документов.

BeginBuildDocumentModelOptions

Параметры для операции сборки модели.

BeginComposeDocumentModelOptions

Параметры для операции создания модели.

BeginCopyModelOptions

Параметры для операции копирования модели.

BoundingRegion

Ограничивающий многоугольник на определенной странице входных данных.

ClassifierDocumentTypeDetails

Сведения о типе документа классификатора.

ClassifyDocumentOptions

Параметры для операции классификации документов.

CommonModelCreationOptions

Параметры, общие для всех операций, определяющих новые модели, например beginBuildDocumentModel, beginComposeDocumentModelи getCopyAuthorization.

CopyAuthorization

Авторизация для копирования модели документа в указанный целевой ресурс и modelId.

CreateDocumentModelOptions

Параметры для операции создания модели.

CurrencyValue

Значение поля валюты.

CustomDocumentModelsDetails

Сведения о пользовательских моделях документов.

DeleteDocumentModelOptions

Параметры удаления модели.

DocumentAddressField

Поле документа, описывающее структурированный физический адрес.

DocumentAnalysisClientOptions

Настраиваемые параметры для DocumentAnalysisClient.

DocumentAnalysisPollOperationState

Состояние операции анализа, которая в конечном итоге создаст тип результата, соответствующий модели.

DocumentAnnotation

Элемент визуальной заметки в документе, например проверка знак или крестик.

DocumentArrayField

Объект DocumentField, состоящий из массива вложенных полей. Все поля в массиве будут иметь одинаковый тип.

DocumentBarcode

Извлеченный штрихкод.

DocumentBooleanField

Объект DocumentField с логическим значением.

DocumentCaption

Объект , представляющий расположение и содержимое таблицы подпись.

DocumentClassifierBuildOperationDetails

Возвращает объект ответа Operation.

DocumentClassifierDetails

Сведения о классификаторе документов.

DocumentClassifierDocumentTypeSources

Набор источников, используемых для создания классификатора документов. Это сопоставление имен типов документов с источниками, которые будут использоваться для обучения модели классификации документов соответствующего исходного типа.

DocumentClassifierOperationState

Состояние операции создания модели.

DocumentCountryRegionField

Объект DocumentField со значением, указывающим страну или регион, представленный в виде строки.

DocumentCurrencyField

Объект DocumentField, описывающий сумму определенной валюты.

DocumentDateField

Объект DocumentField со значением Date.

DocumentFieldCommon

Поля, общие для всех вариантов DocumentField.

DocumentFieldSchema

Описание семантической схемы поля с использованием синтаксиса стиля схемы JSON.

DocumentFootnote

Объект , представляющий расположение и содержимое табличной сноски.

DocumentFormula

Извлеченная формула.

DocumentIntegerField

Объект DocumentField, имеющий целочисленное значение.

DocumentKeyValueElement

Объект , представляющий ключ поля или значение в паре "ключ-значение".

DocumentKeyValuePair

Объект, представляющий поле формы с отдельной меткой поля (ключ) и значением поля (может быть пустым).

DocumentLanguage

Объект , представляющий обнаруженный язык для заданного текстового диапазона.

DocumentLine

Объект строки содержимого, состоящий из соседней последовательности элементов содержимого, таких как слова и метки выделения.

DocumentModel

Хорошо известная спецификация модели, поддерживающая извлечение структурированных документов.

beginAnalyzeDocument См. метод DocumentAnalysisClient, который поддерживает использование этих DocumentModel объектов вместо строк идентификаторов модели для предоставления более надежных типов результатов.

DocumentModelAdministrationClientOptions

Настраиваемые параметры documentModelAdministrationClient.

DocumentModelBuildOperationDetails

Возвращает объект ответа Operation.

DocumentModelComposeOperationDetails

Возвращает объект ответа Operation.

DocumentModelCopyToOperationDetails

Возвращает объект ответа Operation.

DocumentModelDetails

Сведения о модели документа.

DocumentModelOperationState

Состояние операции создания модели.

DocumentModelSummary

Сводка модели документа.

DocumentNumberField

Объект DocumentField, имеющий числовое значение.

DocumentObjectField

Объект DocumentField, состоящий из нескольких именованных свойств, имеющих собственные значения DocumentField.

DocumentPage

Элементы содержимого и макета, извлеченные из страницы из входных данных.

DocumentParagraph

Объект абзаца, состоящий из смежных линий, обычно с общим выравниванием и интервалами.

DocumentPhoneNumberField

Объект DocumentField со значением номера телефона, представленным в виде строки.

DocumentSelectionMark

Объект метки выделения, представляющий проверка прямоугольники, переключатели и другие элементы, указывающие на выделение.

DocumentSelectionMarkField

Объект DocumentField, имеющий значение, указывающее состояние метки выбора (например, флажок или переключатель), представленное в виде строки.

DocumentSignatureField

Объект DocumentField, указывающий состояние сигнатуры, представленной в виде строки.

DocumentSpan

Смежная область объединенного свойства содержимого, указанная как смещение и длина.

DocumentStringField

Объект DocumentField со строковым значением.

DocumentStyle

Объект , представляющий наблюдаемые стили текста.

DocumentTable

Объект таблицы, состоящий из ячеек таблицы, упорядоченных в прямоугольном макете.

DocumentTableCell

Объект , представляющий расположение и содержимое ячейки таблицы.

DocumentTimeField

Объект DocumentField со значением времени, представленным в виде строки.

DocumentTypeDetails

Сведения о типе документа.

DocumentValueField

Простое поле с примитивным значением, например строкой, числом и т. д.

DocumentWord

Объект слова, состоящий из непрерывной последовательности символов. Для языков, не разделенных пробелами, таких как китайский, японский и корейский, каждый символ представлен как собственное слово.

ErrorModel

Сведения об ошибке.

GetCopyAuthorizationOptions

Параметры для метода получения авторизации копирования.

GetModelOptions

Параметры получения сведений о модели.

GetOperationOptions

Параметры получения состояния операции.

GetResourceDetailsOptions

Параметры получения сведений о Распознаватель документов ресурсе.

HasBoundingPolygon

Простые элементы документа, такие как слова, знаки выделения и линии, ограничены многоугольником.

InnerError

Подробная ошибка.

ListModelsOptions

Параметры для перечисления моделей.

ListOperationsOptions

Параметры для перечисления операций.

ModelAdministrationOperationStateCommon

Набор полей, общих для всех операций администрирования.

OperationDetails

Получение объекта ответа Operation.

OperationSummary

Сведения об операции.

Point2D

Представляет точку, используемую для определения ограничивающих многоугольников. Единица измерения имеет значение pixel или inch (см. раздел LengthUnit).

PollerOptions

Параметры для длительных операций (опросов) в клиентах Распознаватель документов.

QuotaDetails

Используемая квота, ограничение и следующий сброс даты и времени.

ResourceDetails

Общие сведения о текущем ресурсе.

Псевдонимы типа

AnalysisPoller

Долго выполняющаяся операция (средство опроса), которая отслеживает состояние операции анализа и в конечном итоге создает тип результата, соответствующий модели.

AnalyzeResultOperationStatus

Определяет значения для AnalyzeResultOperationStatus.

DocumentBarcodeKind

Определяет значения для DocumentBarcodeKind.
KnownDocumentBarcodeKind можно использовать взаимозаменяемо с DocumentBarcodeKind. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

QRCode: QR-код, как определено в ISO/IEC 18004:2015.
PDF417: PDF417, как определено в ISO 15438.
UPCA: GS1 12-значный универсальный код продукта.
UPCE: GS1 6-значный универсальный код продукта.
Code39: штрихкод 39, как определено в ISO/IEC 16388:2007.
Код128: штрихкод 128, как определено в ISO/IEC 15417:2007.
EAN8: GS1 8-значный международный номер статьи (европейский номер статьи).
EAN13: GS1 13-значный международный номер статьи (европейский номер статьи).
DataBar: штрихкод GS1 DataBar.
Code93: штрихкод 93, как определено в ANSI/AIM BC5-1995.
Кодабар: Кодабар штрихкод, как определено в ANSI/AIM BC3-1995.
DataBarExpanded: расширенный штрихкод GS1 DataBar.
ITF: чередуются 2 из 5 штрихкодов, как определено в ANSI/AIM BC2-1995.
MicroQRCode: Микро QR-код, как определено в ISO/IEC 23941:2022.
Ацтек: код Aztec, как определено в ISO/IEC 24778:2008.
DataMatrix: код матрицы данных, как определено в ISO/IEC 16022:2006.
MaxiCode: MaxiCode, как определено в ISO/IEC 16023:2000.

DocumentBuildMode

Определяет значения для DocumentBuildMode.
KnownDocumentBuildMode можно использовать взаимозаменяемо с DocumentBuildMode. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

template: целевые документы с похожими визуальными шаблонами.
neural: поддержка документов с различными визуальными шаблонами.

DocumentClassifierPoller

Долго выполняющаяся операция (средство опроса), которая отслеживает состояние операции создания пользовательского классификатора, в конечном итоге создавая DocumentClassifierDetails.

DocumentClassifierSource

Источник содержимого, который может использоваться для создания классификатора документов.

Одно из двух значений:

  • BlobSource
  • BlobFileListSource
DocumentField

Извлеченное поле. Свойство kind идентифицирует (различает) тип DocumentField.

DocumentFieldType

Определяет значения для DocumentFieldType.
KnownDocumentFieldType можно использовать взаимозаменяемо с DocumentFieldType. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

string: обычный текст.
date: дата, нормализованная в формате ISO 8601 (ГГГГ-ММ-ДД).
time: время, нормализованное до формата ISO 8601 (чч:мм:сс).
phoneNumber: номер телефона, нормализованный до формата E.164 (+{CountryCode}{SubscriberNumber}).
number: число с плавающей запятой, нормализованное до двойной точности с плавающей запятой.
integer: целое число, нормализованное до 64-разрядного целого числа со знаком.
selectionMark: выбрано ли поле?
countryRegion: страна или регион, нормализованный в формате ISO 3166-1 alpha-3 (например, США).
подпись: присутствует ли подпись?
array: список подполей одного типа.
object: именованный список подполей потенциально различных типов.
currency: сумма валюты с необязательным символом валюты и единицей.
address: проанализированный адрес.
boolean: логическое значение, нормализованное до true или false.

DocumentFormulaKind

Определяет значения для DocumentFormulaKind.
KnownDocumentFormulaKind можно использовать взаимозаменяемо с DocumentFormulaKind. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

inline: формула, внедренная в содержимое абзаца.
display: формула в режиме отображения, которая занимает всю строку.

DocumentModelBuildMode

Поддерживаемые режимы сборки модели. Режим сборки модели выбирает подсистему, которую служба использует для обучения модели на основе помеченных обучающих данных.

Доступны следующие возможности:

  • "нейронный", который обеспечивает наивысшее качество модели, способной извлекать данные из классов документов с одинаковой структурой данных, но разными макетами (например, налоговые формы W2, которые могут отличаться в разных компаниях, но всегда содержат одни и те же сведения).
  • "template", который требует, чтобы все документы имели одинаковый фиксированный макет (шаблон).

Дополнительные сведения см. по следующей ссылке: https://aka.ms/azsdk/formrecognizer/buildmode

DocumentModelPoller

Длительная операция (средство опроса), которая отслеживает состояние операции создания модели, в конечном итоге создавая DocumentModelDetails.

DocumentModelSource

Источник контента, который может использоваться для создания модели документа.

Одно из двух значений:

  • BlobSource
  • BlobFileListSource
DocumentSignatureType

Определяет значения для DocumentSignatureType.
KnownDocumentSignatureType можно использовать взаимозаменяемо с DocumentSignatureType. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

signed: обнаружена сигнатура.
unsigned: подписи не обнаружены.

DocumentTableCellKind

Определяет значения для DocumentTableCellKind.
KnownDocumentTableCellKind можно использовать взаимозаменяемо с DocumentTableCellKind. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

content: содержит main содержимого или данных.
rowHeader: описывает содержимое строки.
columnHeader: описывает содержимое столбца.
stubHead: описывает заголовки строк, обычно расположенные в левом верхнем углу таблицы.
description: описывает содержимое (части) таблицы.

FontStyle

Определяет значения для FontStyle.
KnownFontStyle можно использовать взаимозаменяемо с FontStyle. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

normal: символы представлены в обычном режиме.
Курсив: символы визуально наклоняются вправо.

FontWeight

Определяет значения для FontWeight.
KnownFontWeight можно использовать взаимозаменяемо с FontWeight. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

normal: символы представлены в обычном режиме.
bold: символы представлены более толстыми штрихами.

FormRecognizerFeature

Дополнительные возможности (функции), которые можно включить для запроса.

Дополнительные сведения о функциях, доступных в Распознаватель документов, см. в документации по службам:

https://aka.ms/azsdk/formrecognizer/features

FormRecognizerRequestBody

Входные данные запроса, которые можно отправить в виде двоичных данных в службу Распознаватель документов. Распознаватель документов обрабатывает string входные данные как URL-адреса, поэтому, чтобы отправить строку как двоичные входные данные, сначала преобразуйте строку в один из следующих типов входных данных.

LengthUnit

Определяет значения для LengthUnit.
KnownLengthUnit можно использовать взаимозаменяемо с LengthUnit. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

pixel: единица длины для файлов изображений.
inch: единица длины pdf-файлов.

OperationDetailsUnion

Сведения о различных типах операций управления Распознаватель документов.

OperationKind

Определяет значения для OperationKind.
KnownOperationKind можно использовать взаимозаменяемо с OperationKind. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

documentModelBuild: создание новой пользовательской модели документов.
documentModelCompose: создание новой пользовательской модели документов на основе существующих моделей.
documentModelCopyTo: копирование существующей модели документа в другой ресурс, регион или подписку.
documentClassifierBuild: создание новой пользовательской модели классификатора.

OperationStatus

Определяет значения для OperationStatus.

ParagraphRole

Определяет значения для ParagraphRole.
KnownParagraphRole можно использовать взаимозаменяемо с ParagraphRole. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

pageHeader: текст у верхнего края страницы.
pageFooter: текст в нижней части страницы.
pageNumber: номер страницы.
title: заголовок верхнего уровня, описывающий весь документ.
sectionHeading: подзаголовок, описывающий раздел документа.
сноска: заметка, как правило, помещается после main содержимого на странице.
formulaBlock: блок формул, часто с общим выравниванием.

SelectionMarkState

Определяет значения для SelectionMarkState.
KnownSelectionMarkState можно использовать взаимозаменяемо с SelectionMarkState. Это перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

selected: выделена метка выделения, часто обозначаемая проверка ✓ или крестом X внутри выделенной метки.
unselected: метка выбора не выбрана.

StringIndexType

Допустимые типы строковых индексов, поддерживаемые клиентами службы Распознаватель документов и пакета SDK.

Перечисления

KnownDocumentBarcodeKind

Известные значения DocumentBarcodeKind , которые принимает служба.

KnownDocumentBuildMode

Известные значения DocumentBuildMode , которые принимает служба.

KnownDocumentFieldType

Известные значения DocumentFieldType , которые принимает служба.

KnownDocumentFormulaKind

Известные значения DocumentFormulaKind , которые принимает служба.

KnownDocumentSignatureType

Известные значения DocumentSignatureType , которые принимает служба.

KnownDocumentTableCellKind

Известные значения DocumentTableCellKind , которые принимает служба.

KnownFontStyle

Известные значения FontStyle , которые принимает служба.

KnownFontWeight

Известные значения FontWeight , которые принимает служба.

KnownLengthUnit

Известные значения LengthUnit , которые принимает служба.

KnownOperationKind

Известные значения OperationKind , которые принимает служба.

KnownParagraphRole

Известные значения ParagraphRole , которые принимает служба.

KnownSelectionMarkState

Известные значения SelectionMarkState , которые принимает служба.