Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2023-07-31

建置自定義檔分類器。

POST {endpoint}/formrecognizer/documentClassifiers:build?api-version=2023-07-31

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string url	支援的認知服務端點 (通訊協定和主機名，例如： https://westus2.api.cognitive.microsoft.com) 。
api-version	query	True	string	要求的 API 版本。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string	Azure 認知服務訂用帳戶的秘密密鑰。

要求本文

名稱	必要	類型	Description
classifierId	True	string	唯一的檔分類器名稱。
docTypes	True	<string,  ClassifierDocumentTypeDetails>	要分類的檔案類型清單。
description		string	檔分類器描述。

回應

名稱	類型	Description
202 Accepted		要求已順利排入佇列。 Headers Operation-Location: string
Other Status Codes	ErrorResponse	發生錯誤。

安全性

Ocp-Apim-Subscription-Key

Azure 認知服務訂用帳戶的秘密密鑰。

Type: apiKey
In: header

範例

Build Document Classifier

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers:build?api-version=2023-07-31

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

定義

名稱	Description
AzureBlobContentSource	Azure Blob 儲存體 內容。
AzureBlobFileListContentSource	Azure Blob 儲存體 中的檔案清單。
BuildDocumentClassifierRequest	要求本文以建置新的自定義檔分類器。
ClassifierDocumentTypeDetails	分類器檔類型資訊。
Error	錯誤資訊。
ErrorResponse	錯誤回應物件。
InnerError	詳細的錯誤。

AzureBlobContentSource

Azure Blob 儲存體 內容。

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

AzureBlobFileListContentSource

Azure Blob 儲存體 中的檔案清單。

名稱	類型	Description
containerUrl	string	Azure Blob 儲存體 容器 URL。
fileList	string	容器中 JSONL 檔案的路徑，指定用於定型的檔案子集。

BuildDocumentClassifierRequest

要求本文以建置新的自定義檔分類器。

名稱	類型	Description
classifierId	string	唯一的檔分類器名稱。
description	string	檔分類器描述。
docTypes	<string,  ClassifierDocumentTypeDetails>	要分類的檔案類型清單。

ClassifierDocumentTypeDetails

分類器檔類型資訊。

名稱	類型	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob 儲存體 檔案清單，指定分類器檔類型的定型數據。 必須指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource	AzureBlobContentSource	Azure Blob 儲存體 包含分類器檔類型定型數據的位置。 必須指定 azureBlobSource 或 azureBlobFileListSource。

Error

錯誤資訊。

名稱	類型	Description
code	string	錯誤碼。
details	Error[]	詳細錯誤清單。
innererror	InnerError	詳細的錯誤。
message	string	錯誤訊息。
target	string	錯誤的目標。

ErrorResponse

錯誤回應物件。

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

InnerError

詳細的錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	InnerError	詳細的錯誤。
message	string	錯誤訊息。