你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
formrecognizer 包
包
| aio |
类
| AccountProperties |
帐户上所有自定义模型的摘要。 版本 v2.1 中的新增功能：支持 to_dict 和 from_dict 方法 |
| AddressValue |
地址字段值。 版本 2023-07-31 中的新增功能： 单位、 city_district、 state_district、 郊区、 房屋和 级别 属性。 |
| AnalyzeResult |
文档分析结果。 |
| AnalyzedDocument |
描述文档的位置和语义内容的 对象。 |
| BlobFileListSource |
Azure Blob 存储中文件列表的内容源。 |
| BlobSource |
Azure Blob 存储的内容源。 |
| BoundingRegion |
对应于页面的边界区域。 |
| ClassifierDocumentTypeDetails |
训练数据源。 |
| CurrencyValue |
货币值元素。 版本 2023-07-31 中的新增功能： 代码 属性。 |
| CustomDocumentModelsDetails |
有关表单识别器资源下的自定义模型的详细信息。 |
| CustomFormModel |
表示已训练的模型。 版本 v2.1 中的新增功能： model_name 和 属性 属性，支持 to_dict 和 from_dict 方法 |
| CustomFormModelField |
模型将从分析的表单中提取的字段。 版本 v2.1 中的新增功能：支持 to_dict 和 from_dict 方法 |
| CustomFormModelInfo |
自定义模型信息。 版本 v2.1 中的新增功能： model_name 和 属性 属性，支持 to_dict 和 from_dict 方法 |
| CustomFormModelProperties |
可选模型属性。 版本 v2.1 中的新增功能：支持 to_dict 和 from_dict 方法 |
| CustomFormSubmodel |
表示从特定类型的表单中提取字段的子模型。 版本 v2.1 中的新增功能： model_id 属性，支持 to_dict 和 from_dict 方法 |
| DocumentAnalysisClient |
DocumentAnalysisClient 分析文档和图像中的信息，并对文档进行分类。 它是一个接口，用于通过预生成模型分析 (收据、名片、发票、标识文档等) 、分析文档布局、分析常规文档类型以及使用生成模型分析自定义文档 (查看服务支持的模型的完整列表，请参阅： https://aka.ms/azsdk/formrecognizer/models) 。 它根据 URL 中的输入和来自流的输入提供不同的方法。 注意 DocumentAnalysisClient 应与 API 版本一起使用 2022-08-31 及最新版。 若要使用 API 版本 <=v2.1，请实例化 FormRecognizerClient。 版本 2022-08-31 中的新增功能： DocumentAnalysisClient 及其客户端方法。 |
| DocumentAnalysisError |
DocumentAnalysisError 包含服务返回的错误的详细信息。 |
| DocumentAnalysisInnerError |
DocumentAnalysisError 的内部错误详细信息。 |
| DocumentBarcode |
条形码对象。 |
| DocumentClassifierDetails |
文档分类器信息。 包括模型可分类的文档类型。 |
| DocumentField |
一个 对象，表示文档字段值的内容和位置。 版本 2023-07-31 中的新增功能： 布尔 值value_type和 布尔 值 |
| DocumentFormula |
公式对象。 |
| DocumentKeyValueElement |
表示字段键或键值对中的值的对象。 |
| DocumentKeyValuePair |
表示具有不同字段标签的文档字段的对象 (键) 和字段值 (可能为空) 。 |
| DocumentLanguage |
一个 对象，表示给定文本范围检测到的语言。 |
| DocumentLine |
一个内容行对象，该对象表示在文档的单行中找到的内容。 |
| DocumentModelAdministrationClient |
DocumentModelAdministrationClient 是用于生成和管理模型的表单识别器接口。 它提供用于生成模型和分类器的方法，以及用于查看和删除模型和分类器、查看模型和分类器操作、访问帐户信息、将模型复制到另一个表单识别器资源以及从现有模型集合撰写新模型的方法。 注意 DocumentModelAdministrationClient 应与 API 版本一起使用 2022-08-31 及最新版。 若要使用 API 版本 <=v2.1，请实例化 FormTrainingClient。 版本 2022-08-31 中的新增功能： DocumentModelAdministrationClient 及其客户端方法。 |
| DocumentModelAdministrationLROPoller |
实现一个协议，后跟返回的轮询器对象。 |
| DocumentModelDetails |
文档模型信息。 包括模型可以分析的文档类型。 版本 2023-07-31 中的新增功能： expires_on 属性。 |
| DocumentModelSummary |
文档模型信息的摘要，包括模型 ID、其说明以及创建模型时。 版本 2023-07-31 中的新增功能： expires_on 属性。 |
| DocumentPage |
从输入页中提取的内容和布局元素。 版本 2023-07-31 中的新增功能： 条形码和 公式 属性。 |
| DocumentParagraph |
一个段落对象，通常由具有共同对齐和间距的连续行组成。 版本 2023-07-31 中的新增功能： formulaBlock 角色。 |
| DocumentSelectionMark |
一个选择标记对象，表示检查框、单选按钮和其他指示所选内容的元素。 |
| DocumentSpan |
属性内容的连续区域，指定为偏移量和长度。 |
| DocumentStyle |
表示观察到的文本样式的 对象。 版本 2023-07-31 中的新增功能： similar_font_family、 font_style、 font_weight、 颜色和 background_color 属性。 |
| DocumentTable |
由以矩形布局排列的表格单元格组成的表对象。 |
| DocumentTableCell |
一个对象，表示表格单元格的位置和内容。 |
| DocumentTypeDetails |
DocumentTypeDetails 表示模型可以识别的文档类型，包括其字段和类型，以及这些字段的置信度。 |
| DocumentWord |
由连续字符序列组成的单词对象。 对于非空格分隔语言（如中文、日语和朝鲜语），每个字符都表示为自己的单词。 |
| FieldData |
包含表单域的数据。 这包括文本、窗体上文本的位置以及组成文本的元素的集合。 版本 v2.1 中的新增功能： FormSelectionMark 添加到field_elements列表中返回的类型，支持 to_dict 和 from_dict 方法 |
| FormElement |
包含窗体元素的属性的基类型。 版本 v2.1 中的新增功能：支持 to_dict 和 from_dict 方法 |
| FormField |
表示在输入表单中识别的字段。 版本 v2.1 中的新增功能：支持 to_dict 和 from_dict 方法 |
| FormLine |
表示提取的文本行的 对象。 版本 v2.1 中的新增功能： 外观 属性、 对to_dict 和 from_dict 方法的支持 |
| FormPage |
表示从输入文档识别的页面。 包含行、字词、选择标记、表和页面元数据。 版本 v2.1 中的新增功能： selection_marks 属性、 对to_dict 和 from_dict 方法的支持 |
| FormPageRange |
窗体的从 1 开始的页面范围。 版本 v2.1 中的新增功能：支持 to_dict 和 from_dict 方法 |
| FormRecognizerClient |
FormRecognizerClient 将表单和图像中的信息提取到结构化数据中。 它是一个接口，用于通过预生成模型进行分析， (收据、名片、发票、标识文档) 、从表单中识别内容/布局，以及分析已训练模型中的自定义表单。 它根据 URL 中的输入和来自流的输入提供不同的方法。 注意 FormRecognizerClient 应与 API 版本 <=v2.1 一起使用。 若要使用 API 版本 2022-08-31 及更新版本，请实例化 DocumentAnalysisClient。 |
| FormRecognizerError |
表示训练时发生的错误。 版本 v2.1 中的新增功能：支持 to_dict 和 from_dict 方法 |
| FormSelectionMark |
有关提取的选择标记的信息。 v2.1 版中的新增功能：支持 to_dict 和 from_dict 方法 |
| FormTable |
有关页面上包含的提取表的信息。 版本 v2.1 中的新增功能： bounding_box 属性、 对to_dict 和 from_dict 方法的支持 |
| FormTableCell |
表示从输入文档识别的表格中包含的单元格。 版本 v2.1 中的新增功能： FormSelectionMark 已添加到field_elements列表中返回的类型，支持 to_dict 和 from_dict 方法 |
| FormTrainingClient |
FormTrainingClient 是用于创建和管理自定义模型的表单识别器接口。 它提供用于在提供的窗体上训练模型的方法，以及用于查看和删除模型、访问帐户属性、将模型复制到另一个表单识别器资源以及从使用标签训练的现有模型集合中编写模型的方法。 注意 FormTrainingClient 应与 API 版本 <=v2.1 一起使用。 若要使用 API 版本 2022-08-31 及更新版本，请实例化 DocumentModelAdministrationClient。 |
| FormWord |
表示从输入文档中识别的单词。 v2.1 版中的新增功能：支持 to_dict 和 from_dict 方法 |
| OperationDetails |
OperationDetails 包含有关模型操作的信息，包括操作的结果或错误（如果操作已完成）。 请注意，操作信息仅保留 24 小时。 如果操作成功，也可以使用 、、 <xref:azure.ai.formrecognizer.list_document_models><xref:azure.ai.formrecognizer.get_document_classifier><xref:azure.ai.formrecognizer.list_document_classifiers> API 访问<xref:azure.ai.formrecognizer.get_document_model>模型。 版本 2023-07-31 中的新增功能： documentClassifierBuild 类型和 DocumentClassifierDetails 结果。 |
| OperationSummary |
模型操作信息，包括操作的类型和状态、创建时间等。 请注意，操作信息仅保留 24 小时。 如果操作成功，则可以使用 <xref:azure.ai.formrecognizer.get_document_model>、、 <xref:azure.ai.formrecognizer.list_document_models><xref:azure.ai.formrecognizer.get_document_classifier><xref:azure.ai.formrecognizer.list_document_classifiers> API 访问模型。 若要了解操作失败的原因，请使用 <xref:azure.ai.formrecognizer.get_operation> 并提供 operation_id。 版本 2023-07-31 中的新增功能： documentClassifierBuild 类型。 |
| Point |
边界框或多边形上点的 x、y 坐标。 v2.1 版中的新增功能：支持 to_dict 和 from_dict 方法 |
| QuotaDetails |
已用配额、限制和下一次重置日期/时间。 |
| RecognizedForm |
表示已训练或预生成模型已识别的窗体。 fields 属性包含从窗体中提取的表单字段。 表、文本行/字词和选择标记按页提取，并在 pages 属性中找到。 v2.1 版中的新增功能： form_type_confidence 和 model_id 属性、对 to_dict 和 from_dict 方法的支持 |
| ResourceDetails |
有关表单识别器资源的详细信息。 版本 2023-07-31 中的新增功能： neural_document_model_quota 属性。 |
| TextAppearance |
表示文本行外观的 对象。 v2.1 版中的新增功能：支持 to_dict 和 from_dict 方法 |
| TrainingDocumentInfo |
用于训练自定义模型的单个文档的报告。 v2.1 版中的新增功能： model_id 属性、 对to_dict 和 from_dict 方法的支持 |
枚举
| AnalysisFeature |
要启用的文档分析功能。 |
| CustomFormModelStatus |
指示模型可供使用的状态。 |
| DocumentAnalysisApiVersion |
表单识别器 DocumentAnalysisClient 和 DocumentModelAdministrationClient 支持的 API 版本。 |
| FieldValueType |
字段值的语义数据类型。 版本 v2.1 中的新增功能： selectionMark 和 countryRegion 值 |
| FormContentType |
用于上传的内容类型。 版本 v2.1 中的新增功能：支持 image/bmp |
| FormRecognizerApiVersion |
表单识别器 FormRecognizerClient 和 FormTrainingClient 支持的 API 版本。 |
| LengthUnit |
宽度、高度和边界框属性使用的单位。 对于图像，单位为“像素”。 对于 PDF，单位为“英寸”。 |
| ModelBuildMode |
生成自定义模型时使用的模式。 有关详细信息，请参阅 https://aka.ms/azsdk/formrecognizer/buildmode。 |
| TrainingStatus |
训练操作的状态。 |
