Share via

Content Analyzers - Get Defaults

Service:
Azure AI Services
API Version:
2025-11-01

Return default settings for this Content Understanding resource.

GET {endpoint}/contentunderstanding/defaults?api-version=2025-11-01

URI Parameters

Name In Required Type Description
endpoint
 path True

string (uri)

Content Understanding service endpoint.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

ContentUnderstandingDefaults

The request has succeeded.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

Key-based authentication using the access key of the Azure resource.

Type: apiKey
In: header

EntraIdToken

Microsoft Entra ID OAuth2 authentication using an access token.

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 Defaults

Sample request

GET {endpoint}/contentunderstanding/defaults?api-version=2025-11-01

Sample response

Status code:
200 
{
  "modelDeployments": {
    "gpt-4.1": "myGpt41Deployment",
    "text-embedding-3-large": "myTextEmbedding3LargeDeployment"
  }
}

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.
ContentUnderstandingDefaults

default settings for this Content Understanding resource.

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.

ContentUnderstandingDefaults

Object

default settings for this Content Understanding resource.

Name Type Description
modelDeployments

object

Mapping of model names to deployments. Ex. { "gpt-4.1": "myGpt41Deployment", "text-embedding-3-large": "myTextEmbedding3LargeDeployment" }.