Analyzer - Analyze Layout

Referência

Serviço:: Azure AI Services

Versão da API:: 2.1

Extrair informações de texto e layout de um determinado documento. O documento de entrada deve ser de um dos tipos de conteúdo com suporte : 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' ou 'image/bmp'. Como alternativa, use o tipo 'application/json' para especificar o local (URI ou caminho local) do documento a ser analisado.

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 de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).
language	query		Language	Atualmente, apenas africâner ('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 Criméia - Script latino('crh'), Tcheco ('cs'), dinamarquês ('da'), holandês ('nl'), inglês ('en'), estoniano ('et'), fijiano ('fj'), filipino ('fil'), finlandês ('fi'), francês ('fr'), fúliano ('pele'), galego ('gl'), alemão ('de'), Gilbertese ('gil'), esverdeado ('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'), Javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kashubian ('csb'), Khasi ('kha'), coreano ('ko'), curdo - script latino ('ku'), K'iche' ('quc'), Luxemburgo ('lb'), malaio ('ms'), Manx ('gv'),neapolitan ('nap'), norueguês ('não'), Occitan ('oc'), polonês ('pl'), polonês ('pl'), Português ('pt'), Romansh ('rm'), escocês ('sco'), gaélico escocês ('gd'), chinês simplificado ('zh-Hans'), esloveno ('sl'), espanhol ('es'), suaíli ('sw'), sueco ('sv'), tártaro - script latino ('tt'), Tetum ('tet'), chinês tradicional ('zh-Hant'), chinês tradicional ('zh-Hant' '), turco ('tr'), Sorbian Superior ('hsb'), Uzbeque ('uz'), Volapük ('vo'), Walser ('wae'), Frísiano Ocidental ('fy'), Yucatec Maya ('yua'), Zhuang ('za') e Zulu ('zu') têm suporte (imprimir – setenta e três idiomas e manuscrito – somente inglês). O layout dá suporte à identificação automática de idioma e a documentos de vários idiomas, portanto, forneça apenas um código de idioma se você quiser forçar o documentado 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), insira o número de páginas que você deseja obter o resultado do OCR. Para um intervalo de páginas, use um hífen. Separe cada página ou intervalo com uma vírgula.
readingOrder	query		ReadingOrder	Algoritmo de ordem de leitura para classificar as linhas de texto retornadas. Os pedidos de leitura com suporte incluem: básico(padrão), natural.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo da solicitação

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

Nome	Tipo	Description
source	string	Caminho de origem do arquivo.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação é enfileirada 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.

Nome

Tipo

Description

202 Accepted

A solicitação é enfileirada 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

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 202

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

Definições

Nome	Description
ErrorInformation
ErrorResponse
Language	Atualmente, apenas africâner ('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 Criméia - Script latino('crh'), Tcheco ('cs'), dinamarquês ('da'), holandês ('nl'), inglês ('en'), estoniano ('et'), fijiano ('fj'), filipino ('fil'), finlandês ('fi'), francês ('fr'), fúliano ('pele'), galego ('gl'), alemão ('de'), Gilbertese ('gil'), esverdeado ('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'), Javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kashubian ('csb'), Khasi ('kha'), coreano ('ko'), curdo - script latino ('ku'), K'iche' ('quc'), Luxemburgo ('lb'), malaio ('ms'), Manx ('gv'),neapolitan ('nap'), norueguês ('não'), Occitan ('oc'), polonês ('pl'), polonês ('pl'), Português ('pt'), Romansh ('rm'), escocês ('sco'), gaélico escocês ('gd'), chinês simplificado ('zh-Hans'), esloveno ('sl'), espanhol ('es'), suaíli ('sw'), sueco ('sv'), tártaro - script latino ('tt'), Tetum ('tet'), chinês tradicional ('zh-Hant'), chinês tradicional ('zh-Hant' '), turco ('tr'), Sorbian Superior ('hsb'), Uzbeque ('uz'), Volapük ('vo'), Walser ('wae'), Frísiano Ocidental ('fy'), Yucatec Maya ('yua'), Zhuang ('za') e Zulu ('zu') têm suporte (imprimir – setenta e três idiomas e manuscrito – somente inglês). O layout dá suporte à identificação automática de idioma e a documentos de vários idiomas, portanto, forneça apenas um código de idioma se você quiser forçar o documentado a ser processado como esse idioma específico.
ReadingOrder	Algoritmo de ordem de leitura para classificar as linhas de texto retornadas. Os pedidos de leitura com suporte incluem: básico(padrão), natural.
SourcePath	URI ou caminho local para os dados de origem.

ErrorInformation

Nome	Tipo	Description
code	string
message	string

ErrorResponse

Nome	Tipo	Description
error	ErrorInformation

Language

Atualmente, apenas africâner ('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 Criméia - Script latino('crh'), Tcheco ('cs'), dinamarquês ('da'), holandês ('nl'), inglês ('en'), estoniano ('et'), fijiano ('fj'), filipino ('fil'), finlandês ('fi'), francês ('fr'), fúliano ('pele'), galego ('gl'), alemão ('de'), Gilbertese ('gil'), esverdeado ('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'), Javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), Kashubian ('csb'), Khasi ('kha'), coreano ('ko'), curdo - script latino ('ku'), K'iche' ('quc'), Luxemburgo ('lb'), malaio ('ms'), Manx ('gv'),neapolitan ('nap'), norueguês ('não'), Occitan ('oc'), polonês ('pl'), polonês ('pl'), Português ('pt'), Romansh ('rm'), escocês ('sco'), gaélico escocês ('gd'), chinês simplificado ('zh-Hans'), esloveno ('sl'), espanhol ('es'), suaíli ('sw'), sueco ('sv'), tártaro - script latino ('tt'), Tetum ('tet'), chinês tradicional ('zh-Hant'), chinês tradicional ('zh-Hant' '), turco ('tr'), Sorbian Superior ('hsb'), Uzbeque ('uz'), Volapük ('vo'), Walser ('wae'), Frísiano Ocidental ('fy'), Yucatec Maya ('yua'), Zhuang ('za') e Zulu ('zu') têm suporte (imprimir – setenta e três idiomas e manuscrito – somente inglês). O layout dá suporte à identificação automática de idioma e a documentos de vários idiomas, portanto, forneça apenas um código de idioma se você quiser forçar o documentado a ser processado como esse idioma específico.

Nome	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 classificar as linhas de texto retornadas. Os pedidos de leitura com suporte incluem: básico(padrão), natural.

Nome	Tipo	Description
basic	string
natural	string

SourcePath

URI ou caminho local para os dados de origem.

Nome	Tipo	Description
source	string	Caminho de origem do arquivo.

Compartilhar via

Analyzer - Analyze Layout

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Analyze layout

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorInformation

ErrorResponse

Language

ReadingOrder

SourcePath

Recursos adicionais