Document Models - Analyze Document

Szolgáltatás:

Azure AI Services

API-verzió:

2024-07-31-preview

Dokumentumelemzés dokumentummodellel.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string uri	A Document Intelligence szolgáltatás végpontja.
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	A művelethez használni kívánt API-verzió.
features	query		DocumentAnalysisFeature[]	Választható elemzési funkciók listája.
locale	query		string	Területi tipp szövegfelismeréshez és dokumentumelemzéshez. Az érték csak a nyelvi kódot (pl. "en", "fr") vagy BCP 47 nyelvi címkét (pl. "en-US").
output	query		AnalyzeOutputOption[]	Az elemzés során létrehozandó további kimenetek.
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. Volt. "1-3,5,7-9" Reguláris kifejezési minta: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	További kinyerendő mezők listája. Volt. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	A sztring eltolásának és hosszának kiszámításához 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-t vagy a base64Source-t.
urlSource	string	Elemezendő dokumentum URL-címe. Meg kell adni az urlSource-t vagy a base64Source-t.

Válaszok

Name	Típus	Description
202 Accepted		A kérelem feldolgozásra lett elfogadva, de a feldolgozás még nem fejeződött be. Fejlécek Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: accessCode
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize
Jogkivonat URL-címe: https://login.microsoftonline.com/common/oauth2/token

Hatókörök

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

Példák

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Mintakérelem

HTTP

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

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Mintaválasz

Állapotkód:

202

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

Analyze Document from Url

Mintakérelem

HTTP

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

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

Mintaválasz

Állapotkód:

202

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

Definíciók

Name	Description
AnalyzeDocumentRequest	Dokumentumelemzési paraméterek.
AnalyzeOutputOption	Az elemzés során létrehozandó további kimenetek.
ContentFormat	A tartalom formázása az elemzett eredményben.
DocumentAnalysisFeature	Engedélyezendő dokumentumelemzési funkciók.
Error	A hibaobjektum.
ErrorResponse	Hibaválasz-objektum.
InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról.
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-t vagy a base64Source-t.
urlSource	string	Elemezendő dokumentum URL-címe. Meg kell adni az urlSource-t vagy a base64Source-t.

AnalyzeOutputOption

Az elemzés során létrehozandó további kimenetek.

Name	Típus	Description
figures	string	Körülvágott képek létrehozása az észlelt ábrákról.
pdf	string	Kereshető PDF-kimenet létrehozása.

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 megjelenítése formázás nélkül.

DocumentAnalysisFeature

Engedélyezendő dokumentumelemzési funkciók.

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 ember által olvasható ábrázolása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz-objektum.

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

InnerError

Egy objektum, amely részletesebb 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 ember által olvasható ábrázolása.

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 definiált felhasználói megjelenítési karakter vagy gráffü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. JavaScript, Java és .NET által használt.