Analyzers - Analyze

Service:

Azure AI Services

API Version:

2024-12-01-preview

Extract content and fields from input.

POST {endpoint}/contentunderstanding/analyzers/{analyzerId}:analyze?api-version=2024-12-01-preview

URI Parameters

Name	In	Required	Type	Description
analyzerId	path	True	string	The unique identifier of the analyzer. Regex pattern: ^[a-zA-Z0-9._-]{1,64}$
endpoint	path	True	string uri	Content Understanding service endpoint.
api-version	query	True	string	The API version to use for this operation.

Request Header

Name	Required	Type	Description
Operation-Id		string	A client-provided GUID to identify the long-running operation.
x-ms-client-request-id		string uuid	An opaque, globally-unique, client-generated string identifier for the request.

Request Body

Name	Type	Description
url	string	The URL of the document to analyze.

Responses

Name	Type	Description
202 Accepted		The request has been accepted for processing, but processing has not yet completed. Headers Operation-Id: string Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. 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

Analyze URL

Sample request

HTTP

POST {endpoint}/contentunderstanding/analyzers/myAnalyzer:analyze?api-version=2024-12-01-preview


{
  "url": "https://host.com/doc.pdf"
}

Sample response

Status code:

202

Operation-Id: 3b31320d-8bab-4f88-b19c-2322a7f11034
Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzers/myAnalyzer/results/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-12-01-preview

{
  "id": "3b31320d-8bab-4f88-b19c-2322a7f11034",
  "status": "NotStarted"
}

Definitions

Name	Description
AnalyzeRequest	Analyze operation request.
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 Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

AnalyzeRequest

Analyze operation request.

Name	Type	Description
url	string	The URL of the document to analyze.

Azure.Core.Foundations.Error

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

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.