formrecognizer 套件
套件
| aio |
類別
| AccountProperties |
帳戶上所有自訂模型的摘要。 2.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 |
表示定型的模型。 2.1 版的新功能： model_name 和 屬性 屬性、 to_dict 和 from_dict 方法的支援 |
| CustomFormModelField |
模型將從其分析的表單中擷取的欄位。 2.1 版的新功能：支援 to_dict 和 from_dict 方法 |
| CustomFormModelInfo |
自訂模型資訊。 2.1 版的新功能： model_name 和 屬性 屬性、 to_dict 和 from_dict 方法的支援 |
| CustomFormModelProperties |
選擇性的模型屬性。 2.1 版的新功能：支援 to_dict 和 from_dict 方法 |
| CustomFormSubmodel |
表示從特定表單類型擷取欄位的子模型。 2.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和 bool 值 |
| 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 |
檔模型資訊的摘要，包括模型識別碼、其描述，以及建立模型的時間。 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 |
由連續字元序列組成的 word 物件。 對於非空格分隔的語言，例如中文、日文和韓文，每個字元都會以自己的單字表示。 |
| FieldData |
包含表單欄位的資料。 這包括文字、表單上文字的位置，以及組成文字的元素集合。 v2.1 版的新功能： FormSelectionMark 會新增至field_elements清單中傳回的類型、支援 to_dict 和 from_dict 方法 |
| FormElement |
包含表單專案屬性的基底類型。 2.1 版的新功能：支援 to_dict 和 from_dict 方法 |
| FormField |
表示在輸入表單中辨識的欄位。 2.1 版的新功能：支援 to_dict 和 from_dict 方法 |
| FormLine |
物件，表示擷取的文字行。 2.1 版的新功能： 外觀 屬性、 to_dict 和 from_dict 方法的支援 |
| FormPage |
表示從輸入檔辨識的頁面。 包含行、單字、選取標記、資料表和頁面中繼資料。 2.1 版的新功能： selection_marks 屬性、 to_dict 和 from_dict 方法的支援 |
| FormPageRange |
表單的 1 頁範圍。 2.1 版的新功能：支援 to_dict 和 from_dict 方法 |
| FormRecognizerClient |
FormRecognizerClient 會將表單和影像中的資訊擷取到結構化資料中。 介面可用來分析預先建置的模型， (收據、名片、發票、身分識別檔) 、辨識表單的內容/配置，以及從定型模型分析自訂表單。 它會根據 URL 的輸入和來自資料流程的輸入，提供不同的方法。 注意 FormRecognizerClient 應該與 API 版本 < =v2.1 搭配使用。 若要使用 API 版本 2022-08-31 和更新版本，請具現化 DocumentAnalysisClient。 |
| FormRecognizerError |
表示定型時發生的錯誤。 2.1 版的新功能：支援 to_dict 和 from_dict 方法 |
| FormSelectionMark |
擷取選取標記的相關資訊。 2.1 版的新功能：支援 to_dict 和 from_dict 方法 |
| FormTable |
頁面上所包含之擷取資料表的相關資訊。 2.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 |
表示從輸入檔辨識的字組。 2.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.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> 模型。 若要瞭解作業失敗的原因，請使用 <xref:azure.ai.formrecognizer.get_operation> 並提供 operation_id。 2023-07-31 版的新功能： documentClassifierBuild 種類。 |
| Point |
周框方塊或多邊形上點的 x、Y 座標。 2.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 |
物件，表示文字行的外觀。 2.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 |
上傳的內容類型。 2.1 版的新功能：支援 image/bmp |
| FormRecognizerApiVersion |
表格辨識器 FormRecognizerClient 和 FormTrainingClient 支援的 API 版本。 |
| LengthUnit |
寬度、高度和周框方塊屬性所使用的單位。 針對影像，單位為「圖元」。 若為 PDF，則單位為 「inch」。 |
| ModelBuildMode |
建置自訂模型時所使用的模式。 |
| TrainingStatus |
定型作業的狀態。 |
