DocumentTypeDetails Class

DocumentTypeDetails represents a document type that a model can recognize, including its fields and types, and the confidence for those fields.

Inheritance

builtins.object

DocumentTypeDetails

Constructor

DocumentTypeDetails(**kwargs: Any)

Methods

from_dict	Converts a dict in the shape of a DocumentTypeDetails to the model itself.
to_dict	Returns a dict representation of DocumentTypeDetails.

from_dict

Converts a dict in the shape of a DocumentTypeDetails to the model itself.

from_dict(data: Dict) -> DocumentTypeDetails

Parameters

Name	Description
data Required	dict A dictionary in the shape of DocumentTypeDetails.

Returns

Type	Description
DocumentTypeDetails	DocumentTypeDetails

to_dict

Returns a dict representation of DocumentTypeDetails.

to_dict() -> Dict

Returns

Type	Description
dict	dict

Attributes

build_mode

The build mode used when building the custom model. Possible values include: "template", "neural".

build_mode: str | None

description

A description for the model.

description: str | None

field_confidence

Estimated confidence for each field.

field_confidence: Dict[str, float] | None

field_schema

Description of the document semantic schema.

field_schema: Dict[str, Any]