Analyzer - Analyze Layout

Referência

Serviço:: Azure AI Services

Versão da API:: 2.1

Extrair informações de texto e esquema de um determinado documento. O documento de entrada tem de ser de um dos tipos de conteúdo suportados : "application/pdf", "image/jpeg", "image/png", "image/tiff" ou "image/bmp". Em alternativa, utilize o tipo "application/json" para especificar a localização (Uri ou caminho local) do documento a analisar.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus2.api.cognitive.microsoft.com).
language	query		Language	Atualmente, apenas Afrikaans ('af'), albanês ('sq'), asturiano ('ast'), basco ('eu'), Bislama ('bi'), Breton ('br'), catalão ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Corsican ('co'), Tártaro da Crimeia - latim script('crh'), Checo ('cs'), dinamarquês ('da'), neerlandês ('nl'), inglês ('en'), estónio ('et'), fijiano ('fj'), filipino ('fil'), finlandês ('fi'), francês ('fr'), friulian ('fur'), galego ('gl'), alemão ('de'), Gilbertese ('gil'), Greenlandic ('kl'), Crioulo haitiano ('ht'), Hani ('hni'), Hmong Daw ('mww'), húngaro ('hu'), indonésio ('id'), Interlingua ('ia'), Inuktitut ('iu'), irlandês ('ga'), italiano ('it'), japonês ('ja'), javanês ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kashubian ('csb'), Khasi ('kha'), coreano ('ko'), curdo - script latino ('ku'), K'iche' ('quc'), luxemburguês ('lb'), malaio ('ms'), Manx ('gv'), napolitana ('nap'), norueguês ('no'), Occitan ('oc'), polaco ('pl'), polaco ('pl'), Português ('pt'), Romansh ('rm'), escoceses ('sco'), gaélico escocês ('gd'), chinês simplificado ('zh-Hans'), esloveno ('sl'), espanhol ('es'), swahili ('sw'), sueco ('sv'), tártaro - script latino ('tt'), Tetum ('tet'), chinês tradicional ('zh-Han'T'), turco ('tr'), Sorbian Superior ('hsb'), usbeque ('uz'), Volapük ('vo'), Walser ('wae'), Western Frisian ('fy'), Yucatec Maya ('yua'), Zhuang ('za') e Zulu ('zu') são suportados (imprimir – setenta e três línguas e escritas à mão – apenas em inglês). O esquema suporta a identificação automática de idiomas e documentos de vários idiomas, pelo que só fornece um código de idioma se quiser forçar o documento a ser processado como esse idioma específico.
pages	query		string[]	Números de página personalizados para documentos de várias páginas (PDF/TIFF), introduza o número de páginas que pretende obter o resultado do OCR. Para um intervalo de páginas, utilize um hífen. Separe cada página ou intervalo com uma vírgula.
readingOrder	query		ReadingOrder	Algoritmo de ordem de leitura para ordenar as linhas de texto devolvidas. As encomendas de leitura suportadas incluem: básico (predefinição), natural.

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo do Pedido

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

Name	Tipo	Description
source	string	Caminho de origem do ficheiro.

Respostas

Name	Tipo	Description
202 Accepted		O pedido é feito em fila com êxito. Cabeçalhos Operation-Location: string
Other Status Codes	ErrorResponse	Entidade de resposta que acompanha respostas não bem-sucedidas que contêm detalhes adicionais sobre o erro.

Name

Tipo

Description

202 Accepted

O pedido é feito em fila com êxito.

Cabeçalhos

Operation-Location: string

Other Status Codes

ErrorResponse

Entidade de resposta que acompanha respostas não bem-sucedidas que contêm detalhes adicionais sobre o erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Analyze layout

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 202

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

Definições

Name	Description
ErrorInformation
ErrorResponse
Language	Atualmente, apenas Afrikaans ('af'), albanês ('sq'), asturiano ('ast'), basco ('eu'), Bislama ('bi'), Breton ('br'), catalão ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Corsican ('co'), Tártaro da Crimeia - latim script('crh'), Checo ('cs'), dinamarquês ('da'), neerlandês ('nl'), inglês ('en'), estónio ('et'), fijiano ('fj'), filipino ('fil'), finlandês ('fi'), francês ('fr'), friulian ('fur'), galego ('gl'), alemão ('de'), Gilbertese ('gil'), Greenlandic ('kl'), Crioulo haitiano ('ht'), Hani ('hni'), Hmong Daw ('mww'), húngaro ('hu'), indonésio ('id'), Interlingua ('ia'), Inuktitut ('iu'), irlandês ('ga'), italiano ('it'), japonês ('ja'), javanês ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kashubian ('csb'), Khasi ('kha'), coreano ('ko'), curdo - script latino ('ku'), K'iche' ('quc'), luxemburguês ('lb'), malaio ('ms'), Manx ('gv'), napolitana ('nap'), norueguês ('no'), Occitan ('oc'), polaco ('pl'), polaco ('pl'), Português ('pt'), Romansh ('rm'), escoceses ('sco'), gaélico escocês ('gd'), chinês simplificado ('zh-Hans'), esloveno ('sl'), espanhol ('es'), swahili ('sw'), sueco ('sv'), tártaro - script latino ('tt'), Tetum ('tet'), chinês tradicional ('zh-Han'T'), turco ('tr'), Sorbian Superior ('hsb'), usbeque ('uz'), Volapük ('vo'), Walser ('wae'), Western Frisian ('fy'), Yucatec Maya ('yua'), Zhuang ('za') e Zulu ('zu') são suportados (imprimir – setenta e três línguas e escritas à mão – apenas em inglês). O esquema suporta a identificação automática de idiomas e documentos de vários idiomas, pelo que só fornece um código de idioma se quiser forçar o documento a ser processado como esse idioma específico.
ReadingOrder	Algoritmo de ordem de leitura para ordenar as linhas de texto devolvidas. As encomendas de leitura suportadas incluem: básico (predefinição), natural.
SourcePath	Uri ou caminho local para a origem de dados.

ErrorInformation

Name	Tipo	Description
code	string
message	string

ErrorResponse

Name	Tipo	Description
error	ErrorInformation

Language

Atualmente, apenas Afrikaans ('af'), albanês ('sq'), asturiano ('ast'), basco ('eu'), Bislama ('bi'), Breton ('br'), catalão ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Cornish ('kw'), Corsican ('co'), Tártaro da Crimeia - latim script('crh'), Checo ('cs'), dinamarquês ('da'), neerlandês ('nl'), inglês ('en'), estónio ('et'), fijiano ('fj'), filipino ('fil'), finlandês ('fi'), francês ('fr'), friulian ('fur'), galego ('gl'), alemão ('de'), Gilbertese ('gil'), Greenlandic ('kl'), Crioulo haitiano ('ht'), Hani ('hni'), Hmong Daw ('mww'), húngaro ('hu'), indonésio ('id'), Interlingua ('ia'), Inuktitut ('iu'), irlandês ('ga'), italiano ('it'), japonês ('ja'), javanês ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kashubian ('csb'), Khasi ('kha'), coreano ('ko'), curdo - script latino ('ku'), K'iche' ('quc'), luxemburguês ('lb'), malaio ('ms'), Manx ('gv'), napolitana ('nap'), norueguês ('no'), Occitan ('oc'), polaco ('pl'), polaco ('pl'), Português ('pt'), Romansh ('rm'), escoceses ('sco'), gaélico escocês ('gd'), chinês simplificado ('zh-Hans'), esloveno ('sl'), espanhol ('es'), swahili ('sw'), sueco ('sv'), tártaro - script latino ('tt'), Tetum ('tet'), chinês tradicional ('zh-Han'T'), turco ('tr'), Sorbian Superior ('hsb'), usbeque ('uz'), Volapük ('vo'), Walser ('wae'), Western Frisian ('fy'), Yucatec Maya ('yua'), Zhuang ('za') e Zulu ('zu') são suportados (imprimir – setenta e três línguas e escritas à mão – apenas em inglês). O esquema suporta a identificação automática de idiomas e documentos de vários idiomas, pelo que só fornece um código de idioma se quiser forçar o documento a ser processado como esse idioma específico.

Name	Tipo	Description
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

Algoritmo de ordem de leitura para ordenar as linhas de texto devolvidas. As encomendas de leitura suportadas incluem: básico (predefinição), natural.

Name	Tipo	Description
basic	string
natural	string

SourcePath

Uri ou caminho local para a origem de dados.

Name	Tipo	Description
source	string	Caminho de origem do ficheiro.

Partilhar via

Analyzer - Analyze Layout

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Analyze layout

Pedido de amostra

Resposta da amostra

Definições

ErrorInformation

ErrorResponse

Language

ReadingOrder

SourcePath

Recursos adicionais