Document Models - Analyze Document

Tjänst:

Azure AI Services

API-version:

2024-11-30

Analyserar dokument med dokumentmodell.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Slutpunkten för document intelligence-tjänsten.
modelId	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Unikt dokumentmodellnamn.
api-version	query	True	string minLength: 1	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åktagg (t.ex. "en-US").
output	query		AnalyzeOutputOption[]	Ytterligare utdata som ska genereras under analysen.
outputContentFormat	query		DocumentContentFormat	Format för analysresultatets innehåll på den översta nivån.
pages	query		string pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$	1-baserade sidnummer att analysera. Ex. "1-3,5,7-9"
queryFields	query		string[]	Lista över ytterligare fält som ska extraheras. 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 (byte)	Base64-kodning av dokumentet som ska analyseras. Antingen urlSource eller base64Source måste anges.
urlSource	string (uri)	Dokument-URL som ska analyseras. Antingen 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. Sidhuvuden Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Ett oväntat felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

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

Exempel

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Exempelbegäran

HTTP

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

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Exempelsvar

Statuskod:

202

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

Analyze Document from Url

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:

202

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

Definitioner

Name	Description
AnalyzeDocumentRequest	Parametrar för dokumentanalys.
AnalyzeOutputOption	Ytterligare utdata som ska genereras under analysen.
DocumentAnalysisFeature	Funktioner för dokumentanalys som ska aktiveras.
DocumentContentFormat	Format för innehållet i analyserat resultat.
DocumentIntelligenceError	Felobjektet.
DocumentIntelligenceErrorResponse	Felsvarsobjekt.
DocumentIntelligenceInnerError	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

Objekt

Parametrar för dokumentanalys.

Name	Typ	Description
base64Source	string (byte)	Base64-kodning av dokumentet som ska analyseras. Antingen urlSource eller base64Source måste anges.
urlSource	string (uri)	Dokument-URL som ska analyseras. Antingen urlSource eller base64Source måste anges.

AnalyzeOutputOption

Uppräkning

Ytterligare utdata som ska genereras under analysen.

Värde	Description
figures	Generera beskurna bilder av identifierade figurer.
pdf	Generera sökbara PDF-utdata.

DocumentAnalysisFeature

Uppräkning

Funktioner för dokumentanalys som ska aktiveras.

Värde	Description
barcodes	Aktivera identifiering av streckkoder i dokumentet.
formulas	Aktivera identifiering av matematiska uttryck i dokumentet.
keyValuePairs	Aktivera identifiering av allmänna nyckelvärdepar (formulärfält) i dokumentet.
languages	Aktivera identifiering av textinnehållsspråket.
ocrHighResolution	Utför OCR med högre upplösning för att hantera dokument med finstilt.
queryFields	Aktivera extrahering av ytterligare fält via frågeparametern queryFields.
styleFont	Aktivera igenkänning av olika teckensnittsformat.

DocumentContentFormat

Uppräkning

Format för innehållet i analyserat resultat.

Värde	Description
markdown	Markdown-representation av dokumentinnehållet med avsnittsrubriker, tabeller osv.
text	Oformaterad textrepresentation av dokumentinnehållet utan formatering.

DocumentIntelligenceError

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	DocumentIntelligenceError[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Objekt

Felsvarsobjekt.

Name	Typ	Description
error	DocumentIntelligenceError	Felinformation.

DocumentIntelligenceInnerError

Objekt

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

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

StringIndexType

Uppräkning

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

Värde	Description
textElements	Användarupplevt visningstecken, eller grapheme-kluster, som definieras av Unicode 8.0.0.
unicodeCodePoint	Teckenenhet som representeras av en enda unicode-kodpunkt. Används av Python 3.
utf16CodeUnit	Teckenenhet som representeras av en 16-bitars Unicode-kodenhet. Används av JavaScript, Java och .NET.