@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	Azure Blob 容器和容器內 JSONL 檔案清單所定義的定型數據源。
AzureBlobFileListSourceDetails	Azure Blob 記憶體中的檔案清單。
AzureBlobSource	Azure Blob 容器所定義的定型數據源。
AzureBlobSourceDetails	Azure Blob 記憶體內容。
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	具有 Date 值的 DocumentField。
DocumentFieldCommon	所有 DocumentField 變體通用的欄位。
DocumentFieldSchema	使用 JSON 架構樣式語法的欄位語意架構描述。
DocumentFootnote	物件，表示表格腳註的位置和內容。
DocumentFormula	擷取的公式。
DocumentIntegerField	具有整數值的 DocumentField。
DocumentKeyValueElement	物件，表示索引鍵/值組中的欄位索引鍵或值。
DocumentKeyValuePair	物件，代表具有不同欄位卷標的表單域（索引鍵）和域值（可能是空的）。
DocumentLanguage	物件，表示指定文字範圍的偵測到語言。
DocumentLine	內容行物件，由相鄰的內容元素序列組成，例如文字和選取標記。
DocumentModel	支援擷取結構化檔的已知模型規格。 請參閱 documentAnalysisClient beginAnalyzeDocument 方法，其支援使用這些 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	由連續字元序列組成的 word 物件。 對於非空格分隔的語言，例如中文、日文和韓文，每個字元都會以自己的單字表示。
ErrorModel	錯誤資訊。
GetCopyAuthorizationOptions	取得複製授權方法的選項。
GetModelOptions	擷取模型信息的選項。
GetOperationOptions	擷取作業狀態的選項。
GetResourceDetailsOptions	擷取窗體辨識器資源信息的選項。
HasBoundingPolygon	文字、選取標記和線條等簡單檔元素會由多邊形系結。
InnerError	詳細的錯誤。
ListModelsOptions	列出模型的選項。
ListOperationsOptions	列出作業的選項。
ModelAdministrationOperationStateCommon	所有系統管理作業通用的欄位集。
OperationDetails	取得作業回應物件。
OperationSummary	作業資訊。
Point2D	表示用來定義周框多邊形的點。 單位為「圖元」或「英吋」（請參閱 LengthUnit）。
PollerOptions	表單辨識器用戶端中長時間執行作業的選項（輪詢器）。
QuotaDetails	已使用配額、限制及下一次重設日期/時間。
ResourceDetails	目前資源的一般資訊。

類型別名

AnalysisPoller	追蹤分析作業狀態的長時間執行作業 （poller），最終會產生對應至模型的結果類型。
AnalyzeResultOperationStatus	定義 AnalyzeResultOperationStatus 的值。
DocumentBarcodeKind	定義 DocumentBarcodeKind 的值。 KnownDocumentBarcodeKind 可以與 DocumentBarcodeKind 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 QRCode：QR 代碼，如 ISO/IEC 18004：2015 中所定義。 PDF417:P DF417，如 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：Code 93 條碼，如 ANSI/AIM BC5-1995 中所定義。 Codabar：Codabar 條碼，如 ANSI/AIM BC3-1995 中所定義。 DataBarExpanded：GS1 DataBar 展開條碼。 ITF：交錯 2/5 條碼，如 ANSI/AIM BC2-1995 中所定義。 MicroQRCode：Micro 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	追蹤自定義分類器建立作業狀態的長時間執行作業 （poller），最終會產生 DocumentClassifierDetails。
DocumentClassifierSource	可用來建置文件分類器的內容來源。 其中一個： BlobSource （Blob源） BlobFileList源
DocumentField	擷取的欄位。 kind 屬性會識別 DocumentField的類型（區分）。
DocumentFieldType	定義 DocumentFieldType 的值。 KnownDocumentFieldType 可與 DocumentFieldType 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 字串：純文字。 日期：日期，標準化為 ISO 8601（YYYY-MM-DD） 格式。 時間：時間，標準化為 ISO 8601 （hh：mm：ss） 格式。 phoneNumber：電話號碼，標準化為 E.164 （+{CountryCode}{SubscriberNumber}） 格式。 數位：浮點數，標準化為雙精確度浮點數。 整數：整數，標準化為64位帶正負號的整數。 selectionMark：是否選取字段？ countryRegion：國家/地區，標準化為 ISO 3166-1 alpha-3 格式（例如美國）。 簽章：簽章存在嗎？ 陣列：相同類型的子欄位清單。 物件：可能不同類型子欄位的具名清單。 貨幣：具有選擇性貨幣符號和單位的貨幣金額。 位址：剖析的位址。 布爾值：布爾值，正規化為 true 或 false。
DocumentFormulaKind	定義 DocumentFormulaKind 的值。 KnownDocumentFormulaKind 可以與 DocumentFormulaKind 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 內嵌：內嵌在段落內容中的公式。 顯示：顯示模式中的公式會佔用整行。
DocumentModelBuildMode	支援的模型建置模式。 模型建置模式會根據加上標籤的定型數據，選取服務用來定型模型的引擎。 選項包括： “neural”，其會產生最高品質的模型，能夠從具有相同數據結構的文件類別擷取數據，但不同的版面配置（例如，W2 稅單，可能會因公司而異，但一律包含相同的資訊）。 “template”，這需要所有檔具有相同的固定版面配置（範本）。 如需詳細資訊，請參閱下列連結：https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	追蹤模型建立作業狀態的長時間執行作業 （poller），最終會產生 DocumentModelDetails。
DocumentModelSource	可用來建置檔模型的內容來源。 其中一個： BlobSource （Blob源） BlobFileList源
DocumentSignatureType	定義 DocumentSignatureType 的值。 KnownDocumentSignatureType 可以與 DocumentSignatureType 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 簽署：偵測到簽章。 未簽署的：不會偵測到簽章。
DocumentTableCellKind	定義 DocumentTableCellKind 的值。 KnownDocumentTableCellKind 可以與 DocumentTableCellKind 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 內容：包含主要內容/數據。 rowHeader：描述數據列的內容。 columnHeader：描述數據行的內容。 stubHead：描述數據列標頭，通常位於表格左上角。 描述：描述數據表中（部分）的內容。
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	定義表單識別器的已知雲受眾。 要在 TokenCredential 環境中使用 Entra ID（使用 ）進行身份驗證，請在創建 audience 或 DocumentAnalysisClient時提供以下適當的值作為DocumentModelAdministrationClient選項。 默認值適用於在 Azure 公有雲中創建的表單識別器資源，因此只有在不同的雲環境中使用表單識別器時才需要此值。
KnownLengthUnit	服務接受的已知 LengthUnit 值。
KnownOperationKind	服務的已知值 OperationKind。
KnownParagraphRole	服務接受的 ParagraphRole 已知值。
KnownSelectionMarkState	服務的已知值 SelectionMarkState。