Content Analyzers - Analyze Inline
Extract content and fields from input. The analysis result is embedded inline in the JSON response body (HTTP 200) without creating a long-running operation — no polling or separate result retrieval is needed. Intended for lightweight analysis scenarios (e.g., document analyzers without field extraction, small page counts). The result is not persisted on the server. See service documentation for current constraints.
POST {endpoint}/contentunderstanding/analyzers/{analyzerId}:analyzeInline?api-version=2026-06-01-preview
POST {endpoint}/contentunderstanding/analyzers/{analyzerId}:analyzeInline?api-version=2026-06-01-preview&stringEncoding={stringEncoding}&processingLocation={processingLocation}&allowInputTruncation={allowInputTruncation}
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
analyzer
|
path | True |
string minLength: 1maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$ |
The unique identifier of the analyzer. |
|
endpoint
|
path | True |
string (uri) |
Content Understanding service endpoint. |
|
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
|
allow
|
query |
boolean |
Overrides the analyzer's allowInputTruncation setting for this request. When omitted, the analyzer's configured value applies. |
|
|
processing
|
query |
The location where the data may be processed. Defaults to global. |
||
|
string
|
query |
string |
The string encoding format for content spans in the response.
Possible values are 'codePoint', 'utf16', and |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
An opaque, globally-unique, client-generated string identifier for the request. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| inputs | True |
Inputs to analyze. Currently, only pro mode supports multiple inputs. |
|
| modelDeployments |
object |
Specify the default mapping of model names to LLM/embedding deployments in Microsoft Foundry. For details and current semantics, see https://aka.ms/cudoc-quickstart-rest. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
The request has succeeded. Headers x-ms-client-request-id: string |
|
| Other Status Codes |
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
| Analyze URL Inline |
| Analyze URL Inline with Requested Range (Partial) |
Analyze URL Inline
Sample request
POST {endpoint}/contentunderstanding/analyzers/prebuilt-layout:analyzeInline?api-version=2026-06-01-preview
{
"inputs": [
{
"url": "https://host.com/doc.pdf"
}
]
}
Sample response
{
"status": "Succeeded",
"result": {
"analyzerId": "prebuilt-layout",
"apiVersion": "2026-06-01-preview",
"createdAt": "2026-07-01T18:46:36.244Z",
"contents": [
{
"kind": "document",
"mimeType": "application/pdf",
"markdown": "# CONTOSO\n\n...",
"metadata": {
"contentType": "application/pdf",
"pageCount": "2",
"author": "Contoso",
"title": "CONTOSO Document",
"createdAt": "2025-05-01T12:00:00Z",
"language": "en-US"
},
"startPageNumber": 1,
"endPageNumber": 2,
"unit": "inch",
"pages": [
{
"pageNumber": 1,
"width": 8.5,
"height": 11
},
{
"pageNumber": 2,
"width": 8.5,
"height": 11
}
]
}
]
},
"usage": {
"documentPagesStandardInline": 2
}
}
Analyze URL Inline with Requested Range (Partial)
Sample request
POST {endpoint}/contentunderstanding/analyzers/prebuilt-layout:analyzeInline?api-version=2026-06-01-preview&allowInputTruncation=True
{
"inputs": [
{
"url": "https://host.com/doc.pdf",
"range": "3-"
}
]
}
Sample response
{
"status": "Succeeded",
"result": {
"analyzerId": "prebuilt-layout",
"apiVersion": "2026-06-01-preview",
"createdAt": "2026-07-01T18:46:36.244Z",
"warnings": [
{
"code": "InputExceededLimit",
"message": "The requested range exceeded the inline page limit; only pages 3-7 were analyzed. See https://aka.ms/cu-doc-limits.",
"target": "inputs/0"
}
],
"contents": [
{
"kind": "document",
"mimeType": "application/pdf",
"markdown": "# CONTOSO\n\n...",
"startPageNumber": 3,
"endPageNumber": 7,
"unit": "inch"
}
]
},
"usage": {
"documentPagesStandardInline": 5
}
}
Definitions
| Name | Description |
|---|---|
|
Analysis |
Kind of media content. |
|
Analysis |
Additional input to analyze. |
|
Analysis |
Analyze operation result. |
|
Analyze |
Analyze operation request. |
|
Array |
Array field extracted from the content. |
|
Audio |
Audio visual content. Ex. audio/wav, video/mp4. |
|
Audio |
Detected audio/visual content segment. |
|
Azure. |
The error object. |
|
Azure. |
A response containing error details. |
|
Azure. |
An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Boolean |
Boolean field extracted from the content. |
|
Content |
Provides inline response details for analyze operations. |
|
Content |
Semantic data type of the field value. |
|
Content |
Position of the element in markdown, specified as a character offset and length. |
|
Date |
Date field extracted from the content. |
|
Document |
Annotation in a document, such as a strikethrough or a comment. |
|
Document |
Comment associated with a document annotation. |
|
Document |
Document annotation kind. |
|
Document |
Barcode in a document. |
|
Document |
Barcode kind. |
|
Document |
Caption of a table or figure. |
|
Document |
Figure containing a chart, such as a bar chart, line chart, or pie chart. |
|
Document |
A chunk of document content, defined by one or more spans in the markdown. |
|
Document |
Document content. Ex. text/plain, application/pdf, image/jpeg. |
|
Document |
Detected document content segment. |
|
Document |
Footnote of a table or figure. |
|
Document |
Mathematical formula in a document. |
|
Document |
Formula kind. |
|
Document |
Hyperlink in a document, such as a link to a web page or an email address. |
|
Document |
Line in a document, consisting of an contiguous sequence of words. |
|
Document |
Figure containing a diagram, such as a flowchart or network diagram. |
|
Document |
Content from a document page. |
|
Document |
Paragraph in a document, generally consisting of an contiguous sequence of lines with common alignment and spacing. |
|
Document |
Section in a document. |
|
Document |
Signature detected in a document. |
|
Document |
Table in a document, consisting table cells arranged in a rectangular layout. |
|
Document |
Table cell in a document table. |
|
Document |
Table cell kind. |
|
Document |
Word in a document, consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word. |
|
Integer |
Integer field extracted from the content. |
|
Json |
JSON field extracted from the content. |
|
Length |
Length unit used by the width, height, and source properties. |
|
Number |
Number field extracted from the content. |
|
Object |
Object field extracted from the content. |
|
Operation |
The status of the operation |
|
Processing |
The location where the data may be processed. Defaults to global. |
|
Semantic |
Semantic role of the paragraph. |
|
String |
String field extracted from the content. |
|
Time |
Time field extracted from the content. |
|
Transcript |
Transcript phrase. |
|
Transcript |
Transcript word. |
|
Usage |
Usage details. |
AnalysisContentKind
Kind of media content.
| Value | Description |
|---|---|
| document |
Document content, such as pdf, image, txt, etc. |
| audioVisual |
Audio visual content, such as mp3, mp4, etc. |
AnalysisInput
Additional input to analyze.
| Name | Type | Description |
|---|---|---|
| data |
string (byte) |
Base64-encoded binary content of the input to analyze. Only one of url or data should be specified. |
| mimeType |
string |
The MIME type of the input content. Ex. application/pdf, image/jpeg, etc. |
| name |
string |
Name of the input. |
| range |
string |
Range of the input to analyze (ex. |
| url |
string (uri) |
The URL of the input to analyze. Only one of url or data should be specified. |
AnalysisResult
Analyze operation result.
| Name | Type | Default value | Description |
|---|---|---|---|
| analyzerId |
string minLength: 1maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$ |
The unique identifier of the analyzer. |
|
| apiVersion |
string |
The version of the API used to analyze the document. |
|
| contents | AnalysisContent[]: |
The extracted content. |
|
| createdAt |
string (date-time) |
The date and time when the result was created. |
|
| infos |
Additional diagnostic information about the analysis. |
||
| stringEncoding |
string |
codePoint |
The string encoding format for content spans in the response.
Possible values are 'codePoint', 'utf16', and |
| warnings |
Warnings encountered while analyzing the document. |
AnalyzeRequest
Analyze operation request.
| Name | Type | Description |
|---|---|---|
| inputs |
Inputs to analyze. Currently, only pro mode supports multiple inputs. |
|
| modelDeployments |
object |
Specify the default mapping of model names to LLM/embedding deployments in Microsoft Foundry. For details and current semantics, see https://aka.ms/cudoc-quickstart-rest. |
ArrayField
Array field extracted from the content.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the field value. |
| source |
string |
Encoded source that identifies the position of the field value in the content. |
| spans |
Span(s) associated with the field value in the markdown content. |
|
| type |
string:
array |
Semantic data type of the field value. |
| valueArray |
ContentField[]:
|
Array field value. |
AudioVisualContent
Audio visual content. Ex. audio/wav, video/mp4.
| Name | Type | Description |
|---|---|---|
| analyzerId |
string minLength: 1maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$ |
The analyzer that generated this content. |
| cameraShotTimesMs |
integer[] (int64) |
List of camera shot changes in the video, represented by its timestamp in milliseconds. Only if returnDetails is true. |
| category |
string |
Classified content category. |
| endTimeMs |
integer (int64) |
End time of the content in milliseconds. |
| fields |
object |
Extracted fields from the content. |
| height |
integer (int32) |
Height of each video frame in pixels, if applicable. |
| keyFrameTimesMs |
integer[] (int64) |
List of key frames in the video, represented by its timestamp in milliseconds. Only if returnDetails is true. |
| kind |
string:
audio |
Content kind. |
| markdown |
string |
Markdown representation of the content. |
| metadata |
object |
Metadata extracted from the input as string key/value pairs, such as author, title, creation date, or media properties. Keys and values are strings. Only keys with extracted values are present. |
| mimeType |
string |
Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc. |
| path |
string |
The path of the content in the input. |
| segments |
List of detected content segments. Only if enableSegment is true. |
|
| startTimeMs |
integer (int64) |
Start time of the content in milliseconds. |
| transcriptPhrases |
List of transcript phrases. Only if returnDetails is true. |
|
| width |
integer (int32) |
Width of each video frame in pixels, if applicable. |
AudioVisualContentSegment
Detected audio/visual content segment.
| Name | Type | Description |
|---|---|---|
| category |
string |
Classified content category. |
| endTimeMs |
integer (int64) |
End time of the segment in milliseconds. |
| segmentId |
string |
Segment identifier. |
| span |
Span of the segment in the markdown content. |
|
| startTimeMs |
integer (int64) |
Start time of the segment in milliseconds. |
Azure.Core.Foundations.Error
The error object.
| Name | Type | Description |
|---|---|---|
| code |
string |
One of a server-defined set of error codes. |
| details |
An array of details about specific errors that led to this reported error. |
|
| innererror |
An object containing more specific information than the current object about the error. |
|
| message |
string |
A human-readable representation of the error. |
| target |
string |
The target of the error. |
Azure.Core.Foundations.ErrorResponse
A response containing error details.
| Name | Type | Description |
|---|---|---|
| error |
The error object. |
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.
| Name | Type | Description |
|---|---|---|
| code |
string |
One of a server-defined set of error codes. |
| innererror |
Inner error. |
BooleanField
Boolean field extracted from the content.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the field value. |
| source |
string |
Encoded source that identifies the position of the field value in the content. |
| spans |
Span(s) associated with the field value in the markdown content. |
|
| type |
string:
boolean |
Semantic data type of the field value. |
| valueBoolean |
boolean |
Boolean field value. |
ContentAnalyzerInlineResponse
Provides inline response details for analyze operations.
| Name | Type | Description |
|---|---|---|
| result |
The result of the inline analyze request. |
|
| status |
The status of the inline analyze request. |
|
| usage |
Usage details of the inline analyze request. |
ContentFieldType
Semantic data type of the field value.
| Value | Description |
|---|---|
| string |
Plain text. |
| date |
Date, normalized to ISO 8601 (YYYY-MM-DD) format. |
| time |
Time, normalized to ISO 8601 (hh:mm:ss) format. |
| number |
Number as double precision floating point. |
| integer |
Integer as 64-bit signed integer. |
| boolean |
Boolean value. |
| array |
List of subfields of the same type. |
| object |
Named list of subfields. |
| json |
JSON object. |
ContentSpan
Position of the element in markdown, specified as a character offset and length.
| Name | Type | Description |
|---|---|---|
| length |
integer (int32) |
Length of the element in markdown, specified in characters. |
| offset |
integer (int32) |
Starting position (0-indexed) of the element in markdown, specified in characters. |
DateField
Date field extracted from the content.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the field value. |
| source |
string |
Encoded source that identifies the position of the field value in the content. |
| spans |
Span(s) associated with the field value in the markdown content. |
|
| type |
string:
date |
Semantic data type of the field value. |
| valueDate |
string (date) |
Date field value, in ISO 8601 (YYYY-MM-DD) format. |
DocumentAnnotation
Annotation in a document, such as a strikethrough or a comment.
| Name | Type | Description |
|---|---|---|
| author |
string |
Annotation author. |
| comments |
Comments associated with the annotation. |
|
| createdAt |
string (date-time) |
Date and time when the annotation was created. |
| id |
string |
Annotation identifier. |
| kind |
Annotation kind. |
|
| lastModifiedAt |
string (date-time) |
Date and time when the annotation was last modified. |
| source |
string |
Position of the annotation. |
| spans |
Spans of the content associated with the annotation. |
|
| tags |
string[] |
Tags associated with the annotation. |
DocumentAnnotationComment
Comment associated with a document annotation.
| Name | Type | Description |
|---|---|---|
| author |
string |
Author of the comment. |
| createdAt |
string (date-time) |
Date and time when the comment was created. |
| lastModifiedAt |
string (date-time) |
Date and time when the comment was last modified. |
| message |
string |
Comment message in Markdown. |
| tags |
string[] |
Tags associated with the comment. |
DocumentAnnotationKind
Document annotation kind.
| Value | Description |
|---|---|
| highlight |
Highlight annotation. |
| strikethrough |
Strikethrough annotation. |
| underline |
Underline annotation. |
| italic |
Italic annotation. |
| bold |
Bold annotation. |
| circle |
Circle annotation. |
| note |
Note annotation. |
DocumentBarcode
Barcode in a document.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the barcode. |
| kind |
Barcode kind. |
|
| source |
string |
Encoded source that identifies the position of the barcode in the content. |
| span |
Span of the barcode in the markdown content. |
|
| value |
string |
Barcode value. |
DocumentBarcodeKind
Barcode kind.
| Value | Description |
|---|---|
| QRCode |
QR code, as defined in ISO/IEC 18004:2015. |
| PDF417 |
PDF417, as defined in ISO 15438. |
| UPCA |
GS1 12-digit Universal Product Code. |
| UPCE |
GS1 6-digit Universal Product Code. |
| Code39 |
Code 39 barcode, as defined in ISO/IEC 16388:2007. |
| Code128 |
Code 128 barcode, as defined in ISO/IEC 15417:2007. |
| EAN8 |
GS1 8-digit International Article Number (European Article Number). |
| EAN13 |
GS1 13-digit International Article Number (European Article Number). |
| DataBar |
GS1 DataBar barcode. |
| Code93 |
Code 93 barcode, as defined in ANSI/AIM BC5-1995. |
| Codabar |
Codabar barcode, as defined in ANSI/AIM BC3-1995. |
| DataBarExpanded |
GS1 DataBar Expanded barcode. |
| ITF |
Interleaved 2 of 5 barcode, as defined in ANSI/AIM BC2-1995. |
| MicroQRCode |
Micro QR code, as defined in ISO/IEC 23941:2022. |
| Aztec |
Aztec code, as defined in ISO/IEC 24778:2008. |
| DataMatrix |
Data matrix code, as defined in ISO/IEC 16022:2006. |
| MaxiCode |
MaxiCode, as defined in ISO/IEC 16023:2000. |
DocumentCaption
Caption of a table or figure.
| Name | Type | Description |
|---|---|---|
| content |
string |
Content of the caption. |
| elements |
string[] |
Child elements of the caption. |
| source |
string |
Encoded source that identifies the position of the caption in the content. |
| span |
Span of the caption in the markdown content. |
DocumentChartFigure
Figure containing a chart, such as a bar chart, line chart, or pie chart.
| Name | Type | Default value | Description |
|---|---|---|---|
| caption |
Figure caption. |
||
| content |
contentunderstanding.contentanalyzers.analyzeinline |
Chart content represented using Chart.js config. |
|
| description |
string |
Description of the figure. |
|
| elements |
string[] |
Child elements of the figure, excluding any caption or footnotes. |
|
| footnotes |
List of figure footnotes. |
||
| id |
string |
Figure identifier. |
|
| kind |
string:
chart |
unknown |
Figure kind. |
| role |
Semantic role of the figure. |
||
| source |
string |
Encoded source that identifies the position of the figure in the content. |
|
| span |
Span of the figure in the markdown content. |
DocumentChunk
A chunk of document content, defined by one or more spans in the markdown.
| Name | Type | Description |
|---|---|---|
| source |
string |
Encoded source expression describing the visual bounding polygons of the chunk's content on the page. Derived from the union of layout objects (paragraphs, tables, figures) that compose the chunk. |
| spans |
List of spans defining the chunk's position(s) in the markdown content. |
DocumentContent
Document content. Ex. text/plain, application/pdf, image/jpeg.
| Name | Type | Description |
|---|---|---|
| analyzerId |
string minLength: 1maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$ |
The analyzer that generated this content. |
| annotations |
List of annotations in the document. Only if enableAnnotations and returnDetails are true. |
|
| category |
string |
Classified content category. |
| chunks |
List of document chunks. Only if chunkingStrategy is configured on the analyzer. |
|
| endPageNumber |
integer (int32) |
End page number (1-indexed) of the content. |
| fields |
object |
Extracted fields from the content. |
| figures | DocumentFigure[]: |
List of figures in the document. Only if enableLayout and returnDetails are true. |
| hyperlinks |
List of hyperlinks in the document. Only if returnDetails are true. |
|
| kind |
string:
document |
Content kind. |
| markdown |
string |
Markdown representation of the content. |
| metadata |
object |
Metadata extracted from the input as string key/value pairs, such as author, title, creation date, or media properties. Keys and values are strings. Only keys with extracted values are present. |
| mimeType |
string |
Detected MIME type of the content. Ex. application/pdf, image/jpeg, etc. |
| pages |
List of pages in the document. |
|
| paragraphs |
List of paragraphs in the document. Only if enableOcr and returnDetails are true. |
|
| path |
string |
The path of the content in the input. |
| sections |
List of sections in the document. Only if enableLayout and returnDetails are true. |
|
| segments |
List of detected content segments. Only if enableSegment is true. |
|
| signatures |
List of signatures in the document. Only if enableLayout and returnDetails are true. |
|
| startPageNumber |
integer (int32) |
Start page number (1-indexed) of the content. |
| tables |
List of tables in the document. Only if enableLayout and returnDetails are true. |
|
| unit |
Length unit used by the width, height, and source properties. For images/tiff, the default unit is pixel. For PDF, the default unit is inch. |
DocumentContentSegment
Detected document content segment.
| Name | Type | Description |
|---|---|---|
| category |
string |
Classified content category. |
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of the segmentation and category classification. |
| endPageNumber |
integer (int32) |
End page number (1-indexed) of the segment. |
| segmentId |
string |
Segment identifier. |
| source |
string |
Encoded source that identifies the position of the segment in the content. Can be used as the 'range' input to route this segment to a sub-analyzer. |
| span |
Span of the segment in the markdown content. |
|
| startPageNumber |
integer (int32) |
Start page number (1-indexed) of the segment. |
DocumentFootnote
Footnote of a table or figure.
| Name | Type | Description |
|---|---|---|
| content |
string |
Content of the footnote. |
| elements |
string[] |
Child elements of the footnote. |
| source |
string |
Encoded source that identifies the position of the footnote in the content. |
| span |
Span of the footnote in the markdown content. |
DocumentFormula
Mathematical formula in a document.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the formula. |
| kind |
Formula kind. |
|
| source |
string |
Encoded source that identifies the position of the formula in the content. |
| span |
Span of the formula in the markdown content. |
|
| value |
string |
LaTex expression describing the formula. |
DocumentFormulaKind
Formula kind.
| Value | Description |
|---|---|
| inline |
A formula embedded within the content of a paragraph. |
| display |
A formula in display mode that takes up an entire line. |
DocumentHyperlink
Hyperlink in a document, such as a link to a web page or an email address.
| Name | Type | Description |
|---|---|---|
| content |
string |
Hyperlinked content. |
| source |
string |
Position of the hyperlink. |
| span |
Span of the hyperlink in the markdown content. |
|
| url |
string |
URL of the hyperlink. |
DocumentLine
Line in a document, consisting of an contiguous sequence of words.
| Name | Type | Description |
|---|---|---|
| content |
string |
Line text. |
| source |
string |
Encoded source that identifies the position of the line in the content. |
| span |
Span of the line in the markdown content. |
DocumentMermaidFigure
Figure containing a diagram, such as a flowchart or network diagram.
| Name | Type | Default value | Description |
|---|---|---|---|
| caption |
Figure caption. |
||
| content |
string |
Diagram content represented using Mermaid syntax. |
|
| description |
string |
Description of the figure. |
|
| elements |
string[] |
Child elements of the figure, excluding any caption or footnotes. |
|
| footnotes |
List of figure footnotes. |
||
| id |
string |
Figure identifier. |
|
| kind |
string:
mermaid |
unknown |
Figure kind. |
| role |
Semantic role of the figure. |
||
| source |
string |
Encoded source that identifies the position of the figure in the content. |
|
| span |
Span of the figure in the markdown content. |
DocumentPage
Content from a document page.
| Name | Type | Description |
|---|---|---|
| angle |
number (float) maximum: 180 |
The general orientation of the content in clockwise direction, measured in degrees between (-180, 180]. Only if enableOcr is true. |
| barcodes |
List of barcodes in the page. Only if enableBarcode and returnDetails are true. |
|
| formulas |
List of mathematical formulas in the page. Only if enableFormula and returnDetails are true. |
|
| height |
number (float) |
Height of the page. |
| lines |
List of lines in the page. Only if enableOcr and returnDetails are true. |
|
| pageNumber |
integer (int32) minimum: 1 |
Page number (1-based). |
| spans |
Span(s) associated with the page in the markdown content. |
|
| width |
number (float) |
Width of the page. |
| words |
List of words in the page. Only if enableOcr and returnDetails are true. |
DocumentParagraph
Paragraph in a document, generally consisting of an contiguous sequence of lines with common alignment and spacing.
| Name | Type | Description |
|---|---|---|
| content |
string |
Paragraph text. |
| role |
Semantic role of the paragraph. |
|
| source |
string |
Encoded source that identifies the position of the paragraph in the content. |
| span |
Span of the paragraph in the markdown content. |
DocumentSection
Section in a document.
| Name | Type | Description |
|---|---|---|
| elements |
string[] |
Child elements of the section. |
| span |
Span of the section in the markdown content. |
DocumentSignature
Signature detected in a document.
| Name | Type | Description |
|---|---|---|
| elements |
string[] |
Child elements of the signature, such as paragraphs containing text within the signature region. |
| id |
string |
Signature identifier. |
| role |
Semantic role of the signature. |
|
| source |
string |
Encoded source that identifies the position of the signature in the content. |
| span |
Span of the signature in the markdown content. |
DocumentTable
Table in a document, consisting table cells arranged in a rectangular layout.
| Name | Type | Description |
|---|---|---|
| caption |
Table caption. |
|
| cells |
Cells contained within the table. |
|
| columnCount |
integer (int32) minimum: 1 |
Number of columns in the table. |
| footnotes |
List of table footnotes. |
|
| role |
Semantic role of the table. |
|
| rowCount |
integer (int32) minimum: 1 |
Number of rows in the table. |
| source |
string |
Encoded source that identifies the position of the table in the content. |
| span |
Span of the table in the markdown content. |
DocumentTableCell
Table cell in a document table.
| Name | Type | Default value | Description |
|---|---|---|---|
| columnIndex |
integer (int32) |
Column index of the cell. |
|
| columnSpan |
integer (int32) minimum: 1 |
1 |
Number of columns spanned by this cell. |
| content |
string |
Content of the table cell. |
|
| elements |
string[] |
Child elements of the table cell. |
|
| kind | content |
Table cell kind. |
|
| rowIndex |
integer (int32) |
Row index of the cell. |
|
| rowSpan |
integer (int32) minimum: 1 |
1 |
Number of rows spanned by this cell. |
| source |
string |
Encoded source that identifies the position of the table cell in the content. |
|
| span |
Span of the table cell in the markdown content. |
DocumentTableCellKind
Table cell kind.
| Value | Description |
|---|---|
| content |
Main content/data. |
| rowHeader |
Description of the row content. |
| columnHeader |
Description the column content. |
| stubHead |
Description of the row headers, usually located at the top left corner of a table. |
| description |
Description of the content in (parts of) the table. |
DocumentWord
Word in a document, consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the word. |
| content |
string |
Word text. |
| source |
string |
Encoded source that identifies the position of the word in the content. |
| span |
Span of the word in the markdown content. |
IntegerField
Integer field extracted from the content.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the field value. |
| source |
string |
Encoded source that identifies the position of the field value in the content. |
| spans |
Span(s) associated with the field value in the markdown content. |
|
| type |
string:
integer |
Semantic data type of the field value. |
| valueInteger |
integer (int64) |
Integer field value. |
JsonField
JSON field extracted from the content.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the field value. |
| source |
string |
Encoded source that identifies the position of the field value in the content. |
| spans |
Span(s) associated with the field value in the markdown content. |
|
| type |
string:
json |
Semantic data type of the field value. |
| valueJson |
contentunderstanding.contentanalyzers.analyzeinline |
JSON field value. |
LengthUnit
Length unit used by the width, height, and source properties.
| Value | Description |
|---|---|
| pixel |
Pixel unit. |
| inch |
Inch unit. |
NumberField
Number field extracted from the content.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the field value. |
| source |
string |
Encoded source that identifies the position of the field value in the content. |
| spans |
Span(s) associated with the field value in the markdown content. |
|
| type |
string:
number |
Semantic data type of the field value. |
| valueNumber |
number (double) |
Number field value. |
ObjectField
Object field extracted from the content.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the field value. |
| source |
string |
Encoded source that identifies the position of the field value in the content. |
| spans |
Span(s) associated with the field value in the markdown content. |
|
| type |
string:
object |
Semantic data type of the field value. |
| valueObject |
object |
Object field value. |
OperationState
The status of the operation
| Value | Description |
|---|---|
| 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. |
ProcessingLocation
The location where the data may be processed. Defaults to global.
| Value | Description |
|---|---|
| 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. |
SemanticRole
Semantic role of the paragraph.
| Value | Description |
|---|---|
| pageHeader |
Text near the top edge of the page. |
| pageFooter |
Text near the bottom edge of the page. |
| pageNumber |
Page number. |
| title |
Top-level title describing the entire document. |
| sectionHeading |
Sub heading describing a section of the document. |
| footnote |
Note usually placed after the main content on a page. |
| formulaBlock |
Block of formulas, often with shared alignment. |
StringField
String field extracted from the content.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the field value. |
| source |
string |
Encoded source that identifies the position of the field value in the content. |
| spans |
Span(s) associated with the field value in the markdown content. |
|
| type |
string:
string |
Semantic data type of the field value. |
| valueString |
string |
String field value. |
TimeField
Time field extracted from the content.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the field value. |
| source |
string |
Encoded source that identifies the position of the field value in the content. |
| spans |
Span(s) associated with the field value in the markdown content. |
|
| type |
string:
time |
Semantic data type of the field value. |
| valueTime |
string (time) |
Time field value, in ISO 8601 (hh:mm:ss) format. |
TranscriptPhrase
Transcript phrase.
| Name | Type | Description |
|---|---|---|
| confidence |
number (float) minimum: 0maximum: 1 |
Confidence of predicting the phrase. |
| endTimeMs |
integer (int64) |
End time of the phrase in milliseconds. |
| locale |
string |
Detected locale of the phrase. Ex. en-US. |
| span |
Span of the phrase in the markdown content. |
|
| speaker |
string |
Speaker index or name. |
| startTimeMs |
integer (int64) |
Start time of the phrase in milliseconds. |
| text |
string |
Transcript text. |
| words |
List of words in the phrase. |
TranscriptWord
Transcript word.
| Name | Type | Description |
|---|---|---|
| endTimeMs |
integer (int64) |
End time of the word in milliseconds. |
| span |
Span of the word in the markdown content. |
|
| startTimeMs |
integer (int64) |
Start time of the word in milliseconds. |
| text |
string |
Transcript text. |
UsageDetails
Usage details.
| Name | Type | Description |
|---|---|---|
| advancedContextualizationTokens |
integer (int32) |
The number of advanced contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting. |
| audioHours |
number (float) |
The hours of audio processed. |
| contextualizationTokens |
integer (int32) |
The number of contextualization tokens consumed for preparing context, generating confidence scores, source grounding, and output formatting. |
| documentPagesBasic |
integer (int32) |
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. |
| documentPagesBasicInline |
integer (int32) |
The number of document pages processed at the basic level by an inline analyze operation. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page. |
| documentPagesMinimal |
integer (int32) |
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. |
| documentPagesMinimalInline |
integer (int32) |
The number of document pages processed at the minimal level by an inline analyze operation. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page. |
| documentPagesStandard |
integer (int32) |
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. |
| documentPagesStandardInline |
integer (int32) |
The number of document pages processed at the standard level by an inline analyze operation. For documents without explicit pages (ex. txt, html), every 3000 UTF-16 characters is counted as one page. |
| tokens |
object |
The number of LLM and embedding tokens consumed, grouped by model (ex. GTP 4.1) and type (ex. input, cached input, output). |
| videoHours |
number (float) |
The hours of video processed. |