Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2023-07-31

Analyserar dokument med dokumentmodell.

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-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string url	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string	Unikt dokumentmodellnamn. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Begärd API-version.
features	query		DocumentAnalysisFeature[]	Lista över valfria analysfunktioner.
locale	query		string	Språktips för textigenkänning och dokumentanalys. Värdet får endast innehålla språkkoden (t.ex. "en", "fr") eller BCP 47-språktaggen (t.ex. "en-US").
pages	query		string	Lista över 1-baserade sidnummer att analysera. t.ex. "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	Metod som används för att beräkna strängförskjutning och längd.

Begärandehuvud

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	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Den hemliga nyckeln för din Azure Cognitive Services-prenumeration.

Begärandetext

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	Base64-kodning av dokumentet som ska analyseras. UrlSource eller base64Source måste anges.
urlSource	string	Dokument-URL som ska analyseras. UrlSource eller base64Source måste anges.

Svar

Name	Typ	Description
202 Accepted		Begäran har placerats i kö. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Fel påträffades.

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure Cognitive Services-prenumeration.

Type: apiKey
In: header

Exempel

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

Definitioner

Name	Description
AnalyzeDocumentRequest	Parametrar för dokumentanalys.
DocumentAnalysisFeature	Lista över valfria analysfunktioner.
Error	Felinformation.
ErrorResponse	Felsvarsobjekt.
InnerError	Detaljerat fel.
StringIndexType	Metod som används för att beräkna strängförskjutning och längd.

AnalyzeDocumentRequest

Parametrar för dokumentanalys.

Name	Typ	Description
base64Source	string	Base64-kodning av dokumentet som ska analyseras. UrlSource eller base64Source måste anges.
urlSource	string	Dokument-URL som ska analyseras. UrlSource eller base64Source måste anges.

DocumentAnalysisFeature

Lista över valfria analysfunktioner.

Name	Typ	Description
barcodes	string	Aktivera identifiering av streckkoder i dokumentet.
formulas	string	Aktivera identifiering av matematiska uttryck i dokumentet.
keyValuePairs	string	Aktivera identifiering av allmänna nyckelvärdepar (formulärfält) i dokumentet.
languages	string	Aktivera identifiering av textinnehållsspråket.
ocrHighResolution	string	Utför OCR med en högre upplösning för att hantera dokument med finstilt tryck.
styleFont	string	Aktivera igenkänning av olika teckensnittsformat.

Error

Felinformation.

Name	Typ	Description
code	string	Felkod.
details	Error[]	Lista över detaljerade fel.
innererror	InnerError	Detaljerat fel.
message	string	Felmeddelande.
target	string	Målet för felet.

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

InnerError

Detaljerat fel.

Name	Typ	Description
code	string	Felkod.
innererror	InnerError	Detaljerat fel.
message	string	Felmeddelande.

StringIndexType

Metod som används för att beräkna strängförskjutning och längd.

Name	Typ	Description
textElements	string	Användarupplevt visningstecken, eller grapheme-kluster, enligt definitionen i Unicode 8.0.0.
unicodeCodePoint	string	Teckenenhet som representeras av en enda unicode-kodpunkt. Används av Python 3.
utf16CodeUnit	string	Teckenenhet som representeras av en 16-bitars Unicode-kodenhet. Används av JavaScript, Java och .NET.