DocumentClassifierDetails Class

Document classifier info.

Constructor

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

Variables

Name	Description
classifier_id	str Unique document classifier name. Required.
description	str Document classifier description.
created_date_time	datetime Date and time (UTC) when the document classifier was created. Required.
expiration_date_time	datetime Date and time (UTC) when the document classifier will expire.
api_version	str API version used to create this document classifier. Required.
base_classifier_id	str Base classifierId on top of which the classifier was trained.
doc_types	dict[str, ClassifierDocumentTypeDetails] List of document types to classify against. Required.
warnings	list[Warning] List of warnings encountered while building the classifier.

Methods

as_dict	Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify 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

clear() -> None

copy

copy() -> Model

get

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

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

keys

keys() -> KeysView[str]

pop

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

Parameters

Name	Description
key Required
default

popitem

popitem() -> Tuple[str, Any]

setdefault

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

Parameters

Name	Description
key Required
default

update

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

values

values() -> ValuesView[Any]

Attributes

api_version

API version used to create this document classifier. Required.

api_version: str

base_classifier_id

Base classifierId on top of which the classifier was trained.

base_classifier_id: str | None

classifier_id

Unique document classifier name. Required.

classifier_id: str

created_date_time

Date and time (UTC) when the document classifier was created. Required.

created_date_time: datetime

description

Document classifier description.

description: str | None

doc_types

List of document types to classify against. Required.

doc_types: Dict[str, _models.ClassifierDocumentTypeDetails]

expiration_date_time

Date and time (UTC) when the document classifier will expire.

expiration_date_time: datetime | None

warnings

List of warnings encountered while building the classifier.

warnings: List[_models.Warning] | None