plugins.panels.similarity_search#

Module contents#

Similarity search panel.

This panel provides a non-blocking interface for running similarity searches against pre-computed embeddings. Queries run as delegated operations and results are stored as persistent runs that users can browse, apply, clone, and iterate on.

Copyright 2017-2026, Voxel51, Inc.
voxel51.com

Classes:

SimilaritySearchPanel([_builtin])

Panel for running and managing similarity search queries.

class plugins.panels.similarity_search.SimilaritySearchPanel(_builtin=False)#

Bases: Panel

Panel for running and managing similarity search queries.

Attributes:

`config`	The `OperatorConfig` for the operator.
`builtin`	Whether the operator is builtin.
`name`
`uri`	The unique identifier of the operator: `plugin_name/operator_name`.

Methods:

`on_load`(ctx)
`on_unload`(ctx)
`get_brain_keys`(ctx)	Refresh available similarity brain keys.
`list_runs`(ctx)	Refresh the runs list.
`apply_run`(ctx)	Apply a completed run's results as the current view.
`delete_run`(ctx)	Delete a run from the store.
`bulk_delete_runs`(ctx)	Delete multiple runs from the store.
`clone_run`(ctx)	Return a run's config for pre-filling the new search form.
`rename_run`(ctx)	Rename a run.
`on_change_view`(ctx)	Called when the panel navigates between pages.
`get_sample_media`(ctx)	Return filepaths for the given sample IDs.
`render`(ctx)	Defines the panel's layout and events.
`add_secrets`(secrets)	Adds secrets to the operator.
`execute`(ctx)	Executes the operator.
`method_to_uri`(method_name)	Converts a method name to a URI.
`on_startup`(ctx)
`resolve_delegation`(ctx)	Returns the resolved forced delegation flag.
`resolve_execution_options`(ctx)	Returns the resolved execution options.
`resolve_input`(ctx)	Returns the resolved input property.
`resolve_output`(ctx)	Returns the resolved output property.
`resolve_placement`(ctx)	Returns the resolved placement of the operator.
`resolve_run_name`(ctx)	Returns the resolved run name of the operator.
`resolve_type`(ctx, type)	Returns the resolved input or output property.
`to_json`()	Returns a JSON representation of the operator.

property config#: The OperatorConfig for the operator.

on_load(ctx)#

on_unload(ctx)#

get_brain_keys(ctx)#: Refresh available similarity brain keys.

list_runs(ctx)#: Refresh the runs list.

apply_run(ctx)#: Apply a completed run’s results as the current view.

delete_run(ctx)#: Delete a run from the store.

bulk_delete_runs(ctx)#: Delete multiple runs from the store.

clone_run(ctx)#: Return a run’s config for pre-filling the new search form.

rename_run(ctx)#: Rename a run.

on_change_view(ctx)#: Called when the panel navigates between pages.

get_sample_media(ctx)#: Return filepaths for the given sample IDs.

render(ctx)#

Defines the panel’s layout and events.

This method is called after every panel event is called (on load, button callback, context change event, etc).

Parameters:: ctx – the fiftyone.operators.executor.ExecutionContext
Returns:: a fiftyone.operators.types.Property

add_secrets(secrets)#

Adds secrets to the operator.

Parameters:: secrets – a list of secrets

property builtin#: Whether the operator is builtin.

execute(ctx)#

Executes the operator.

Subclasses must implement this method.

Parameters:: ctx – the fiftyone.operators.executor.ExecutionContext
Returns:: JSON serializable data, or None

method_to_uri(method_name)#

Converts a method name to a URI.

Parameters:: method_name – the method name
Returns:: a URI

property name#

on_startup(ctx)#

resolve_delegation(ctx)#

Returns the resolved forced delegation flag.

Subclasses can implement this method to decide if delegated execution should be forced for the given operation.

Parameters:: ctx – the fiftyone.operators.executor.ExecutionContext
Returns:: whether the operation should be delegated (True), run immediately (False), or None to defer to resolve_execution_options() to specify the available options

resolve_execution_options(ctx)#

Returns the resolved execution options.

Subclasses can implement this method to define the execution options available for the operation.

Parameters:: ctx – the fiftyone.operators.executor.ExecutionContext
Returns:: a fiftyone.operators.executor.ExecutionOptions instance

resolve_input(ctx)#

Returns the resolved input property.

Subclasses can implement this method to define the inputs to the operator. This method should never be called directly. Instead use resolve_type().

By default, this method is called once when the operator is created. If the operator is dynamic, this method is called each time the input changes.

Parameters:: ctx – the fiftyone.operators.executor.ExecutionContext
Returns:: a fiftyone.operators.types.Property, or None

resolve_output(ctx)#

Returns the resolved output property.

Subclasses can implement this method to define the outputs of the operator.

By default, this method is called once when the operator is created. If the operator is dynamic, this method is called after the operator is executed.

Parameters:: ctx – the fiftyone.operators.executor.ExecutionContext
Returns:: a fiftyone.operators.types.Property, or None

resolve_placement(ctx)#

Returns the resolved placement of the operator.

Subclasses can implement this method to define the placement of the operator.

Parameters:: ctx – the fiftyone.operators.executor.ExecutionContext
Returns:: a fiftyone.operators.types.Placement, or None

resolve_run_name(ctx)#

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:: ctx – the fiftyone.operators.executor.ExecutionContext
Returns:: a string, or None

resolve_type(ctx, type)#

Returns the resolved input or output property.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext
type – the type of property to resolve, either "inputs" or "outputs"

Returns:

a fiftyone.operators.types.Property, or None

to_json()#

Returns a JSON representation of the operator.

Returns:: a JSON dict

property uri#: The unique identifier of the operator: plugin_name/operator_name.