pycognaize.document.field.link_field.LinkField

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

Bases: Field

Base class for all pycognaize link fields

Parameters:

name (str)
value (str)
tags (Optional[List[ExtractionTag]])
field_id (Optional[str])
group_key (str)
confidence (Optional[float])
group_name (str)
mapping (Optional[List[Dict[str, str]]])

Methods

`construct_from_raw`	Create LinkField object from dictionary
`to_dict`	Converts LinkField 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 LinkField object from dictionary

Parameters:

raw (dict)
pages (Dict[int, Page])
html (Optional[HTML])
labels (ClassificationLabels)

Return type:

LinkField

html_tag_class: alias of HTMLTag

tag_class: alias of ExtractionTag

to_dict()[source]

Converts LinkField object to dictionary

Return type:: dict