Analyzer - Analyze Layout

Referenz

Dienst:: Azure AI Services

API-Version:: 2.1

Extrahiert Text- und Layoutinformationen aus einem bestimmten Dokument Das Eingabedokument muss einem der unterstützten Inhaltstypen entsprechen: "application/pdf", "image/jpeg", "image/png", "image/tiff" oder "image/bmp". Alternativ können Sie den Typ "application/json" verwenden, um den Speicherort (Uri oder lokaler Pfad) des zu analysierenden Dokuments anzugeben.

POST {endpoint}/formrecognizer/v2.1/layout/analyze

Mit optionalen Parametern:

POST {endpoint}/formrecognizer/v2.1/layout/analyze?pages={pages}&language={language}&readingOrder={readingOrder}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus2.api.cognitive.microsoft.com
language	query		Language	Derzeit nur Afrikaans ('af'), Albanisch ('sq'), Asturisch ('ast'), Baskisch ('eu'), Bislama ('bi'), Bretonisch ('br'), Katalanisch ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Korsisch ('co'), Krimtatarisch - Lateinische Schrift('crh'), Tschechisch ('cs'), Dänisch ('da'), Niederländisch ('nl'), Englisch ('en'), Estnisch ('et'), Fidschin ('fj'), Filipino ('fil'), Finnisch ('fi'), Französisch ('fr'), Friaulisch ('fur'), Galizisch ('gl'), Deutsch ('de'), Gilbertese ('gil'), Grönländisch ('kl'), Haitian Creole ('ht'), Hani ('hni'), Hmong Daw ('mww'), Ungarisch ('hu'), Indonesisch ('id'), Interlingua ('ia'), Inuktitut ('iu'), Irisch ('ga'), Italienisch ('it'), Japanisch ('ja'), Javanesisch ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kaschubisch ('csb'), Khasi ('kha'), Koreanisch ('ko'), Kurdisch - Lateinische Schrift ('ku'), K'iche' ('quc'), Luxemburgisch ('lb'), Malaiisch ('ms'), Manx ('gv'), neapolitanisch ('nap'), Norwegisch ('no'), Okzitanisch ('oc'), Polnisch ('pl'), Portugiesisch ('pt'), Rätoromanisch ('rm'), Schotten ('sco'), Schottisch gälisch ('gd'), vereinfachtes Chinesisch ('zh-Hans'), Slowenisch ('sl'), Spanisch ('es'), Swahili ('sw'), Schwedisch ('sv'), Tatarisch - Lateinische Schrift ('tt'), Tetum ('tet'), traditionelles Chinesisch ('zh-Hant'), Türkisch ('tr'), Obersorbisch ('hsb'), Usbeken ('uz'), Volapük ('vo'), Walser ('wae'), Westfriesisch ('fy'), Yucatec Maya ('yua'), Zhuang ('za') und Zulu ('zu') werden unterstützt (Druck – dreiunddundbzig Sprachen und handschriftlich – nur Englisch). Layout unterstützt die automatische Spracherkennung und mehrsprachige Dokumente. Stellen Sie daher nur einen Sprachcode bereit, wenn Sie erzwingen möchten, dass das Dokumentierte als bestimmte Sprache verarbeitet wird.
pages	query		string[]	Benutzerdefinierte Seitenzahlen für mehrseitige Dokumente (PDF/TIFF), geben Sie die Anzahl der Seiten ein, die Das OCR-Ergebnis erhalten soll. Verwenden Sie für einen Bereich von Seiten einen Bindestrich. Trennen Sie jede Seite oder jeden Bereich durch ein Komma.
readingOrder	query		ReadingOrder	Lesereihenfolgealgorithmus, um die zurückgegebenen Textzeilen zu sortieren. Zu den unterstützten Lesereihenfolgen gehören: basic(default), natural.

