Document Models - Analyze Document From Stream

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Analisa o documento com o modelo de documento.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-11-30

Com parâmetros opcionais:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-11-30&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string uri	O ponto de extremidade do serviço do Document Intelligence.
modelId	path	True	string	Nome exclusivo do modelo de documento. Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	A versão da API a ser usada para esta operação.
features	query		DocumentAnalysisFeature[]	Lista de recursos de análise opcionais.
locale	query		string	Dica de localidade para reconhecimento de texto e análise de documentos. O valor pode conter apenas o código de idioma (ex. "en", "fr") ou a marca de idioma BCP 47 (ex. "en-US").
output	query		AnalyzeOutputOption[]	Saídas adicionais a serem geradas durante a análise.
outputContentFormat	query		DocumentContentFormat	Formato do conteúdo de nível superior do resultado de análise.
pages	query		string	Números de página baseados em 1 a serem analisados. Ex. "1-3,5,7-9" Padrão Regex: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Lista de campos adicionais a serem extraídos. Ex. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

Corpo da solicitação

Media Types: "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Nome	Tipo	Description
input	string	Conteúdo de entrada.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. Cabeçalhos Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

Analyze Document from Url

Solicitação de exemplo

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?api-version=2024-11-30&pages=1-2,4&locale=en-US&stringIndexType=textElements

"{binaryFile}"

Resposta de exemplo

Código de status:

202

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

Definições

Nome	Description
AnalyzeOutputOption	Saídas adicionais a serem geradas durante a análise.
DocumentAnalysisFeature	Recursos de análise de documentos a serem habilitados.
DocumentContentFormat	Formato do conteúdo no resultado analisado.
DocumentIntelligenceError	O objeto de erro.
DocumentIntelligenceErrorResponse	Objeto de resposta de erro.
DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas sobre o erro.
StringIndexType	Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

AnalyzeOutputOption

Saídas adicionais a serem geradas durante a análise.

Nome	Tipo	Description
figures	string	Gerar imagens cortadas de figuras detectadas.
pdf	string	Gerar saída de PDF pesquisável.

DocumentAnalysisFeature

Recursos de análise de documentos a serem habilitados.

Nome	Tipo	Description
barcodes	string	Habilite a detecção de códigos de barras no documento.
formulas	string	Habilite a detecção de expressões matemáticas no documento.
keyValuePairs	string	Habilite a detecção de pares de valor de chave geral (campos de formulário) no documento.
languages	string	Habilite a detecção do idioma de conteúdo de texto.
ocrHighResolution	string	Execute o OCR em uma resolução mais alta para lidar com documentos com impressão fina.
queryFields	string	Habilite a extração de campos adicionais por meio do parâmetro de consulta queryFields.
styleFont	string	Habilite o reconhecimento de vários estilos de fonte.

DocumentContentFormat

Formato do conteúdo no resultado analisado.

Nome	Tipo	Description
markdown	string	Representação markdown do conteúdo do documento com títulos de seção, tabelas etc.
text	string	Representação de texto sem formatação do conteúdo do documento sem nenhuma formatação.

DocumentIntelligenceError

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	DocumentIntelligenceError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

Nome	Tipo	Description
error	DocumentIntelligenceError	Informações de erro.

DocumentIntelligenceInnerError

Um objeto que contém informações mais específicas sobre o erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	DocumentIntelligenceInnerError	Erro interno.
message	string	Uma representação legível pelo ser humano do erro.

StringIndexType

Método usado para calcular o deslocamento e o comprimento da cadeia de caracteres.

Nome	Tipo	Description
textElements	string	Caractere de exibição percebido pelo usuário ou cluster grapheme, conforme definido pelo Unicode 8.0.0.
unicodeCodePoint	string	Unidade de caractere representada por um único ponto de código unicode. Usado pelo Python 3.
utf16CodeUnit	string	Unidade de caractere representada por uma unidade de código Unicode de 16 bits. Usado por JavaScript, Java e .NET.