pycognaize.document.field.text_field.TextField

class TextField(name, value='', tags=None, field_id=None, group_key=None, confidence=-1.0, group_name=None, classification_labels=None, mapping=None)[source]

Bases: Field

Base class for all pycognaize text fields

Parameters:

  • name (str)

  • value (str)

  • tags (Optional[List[ExtractionTag]])

  • field_id (Optional[str])

  • group_key (str)

  • confidence (Optional[float])

  • group_name (str)

  • classification_labels (Optional[ClassificationLabels])

  • mapping (Optional[List[Dict[str, str]]])

Methods

construct_from_raw

Create TextField object from dictionary

to_dict

Converts TextField object to dictionary

Attributes

classes

classification_labels

confidence

field_id

group_key

group_name

mapping

name

raw_value

tags

value

classmethod construct_from_raw(raw, pages, html=None, labels=None)[source]

Create TextField object from dictionary

Parameters:
Return type:

TextField

html_tag_class

alias of HTMLTag

tag_class

alias of ExtractionTag

to_dict()[source]

Converts TextField object to dictionary

Return type:

dict