Anforderungsheader

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Anforderungstext

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Name	Typ	Beschreibung
source	string	Dateiquellpfad.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wird erfolgreich in die Warteschlange gestellt. Header Operation-Location: string
Other Status Codes	ErrorResponse	Antwortentität, die nicht erfolgreiche Antworten begleitet, die zusätzliche Details zum Fehler enthält.

Name

Typ

Beschreibung

202 Accepted

Die Anforderung wird erfolgreich in die Warteschlange gestellt.

Header

Operation-Location: string

Other Status Codes

ErrorResponse

Antwortentität, die nicht erfolgreiche Antworten begleitet, die zusätzliche Details zum Fehler enthält.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Analyze layout

Beispielanforderung

HTTP

POST {endpoint}/formrecognizer/v2.1/layout/analyze?language=en

Beispiel für eine Antwort

Statuscode:: 202

Operation-Location: {endpoint}/formrecognizer/v2.1/layout/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Definitionen

Name	Beschreibung
ErrorInformation
ErrorResponse
Language	Derzeit nur Afrikaans ('af'), Albanisch ('sq'), Asturisch ('ast'), Baskisch ('eu'), Bislama ('bi'), Bretonisch ('br'), Katalanisch ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Korsisch ('co'), Krimtatarisch - Lateinische Schrift('crh'), Tschechisch ('cs'), Dänisch ('da'), Niederländisch ('nl'), Englisch ('en'), Estnisch ('et'), Fidschin ('fj'), Filipino ('fil'), Finnisch ('fi'), Französisch ('fr'), Friaulisch ('fur'), Galizisch ('gl'), Deutsch ('de'), Gilbertese ('gil'), Grönländisch ('kl'), Haitian Creole ('ht'), Hani ('hni'), Hmong Daw ('mww'), Ungarisch ('hu'), Indonesisch ('id'), Interlingua ('ia'), Inuktitut ('iu'), Irisch ('ga'), Italienisch ('it'), Japanisch ('ja'), Javanesisch ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kaschubisch ('csb'), Khasi ('kha'), Koreanisch ('ko'), Kurdisch - Lateinische Schrift ('ku'), K'iche' ('quc'), Luxemburgisch ('lb'), Malaiisch ('ms'), Manx ('gv'), neapolitanisch ('nap'), Norwegisch ('no'), Okzitanisch ('oc'), Polnisch ('pl'), Portugiesisch ('pt'), Rätoromanisch ('rm'), Schotten ('sco'), Schottisch gälisch ('gd'), vereinfachtes Chinesisch ('zh-Hans'), Slowenisch ('sl'), Spanisch ('es'), Swahili ('sw'), Schwedisch ('sv'), Tatarisch - Lateinische Schrift ('tt'), Tetum ('tet'), traditionelles Chinesisch ('zh-Hant'), Türkisch ('tr'), Obersorbisch ('hsb'), Usbeken ('uz'), Volapük ('vo'), Walser ('wae'), Westfriesisch ('fy'), Yucatec Maya ('yua'), Zhuang ('za') und Zulu ('zu') werden unterstützt (Druck – dreiunddundbzig Sprachen und handschriftlich – nur Englisch). Layout unterstützt die automatische Spracherkennung und mehrsprachige Dokumente. Stellen Sie daher nur einen Sprachcode bereit, wenn Sie erzwingen möchten, dass das Dokumentierte als bestimmte Sprache verarbeitet wird.
ReadingOrder	Lesereihenfolgealgorithmus, um die zurückgegebenen Textzeilen zu sortieren. Zu den unterstützten Lesereihenfolgen gehören: basic(default), natural.
SourcePath	URI oder lokaler Pfad zu Quelldaten.

ErrorInformation

Name	Typ	Beschreibung
code	string
message	string

ErrorResponse

Name	Typ	Beschreibung
error	ErrorInformation

Language

