compass.extraction.small_wind.parse.StructuredSmallWindParser#

class StructuredSmallWindParser(llm_service, usage_tracker=None, **kwargs)[source]#

Bases: OrdinanceParser

Base class for parsing structured data

Parameters:

  • llm_service (Service) – LLM service used for queries.

  • usage_tracker (UsageTracker, optional) – Optional tracker instance to monitor token usage during LLM calls. By default, None.

  • **kwargs –

    Keyword arguments to be passed to the underlying service processing function (i.e. llm_service.call(**kwargs)). Should not contain the following keys:

    • usage_sub_label

    • messages

    These arguments are provided by this caller object.

Methods

parse(text)

Parse text and extract structured data

Attributes

IN_LABEL

Identifier for text ingested by this class

OUT_LABEL

Identifier for final structured data output

TASK_ID

ID to use for this extraction for linking with LLM configs
abstract property IN_LABEL#

Identifier for text ingested by this class

Type:

str

abstract property OUT_LABEL#

Identifier for final structured data output

Type:

str

TASK_ID = 'data_extraction'#

ID to use for this extraction for linking with LLM configs

abstractmethod async parse(text)#

Parse text and extract structured data

Parameters:

text (str) – Text which may or may not contain information relevant to the current extraction.

Returns:

pandas.DataFrame or None – DataFrame containing structured extracted data. Can also be None if no relevant values can be parsed from the text.