ContentAnalyzer Class

Analyzer that extracts content and fields from multimodal documents.

Constructor

ContentAnalyzer(*args: Any, **kwargs: Any)

Variables

Name	Description
analyzer_id	str The unique identifier of the analyzer. Required.
description	str A description of the analyzer.
tags	dict[str, str] Tags associated with the analyzer.
status	str or ContentAnalyzerStatus The status of the analyzer. Required. Known values are: "creating", "ready", "deleting", and "failed".
created_at	datetime The date and time when the analyzer was created. Required.
last_modified_at	datetime The date and time when the analyzer was last modified. Required.
warnings	list[<xref:azure.core.ODataV4Format>] Warnings encountered while creating the analyzer.
base_analyzer_id	str The analyzer to incrementally train from.
config	ContentAnalyzerConfig Analyzer configuration settings.
field_schema	ContentFieldSchema The schema of fields to extracted.
dynamic_field_schema	bool Indicates whether the result may contain additional fields outside of the defined schema.
processing_location	str or ProcessingLocation The location where the data may be processed. Defaults to global. Known values are: "geography", "dataZone", and "global".
knowledge_sources	list[KnowledgeSource] Additional knowledge sources used to enhance the analyzer.
models	dict[str, str] Mapping of model roles to specific model names. Ex. { "completion": "gpt-4.1", "embedding": "text-embedding-3-large" }.
supported_models	SupportedModels Chat completion and embedding models supported by the analyzer.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from the dictionary.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.
setdefault	Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
update	Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on the mapping's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on the mapping's values

Attributes

analyzer_id

The unique identifier of the analyzer. Required.

analyzer_id: str

base_analyzer_id

The analyzer to incrementally train from.

base_analyzer_id: str | None

config

Analyzer configuration settings.

config: _models.ContentAnalyzerConfig | None

created_at

The date and time when the analyzer was created. Required.

created_at: datetime

description

A description of the analyzer.

description: str | None

dynamic_field_schema

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

dynamic_field_schema: bool | None

field_schema

The schema of fields to extracted.

field_schema: _models.ContentFieldSchema | None

knowledge_sources

Additional knowledge sources used to enhance the analyzer.

knowledge_sources: list['_models.KnowledgeSource'] | None

last_modified_at

The date and time when the analyzer was last modified. Required.

last_modified_at: datetime

models

"gpt-4.1", "embedding": "text-embedding-3-large" }.

models: dict[str, str] | None

processing_location

The location where the data may be processed. Defaults to global. Known values are: "geography", "dataZone", and "global".

processing_location: str | _models.ProcessingLocation | None

status

"creating", "ready", "deleting", and "failed".

status: str | _models.ContentAnalyzerStatus

supported_models

Chat completion and embedding models supported by the analyzer.

supported_models: _models.SupportedModels | None

tags

Tags associated with the analyzer.

tags: dict[str, str] | None

warnings

Warnings encountered while creating the analyzer.

warnings: list[azure.core.exceptions.ODataV4Format] | None