共用方式為

Document Classifiers - Build Classifier

  • 參考
服務:
Azure AI Services
API 版本:
2024-11-30

建置自定義檔分類器。

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-11-30

URI 參數

名稱 位於 必要 類型 Description
endpoint
 path True

string

uri

Document Intelligence 服務端點。
api-version
 query True

string

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

要求本文

名稱 必要 類型 Description
classifierId True

string

唯一的檔分類器名稱。
docTypes True

<string,  ClassifierDocumentTypeDetails>

要分類的檔案類型清單。
allowOverwrite

boolean

允許以相同名稱覆寫現有的分類器。
baseClassifierId

string

要定型分類器的基底 classifierId。
description

string

檔分類器描述。

回應

名稱 類型 Description
202 Accepted

要求已接受進行處理，但尚未完成處理。

標題

  • Operation-Location: string
  • Retry-After: integer
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

範例

Build Document Classifier

範例要求

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers:build?api-version=2024-11-30

{
  "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"
      }
    }
  }
}

範例回覆

狀態碼:
202 
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30

定義

名稱 Description
AzureBlobContentSource

Azure Blob 記憶體內容。
AzureBlobFileListContentSource

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

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

分類器檔類型資訊。
ContentSourceKind

內容類型。
DocumentIntelligenceError

error 物件。
DocumentIntelligenceErrorResponse

錯誤回應物件。
DocumentIntelligenceInnerError

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

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
allowOverwrite

boolean

False

允許以相同名稱覆寫現有的分類器。
baseClassifierId

string

要定型分類器的基底 classifierId。
classifierId

string

唯一的檔分類器名稱。
description

string

檔分類器描述。
docTypes

<string,  ClassifierDocumentTypeDetails>

要分類的檔案類型清單。

ClassifierDocumentTypeDetails

分類器檔類型資訊。

名稱 類型 Description
azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob 記憶體檔案清單，指定分類器檔類型的定型數據。 必須指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource

AzureBlobContentSource

Azure Blob 記憶體位置，其中包含分類器檔類型的定型數據。 必須指定 azureBlobSource 或 azureBlobFileListSource。
sourceKind

ContentSourceKind

定型數據源的類型。

ContentSourceKind

內容類型。

名稱 類型 Description
azureBlob

string

Azure Blob 記憶體容器內路徑中的檔案。
azureBlobFileList

string

指定 Azure Blob 記憶體容器中個別檔案的檔案清單。
base64

string

透過Base64編碼表示的內容。
url

string

特定 URL 上的內容。

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

錯誤的人類可讀取表示法。