Document Models - Get Analyze Result Figure

  • Referência
Serviço:
Azure AI Services
Versão da API:
2024-07-31-preview

Obtém a imagem cortada gerada da figura especificada da análise do documento.

GET {endpoint}/documentintelligence/documentModels/{modelId}/analyzeResults/{resultId}/figures/{figureId}?api-version=2024-07-31-preview

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.
figureId
 path True

string

ID da figura.
modelId
 path True

string

Nome exclusivo do modelo de documento.

Padrão Regex: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
resultId
 path True

string

uuid

Analisar a ID do resultado da operação.
api-version
 query True

string

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

file

A solicitação foi bem-sucedida.

Media Types: "image/png", "application/json"
Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Media Types: "image/png", "application/json"

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

Get Analyze Document Result Figure

Solicitação de exemplo

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034/figures/1.0?api-version=2024-07-31-preview

Resposta de exemplo

Código de status:
200 
"{imageBinary}"

Definições

Nome Description
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.

Error

O objeto de erro.

Nome Tipo Description
code

string

Um de um conjunto definido pelo servidor de códigos de erro.
details

Error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
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 pelo ser humano do erro.
target

string

O destino do erro.

ErrorResponse

Objeto de resposta de erro.

Nome Tipo Description
error

Error

Informações de erro.

InnerError

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

InnerError

Erro interno.
message

string

Uma representação legível pelo ser humano do erro.