Document Models - Analyze Document From Stream

Serviço:

Azure AI Services

Versão da API:

2024-02-29-preview

Analisa o documento com o modelo de documento.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-02-29-preview

Com parâmetros opcionais:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-02-29-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O ponto final do serviço 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 utilizar para esta operação.
features	query		DocumentAnalysisFeature[]	Lista de funcionalidades de análise opcionais.
locale	query		string	Sugestão de localização para reconhecimento de texto e análise de documentos. O valor pode conter apenas o código de idioma (por exemplo, "en", "fr") ou a etiqueta de idioma BCP 47 (ex. "en-US").
outputContentFormat	query		ContentFormat	Formato do conteúdo de nível superior do resultado de análise.
pages	query		string	Lista de números de página baseados em 1 para analisar. Por exemplo: "1-3,5,7-9" Padrão Regex: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Lista de campos adicionais a extrair. Por exemplo: "NumberOfGuests, StoreNumber"
stringIndexType	query		StringIndexType	Método utilizado para calcular o desvio e o comprimento das cadeias de carateres.

Corpo do Pedido

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"

Name	Tipo	Description
input	string	Conteúdo de entrada.

Respostas

Name	Tipo	Description
202 Accepted		O pedido foi aceite para processamento, mas o processamento ainda não foi concluído. Cabeçalhos Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

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

Âmbitos

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

Exemplos

Analyze Document from Url

Pedido de amostra

HTTP

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

"{binaryFile}"

Resposta da amostra

Código de estado:

202

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

Definições

Name	Description
ContentFormat	Formato do conteúdo no resultado analisado.
DocumentAnalysisFeature	Lista de funcionalidades de análise opcionais.
Error	O objeto de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Um objeto que contém informações mais específicas sobre o erro.
StringIndexType	Método utilizado para calcular o desvio e o comprimento das cadeias de carateres.

ContentFormat

Formato do conteúdo no resultado analisado.

Name	Tipo	Description
markdown	string	Representação markdown do conteúdo do documento com cabeçalhos de secção, tabelas, etc.
text	string	Representação de texto simples do conteúdo do documento sem qualquer formatação.

DocumentAnalysisFeature

Lista de funcionalidades de análise opcionais.

Name	Tipo	Description
barcodes	string	Ative a deteção de códigos de barras no documento.
formulas	string	Ative a deteção de expressões matemáticas no documento.
keyValuePairs	string	Ative a deteção de pares de valores de chave geral (campos de formulário) no documento.
languages	string	Ative a deteção do idioma do conteúdo de texto.
ocrHighResolution	string	Execute o OCR numa resolução superior para processar documentos com letras minúsculas.
queryFields	string	Ative a extração de campos adicionais através do parâmetro de consulta queryFields.
styleFont	string	Ative o reconhecimento de vários estilos de tipo de letra.

Error

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innererror	InnerError	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 por humanos do erro.
target	string	O destino do erro.

ErrorResponse

Objeto de resposta de erro.

Name	Tipo	Description
error	Error	Informações de erro.

InnerError

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

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
innererror	InnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

StringIndexType

Método utilizado para calcular o desvio e o comprimento das cadeias de carateres.

Name	Tipo	Description
textElements	string	Caráter de apresentação percepcionado pelo utilizador ou cluster de grafos, conforme definido pelo Unicode 8.0.0.
unicodeCodePoint	string	Unidade de carateres representada por um único ponto de código unicode. Utilizado pelo Python 3.
utf16CodeUnit	string	Unidade de carateres representada por uma unidade de código Unicode de 16 bits. Utilizado por JavaScript, Java e .NET.