Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2023-07-31

Analyzuje dokument pomocí modelu dokumentu.

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string url	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string	Jedinečný název modelu dokumentu. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Požadovaná verze rozhraní API
features	query		DocumentAnalysisFeature[]	Seznam volitelných analytických funkcí
locale	query		string	Nápověda k národnímu prostředí pro rozpoznávání textu a analýzu dokumentů Hodnota může obsahovat pouze kód jazyka (např. "en", "fr") nebo značku jazyka BCP 47 (např. "en-US").
pages	query		string	Seznam čísel stránek založených na 1. Například "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	Metoda použitá k výpočtu posunu řetězce a délky.

Hlavička požadavku

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	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Tajný klíč vašeho předplatného služeb Azure Cognitive Services.

Text požadavku

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	Typ	Description
base64Source	string	Kódování Base64 dokumentu k analýze. Musí být zadána adresa urlSource nebo base64Source.
urlSource	string	Adresa URL dokumentu k analýze Musí být zadána adresa urlSource nebo base64Source.

Odpovědi

Name	Typ	Description
202 Accepted		Požadavek je úspěšně zařazen do fronty. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Tajný klíč vašeho předplatného služeb Azure Cognitive Services.

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
AnalyzeDocumentRequest	Parametry analýzy dokumentu.
DocumentAnalysisFeature	Seznam volitelných analytických funkcí
Error	Informace o chybě.
ErrorResponse	Objekt odpovědi na chybu.
InnerError	Podrobná chyba.
StringIndexType	Metoda použitá k výpočtu posunu řetězce a délky.

AnalyzeDocumentRequest

Parametry analýzy dokumentu.

Name	Typ	Description
base64Source	string	Kódování Base64 dokumentu k analýze. Musí být zadána adresa urlSource nebo base64Source.
urlSource	string	Adresa URL dokumentu k analýze Musí být zadána adresa urlSource nebo base64Source.

DocumentAnalysisFeature

Seznam volitelných analytických funkcí

Name	Typ	Description
barcodes	string	Povolte detekci čárových kódů v dokumentu.
formulas	string	Povolte detekci matematických výrazů v dokumentu.
keyValuePairs	string	Povolte v dokumentu detekci obecných párů hodnot klíčů (polí formuláře).
languages	string	Povolte rozpoznávání jazyka textového obsahu.
ocrHighResolution	string	Provádějte funkci OCR s vyšším rozlišením pro zpracování dokumentů s jemným tiskem.
styleFont	string	Povolte rozpoznávání různých stylů písma.

Error

Informace o chybě.

Name	Typ	Description
code	string	Kód chyby
details	Error[]	Seznam podrobných chyb
innererror	InnerError	Podrobná chyba.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt odpovědi na chybu.

Name	Typ	Description
error	Error	Informace o chybě.

InnerError

Podrobná chyba.

Name	Typ	Description
code	string	Kód chyby
innererror	InnerError	Podrobná chyba.
message	string	Chybová zpráva.

StringIndexType

Metoda použitá k výpočtu posunu řetězce a délky.

Name	Typ	Description
textElements	string	Zobrazovaný znak vnímaný uživatelem neboli grafeme cluster definovaný v Kódu Unicode 8.0.0.
unicodeCodePoint	string	Znaková jednotka reprezentovaná jedním bodem kódu Unicode. Používá se v Pythonu 3.
utf16CodeUnit	string	Znaková jednotka reprezentovaná 16bitovou jednotkou kódu Unicode. Používá se v JavaScriptu, Javě a .NET.