ContentAnalyzerConfig Class

Configuration settings for an analyzer.

Constructor

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

Variables

Name	Description
return_details	bool Return all content details.
locales	list[str] List of locale hints for speech transcription.
enable_ocr	bool Enable optical character recognition (OCR).
enable_layout	bool Enable layout analysis.
enable_figure_description	bool Enable generation of figure description.
enable_figure_analysis	bool Enable analysis of figures, such as charts and diagrams.
enable_formula	bool Enable mathematical formula detection.
table_format	str or TableFormat Representation format of tables in analyze result markdown. Known values are: "html" and "markdown".
chart_format	str or ChartFormat Representation format of charts in analyze result markdown. Known values are: "chartJs" and "markdown".
annotation_format	str or AnnotationFormat Representation format of annotations in analyze result markdown. Known values are: "none" and "markdown".
disable_face_blurring	bool Disable the default blurring of faces for privacy while processing the content.
estimate_field_source_and_confidence	bool Return field grounding source and confidence.
content_categories	dict[str, ContentCategoryDefinition] Map of categories to classify the input content(s) against.
enable_segment	bool Enable segmentation of the input by contentCategories.
segment_per_page	bool Force segmentation of document content by page.
omit_content	bool Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
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: D[k] if k in D, else d. :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 D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :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 D.

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: D[k] if k in D, else d. :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	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D'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 D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

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

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :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 D's values

Attributes

annotation_format

"none" and "markdown".

annotation_format: str | _models.AnnotationFormat | None

chart_format

"chartJs" and "markdown".

chart_format: str | _models.ChartFormat | None

content_categories

Map of categories to classify the input content(s) against.

content_categories: dict[str, '_models.ContentCategoryDefinition'] | None

disable_face_blurring

Disable the default blurring of faces for privacy while processing the content.

disable_face_blurring: bool | None

enable_figure_analysis

Enable analysis of figures, such as charts and diagrams.

enable_figure_analysis: bool | None

enable_figure_description

Enable generation of figure description.

enable_figure_description: bool | None

enable_formula

Enable mathematical formula detection.

enable_formula: bool | None

enable_layout

Enable layout analysis.

enable_layout: bool | None

enable_ocr

Enable optical character recognition (OCR).

enable_ocr: bool | None

enable_segment

Enable segmentation of the input by contentCategories.

enable_segment: bool | None

estimate_field_source_and_confidence

Return field grounding source and confidence.

estimate_field_source_and_confidence: bool | None

locales

List of locale hints for speech transcription.

locales: list[str] | None

omit_content

Omit the content for this analyzer from analyze result. Only return content(s) from additional analyzers specified in contentCategories, if any.

omit_content: bool | None

return_details

Return all content details.

return_details: bool | None

segment_per_page

Force segmentation of document content by page.

segment_per_page: bool | None

table_format

"html" and "markdown".

table_format: str | _models.TableFormat | None