Analyzer - Analyze Invoice

服務:

Azure AI Services

API 版本:

2.1

從指定的發票檔擷取域文字和語意值。 輸入文件必須是其中一種支援的內容類型 ：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。 或者，使用 'application/json' 類型指定要分析之檔的位置 （Uri）。

POST {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyze

含選擇性參數:

POST {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyze?includeTextDetails={includeTextDetails}&locale={locale}&pages={pages}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點（通訊協定和主機名，例如：https://westus2.api.cognitive.microsoft.com）。
includeTextDetails	query		boolean	在結果中包含文字行和項目參考。
locale	query		Locale	輸入文件的地區設定。 支援的地區設定包括：en-AU、en-CA、en-GB、en-IN、en-US（預設值）。
pages	query		string[]	多頁檔的自定義頁碼（PDF/TIFF），輸入您想要取得 OCR 結果的頁面數目。 針對頁面範圍，請使用連字元。 以逗號分隔每個頁面或範圍。

要求標頭

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string

要求本文

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

名稱	類型	Description
source	string minLength: 0 maxLength: 2048	檔案來源路徑。

回應

名稱	類型	Description
202 Accepted		要求已成功排入佇列。 標題 Operation-Location: string
Other Status Codes	ErrorResponse	隨附非成功回應的響應實體，其中包含有關錯誤的其他詳細數據。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

Analyze receipt

範例要求

HTTP

POST {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyze

範例回覆

狀態碼:

202

Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

定義

名稱	Description
ErrorInformation
ErrorResponse
Locale	輸入文件的地區設定。 支援的地區設定包括：en-AU、en-CA、en-GB、en-IN、en-US（預設值）。
SourcePath	源數據的 URI 或本機路徑。

ErrorInformation

Object

名稱	類型	Description
code	string
message	string

ErrorResponse

Object

名稱	類型	Description
error	ErrorInformation

Locale

列舉型別

輸入文件的地區設定。 支援的地區設定包括：en-AU、en-CA、en-GB、en-IN、en-US（預設值）。

值	Description
en-AU
en-CA
en-GB
en-IN
en-US

SourcePath

Object

源數據的 URI 或本機路徑。

名稱	類型	Description
source	string minLength: 0 maxLength: 2048	檔案來源路徑。