Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2022-08-31

A dokumentumot a dokumentummodellel elemzi.

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?api-version=2022-08-31

With optional parameters:

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?pages={pages}&locale={locale}&stringIndexType={stringIndexType}&api-version=2022-08-31

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string	Egyedi dokumentummodell neve. Regex pattern: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}
api-version	query	True	ApiVersion	Kért API-verzió.
locale	query		string	Területi tipp a szövegfelismeréshez és a dokumentumelemzéshez. Az érték csak a nyelvi kódot (pl. "en", "fr") vagy BCP 47 nyelvi címkét (pl. "en-US") tartalmazhatja.
pages	query		string	Az elemezni kívánt 1-alapú oldalszámok listája. Pl. "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	A sztring eltolásának és hosszának kiszámításához használt módszer.

Kérelem fejléce

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif"

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string

Kérelem törzse

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif"

Name	Típus	Description
base64Source	string	Az elemezni kívánt dokumentum Base64-kódolása
urlSource	string	Elemezendő dokumentum URL-címe

Válaszok

Name	Típus	Description
202 Accepted		A kérés sikeresen várólistára van helyezve. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Példák

AnalyzeDocument_Base64

AnalyzeDocument_Url

AnalyzeDocument_Base64

Sample Request

HTTP

POST {endpoint}/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2022-08-31

{
  "base64Source": ""
}

Sample Response

Status code:

202

Operation-Location: {endpoint}/formrecognizer/documentModels/prebuilt-layout/analyzeResults/{resultId}?api-version=2022-08-31

AnalyzeDocument_Url

Sample Request

HTTP

POST {endpoint}/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2022-08-31

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

Sample Response

Status code:

202

Operation-Location: {endpoint}/formrecognizer/documentModels/customModel/analyzeResults/{resultId}?api-version=2022-08-31

Definíciók

Name	Description
AnalyzeDocumentRequest	Dokumentumelemzési paraméterek.
ApiVersion	API-verzió.
Error	Hibainformáció.
ErrorResponse	Hibaválasz-objektum.
InnerError	Részletes hiba.
StringIndexType	A sztring eltolásának és hosszának kiszámításához használt módszer.

AnalyzeDocumentRequest

Dokumentumelemzési paraméterek.

Name	Típus	Description
base64Source	string	Az elemezni kívánt dokumentum Base64-kódolása
urlSource	string	Elemezendő dokumentum URL-címe

ApiVersion

API-verzió.

Name	Típus	Description
2022-08-31	string

Error

Hibainformáció.

Name	Típus	Description
code	string	Hibakód.
details	Error[]	Részletes hibák listája.
innererror	InnerError	Részletes hiba.
message	string	Hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz-objektum.

Name	Típus	Description
error	Error	Hibainformáció.

InnerError

Részletes hiba.

Name	Típus	Description
code	string	Hibakód.
innererror	InnerError	Részletes hiba.
message	string	Hibaüzenet.

StringIndexType

A sztring eltolásának és hosszának kiszámításához használt módszer.

Name	Típus	Description
textElements	string
unicodeCodePoint	string
utf16CodeUnit	string