Derzeit nur Afrikaans ('af'), Albanisch ('sq'), Asturisch ('ast'), Baskisch ('eu'), Bislama ('bi'), Bretonisch ('br'), Katalanisch ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Korsisch ('co'), Krimtatarisch - Lateinische Schrift('crh'), Tschechisch ('cs'), Dänisch ('da'), Niederländisch ('nl'), Englisch ('en'), Estnisch ('et'), Fidschin ('fj'), Filipino ('fil'), Finnisch ('fi'), Französisch ('fr'), Friaulisch ('fur'), Galizisch ('gl'), Deutsch ('de'), Gilbertese ('gil'), Grönländisch ('kl'), Haitian Creole ('ht'), Hani ('hni'), Hmong Daw ('mww'), Ungarisch ('hu'), Indonesisch ('id'), Interlingua ('ia'), Inuktitut ('iu'), Irisch ('ga'), Italienisch ('it'), Japanisch ('ja'), Javanesisch ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kaschubisch ('csb'), Khasi ('kha'), Koreanisch ('ko'), Kurdisch - Lateinische Schrift ('ku'), K'iche' ('quc'), Luxemburgisch ('lb'), Malaiisch ('ms'), Manx ('gv'), neapolitanisch ('nap'), Norwegisch ('no'), Okzitanisch ('oc'), Polnisch ('pl'), Portugiesisch ('pt'), Rätoromanisch ('rm'), Schotten ('sco'), Schottisch gälisch ('gd'), vereinfachtes Chinesisch ('zh-Hans'), Slowenisch ('sl'), Spanisch ('es'), Swahili ('sw'), Schwedisch ('sv'), Tatarisch - Lateinische Schrift ('tt'), Tetum ('tet'), traditionelles Chinesisch ('zh-Hant'), Türkisch ('tr'), Obersorbisch ('hsb'), Usbeken ('uz'), Volapük ('vo'), Walser ('wae'), Westfriesisch ('fy'), Yucatec Maya ('yua'), Zhuang ('za') und Zulu ('zu') werden unterstützt (Druck – dreiunddundbzig Sprachen und handschriftlich – nur Englisch). Layout unterstützt die automatische Spracherkennung und mehrsprachige Dokumente. Stellen Sie daher nur einen Sprachcode bereit, wenn Sie erzwingen möchten, dass das Dokumentierte als bestimmte Sprache verarbeitet wird.

Name	Typ	Beschreibung
af	string
ast	string
bi	string
br	string
ca	string
ceb	string
ch	string
co	string
crh	string
cs	string
csb	string
da	string
de	string
en	string
es	string
et	string
eu	string
fi	string
fil	string
fj	string
fr	string
fur	string
fy	string
ga	string
gd	string
gil	string
gl	string
gv	string
hni	string
hsb	string
ht	string
hu	string
ia	string
id	string
it	string
iu	string
ja	string
jv	string
kaa	string
kac	string
kea	string
kha	string
kl	string
ko	string
ku	string
kw	string
lb	string
ms	string
mww	string
nap	string
nl	string
no	string
oc	string
pl	string
pt	string
quc	string
rm	string
sco	string
sl	string
sq	string
sv	string
sw	string
tet	string
tr	string
tt	string
uz	string
vo	string
wae	string
yua	string
za	string
zh-Hans	string
zh-Hant	string
zu	string

ReadingOrder

Lesereihenfolgealgorithmus, um die zurückgegebenen Textzeilen zu sortieren. Zu den unterstützten Lesereihenfolgen gehören: basic(default), natural.

Name	Typ	Beschreibung
basic	string
natural	string

SourcePath

URI oder lokaler Pfad zu Quelldaten.

Name	Typ	Beschreibung
source	string	Dateiquellpfad.

Freigeben über

Analyzer - Analyze Layout

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Beispiele

Analyze layout

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorInformation

ErrorResponse

Language

ReadingOrder

SourcePath

Zusätzliche Ressourcen