Document Models - Analyze Document
Analyzuje dokument pomocí modelu dokumentu.
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview
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}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Koncový bod služby Document Intelligence. |
model
|
path | True |
string |
Jedinečný název modelu dokumentu. Regex pattern: |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
features
|
query |
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 |
Formát obsahu nejvyšší úrovně výsledků analýzy |
||
pages
|
query |
string |
Seznam čísel stránek založených na 1. Například "1-3,5,7-9" Regex pattern: |
|
query
|
query |
string[] |
Seznam dalších polí, která se mají extrahovat. Například "NumberOfGuests,StoreNumber" |
|
string
|
query |
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 k analýze 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. Headers
|
|
Other Status Codes |
Neočekávaná chybová odpověď. |
Zabezpečení
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 |
Příklady
Analyze Document from Base64 |
Analyze Document from Url |
Analyze Document from Base64
Sample Request
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
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
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
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview
Definice
Name | Description |
---|---|
Analyze |
Parametry analýzy dokumentů. |
Content |
Formát obsahu v analyzovaném výsledku |
Document |
Seznam volitelných analytických funkcí |
Error |
Objekt chyby. |
Error |
Objekt odpovědi na chybu. |
Inner |
Objekt obsahující konkrétnější informace o chybě. |
String |
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 k analýze Musí být zadána adresa urlSource nebo base64Source. |
ContentFormat
Formát obsahu v analyzovaném výsledku
Name | Typ | Description |
---|---|---|
markdown |
string |
Markdown znázorňuje obsah dokumentu pomocí nadpisů oddílů, tabulek atd. |
text |
string |
Reprezentace obsahu dokumentu ve formátu prostého textu bez formátování |
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 detekci obecných párů hodnot klíčů (polí formuláře) v dokumentu. |
languages |
string |
Povolte rozpoznávání jazyka textového obsahu. |
ocrHighResolution |
string |
Při zpracování dokumentů s jemným tiskem proveďte OCR ve vyšším rozlišení. |
queryFields |
string |
Povolte extrakci dalších polí prostřednictvím parametru dotazu queryFields. |
styleFont |
string |
Povolte rozpoznávání různých stylů písma. |
Error
Objekt chyby.
Name | Typ | Description |
---|---|---|
code |
string |
Jeden ze serverem definované sady kódů chyb. |
details |
Error[] |
Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě. |
innererror |
Objekt obsahující konkrétnější informace o chybě než aktuální objekt. |
|
message |
string |
Lidsky čitelná reprezentace chyby. |
target |
string |
Cíl chyby. |
ErrorResponse
Objekt odpovědi na chybu.
Name | Typ | Description |
---|---|---|
error |
Informace o chybě. |
InnerError
Objekt obsahující konkrétnější informace o chybě.
Name | Typ | Description |
---|---|---|
code |
string |
Jeden ze serverem definované sady kódů chyb. |
innererror |
Vnitřní chyba. |
|
message |
string |
Lidsky čitelná reprezentace chyby. |
StringIndexType
Metoda použitá k výpočtu posunu a délky řetězce
Name | Typ | Description |
---|---|---|
textElements |
string |
Zobrazovaný znak vnímaný uživatelem neboli grafeme cluster definovaný v kódování 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. |