Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Analyserar dokument med dokumentmodell.

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

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Slutpunkten för dokumentinformationstjänsten.
modelId	path	True	string	Unikt namn på dokumentmodell. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
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").
outputContentFormat	query		ContentFormat	Format för analysresultatets innehåll på den översta nivån.
pages	query		string	Lista över 1-baserade sidnummer som ska analyseras. t.ex. "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Lista över ytterligare fält som ska extraheras. t.ex. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Metod som används för att beräkna strängförskjutning och längd.

Begärandetext

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 godkänts för bearbetning, men bearbetningen har ännu inte slutförts. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

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

Exempel

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

Definitioner

Name	Description
AnalyzeDocumentRequest	Parametrar för dokumentanalys.
ContentFormat	Format för innehållet i analyserat resultat.
DocumentAnalysisFeature	Lista över valfria analysfunktioner.
Error	Felobjektet.
ErrorResponse	Felsvarsobjekt.
InnerError	Ett objekt som innehåller mer specifik information om felet.
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.

ContentFormat

Format för innehållet i analyserat resultat.

Name	Typ	Description
markdown	string	Markdown-representation av dokumentinnehållet med avsnittsrubriker, tabeller osv.
text	string	Oformaterad textrepresentation av dokumentinnehållet utan formatering.

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 nyckel/värde-par (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.
queryFields	string	Aktivera extrahering av ytterligare fält via frågeparametern queryFields.
styleFont	string	Aktivera igenkänning av olika teckensnittsformat.

Error

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

InnerError

Ett objekt som innehåller mer specifik information om felet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	InnerError	Inre fel.
message	string	En mänsklig läsbar representation av felet.

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.