Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2023-07-31

A dokumentumot a dokumentummodellel elemzi.

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

With optional parameters:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string url	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	string	Kért API-verzió.
features	query		DocumentAnalysisFeature[]	Választható elemzési funkciók listája.
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", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string	Az Azure Cognitive Services-előfizetés titkos kulcsa.

Kérelem törzse

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Name	Típus	Description
base64Source	string	Az elemezni kívánt dokumentum Base64-kódolása. Meg kell adni az urlSource vagy a base64Source értéket.
urlSource	string	Elemezendő dokumentum URL-címe. Meg kell adni az urlSource vagy a base64Source értéket.

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

Az Azure Cognitive Services-előfizetés titkos kulcsa.

Type: apiKey
In: header

Példák

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Analyze Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

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

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Definíciók

Name	Description
AnalyzeDocumentRequest	Dokumentumelemzési paraméterek.
DocumentAnalysisFeature	Választható elemzési funkciók listája.
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. Meg kell adni az urlSource vagy a base64Source értéket.
urlSource	string	Elemezendő dokumentum URL-címe. Meg kell adni az urlSource vagy a base64Source értéket.

DocumentAnalysisFeature

Választható elemzési funkciók listája.

Name	Típus	Description
barcodes	string	Engedélyezze a vonalkódok észlelését a dokumentumban.
formulas	string	Matematikai kifejezések észlelésének engedélyezése a dokumentumban.
keyValuePairs	string	Engedélyezze az általános kulcsértékpárok (űrlapmezők) észlelését a dokumentumban.
languages	string	Engedélyezze a szöveges tartalom nyelvének észlelését.
ocrHighResolution	string	Hajtsa végre az OCR-t nagyobb felbontásban a dokumentumok finom nyomtatással való kezeléséhez.
styleFont	string	Engedélyezze a különböző betűstílusok felismerését.

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	A Unicode 8.0.0 által meghatározott felhasználói megjelenítési karakter vagy grapheme-fürt.
unicodeCodePoint	string	Egyetlen Unicode-kódpont által képviselt karakteregység. A Python 3 használja.
utf16CodeUnit	string	Egy 16 bites Unicode-kódegység által képviselt karakteregység. A JavaScript, a Java és a .NET által használt.