Content Understanding (stable:2025-11-01)

2025/11/20 • 15 new methods

ContentAnalyzers_GetResult (new)
Description :  Get the result of an analysis operation.
Reference :  Link ¶

⚼ Request

GET:  /analyzerResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The version of the API used to analyze the document. ,
Required: False ,
}
string ,
createdAt:
{
Description: The date and time when the result was created. ,
Format: date-time ,
Required: False ,
}
string ,
warnings:
{
Description: Warnings encountered while analyzing the document. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
stringEncoding:
{
Description: The string encoding format for content spans in the response. Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") ,
Required: False ,
}
string ,
contents:
{
Description: The extracted content. ,
Required: True ,
}
[
{
kind:
{
Description: Content kind. ,
Enum:
{
document: Document content, such as pdf, image, txt, etc. ,
audioVisual: Audio visual content, such as mp3, mp4, etc. ,
}
,
Required: True ,
}
enum ,
mimeType:
{
Description: Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The analyzer that generated this content. ,
Required: False ,
}
string ,
category:
{
Description: Classified content category. ,
Required: False ,
}
string ,
path:
{
Description: The path of the content in the input. ,
Required: False ,
}
string ,
markdown:
{
Description: Markdown representation of the content. ,
Required: False ,
}
string ,
fields:
{
Description: Extracted fields from the content. ,
Required: False ,
}
object ,
}
,
]
,
}
,
usage:
{
Description: Usage details of the analyze operation. ,
Required: False ,
}
{
documentPagesMinimal:
{
Description: The number of document pages processed at the minimal level. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page. ,
Format: int32 ,
Required: False ,
}
integer ,
documentPagesBasic:
{
Description: The number of document pages processed at the basic level. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page. ,
Format: int32 ,
Required: False ,
}
integer ,
documentPagesStandard:
{
Description: The number of document pages processed at the standard level. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page. ,
Format: int32 ,
Required: False ,
}
integer ,
audioHours:
{
Description: The hours of audio processed. ,
Format: float ,
Required: False ,
}
number ,
videoHours:
{
Description: The hours of video processed. ,
Format: float ,
Required: False ,
}
number ,
contextualizationTokens:
{
Description: The number of contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting. ,
Format: int32 ,
Required: False ,
}
integer ,
tokens:
{
Description: The number of LLM and embedding tokens consumed, grouped by model (ex. GTP 4.1) and type (ex. input, cached input, output). ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_DeleteResult (new)
Description :  Mark the result of an analysis operation for deletion.
Reference :  Link ¶

⚼ Request

DELETE:  /analyzerResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_GetResultFile (new)
Description :  Get a file associated with the result of an analysis operation.
Reference :  Link ¶

⚼ Request

GET:  /analyzerResults/{operationId}/files/{path}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier. ,
Required: True ,
}
string ,
path:
{
Description: File path. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_List (new)
Description :  List analyzers.
Reference :  Link ¶

⚼ Request

GET:  /analyzers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of ContentAnalyzer items ,
}
{
value:
{
Description: The ContentAnalyzer items on this page ,
Required: True ,
}
[
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableFigureDescription:
{
Description: Enable generation of figure description. ,
Required: False ,
}
boolean ,
enableFigureAnalysis:
{
Description: Enable analysis of figures, such as charts and diagrams. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. ,
markdown: Represent tables using GitHub Flavored Markdown table syntax, which does not support merged cells or rich headers. ,
} ,
Required: False ,
} enum ,
chartFormat:
{
Description: Representation format of charts in analyze result markdown. ,
Enum:
{
chartJs: Represent charts as Chart.js code blocks. ,
markdown: Represent charts as markdown tables. ,
}
,
Required: False ,
}
enum ,
annotationFormat:
{
Description: Representation format of annotations in analyze result markdown. ,
Enum:
{
none: Do not represent annotations. ,
markdown: Represent basic annotation information using markdown formatting. ,
}
,
Required: False ,
}
enum ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return field grounding source and confidence. ,
Required: False ,
}
boolean ,
contentCategories:
{
Description: Map of categories to classify the input content(s) against. ,
Required: False ,
}
object ,
enableSegment:
{
Description: Enable segmentation of the input by contentCategories. ,
Required: False ,
}
boolean ,
segmentPerPage:
{
Description: Force segmentation of document content by page. ,
Required: False ,
}
boolean ,
omitContent:
{
Description: Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any. ,
Required: False ,
}
boolean ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
dynamicFieldSchema:
{
Description: Indicates whether the result may contain additional fields outside of the defined schema. ,
Required: False ,
}
boolean ,
processingLocation:
{
Description: The location where the data may be processed. Defaults to global. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
labeledData: A labeled data knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
models:
{
Description: Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }. ,
Required: False ,
}
object ,
supportedModels:
{
Description: Chat completion and embedding models supported by the analyzer. ,
Required: False ,
}
{
completion:
{
Description: Chat completion models supported by the analyzer. ,
Required: True ,
}
object ,
embedding:
{
Description: Embedding models supported by the analyzer. ,
Required: True ,
}
object ,
}
,
} , ] ,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
} , }

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_Get (new)
Description :  Get analyzer properties.
Reference :  Link ¶

