Document Classifiers - Get Classifier

服務:

Azure AI Services

API 版本:

2024-07-31-preview

取得詳細的文件分類器資訊。

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}?api-version=2024-07-31-preview

URI 參數

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

要求標頭

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

回應

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

安全性

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 Document Classifier

範例要求

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier?api-version=2024-07-31-preview

範例回覆

狀態碼:

200

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "createdDateTime": "2022-07-30T00:00:00Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-07-31-preview",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "fileList": "formB.jsonl"
      }
    }
  }
}

定義

名稱	Description
AzureBlobContentSource	Azure Blob 記憶體內容。
AzureBlobFileListContentSource	Azure Blob 記憶體中的檔案清單。
ClassifierDocumentTypeDetails	分類器檔類型資訊。
ContentSourceKind	內容類型。
DocumentClassifierDetails	檔分類器資訊。
Error	error 物件。
ErrorResponse	錯誤回應物件。
InnerError	物件，包含有關錯誤的更特定資訊。
Warning	error 物件。

AzureBlobContentSource

Azure Blob 記憶體內容。

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

AzureBlobFileListContentSource

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

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

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 上的內容。

DocumentClassifierDetails

檔分類器資訊。

名稱	類型	Description
apiVersion	string	用來建立此文件分類器的 API 版本。
baseClassifierId	string	分類器訓練的基底分類器標識碼。
classifierId	string	唯一的檔分類器名稱。
createdDateTime	string	建立文件分類器的日期和時間 （UTC）。
description	string	檔分類器描述。
docTypes	<string,  ClassifierDocumentTypeDetails>	要分類的檔案類型清單。
expirationDateTime	string	檔分類器到期的日期和時間（UTC）。
warnings	Warning[]	建置分類器時遇到的警告清單。

Error

error 物件。

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

ErrorResponse

錯誤回應物件。

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

InnerError

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

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

Warning

error 物件。

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