Analyzers - Analyze Binary

服務:

Azure AI Services

API 版本:

2024-12-01-preview

從輸入擷取內容和欄位。

POST {endpoint}/contentunderstanding/analyzers/{analyzerId}:analyze?_overload=analyzeBinary&api-version=2024-12-01-preview

URI 參數

名稱	位於	必要	類型	Description
analyzerId	path	True	string	分析器的唯一標識碼。 Regex 模式: ^[a-zA-Z0-9._-]{1,64}$
endpoint	path	True	string uri	Content Understanding 服務端點。
api-version	query	True	string	要用於這項作業的 API 版本。

要求標頭

名稱	必要	類型	Description
Operation-Id		string	用戶端提供的 GUID，用來識別長時間執行的作業。
x-ms-client-request-id		string uuid	要求不透明、全域唯一、用戶端產生的字串標識碼。

要求本文

名稱	類型	Description
input	string	要分析的檔二進位內容。

回應

名稱	類型	Description
202 Accepted		要求已接受進行處理，但尚未完成處理。 標題 Operation-Id: string Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

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

範例

Analyze File

範例要求

HTTP

POST {endpoint}/contentunderstanding/analyzers/myAnalyzer:analyze?_overload=analyzeBinary&api-version=2024-12-01-preview


"RXhhbXBsZSBGaWxl"

範例回覆

狀態碼:

202

Operation-Id: 3b31320d-8bab-4f88-b19c-2322a7f11034
Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzers/myAnalyzer/results/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-12-01-preview

{
  "id": "3b31320d-8bab-4f88-b19c-2322a7f11034",
  "status": "NotStarted"
}

定義

名稱	Description
Azure.Core.Foundations.Error	error 物件。
Azure.Core.Foundations.ErrorResponse	包含錯誤詳細數據的回應。
Azure.Core.Foundations.InnerError	物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

Azure.Core.Foundations.Error

error 物件。

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

Azure.Core.Foundations.ErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	error 物件。

Azure.Core.Foundations.InnerError

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。