Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Dokumentum elemzése dokumentummodellel.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview

With optional parameters:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A Document Intelligence szolgáltatás végpontja.
modelId	path	True	string	Egyedi dokumentummodell neve. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	A művelethez használandó 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.
outputContentFormat	query		ContentFormat	Az elemzési eredmény legfelső szintű tartalmának formátuma.
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+)?))*$
queryFields	query		string[]	A kibontandó további mezők listája. Pl. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	A sztringek eltolásának és hosszának kiszámítására használt módszer.

Kérelem törzse

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ést elfogadták feldolgozásra, de a feldolgozás még nem fejeződött be. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

Name	Description
https://cognitiveservices.azure.com/.default

Példák

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview

Analyze Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

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

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview

Definíciók

Name	Description
AnalyzeDocumentRequest	Dokumentumelemzési paraméterek.
ContentFormat	A tartalom formázása az elemzett eredményben.
DocumentAnalysisFeature	A választható elemzési funkciók listája.
Error	A hibaobjektum.
ErrorResponse	Hibaválasz-objektum.
InnerError	Egy objektum, amely pontosabb információkat tartalmaz a hibáról.
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.

ContentFormat

A tartalom formázása az elemzett eredményben.

Name	Típus	Description
markdown	string	A dokumentum tartalmának Markdown-ábrázolása szakaszfejlécekkel, táblázatokkal stb.
text	string	A dokumentum tartalmának egyszerű szöveges ábrázolása formázás nélkül.

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.
queryFields	string	További mezők kinyerésének engedélyezése a queryFields lekérdezési paraméterrel.
styleFont	string	Különböző betűstílusok felismerésének engedélyezése.

Error

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz-objektum.

Name	Típus	Description
error	Error	Hibaadatok.

InnerError

Egy objektum, amely pontosabb információkat tartalmaz a hibáról.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	InnerError	Belső hiba.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.

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.