DocumentTypeDetails Class

Document type info.

Constructor

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

Variables

Name	Description
description	str Document model description.
build_mode	str or DocumentBuildMode Custom document model build mode. Known values are: "template" and "neural".
field_schema	dict[str, DocumentFieldSchema] Description of the document semantic schema using a JSON Schema style syntax.
field_confidence	dict[str, float] Estimated confidence for each field.
model_id	str Document model to use for analyzing documents with specified type.
confidence_threshold	float Only perform analysis if docType confidence is above threshold.
features	list[str or DocumentAnalysisFeature] List of optional analysis features.
query_fields	list[str] List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber".
max_documents_to_analyze	int Maximum number of documents of specified type to analyze. Default=all.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
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

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

build_mode

"template" and "neural".

build_mode: str | _models.DocumentBuildMode | None

confidence_threshold

Only perform analysis if docType confidence is above threshold.

confidence_threshold: float | None

description

Document model description.

description: str | None

features

List of optional analysis features.

features: List[str | _models.DocumentAnalysisFeature] | None

field_confidence

Estimated confidence for each field.

field_confidence: Dict[str, float] | None

field_schema

Description of the document semantic schema using a JSON Schema style syntax.

field_schema: Dict[str, _models.DocumentFieldSchema] | None

max_documents_to_analyze

Maximum number of documents of specified type to analyze. Default=all.

max_documents_to_analyze: int | None

model_id

Document model to use for analyzing documents with specified type.

model_id: str | None

query_fields

List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber".

query_fields: List[str] | None