⚼ Request

GET:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableFigureDescription:
{
Description: Enable generation of figure description. ,
Required: False ,
}
boolean ,
enableFigureAnalysis:
{
Description: Enable analysis of figures, such as charts and diagrams. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. ,
markdown: Represent tables using GitHub Flavored Markdown table syntax, which does not support merged cells or rich headers. ,
} ,
Required: False ,
} enum ,
chartFormat:
{
Description: Representation format of charts in analyze result markdown. ,
Enum:
{
chartJs: Represent charts as Chart.js code blocks. ,
markdown: Represent charts as markdown tables. ,
}
,
Required: False ,
}
enum ,
annotationFormat:
{
Description: Representation format of annotations in analyze result markdown. ,
Enum:
{
none: Do not represent annotations. ,
markdown: Represent basic annotation information using markdown formatting. ,
}
,
Required: False ,
}
enum ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return field grounding source and confidence. ,
Required: False ,
}
boolean ,
contentCategories:
{
Description: Map of categories to classify the input content(s) against. ,
Required: False ,
}
object ,
enableSegment:
{
Description: Enable segmentation of the input by contentCategories. ,
Required: False ,
}
boolean ,
segmentPerPage:
{
Description: Force segmentation of document content by page. ,
Required: False ,
}
boolean ,
omitContent:
{
Description: Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any. ,
Required: False ,
}
boolean ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
dynamicFieldSchema:
{
Description: Indicates whether the result may contain additional fields outside of the defined schema. ,
Required: False ,
}
boolean ,
processingLocation:
{
Description: The location where the data may be processed. Defaults to global. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
labeledData: A labeled data knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
models:
{
Description: Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }. ,
Required: False ,
}
object ,
supportedModels:
{
Description: Chat completion and embedding models supported by the analyzer. ,
Required: False ,
}
{
completion:
{
Description: Chat completion models supported by the analyzer. ,
Required: True ,
}
object ,
embedding:
{
Description: Embedding models supported by the analyzer. ,
Required: True ,
}
object ,
}
,
} , }

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_CreateOrReplace (new)
Description :  Create a new analyzer asynchronously.
Reference :  Link ¶

⚼ Request

