Document Models - Get Model

參考

服務:: Azure AI Services

API 版本:: 2024-11-30

取得詳細的檔模型資訊。

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-11-30

URI 參數

名稱位於必要類型 Description

名稱	位於	必要	類型	Description
endpoint	path	True	string uri	Document Intelligence 服務端點。
modelId	path	True	string	唯一的檔模型名稱。 Regex 模式: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	要用於這項作業的 API 版本。

endpoint

path

True

string

uri

Document Intelligence 服務端點。

modelId

path

True

string

唯一的檔模型名稱。

Regex 模式: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

api-version

query

True

string

要用於這項作業的 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	要求不透明、全域唯一、用戶端產生的字串標識碼。

回應

名稱	類型	Description
200 OK	DocumentModelDetails	要求已成功。標題 x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	未預期的錯誤回應。

名稱

類型

Description

200 OK

DocumentModelDetails

要求已成功。

標題

x-ms-client-request-id: string

Other Status Codes

DocumentIntelligenceErrorResponse

未預期的錯誤回應。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: accessCode
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize
權杖 URL: https://login.microsoftonline.com/common/oauth2/token

範圍

名稱	Description
https://cognitiveservices.azure.com/.default

範例

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

範例要求

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-11-30

範例回覆

狀態碼:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-11-30",
  "docTypes": {
    "myForm": {
      "fieldSchema": {
        "Name": {
          "type": "string"
        },
        "Date": {
          "type": "date"
        },
        "Amount": {
          "type": "number"
        }
      },
      "buildMode": "template",
      "fieldConfidence": {
        "Name": 0.9,
        "Date": 0.95,
        "Amount": 0.93
      }
    }
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Get Prebuilt Document Model

範例要求

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-11-30

範例回覆

狀態碼:: 200

{
  "modelId": "prebuilt-invoice",
  "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.",
  "createdDateTime": "2021-07-30T00:00:00Z",
  "apiVersion": "2024-11-30",
  "docTypes": {
    "prebuilt:invoice": {
      "fieldSchema": {
        "CustomerName": {
          "type": "string"
        },
        "CustomerId": {
          "type": "string"
        },
        "PurchaseOrder": {
          "type": "string"
        },
        "InvoiceId": {
          "type": "string"
        },
        "InvoiceDate": {
          "type": "date"
        },
        "DueDate": {
          "type": "date"
        },
        "VendorName": {
          "type": "string"
        },
        "VendorAddress": {
          "type": "string"
        },
        "VendorAddressRecipient": {
          "type": "string"
        },
        "CustomerAddress": {
          "type": "string"
        },
        "CustomerAddressRecipient": {
          "type": "string"
        },
        "BillingAddress": {
          "type": "string"
        },
        "BillingAddressRecipient": {
          "type": "string"
        },
        "ShippingAddress": {
          "type": "string"
        },
        "ShippingAddressRecipient": {
          "type": "string"
        },
        "SubTotal": {
          "type": "number"
        },
        "TotalTax": {
          "type": "number"
        },
        "InvoiceTotal": {
          "type": "number"
        },
        "AmountDue": {
          "type": "number"
        },
        "PreviousUnpaidBalance": {
          "type": "number"
        },
        "RemittanceAddress": {
          "type": "string"
        },
        "RemittanceAddressRecipient": {
          "type": "string"
        },
        "ServiceAddress": {
          "type": "string"
        },
        "ServiceAddressRecipient": {
          "type": "string"
        },
        "ServiceStartDate": {
          "type": "date"
        },
        "ServiceEndDate": {
          "type": "date"
        },
        "Items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Amount": {
                "type": "number"
              },
              "Date": {
                "type": "date"
              },
              "Description": {
                "type": "string"
              },
              "Quantity": {
                "type": "number"
              },
              "ProductCode": {
                "type": "string"
              },
              "Tax": {
                "type": "number"
              },
              "Unit": {
                "type": "string"
              },
              "UnitPrice": {
                "type": "number"
              }
            }
          }
        }
      }
    }
  },
  "tags": {}
}

定義

名稱	Description
AzureBlobContentSource	Azure Blob 記憶體內容。
AzureBlobFileListContentSource	Azure Blob 記憶體中的檔案清單。
DocumentAnalysisFeature	要啟用的檔分析功能。
DocumentBuildMode	自訂檔案模型建置模式。
DocumentFieldSchema	使用 JSON 架構樣式語法的欄位語意架構描述。
DocumentFieldType	域值的語意數據類型。
DocumentIntelligenceError	error 物件。
DocumentIntelligenceErrorResponse	錯誤回應物件。
DocumentIntelligenceInnerError	物件，包含有關錯誤的更特定資訊。
DocumentIntelligenceWarning	error 物件。
DocumentModelDetails	檔模型資訊。
DocumentTypeDetails	檔類型資訊。
SplitMode	檔案分割行為。

AzureBlobContentSource

Azure Blob 記憶體內容。

名稱	類型	Description
containerUrl	string	Azure Blob 記憶體容器 URL。
prefix	string	Blob 名稱前置詞。

AzureBlobFileListContentSource

Azure Blob 記憶體中的檔案清單。

名稱	類型	Description
containerUrl	string	Azure Blob 記憶體容器 URL。
fileList	string	指定文件子集之容器內的 JSONL 檔案路徑。

DocumentAnalysisFeature

要啟用的檔分析功能。

