你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@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	由 Azure Blob 容器和容器中的 JSONL 文件列表定义的训练数据源。
AzureBlobFileListSourceDetails	Azure Blob 存储 中的文件列表。
AzureBlobSource	由 Azure Blob 容器定义的训练数据源。
AzureBlobSourceDetails	Azure Blob 存储内容。
BeginBuildDocumentClassifierOptions	文档分类器生成操作的选项。
BeginBuildDocumentModelOptions	模型生成操作的选项。
BeginComposeDocumentModelOptions	模型组合操作的选项。
BeginCopyModelOptions	复制模型操作的选项。
BoundingRegion	在输入的特定页上绑定多边形。
ClassifierDocumentTypeDetails	分类器文档类型信息。
ClassifyDocumentOptions	文档分类操作的选项。
CommonModelCreationOptions	用于定义新模型的所有操作（如 、 beginComposeDocumentModel和 getCopyAuthorization）beginBuildDocumentModel的通用选项。
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	具有 Date 值的 DocumentField。
DocumentFieldCommon	所有 DocumentField 变体通用的字段。
DocumentFieldSchema	使用 JSON 架构样式语法的字段语义架构的说明。
DocumentFootnote	一个 对象，表示表脚注的位置和内容。
DocumentFormula	提取的公式。
DocumentIntegerField	具有整数值的 DocumentField。
DocumentKeyValueElement	表示字段键或键值对中的值的对象。
DocumentKeyValuePair	表示具有不同字段标签的窗体字段的对象 (键) 和字段值 () 可能为空。
DocumentLanguage	一个 对象，表示给定文本范围检测到的语言。
DocumentLine	一个内容行对象，该对象由相邻的内容元素序列（如字词和选择标记）组成。
DocumentModel	支持提取结构化文档的已知模型规范。 beginAnalyzeDocument请参阅 DocumentAnalysisClient 的方法，该方法支持使用这些DocumentModel对象而不是模型 ID 字符串来提供更强的结果类型。
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：CODE 39 条形码，如 ISO/IEC 16388：2007 中定义。 Code128：CODE 128 条形码，如 ISO/IEC 15417：2007 中定义。 EAN8：GS1 8 位国际物品号 (欧洲文章编号) 。 EAN13：GS1 13 位国际物品号 (欧洲文章编号) 。 DataBar：GS1 DataBar 条形码。 Code93：代码 93 条形码，如 ANSI/AIM BC5-1995 中定义。 Codabar：Codabar 条形码，如 ANSI/AIM BC3-1995 中定义。 DataBarExpanded：GS1 DataBar 扩展条形码。 ITF：交错 2（共 5 个条形码），如 ANSI/AIM BC2-1995 中定义。 MicroQRCode：微 QR 码，如 ISO/IEC 23941：2022 中定义。 Aztec：Aztec 代码，如 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 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 字符串：纯文本。 date：日期，规范化为 ISO 8601 (YYYY-MM-DD) 格式。 time：时间，规范化为 ISO 8601 (hh：mm：ss) 格式。 phoneNumber：电话号码，规范化为 E.164 (+{CountryCode}{SubscriberNumber}) 格式。 number：浮点数，规范化为双精度浮点。 integer：整数，规范化为 64 位带符号整数。 selectionMark：是否选择了字段？ countryRegion：国家/地区，规范化为 ISO 3166-1 alpha-3 格式， (例如 USA) 。 签名：签名是否存在？ array：相同类型的子字段列表。 对象：可能不同类型的子字段的命名列表。 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 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已签名：检测到签名。 unsigned：未检测到签名。
DocumentTableCellKind	定义 DocumentTableCellKind 的值。 KnownDocumentTableCellKind 可与 DocumentTableCellKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 content：包含main内容/数据。 rowHeader：描述行的内容。 columnHeader：描述列的内容。 存根头：描述通常位于表格左上角的行标题。 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 的已知值。