ContentAnalyzer interface

Package:

@azure/ai-content-understanding

Analyzer that extracts content and fields from multimodal documents.

Properties

analyzerId	The unique identifier of the analyzer.
baseAnalyzerId	The analyzer to incrementally train from.
config	Analyzer configuration settings.
createdAt	The date and time when the analyzer was created.
description	A description of the analyzer.
dynamicFieldSchema	Indicates whether the result may contain additional fields outside of the defined schema.
fieldSchema	The schema of fields to extracted.
knowledgeSources	Additional knowledge sources used to enhance the analyzer.
lastModifiedAt	The date and time when the analyzer was last modified.
models	Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
processingLocation	The location where the data may be processed. Defaults to global.
status	The status of the analyzer.
supportedModels	Chat completion and embedding models supported by the analyzer.
tags	Tags associated with the analyzer.
warnings	Warnings encountered while creating the analyzer.

Property Details

analyzerId

The unique identifier of the analyzer.

analyzerId: string

Property Value

string

baseAnalyzerId

The analyzer to incrementally train from.

baseAnalyzerId?: string

Property Value

string

config

Analyzer configuration settings.

config?: ContentAnalyzerConfig

Property Value

ContentAnalyzerConfig

createdAt

The date and time when the analyzer was created.

createdAt: Date

Property Value

Date

description

A description of the analyzer.

description?: string

Property Value

string

dynamicFieldSchema

Indicates whether the result may contain additional fields outside of the defined schema.

dynamicFieldSchema?: boolean

Property Value

boolean

fieldSchema

The schema of fields to extracted.

fieldSchema?: ContentFieldSchema

Property Value

ContentFieldSchema

knowledgeSources

Additional knowledge sources used to enhance the analyzer.

knowledgeSources?: KnowledgeSourceUnion[]

Property Value

KnowledgeSourceUnion[]

lastModifiedAt

The date and time when the analyzer was last modified.

lastModifiedAt: Date

Property Value

Date

models

Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.

models?: Record<string, string>

Property Value

Record<string, string>

processingLocation

The location where the data may be processed. Defaults to global.

processingLocation?: ProcessingLocation

Property Value

ProcessingLocation

status

The status of the analyzer.

status: ContentAnalyzerStatus

Property Value

ContentAnalyzerStatus

supportedModels

Chat completion and embedding models supported by the analyzer.

supportedModels?: SupportedModels

Property Value

SupportedModels

tags

Tags associated with the analyzer.

tags?: Record<string, string>

Property Value

Record<string, string>

warnings

Warnings encountered while creating the analyzer.

warnings?: ErrorModel[]

Property Value

ErrorModel[]