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

@azure/ai-form-recognizer package

Классы

AzureKeyCredential

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

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

Примеры:

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

Azure Active Directory

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

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

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

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

const credential = new AzureKeyCredential("<API key>");
const client = new DocumentAnalysisClient(
  "https://<resource name>.cognitiveservices.azure.com",
  credential,
);
DocumentModelAdministrationClient

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

Примеры:

Azure Active Directory

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

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

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

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

const credential = new AzureKeyCredential("<API key>");
const client = new DocumentModelAdministrationClient(
  "https://<resource name>.cognitiveservices.azure.com",
  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

Получение объекта ответа операции.
DocumentClassifierDetails

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

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

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

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

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

DocumentField, имеющий значение даты.
DocumentFieldCommon

Поля, которые являются общими для всех вариантов DocumentField.
DocumentFieldSchema

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

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

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

DocumentField, имеющий целочисленное значение.
DocumentKeyValueElement

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

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

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

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

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

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

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

Получение объекта ответа операции.
DocumentModelComposeOperationDetails

Получение объекта ответа операции.
DocumentModelCopyToOperationDetails

Получение объекта ответа операции.
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

Получение объекта ответа операции.
OperationSummary

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

Представляет точку, используемую для определения ограничивающих многоугольников. Единица — "пиксель" или "дюйм" (см. 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.
Code128: код 128 штрихкодов, как определено в ISO/IEC 15417:2007.
EAN8: GS1 8-значный международный номер статьи (номер европейской статьи).
EAN13: GS1 13-значный международный номер статьи (номер европейской статьи).
DataBar : штрихкод GS1 DataBar.
Code93: код 93 штрихкода, как определено в ANSI/AIM BC5-1995.
Кодабар: штрихкод Codabar, как определено в ANSI/AIM BC3-1995.
DataBarExpanded: расширенный штрихкод GS1 DataBar.
ITF: чередуется 2 из 5 штрихкодов, как определено в ANSI/AIM BC2-1995.
MicroQRCode: микро QR-код, как определено в ISO/IEC 23941:2022.
Aztec: Aztec code, как определено в ISO/IEC 24778:2008.
DataMatrix: код матрицы данных, как определено в ISO/IEC 16022:2006.
MaxiCode: MaxiCode, как определено в ISO/IEC 16023:2000.
DocumentBuildMode

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

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

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

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

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

Одно из следующих:

  • BlobSource
  • BlobFileListSource
DocumentField

Извлеченное поле. Свойство kind определяет (дискриминирует) тип DocumentField.
DocumentFieldType

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

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

строка: обычный текст.
дата: дата, нормализованная до формата ISO 8601 (ГГГГ-MM-DD).
времени: время, нормализованное до формата ISO 8601 (hh:mm:ss).
phoneNumber: номер телефона, нормализованный до формата E.164 (+{CountryCode}{SubscriptionNumber}).
число: число с плавающей запятой, нормализованное для двойной точности с плавающей запятой.
целочисленное: целочисленное число, нормализованное до 64-разрядного целого числа со знаком.
selectionMark: выбрано ли поле?
countryRegion: страна или регион, нормализованный до формата ISO 3166-1 alpha-3 (например, США).
подписи: присутствует ли подпись?
массив: список подфилдов одного типа.
объект: именованный список подфилдов потенциально разных типов.
валюту: сумма валюты с необязательным символом валюты и единицей.
адрес: проанализированный адрес.
логические: логическое значение, нормализованное до true или false.
DocumentFormulaKind

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

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

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

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

Ниже приведены следующие параметры:

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

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

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

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

Одно из следующих:

  • BlobSource
  • BlobFileListSource
DocumentSignatureType

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

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

подписанный: обнаружена подпись.
без знака: подписи не обнаружены.
DocumentTableCellKind

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

пиксель: единица длины для файлов изображений.
дюйма: длина единицы для PDF-файлов.
OperationDetailsUnion

Сведения о любом из нескольких типов операций управления распознавателями документов.
OperationKind

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

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

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

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

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

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

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

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

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

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

Допустимые типы строковых индексов, поддерживаемые службой распознавателя документов и клиентами ПАКЕТА SDK.

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

KnownDocumentBarcodeKind

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

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

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

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

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

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

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

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

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

Чтобы пройти аутентификацию с помощью Entra Id (с TokenCredentialпомощью ) в среде Sovereign Cloud , укажите соответствующее значение ниже в качестве варианта audience при создании DocumentAnalysisClient или DocumentModelAdministrationClient.

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

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

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

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

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