PUT:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
allowReplace:
{
Description: Allow the operation to replace an existing resource. ,
Required: False ,
}
boolean ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableFigureDescription:
{
Description: Enable generation of figure description. ,
Required: False ,
}
boolean ,
enableFigureAnalysis:
{
Description: Enable analysis of figures, such as charts and diagrams. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. ,
markdown: Represent tables using GitHub Flavored Markdown table syntax, which does not support merged cells or rich headers. ,
} ,
Required: False ,
} enum ,
chartFormat:
{
Description: Representation format of charts in analyze result markdown. ,
Enum:
{
chartJs: Represent charts as Chart.js code blocks. ,
markdown: Represent charts as markdown tables. ,
}
,
Required: False ,
}
enum ,
annotationFormat:
{
Description: Representation format of annotations in analyze result markdown. ,
Enum:
{
none: Do not represent annotations. ,
markdown: Represent basic annotation information using markdown formatting. ,
}
,
Required: False ,
}
enum ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return field grounding source and confidence. ,
Required: False ,
}
boolean ,
contentCategories:
{
Description: Map of categories to classify the input content(s) against. ,
Required: False ,
}
object ,
enableSegment:
{
Description: Enable segmentation of the input by contentCategories. ,
Required: False ,
}
boolean ,
segmentPerPage:
{
Description: Force segmentation of document content by page. ,
Required: False ,
}
boolean ,
omitContent:
{
Description: Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any. ,
Required: False ,
}
boolean ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
dynamicFieldSchema:
{
Description: Indicates whether the result may contain additional fields outside of the defined schema. ,
Required: False ,
}
boolean ,
processingLocation:
{
Description: The location where the data may be processed. Defaults to global. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
labeledData: A labeled data knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
models:
{
Description: Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }. ,
Required: False ,
}
object ,
supportedModels:
{
Description: Chat completion and embedding models supported by the analyzer. ,
Required: False ,
}
{
completion:
{
Description: Chat completion models supported by the analyzer. ,
Required: True ,
}
object ,
embedding:
{
Description: Embedding models supported by the analyzer. ,
Required: True ,
}
object ,
}
,
} , }

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableFigureDescription:
{
Description: Enable generation of figure description. ,
Required: False ,
}
boolean ,
enableFigureAnalysis:
{
Description: Enable analysis of figures, such as charts and diagrams. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. ,
markdown: Represent tables using GitHub Flavored Markdown table syntax, which does not support merged cells or rich headers. ,
} ,
Required: False ,
} enum ,
chartFormat:
{
Description: Representation format of charts in analyze result markdown. ,
Enum:
{
chartJs: Represent charts as Chart.js code blocks. ,
markdown: Represent charts as markdown tables. ,
}
,
Required: False ,
}
enum ,
annotationFormat:
{
Description: Representation format of annotations in analyze result markdown. ,
Enum:
{
none: Do not represent annotations. ,
markdown: Represent basic annotation information using markdown formatting. ,
}
,
Required: False ,
}
enum ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return field grounding source and confidence. ,
Required: False ,
}
boolean ,
contentCategories:
{
Description: Map of categories to classify the input content(s) against. ,
Required: False ,
}
object ,
enableSegment:
{
Description: Enable segmentation of the input by contentCategories. ,
Required: False ,
}
boolean ,
segmentPerPage:
{
Description: Force segmentation of document content by page. ,
Required: False ,
}
boolean ,
omitContent:
{
Description: Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any. ,
Required: False ,
}
boolean ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
dynamicFieldSchema:
{
Description: Indicates whether the result may contain additional fields outside of the defined schema. ,
Required: False ,
}
boolean ,
processingLocation:
{
Description: The location where the data may be processed. Defaults to global. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
labeledData: A labeled data knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
models:
{
Description: Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }. ,
Required: False ,
}
object ,
supportedModels:
{
Description: Chat completion and embedding models supported by the analyzer. ,
Required: False ,
}
{
completion:
{
Description: Chat completion models supported by the analyzer. ,
Required: True ,
}
object ,
embedding:
{
Description: Embedding models supported by the analyzer. ,
Required: True ,
}
object ,
}
,
} , }

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableFigureDescription:
{
Description: Enable generation of figure description. ,
Required: False ,
}
boolean ,
enableFigureAnalysis:
{
Description: Enable analysis of figures, such as charts and diagrams. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. ,
markdown: Represent tables using GitHub Flavored Markdown table syntax, which does not support merged cells or rich headers. ,
} ,
Required: False ,
} enum ,
chartFormat:
{
Description: Representation format of charts in analyze result markdown. ,
Enum:
{
chartJs: Represent charts as Chart.js code blocks. ,
markdown: Represent charts as markdown tables. ,
}
,
Required: False ,
}
enum ,
annotationFormat:
{
Description: Representation format of annotations in analyze result markdown. ,
Enum:
{
none: Do not represent annotations. ,
markdown: Represent basic annotation information using markdown formatting. ,
}
,
Required: False ,
}
enum ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return field grounding source and confidence. ,
Required: False ,
}
boolean ,
contentCategories:
{
Description: Map of categories to classify the input content(s) against. ,
Required: False ,
}
object ,
enableSegment:
{
Description: Enable segmentation of the input by contentCategories. ,
Required: False ,
}
boolean ,
segmentPerPage:
{
Description: Force segmentation of document content by page. ,
Required: False ,
}
boolean ,
omitContent:
{
Description: Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any. ,
Required: False ,
}
boolean ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
dynamicFieldSchema:
{
Description: Indicates whether the result may contain additional fields outside of the defined schema. ,
Required: False ,
}
boolean ,
processingLocation:
{
Description: The location where the data may be processed. Defaults to global. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
labeledData: A labeled data knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
models:
{
Description: Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }. ,
Required: False ,
}
object ,
supportedModels:
{
Description: Chat completion and embedding models supported by the analyzer. ,
Required: False ,
}
{
completion:
{
Description: Chat completion models supported by the analyzer. ,
Required: True ,
}
object ,
embedding:
{
Description: Embedding models supported by the analyzer. ,
Required: True ,
}
object ,
}
,
} , }

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_Update (new)
Description :  Update analyzer properties.
Reference :  Link ¶