名稱	類型	Description
barcodes	string	啟用文件中條碼的偵測。
formulas	string	啟用檔中數學表達式的偵測。
keyValuePairs	string	啟用檔中一般索引鍵值組（表單域）的偵測。
languages	string	啟用文字內容語言的偵測。
ocrHighResolution	string	以更高的解析度執行 OCR，以處理具有精細列印的檔。
queryFields	string	透過 queryFields 查詢參數啟用其他欄位的擷取。
styleFont	string	啟用各種字型樣式的辨識。

DocumentBuildMode

自訂檔案模型建置模式。

名稱	類型	Description
neural	string	支援具有各種視覺範本的檔。
template	string	以具有類似視覺範本的檔為目標。

DocumentFieldSchema

使用 JSON 架構樣式語法的欄位語意架構描述。

名稱	類型	Description
description	string	欄位描述。
example	string	範例欄位內容。
items	DocumentFieldSchema	每個數位型態架構。
properties	<string, DocumentFieldSchema>	物件欄位的具名子欄位。
type	DocumentFieldType	域值的語意數據類型。

DocumentFieldType

域值的語意數據類型。

名稱	類型	Description
address	string	剖析的位址。
array	string	相同類型的子欄位清單。
boolean	string	布爾值，標準化為 true 或 false。
countryRegion	string	國家/地區，標準化為 ISO 3166-1 alpha-3 格式（例如美國）。
currency	string	具有選擇性貨幣符號和單位的貨幣金額。
date	string	日期，標準化為 ISO 8601 （YYYY-MM-DD）格式。
integer	string	整數，標準化為64位帶正負號的整數。
number	string	浮點數，標準化為雙精確度浮點數。
object	string	可能不同類型的子欄位具名清單。
phoneNumber	string	電話號碼，標準化為 E.164 （+{CountryCode}{SubscriberNumber}）格式。
selectionGroup	string	選取字串值的陣列。
selectionMark	string	是否選取欄位？
signature	string	簽章是否存在？
string	string	純文本。
time	string	時間，標準化為 ISO 8601 （hh：mm：ss）格式。

DocumentIntelligenceError

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	DocumentIntelligenceError[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	DocumentIntelligenceInnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

DocumentIntelligenceErrorResponse

錯誤回應物件。

名稱	類型	Description
error	DocumentIntelligenceError	錯誤資訊。

DocumentIntelligenceInnerError

物件，包含有關錯誤的更特定資訊。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	DocumentIntelligenceInnerError	內部錯誤。
message	string	錯誤的人類可讀取表示法。

DocumentIntelligenceWarning

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的警告碼。
message	string	人類可讀取的警告表示法。
target	string	錯誤的目標。

DocumentModelDetails

檔模型資訊。

名稱	類型	預設值	Description
apiVersion	string		用來建立此檔模型的 API 版本。
azureBlobFileListSource	AzureBlobFileListContentSource		指定定型數據的 Azure Blob 記憶體檔案清單。必須指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource	AzureBlobContentSource		包含定型數據的 Azure Blob 記憶體位置。必須指定 azureBlobSource 或 azureBlobFileListSource。
buildMode	DocumentBuildMode		自訂檔案模型建置模式。
classifierId	string		針對撰寫的模型，用來分割和分類輸入檔的自定義分類器。
createdDateTime	string		建立檔模型的日期和時間（UTC）。
description	string		檔模型描述。
docTypes	<string, DocumentTypeDetails>		支援的檔案類型。
expirationDateTime	string		檔模型到期的日期和時間（UTC）。
modelId	string		唯一的檔模型名稱。
modifiedDateTime	string		上次修改檔模型的日期和時間（UTC）。
split	SplitMode	none	針對撰寫的模型，檔案分割行為。
tags	object		與檔模型相關聯的索引鍵/值標籤屬性清單。
trainingHours	number		模型定型所耗用的 V100 對等 GPU 時數。
warnings	DocumentIntelligenceWarning[]		建置模型時遇到的警告清單。

DocumentTypeDetails

檔類型資訊。

名稱	類型	Description
buildMode	DocumentBuildMode	自訂檔案模型建置模式。
confidenceThreshold	number	只有在 docType 信賴度高於臨界值時，才執行分析。
description	string	檔模型描述。
features	DocumentAnalysisFeature[]	選擇性分析功能的清單。
fieldConfidence	object	每個欄位的估計信賴度。
fieldSchema	<string, DocumentFieldSchema>	使用 JSON 架構樣式語法的檔語意架構描述。
maxDocumentsToAnalyze	integer	要分析之指定類型的檔案數目上限。 Default=all。
modelId	string	用於分析具有指定類型之檔的檔案模型。
queryFields	string[]	要擷取的其他欄位清單。前任。 “NumberOfGuests，StoreNumber”

SplitMode

檔案分割行為。

名稱	類型	Description
auto	string	自動將檔案分割成檔。
none	string	將整個檔案視為單一檔。
perPage	string	將檔案中的每個頁面視為個別的檔。

共用方式為

Document Models - Get Model

URI 參數

要求標頭

回應

安全性

Ocp-Apim-Subscription-Key

OAuth2Auth

範圍

範例

Get Custom Document Model

範例要求

範例回覆

Get Prebuilt Document Model

範例要求

範例回覆

定義

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentAnalysisFeature

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentIntelligenceError

DocumentIntelligenceErrorResponse

DocumentIntelligenceInnerError

DocumentIntelligenceWarning

DocumentModelDetails

DocumentTypeDetails

SplitMode

其他資源