Document Models - Analyze Document

Szolgáltatás:

Azure AI Services

API-verzió:

2023-07-31

Dokumentum elemzése dokumentummodellel.

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

Opcionális paraméterekkel:

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. Reguláris kifejezési minta: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Kért API-verzió.
features	query		DocumentAnalysisFeature[]	A választható elemzési funkciók listája.
locale	query		string	Területi beállítási javaslat 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" Reguláris kifejezési minta: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	A sztringek eltolásának és hosszának kiszámítására 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	Elemezni kívánt 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 várólistára helyezése sikeresen megtörtént. Fejlécek 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.

Típus: apiKey
In: header

Példák

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Mintakérelem

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"
}

Mintaválasz

Állapotkód:

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

Mintakérelem

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"
}

Mintaválasz

Állapotkód:

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	A választható elemzési funkciók listája.
Error	Hibaadatok.
ErrorResponse	Hibaválasz-objektum.
InnerError	Részletes hiba.
StringIndexType	A sztringek eltolásának és hosszának kiszámítására 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	Elemezni kívánt dokumentum URL-címe. Meg kell adni az urlSource vagy a base64Source értéket.

DocumentAnalysisFeature

A 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	Az OCR nagyobb felbontásban történő végrehajtása a dokumentumok finom nyomtatással történő kezeléséhez.
styleFont	string	Különböző betűstílusok felismerésének engedélyezése.

Error

Hibaadatok.

Name	Típus	Description
code	string	Hibakód.
details	Error[]	A 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	Hibaadatok.

InnerError

Részletes hiba.

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

StringIndexType

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

Name	Típus	Description
textElements	string	Felhasználó által érzékelt megjelenítési karakter vagy gráffürt, a Unicode 8.0.0-s verziójában meghatározottak szerint.
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. JavaScript, Java és .NET által használt.