DocTypeInfo Class

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

New in version v2022-01-30-preview: The build_mode property

Inheritance
builtins.object
DocTypeInfo

Constructor

DocTypeInfo(**kwargs)

Variables

description
str

A description for the model.

build_mode
str

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

field_schema
dict[str, <xref:Any>]

Description of the document semantic schema.

field_confidence
dict[str, float]

Estimated confidence for each field.

Methods

from_dict

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

to_dict

Returns a dict representation of DocTypeInfo.

from_dict

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

from_dict(data: dict) -> azure.ai.formrecognizer._models.DocTypeInfo

Parameters

data
dict
Required

A dictionary in the shape of DocTypeInfo.

data
Required

Returns

DocTypeInfo

Return type

to_dict

Returns a dict representation of DocTypeInfo.

to_dict() -> dict

Returns

dict

Return type