共用方式為


Document Classifiers - Classify Document

使用檔案分類器將檔分類。

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-07-31-preview
POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-07-31-preview&stringIndexType={stringIndexType}&split={split}&pages={pages}

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 版本。

pages
query

string

要分析的 1 頁碼清單。 前任。 "1-3,5,7-9"

Regex 模式: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$

split
query

SplitMode

檔分割模式。

stringIndexType
query

StringIndexType

用來計算字串位移和長度的方法。

要求本文

名稱 類型 Description
base64Source

string

要分類之檔的Base64編碼方式。 必須指定urlSource或base64Source。

urlSource

string

要分類的檔URL。 必須指定urlSource或base64Source。

回應

名稱 類型 Description
202 Accepted

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

標題

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

範例

Classify Document from Url

範例要求

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/classifierId:analyze?_overload=classifyDocument&api-version=2024-07-31-preview&stringIndexType=textElements

{
  "urlSource": "http://host.com/doc.pdf"
}

範例回覆

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview

定義

名稱 Description
ClassifyDocumentRequest

檔分類參數。

Error

error 物件。

ErrorResponse

錯誤回應物件。

InnerError

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

SplitMode

檔案分割行為。

StringIndexType

用來計算字串位移和長度的方法。

ClassifyDocumentRequest

檔分類參數。

名稱 類型 Description
base64Source

string

要分類之檔的Base64編碼方式。 必須指定urlSource或base64Source。

urlSource

string

要分類的檔URL。 必須指定urlSource或base64Source。

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

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

SplitMode

檔案分割行為。

名稱 類型 Description
auto

string

自動將檔案分割成檔。

none

string

將整個檔案視為單一檔。

perPage

string

將檔案中的每個頁面視為個別的檔。

StringIndexType

用來計算字串位移和長度的方法。

名稱 類型 Description
textElements

string

使用者感知的顯示字元或 grapheme 叢集,如 Unicode 8.0.0 所定義。

unicodeCodePoint

string

以單一 Unicode 字碼點表示的字元單位。 由 Python 3 使用。

utf16CodeUnit

string

以16位Unicode字碼單位表示的字元單位。 由 JavaScript、Java 和 .NET 使用。