Analyzer - Analyze Receipt

Služba:

Azure AI Services

Verze rozhraní API:

2.1

Extrahujte text pole a sémantické hodnoty z daného dokladu účtenky. Vstupní dokument musí mít jeden z podporovaných typů obsahu – "application/pdf", "image/jpeg", "image/png", "image/tiff" nebo "image/bmp". Případně můžete použít typ application/json k určení umístění (URI) dokumentu, který se má analyzovat.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus2.api.cognitive.microsoft.com).
includeTextDetails	query		boolean	Do výsledku zahrňte textové řádky a odkazy na elementy.
locale	query		Locale	Národní prostředí vstupního dokumentu. Mezi podporovaná národní prostředí patří: en-AU, en-CA, en-GB, en-IN, en-US(default).
pages	query		string[]	Vlastní čísla stránek pro vícestránkové dokumenty (PDF/TIFF) zadejte počet stránek, na které chcete získat výsledek OCR. Pro rozsah stránek použijte spojovník. Každou stránku nebo oblast oddělte čárkou.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Text požadavku

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

Name	Typ	Description
source	string	Cesta ke zdroji souboru.

Odpovědi

Name	Typ	Description
202 Accepted		Požadavek se úspěšně zařadil do fronty. Hlavičky Operation-Location: string
Other Status Codes	ErrorResponse	Entita odpovědi doprovázející neúspěšné odpovědi obsahující další podrobnosti o chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

Analyze receipt

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

202

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

Definice

Name	Description
ErrorInformation
ErrorResponse
Locale	Národní prostředí vstupního dokumentu. Mezi podporovaná národní prostředí patří: en-AU, en-CA, en-GB, en-IN, en-US(default).
SourcePath	Identifikátor URI nebo místní cesta ke zdrojovým datům.

ErrorInformation

Name	Typ	Description
code	string
message	string

ErrorResponse

Name	Typ	Description
error	ErrorInformation

Locale

Národní prostředí vstupního dokumentu. Mezi podporovaná národní prostředí patří: en-AU, en-CA, en-GB, en-IN, en-US(default).

Name	Typ	Description
en-AU	string
en-CA	string
en-GB	string
en-IN	string
en-US	string

SourcePath

Identifikátor URI nebo místní cesta ke zdrojovým datům.

Name	Typ	Description
source	string	Cesta ke zdroji souboru.