Share via

Document Models - Get Analyze Result Figure

  • Reference
Service:
Azure AI Services
API Version:
2024-07-31-preview

Gets the generated cropped image of specified figure from document analysis.

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

URI Parameters

Name In Required Type Description
endpoint
 path True

string

uri

The Document Intelligence service endpoint.
figureId
 path True

string

Figure ID.
modelId
 path True

string

Unique document model name.

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

string

uuid

Analyze operation result ID.
api-version
 query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

file

The request has succeeded.

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

ErrorResponse

An unexpected error response.

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

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Examples

Get Analyze Document Result Figure

Sample request

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

Sample response

Status code:
200 
"{imageBinary}"

Definitions

Name Description
Error

The error object.
ErrorResponse

Error response object.
InnerError

An object containing more specific information about the error.

Error

The error object.

Name Type Description
code

string

One of a server-defined set of error codes.
details

Error[]

An array of details about specific errors that led to this reported error.
innererror

InnerError

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.
target

string

The target of the error.

ErrorResponse

Error response object.

Name Type Description
error

Error

Error info.

InnerError

An object containing more specific information about the error.

Name Type Description
code

string

One of a server-defined set of error codes.
innererror

InnerError

Inner error.
message

string

A human-readable representation of the error.