⚼ Request

PATCH:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Analyzer that extracts content and fields from multimodal documents. ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableFigureDescription:
{
Description: Enable generation of figure description. ,
Required: False ,
}
boolean ,
enableFigureAnalysis:
{
Description: Enable analysis of figures, such as charts and diagrams. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. ,
markdown: Represent tables using GitHub Flavored Markdown table syntax, which does not support merged cells or rich headers. ,
} ,
Required: False ,
} enum ,
chartFormat:
{
Description: Representation format of charts in analyze result markdown. ,
Enum:
{
chartJs: Represent charts as Chart.js code blocks. ,
markdown: Represent charts as markdown tables. ,
}
,
Required: False ,
}
enum ,
annotationFormat:
{
Description: Representation format of annotations in analyze result markdown. ,
Enum:
{
none: Do not represent annotations. ,
markdown: Represent basic annotation information using markdown formatting. ,
}
,
Required: False ,
}
enum ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return field grounding source and confidence. ,
Required: False ,
}
boolean ,
contentCategories:
{
Description: Map of categories to classify the input content(s) against. ,
Required: False ,
}
object ,
enableSegment:
{
Description: Enable segmentation of the input by contentCategories. ,
Required: False ,
}
boolean ,
segmentPerPage:
{
Description: Force segmentation of document content by page. ,
Required: False ,
}
boolean ,
omitContent:
{
Description: Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any. ,
Required: False ,
}
boolean ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
dynamicFieldSchema:
{
Description: Indicates whether the result may contain additional fields outside of the defined schema. ,
Required: False ,
}
boolean ,
processingLocation:
{
Description: The location where the data may be processed. Defaults to global. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
labeledData: A labeled data knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
models:
{
Description: Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }. ,
Required: False ,
}
object ,
supportedModels:
{
Description: Chat completion and embedding models supported by the analyzer. ,
Required: False ,
}
{
completion:
{
Description: Chat completion models supported by the analyzer. ,
Required: True ,
}
object ,
embedding:
{
Description: Embedding models supported by the analyzer. ,
Required: True ,
}
object ,
}
,
} , }

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_Delete (new)
Description :  Delete analyzer.
Reference :  Link ¶

⚼ Request

