meerkat.interactive.app.src.lib.component.core.Match¶

class Match(df: meerkat.dataframe.DataFrame = None, *, against: str, text: str = '', encoder: Union[str, Encoder] = 'clip', title: str = 'Match', enable_selection: bool = False, reset_criterion: bool = False, on_match: meerkat.interactive.endpoint.EndpointProperty = None, get_match_schema: meerkat.interactive.endpoint.EndpointProperty = None, on_clickminus: meerkat.interactive.endpoint.Endpoint = None, on_unclickminus: meerkat.interactive.endpoint.Endpoint = None, on_clickplus: meerkat.interactive.endpoint.Endpoint = None, on_unclickplus: meerkat.interactive.endpoint.Endpoint = None, on_reset: meerkat.interactive.endpoint.Endpoint = None)[source]¶
__init__(df: meerkat.dataframe.DataFrame = None, *, against: str, text: str = '', encoder: Union[str, Encoder] = 'clip', title: str = 'Match', enable_selection: bool = False, reset_criterion: bool = False, on_match: meerkat.interactive.endpoint.EndpointProperty = None, get_match_schema: meerkat.interactive.endpoint.EndpointProperty = None, on_clickminus: meerkat.interactive.endpoint.Endpoint = None, on_unclickminus: meerkat.interactive.endpoint.Endpoint = None, on_clickplus: meerkat.interactive.endpoint.Endpoint = None, on_unclickplus: meerkat.interactive.endpoint.Endpoint = None, on_reset: meerkat.interactive.endpoint.Endpoint = None)[source]¶
Parameters

  • df – The DataFrame.

  • against – The column to match against.

  • text – The query text.

  • encoder – The encoder to use.

  • title – The title of the component.

  • enable_selection – Whether to enable selection for image-based matching.

  • reset_criterion – Whether to reset the criterion when on_reset is called.

  • on_match – The endpoint to call when the match button is clicked. This endpoint will be called after self.criterion is set.

Methods

__init__([df, text, encoder, title, ...])

param df

The DataFrame.

append(other)

construct([_fields_set])

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.

copy(*[, include, exclude, update, deep])

Duplicate a model, optionally choose which fields to include, exclude and change.

dict(*[, include, exclude, by_alias, ...])

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

from_id(id)

from_orm(obj)

get_components()

json(*[, include, exclude, by_alias, ...])

Generate a JSON representation of the model, include and exclude arguments as per dict().

on_external_selection_change(external_selection)

parse_file(path, *[, content_type, ...])

parse_obj(obj)

parse_raw(b, *[, content_type, encoding, ...])

prepend_meerkat_id_prefix(id)

schema([by_alias, ref_template])

schema_json(*[, by_alias, ref_template])

set_selection(selection)

update_forward_refs(**localns)

Try to update ForwardRefs on fields based on this Model, globalns and localns.

validate(value)

Attributes

alias

component_name

criterion

event_names

events

frontend

Returns a Pydantic model that can be should be sent to the frontend.

frontend_alias

id

identifiable_group

library

namespace

path

prop_bindings

prop_names

props

slots

slottable

virtual_props

Props, and all events (as_*) as props.

wrapper_import_style

df

against

text

title

enable_selection

reset_criterion

on_match

get_match_schema

on_clickminus

on_unclickminus

on_clickplus

on_unclickplus

on_reset