Share via

Content Analyzers - Get Result File

Service:
Azure AI Services
API Version:
2025-05-01-preview

Get a file associated with the result of an analysis operation.

GET {endpoint}/contentunderstanding/analyzerResults/{operationId}/files/{path}?api-version=2025-05-01-preview

URI Parameters

Name In Required Type Description
endpoint
 path True

string (uri)

Content Understanding service endpoint.
operationId
 path True

string

Operation identifier.
path
 path True

string

File path.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

file

The request has succeeded.

Media Types: "*/*", "application/json"
Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Media Types: "*/*", "application/json"

Headers

x-ms-error-code: string

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 Analysis Result File

Sample request

GET {endpoint}/contentunderstanding/analyzerResults/3b31320d-8bab-4f88-b19c-2322a7f11034/files/figure-1.1?api-version=2025-05-01-preview

Sample response

Status code:
200 
"{imageBinary}"

Definitions

Name Description
Azure.Core.Foundations.Error

The error object.
Azure.Core.Foundations.ErrorResponse

A response containing error details.
Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Azure.Core.Foundations.Error

Object

The error object.

Name Type Description
code

string

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

Azure.Core.Foundations.Error[]

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

Azure.Core.Foundations.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.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name Type Description
error

Azure.Core.Foundations.Error

The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name Type Description
code

string

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

Azure.Core.Foundations.InnerError

Inner error.