DELETE:  /analyzers/{analyzerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_Analyze (new)
Description :  Extract content and fields from input.
Reference :  Link ¶

⚼ Request

POST:  /analyzers/{analyzerId}:analyze
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
stringEncoding:
{
Description: The string encoding format for content spans in the response. Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") ,
Required: False ,
}
string ,
processingLocation:
{
Description: The location where the data may be processed. Defaults to global. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
inputs:
{
Description: Inputs to analyze. Currently, only pro mode supports multiple inputs. ,
Required: False ,
}
[
{
url:
{
Description: The URL of the input to analyze. Only one of url or data should be specified. ,
Format: uri ,
Required: False ,
}
string ,
data:
{
Description: Base64-encoded binary content of the input to analyze. Only one of url or data should be specified. ,
Format: byte ,
Required: False ,
}
string ,
name:
{
Description: Name of the input. ,
Required: False ,
}
string ,
mimeType:
{
Description: The MIME type of the input content. Ex. application/pdf, image/jpeg, etc. ,
Required: False ,
}
string ,
range:
{
Description: Range of the input to analyze (ex. `1-3,5,9-`). Document content uses 1-based page numbers, while audio visual content uses integer milliseconds. ,
Required: False ,
}
string ,
}
,
]
,
modelDeployments:
{
Description: Override default mapping of model names to deployments. Ex. { "gpt-4.1": "myGpt41Deployment", "text-embedding-3-large": "myTextEmbedding3LargeDeployment" }. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Provides status details for long running operations. ,
}
{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The version of the API used to analyze the document. ,
Required: False ,
}
string ,
createdAt:
{
Description: The date and time when the result was created. ,
Format: date-time ,
Required: False ,
}
string ,
warnings:
{
Description: Warnings encountered while analyzing the document. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
stringEncoding:
{
Description: The string encoding format for content spans in the response. Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") ,
Required: False ,
}
string ,
contents:
{
Description: The extracted content. ,
Required: True ,
}
[
{
kind:
{
Description: Content kind. ,
Enum:
{
document: Document content, such as pdf, image, txt, etc. ,
audioVisual: Audio visual content, such as mp3, mp4, etc. ,
}
,
Required: True ,
}
enum ,
mimeType:
{
Description: Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The analyzer that generated this content. ,
Required: False ,
}
string ,
category:
{
Description: Classified content category. ,
Required: False ,
}
string ,
path:
{
Description: The path of the content in the input. ,
Required: False ,
}
string ,
markdown:
{
Description: Markdown representation of the content. ,
Required: False ,
}
string ,
fields:
{
Description: Extracted fields from the content. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_AnalyzeBinary (new)
Description :  Extract content and fields from input.
Reference :  Link ¶

⚼ Request

POST:  /analyzers/{analyzerId}:analyzeBinary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
stringEncoding:
{
Description: The string encoding format for content spans in the response. Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") ,
Required: False ,
}
string ,
processingLocation:
{
Description: The location where the data may be processed. Defaults to global. ,
Required: False ,
}
string ,
range:
{
Description: Range of the input to analyze (ex. `1-3,5,9-`). Document content uses 1-based page numbers, while audio visual content uses integer milliseconds. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
input:
{
Description: The binary content of the document to analyze. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Provides status details for long running operations. ,
}
{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The version of the API used to analyze the document. ,
Required: False ,
}
string ,
createdAt:
{
Description: The date and time when the result was created. ,
Format: date-time ,
Required: False ,
}
string ,
warnings:
{
Description: Warnings encountered while analyzing the document. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
stringEncoding:
{
Description: The string encoding format for content spans in the response. Possible values are 'codePoint', 'utf16', and `utf8`. Default is `codePoint`.") ,
Required: False ,
}
string ,
contents:
{
Description: The extracted content. ,
Required: True ,
}
[
{
kind:
{
Description: Content kind. ,
Enum:
{
document: Document content, such as pdf, image, txt, etc. ,
audioVisual: Audio visual content, such as mp3, mp4, etc. ,
}
,
Required: True ,
}
enum ,
mimeType:
{
Description: Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The analyzer that generated this content. ,
Required: False ,
}
string ,
category:
{
Description: Classified content category. ,
Required: False ,
}
string ,
path:
{
Description: The path of the content in the input. ,
Required: False ,
}
string ,
markdown:
{
Description: Markdown representation of the content. ,
Required: False ,
}
string ,
fields:
{
Description: Extracted fields from the content. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_Copy (new)
Description :  Create a copy of the source analyzer to the current location.
Reference :  Link ¶

⚼ Request

POST:  /analyzers/{analyzerId}:copy
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
allowReplace:
{
Description: Allow the operation to replace an existing resource. ,
Required: False ,
}
boolean ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
sourceAzureResourceId:
{
Description: Azure resource ID of the source analyzer location. Defaults to the current resource. ,
Required: False ,
}
string ,
sourceRegion:
{
Description: Azure region of the source analyzer location. Defaults to current region. ,
Required: False ,
}
string ,
sourceAnalyzerId:
{
Description: Source analyzer ID. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Provides status details for long running operations. ,
}
{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableFigureDescription:
{
Description: Enable generation of figure description. ,
Required: False ,
}
boolean ,
enableFigureAnalysis:
{
Description: Enable analysis of figures, such as charts and diagrams. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. ,
markdown: Represent tables using GitHub Flavored Markdown table syntax, which does not support merged cells or rich headers. ,
} ,
Required: False ,
} enum ,
chartFormat:
{
Description: Representation format of charts in analyze result markdown. ,
Enum:
{
chartJs: Represent charts as Chart.js code blocks. ,
markdown: Represent charts as markdown tables. ,
}
,
Required: False ,
}
enum ,
annotationFormat:
{
Description: Representation format of annotations in analyze result markdown. ,
Enum:
{
none: Do not represent annotations. ,
markdown: Represent basic annotation information using markdown formatting. ,
}
,
Required: False ,
}
enum ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return field grounding source and confidence. ,
Required: False ,
}
boolean ,
contentCategories:
{
Description: Map of categories to classify the input content(s) against. ,
Required: False ,
}
object ,
enableSegment:
{
Description: Enable segmentation of the input by contentCategories. ,
Required: False ,
}
boolean ,
segmentPerPage:
{
Description: Force segmentation of document content by page. ,
Required: False ,
}
boolean ,
omitContent:
{
Description: Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any. ,
Required: False ,
}
boolean ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
dynamicFieldSchema:
{
Description: Indicates whether the result may contain additional fields outside of the defined schema. ,
Required: False ,
}
boolean ,
processingLocation:
{
Description: The location where the data may be processed. Defaults to global. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
labeledData: A labeled data knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
models:
{
Description: Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }. ,
Required: False ,
}
object ,
supportedModels:
{
Description: Chat completion and embedding models supported by the analyzer. ,
Required: False ,
}
{
completion:
{
Description: Chat completion models supported by the analyzer. ,
Required: True ,
}
object ,
embedding:
{
Description: Embedding models supported by the analyzer. ,
Required: True ,
}
object ,
}
,
} , } , }

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_GrantCopyAuthorization (new)
Description :  Get authorization for copying this analyzer to another location.
Reference :  Link ¶

⚼ Request

POST:  /analyzers/{analyzerId}:grantCopyAuthorization
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Required: True ,
}
{
targetAzureResourceId:
{
Description: Azure resource ID of the target analyzer location. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Azure region of the target analyzer location. Defaults to current region. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Copy authorization details for cross-resource copy. ,
}
{
source:
{
Description: Full path of the source analyzer. ,
Required: True ,
}
string ,
targetAzureResourceId:
{
Description: Azure resource ID of the target location to copy to. ,
Required: True ,
}
string ,
expiresAt:
{
Description: Date/time when the copy authorization expires. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_GetOperationStatus (new)
Description :  Get the status of an analyzer creation operation.
Reference :  Link ¶

⚼ Request

GET:  /analyzers/{analyzerId}/operations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
operationId:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The unique ID of the operation. ,
Required: True ,
}
string ,
status:
{
Description: The status of the operation ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error object that describes the error when status is "Failed". ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
result:
{
Description: The result of the operation. ,
Required: False ,
}
{
analyzerId:
{
Description: The unique identifier of the analyzer. ,
Required: True ,
}
string ,
description:
{
Description: A description of the analyzer. ,
Required: False ,
}
string ,
tags:
{
Description: Tags associated with the analyzer. ,
Required: False ,
}
object ,
status:
{
Description: The status of the analyzer. ,
Enum:
{
creating: The resource is being created. ,
ready: The resource is ready. ,
deleting: The resource is being deleted. ,
failed: The resource failed during creation. ,
}
,
Required: True ,
}
enum ,
createdAt:
{
Description: The date and time when the analyzer was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedAt:
{
Description: The date and time when the analyzer was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
warnings:
{
Description: Warnings encountered while creating the analyzer. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
baseAnalyzerId:
{
Description: The analyzer to incrementally train from. ,
Required: False ,
}
string ,
config:
{
Description: Analyzer configuration settings. ,
Required: False ,
}
{
returnDetails:
{
Description: Return all content details. ,
Required: False ,
}
boolean ,
locales:
{
Description: List of locale hints for speech transcription. ,
Required: False ,
}
[
string ,
]
,
enableOcr:
{
Description: Enable optical character recognition (OCR). ,
Required: False ,
}
boolean ,
enableLayout:
{
Description: Enable layout analysis. ,
Required: False ,
}
boolean ,
enableFigureDescription:
{
Description: Enable generation of figure description. ,
Required: False ,
}
boolean ,
enableFigureAnalysis:
{
Description: Enable analysis of figures, such as charts and diagrams. ,
Required: False ,
}
boolean ,
enableFormula:
{
Description: Enable mathematical formula detection. ,
Required: False ,
}
boolean ,
tableFormat:
{
Description: Representation format of tables in analyze result markdown. ,
Enum:
{
html: Represent tables using HTML table elements: \, \, \
, \
. ,
markdown: Represent tables using GitHub Flavored Markdown table syntax, which does not support merged cells or rich headers. ,
} ,
Required: False ,
} enum ,
chartFormat:
{
Description: Representation format of charts in analyze result markdown. ,
Enum:
{
chartJs: Represent charts as Chart.js code blocks. ,
markdown: Represent charts as markdown tables. ,
}
,
Required: False ,
}
enum ,
annotationFormat:
{
Description: Representation format of annotations in analyze result markdown. ,
Enum:
{
none: Do not represent annotations. ,
markdown: Represent basic annotation information using markdown formatting. ,
}
,
Required: False ,
}
enum ,
disableFaceBlurring:
{
Description: Disable the default blurring of faces for privacy while processing the content. ,
Required: False ,
}
boolean ,
estimateFieldSourceAndConfidence:
{
Description: Return field grounding source and confidence. ,
Required: False ,
}
boolean ,
contentCategories:
{
Description: Map of categories to classify the input content(s) against. ,
Required: False ,
}
object ,
enableSegment:
{
Description: Enable segmentation of the input by contentCategories. ,
Required: False ,
}
boolean ,
segmentPerPage:
{
Description: Force segmentation of document content by page. ,
Required: False ,
}
boolean ,
omitContent:
{
Description: Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any. ,
Required: False ,
}
boolean ,
} ,
fieldSchema:
{
Description: The schema of fields to extracted. ,
Required: False ,
}
{
name:
{
Description: The name of the field schema. ,
Required: False ,
}
string ,
description:
{
Description: A description of the field schema. ,
Required: False ,
}
string ,
fields:
{
Description: The fields defined in the schema. ,
Required: True ,
}
object ,
definitions:
{
Description: Additional definitions referenced by the fields in the schema. ,
Required: False ,
}
object ,
}
,
dynamicFieldSchema:
{
Description: Indicates whether the result may contain additional fields outside of the defined schema. ,
Required: False ,
}
boolean ,
processingLocation:
{
Description: The location where the data may be processed. Defaults to global. ,
Enum:
{
geography: Data may be processed in the same geography as the resource. ,
dataZone: Data may be processed in the same data zone as the resource. ,
global: Data may be processed in any Azure data center globally. ,
}
,
Required: False ,
}
enum ,
knowledgeSources:
{
Description: Additional knowledge sources used to enhance the analyzer. ,
Required: False ,
}
[
{
kind:
{
Description: The kind of knowledge source. ,
Enum:
{
labeledData: A labeled data knowledge source. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
models:
{
Description: Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }. ,
Required: False ,
}
object ,
supportedModels:
{
Description: Chat completion and embedding models supported by the analyzer. ,
Required: False ,
}
{
completion:
{
Description: Chat completion models supported by the analyzer. ,
Required: True ,
}
object ,
embedding:
{
Description: Embedding models supported by the analyzer. ,
Required: True ,
}
object ,
}
,
} ,
usage:
{
Description: Usage details of the analyzer creation operation. ,
Required: False ,
}
{
documentPagesMinimal:
{
Description: The number of document pages processed at the minimal level. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page. ,
Format: int32 ,
Required: False ,
}
integer ,
documentPagesBasic:
{
Description: The number of document pages processed at the basic level. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page. ,
Format: int32 ,
Required: False ,
}
integer ,
documentPagesStandard:
{
Description: The number of document pages processed at the standard level. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page. ,
Format: int32 ,
Required: False ,
}
integer ,
audioHours:
{
Description: The hours of audio processed. ,
Format: float ,
Required: False ,
}
number ,
videoHours:
{
Description: The hours of video processed. ,
Format: float ,
Required: False ,
}
number ,
contextualizationTokens:
{
Description: The number of contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting. ,
Format: int32 ,
Required: False ,
}
integer ,
tokens:
{
Description: The number of LLM and embedding tokens consumed, grouped by model (ex. GTP 4.1) and type (ex. input, cached input, output). ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_GetDefaults (new)
Description :  Return default settings for this Content Understanding resource.
Reference :  Link ¶

⚼ Request

GET:  /defaults
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ContentAnalyzers_UpdateDefaults (new)
Description :  Return default settings for this Content Understanding resource.
Reference :  Link ¶

⚼ Request

PATCH:  /defaults
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
modelDeployments:
{
Description: Mapping of model names to deployments. Ex. { "gpt-4.1": "myGpt41Deployment", "text-embedding-3-large": "myTextEmbedding3LargeDeployment" }. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}