Document Models - Analyze Document

Služba:

Azure AI Services

Verze rozhraní API:

2024-07-31-preview

Analyzuje dokument pomocí modelu dokumentu.

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

S volitelnými parametry:

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string uri	Koncový bod služby Document Intelligence
modelId	path	True	string	Jedinečný název modelu dokumentu Vzor regulárního výrazu: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
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").
output	query		AnalyzeOutputOption[]	Další výstupy, které se generují během analýzy.
outputContentFormat	query		ContentFormat	Formát obsahu nejvyšší úrovně analýzy výsledků
pages	query		string	Seznam čísel stránek založených na 1, která se mají analyzovat Ex. "1-3,5,7-9" Vzor regulárního výrazu: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Seznam dalších polí k extrakci Ex. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Metoda použitá k výpočtu posunu a délky řetězce

Text požadavku

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, která se má analyzovat. Musí být zadána adresa URLSource nebo base64Source.

Odpovědi

Name	Typ	Description
202 Accepted		Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno. Hlavičky Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

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

Příklady

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Ukázkový požadavek

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"
}

Ukázková odpověď

Stavový kó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

Ukázkový požadavek

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"
}

Ukázková odpověď

Stavový kód:

202

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

Definice

Name	Description
AnalyzeDocumentRequest	Parametry analýzy dokumentů
AnalyzeOutputOption	Další výstupy, které se generují během analýzy.
ContentFormat	Formát obsahu v analyzovaném výsledku
DocumentAnalysisFeature	Funkce analýzy dokumentů, které chcete povolit.
Error	Objekt chyby.
ErrorResponse	Objekt odpovědi na chybu
InnerError	Objekt obsahující konkrétnější informace o chybě.
StringIndexType	Metoda použitá k výpočtu posunu a délky řetězce

AnalyzeDocumentRequest

Parametry analýzy dokumentů

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, která se má analyzovat. Musí být zadána adresa URLSource nebo base64Source.

AnalyzeOutputOption

Další výstupy, které se generují během analýzy.

Name	Typ	Description
figures	string	Vygenerujte oříznuté obrázky zjištěných obrázků.
pdf	string	Vygenerujte prohledávatelný výstup PDF.

ContentFormat

Formát obsahu v analyzovaném výsledku

Name	Typ	Description
markdown	string	Reprezentace obsahu dokumentu pomocí nadpisů oddílů, tabulek atd.
text	string	Reprezentace obsahu dokumentu ve formátu prostého textu bez formátování

DocumentAnalysisFeature

Funkce analýzy dokumentů, které chcete povolit.

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 detekci obecných párů klíč-hodnota (pole formulářů) v dokumentu.
languages	string	Povolte detekci jazyka textového obsahu.
ocrHighResolution	string	Pokud chcete zpracovávat dokumenty s jemným tiskem, proveďte OCR s vyšším rozlišením.
queryFields	string	Povolte extrakci dalších polí pomocí parametru dotazu queryFields.
styleFont	string	Povolte rozpoznávání různých stylů písem.

Error

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorResponse

Objekt odpovědi na chybu

Name	Typ	Description
error	Error	Informace o chybě

InnerError

Objekt obsahující konkrétnější informace o chybě.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	InnerError	Vnitřní chyba.
message	string	Čitelné znázornění chyby člověkem.

StringIndexType

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

Name	Typ	Description
textElements	string	Uživatelem vnímaný znak zobrazení nebo cluster grapheme definovaný kódem Unicode 8.0.0.
unicodeCodePoint	string	Znaková jednotka reprezentovaná jedním bodem kódu Unicode. Používá python 3.
utf16CodeUnit	string	Znaková jednotka reprezentovaná 16bitovou jednotkou kódu Unicode Používá se v JavaScriptu, Javě a .NET.