# plugins.panels.similarity_search * [plugins.panels.similarity_search.constants](plugins.panels.similarity_search.constants.md) * [`RunStatus`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus) * [`RunStatus.PENDING`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.PENDING) * [`RunStatus.RUNNING`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.RUNNING) * [`RunStatus.COMPLETED`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.COMPLETED) * [`RunStatus.FAILED`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.FAILED) * [`RunStatus.encode()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.encode) * [`RunStatus.replace()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.replace) * [`RunStatus.split()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.split) * [`RunStatus.rsplit()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.rsplit) * [`RunStatus.join()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.join) * [`RunStatus.capitalize()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.capitalize) * [`RunStatus.casefold()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.casefold) * [`RunStatus.title()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.title) * [`RunStatus.center()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.center) * [`RunStatus.count()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.count) * [`RunStatus.expandtabs()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.expandtabs) * [`RunStatus.find()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.find) * [`RunStatus.partition()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.partition) * [`RunStatus.index()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.index) * [`RunStatus.ljust()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.ljust) * [`RunStatus.lower()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.lower) * [`RunStatus.lstrip()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.lstrip) * [`RunStatus.rfind()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.rfind) * [`RunStatus.rindex()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.rindex) * [`RunStatus.rjust()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.rjust) * [`RunStatus.rstrip()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.rstrip) * [`RunStatus.rpartition()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.rpartition) * [`RunStatus.splitlines()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.splitlines) * [`RunStatus.strip()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.strip) * [`RunStatus.swapcase()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.swapcase) * [`RunStatus.translate()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.translate) * [`RunStatus.upper()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.upper) * [`RunStatus.startswith()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.startswith) * [`RunStatus.endswith()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.endswith) * [`RunStatus.removeprefix()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.removeprefix) * [`RunStatus.removesuffix()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.removesuffix) * [`RunStatus.isascii()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.isascii) * [`RunStatus.islower()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.islower) * [`RunStatus.isupper()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.isupper) * [`RunStatus.istitle()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.istitle) * [`RunStatus.isspace()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.isspace) * [`RunStatus.isdecimal()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.isdecimal) * [`RunStatus.isdigit()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.isdigit) * [`RunStatus.isnumeric()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.isnumeric) * [`RunStatus.isalpha()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.isalpha) * [`RunStatus.isalnum()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.isalnum) * [`RunStatus.isidentifier()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.isidentifier) * [`RunStatus.isprintable()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.isprintable) * [`RunStatus.zfill()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.zfill) * [`RunStatus.format()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.format) * [`RunStatus.format_map()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.format_map) * [`RunStatus.maketrans()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.RunStatus.maketrans) * [`QueryType`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType) * [`QueryType.TEXT`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.TEXT) * [`QueryType.IMAGE`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.IMAGE) * [`QueryType.UPLOAD`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.UPLOAD) * [`QueryType.encode()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.encode) * [`QueryType.replace()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.replace) * [`QueryType.split()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.split) * [`QueryType.rsplit()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.rsplit) * [`QueryType.join()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.join) * [`QueryType.capitalize()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.capitalize) * [`QueryType.casefold()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.casefold) * [`QueryType.title()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.title) * [`QueryType.center()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.center) * [`QueryType.count()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.count) * [`QueryType.expandtabs()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.expandtabs) * [`QueryType.find()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.find) * [`QueryType.partition()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.partition) * [`QueryType.index()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.index) * [`QueryType.ljust()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.ljust) * [`QueryType.lower()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.lower) * [`QueryType.lstrip()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.lstrip) * [`QueryType.rfind()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.rfind) * [`QueryType.rindex()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.rindex) * [`QueryType.rjust()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.rjust) * [`QueryType.rstrip()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.rstrip) * [`QueryType.rpartition()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.rpartition) * [`QueryType.splitlines()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.splitlines) * [`QueryType.strip()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.strip) * [`QueryType.swapcase()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.swapcase) * [`QueryType.translate()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.translate) * [`QueryType.upper()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.upper) * [`QueryType.startswith()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.startswith) * [`QueryType.endswith()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.endswith) * [`QueryType.removeprefix()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.removeprefix) * [`QueryType.removesuffix()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.removesuffix) * [`QueryType.isascii()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.isascii) * [`QueryType.islower()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.islower) * [`QueryType.isupper()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.isupper) * [`QueryType.istitle()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.istitle) * [`QueryType.isspace()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.isspace) * [`QueryType.isdecimal()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.isdecimal) * [`QueryType.isdigit()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.isdigit) * [`QueryType.isnumeric()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.isnumeric) * [`QueryType.isalpha()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.isalpha) * [`QueryType.isalnum()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.isalnum) * [`QueryType.isidentifier()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.isidentifier) * [`QueryType.isprintable()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.isprintable) * [`QueryType.zfill()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.zfill) * [`QueryType.format()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.format) * [`QueryType.format_map()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.format_map) * [`QueryType.maketrans()`](plugins.panels.similarity_search.constants.md#plugins.panels.similarity_search.constants.QueryType.maketrans) * [plugins.panels.similarity_search.operators](plugins.panels.similarity_search.operators.md) * [`SimilaritySearchOperator`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator) * [`SimilaritySearchOperator.config`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.config) * [`SimilaritySearchOperator.execute()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.execute) * [`SimilaritySearchOperator.add_secrets()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.add_secrets) * [`SimilaritySearchOperator.builtin`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.builtin) * [`SimilaritySearchOperator.method_to_uri()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.method_to_uri) * [`SimilaritySearchOperator.name`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.name) * [`SimilaritySearchOperator.resolve_delegation()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.resolve_delegation) * [`SimilaritySearchOperator.resolve_execution_options()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.resolve_execution_options) * [`SimilaritySearchOperator.resolve_input()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.resolve_input) * [`SimilaritySearchOperator.resolve_output()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.resolve_output) * [`SimilaritySearchOperator.resolve_placement()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.resolve_placement) * [`SimilaritySearchOperator.resolve_run_name()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.resolve_run_name) * [`SimilaritySearchOperator.resolve_type()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.resolve_type) * [`SimilaritySearchOperator.risk_level`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.risk_level) * [`SimilaritySearchOperator.to_json()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.to_json) * [`SimilaritySearchOperator.uri`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchOperator.uri) * [`InitSimilarityRunOperator`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator) * [`InitSimilarityRunOperator.config`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.config) * [`InitSimilarityRunOperator.execute()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.execute) * [`InitSimilarityRunOperator.add_secrets()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.add_secrets) * [`InitSimilarityRunOperator.builtin`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.builtin) * [`InitSimilarityRunOperator.method_to_uri()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.method_to_uri) * [`InitSimilarityRunOperator.name`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.name) * [`InitSimilarityRunOperator.resolve_delegation()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.resolve_delegation) * [`InitSimilarityRunOperator.resolve_execution_options()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.resolve_execution_options) * [`InitSimilarityRunOperator.resolve_input()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.resolve_input) * [`InitSimilarityRunOperator.resolve_output()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.resolve_output) * [`InitSimilarityRunOperator.resolve_placement()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.resolve_placement) * [`InitSimilarityRunOperator.resolve_run_name()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.resolve_run_name) * [`InitSimilarityRunOperator.resolve_type()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.resolve_type) * [`InitSimilarityRunOperator.risk_level`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.risk_level) * [`InitSimilarityRunOperator.to_json()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.to_json) * [`InitSimilarityRunOperator.uri`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.InitSimilarityRunOperator.uri) * [`ListSimilarityRunsOperator`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator) * [`ListSimilarityRunsOperator.config`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.config) * [`ListSimilarityRunsOperator.execute()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.execute) * [`ListSimilarityRunsOperator.add_secrets()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.add_secrets) * [`ListSimilarityRunsOperator.builtin`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.builtin) * [`ListSimilarityRunsOperator.method_to_uri()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.method_to_uri) * [`ListSimilarityRunsOperator.name`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.name) * [`ListSimilarityRunsOperator.resolve_delegation()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.resolve_delegation) * [`ListSimilarityRunsOperator.resolve_execution_options()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.resolve_execution_options) * [`ListSimilarityRunsOperator.resolve_input()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.resolve_input) * [`ListSimilarityRunsOperator.resolve_output()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.resolve_output) * [`ListSimilarityRunsOperator.resolve_placement()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.resolve_placement) * [`ListSimilarityRunsOperator.resolve_run_name()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.resolve_run_name) * [`ListSimilarityRunsOperator.resolve_type()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.resolve_type) * [`ListSimilarityRunsOperator.risk_level`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.risk_level) * [`ListSimilarityRunsOperator.to_json()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.to_json) * [`ListSimilarityRunsOperator.uri`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.ListSimilarityRunsOperator.uri) * [`SimilaritySearchSubscriptionOperator`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator) * [`SimilaritySearchSubscriptionOperator.subscription_config`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.subscription_config) * [`SimilaritySearchSubscriptionOperator.IS_SSE_OPERATOR`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.IS_SSE_OPERATOR) * [`SimilaritySearchSubscriptionOperator.add_secrets()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.add_secrets) * [`SimilaritySearchSubscriptionOperator.builtin`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.builtin) * [`SimilaritySearchSubscriptionOperator.config`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.config) * [`SimilaritySearchSubscriptionOperator.execute()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.execute) * [`SimilaritySearchSubscriptionOperator.method_to_uri()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.method_to_uri) * [`SimilaritySearchSubscriptionOperator.name`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.name) * [`SimilaritySearchSubscriptionOperator.resolve_delegation()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.resolve_delegation) * [`SimilaritySearchSubscriptionOperator.resolve_execution_options()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.resolve_execution_options) * [`SimilaritySearchSubscriptionOperator.resolve_input()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.resolve_input) * [`SimilaritySearchSubscriptionOperator.resolve_output()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.resolve_output) * [`SimilaritySearchSubscriptionOperator.resolve_placement()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.resolve_placement) * [`SimilaritySearchSubscriptionOperator.resolve_run_name()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.resolve_run_name) * [`SimilaritySearchSubscriptionOperator.resolve_type()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.resolve_type) * [`SimilaritySearchSubscriptionOperator.risk_level`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.risk_level) * [`SimilaritySearchSubscriptionOperator.to_json()`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.to_json) * [`SimilaritySearchSubscriptionOperator.uri`](plugins.panels.similarity_search.operators.md#plugins.panels.similarity_search.operators.SimilaritySearchSubscriptionOperator.uri) * [plugins.panels.similarity_search.run_manager](plugins.panels.similarity_search.run_manager.md) * [`get_head_dataset_id()`](plugins.panels.similarity_search.run_manager.md#plugins.panels.similarity_search.run_manager.get_head_dataset_id) * [`RunManager`](plugins.panels.similarity_search.run_manager.md#plugins.panels.similarity_search.run_manager.RunManager) * [`RunManager.create_run()`](plugins.panels.similarity_search.run_manager.md#plugins.panels.similarity_search.run_manager.RunManager.create_run) * [`RunManager.get_run()`](plugins.panels.similarity_search.run_manager.md#plugins.panels.similarity_search.run_manager.RunManager.get_run) * [`RunManager.set_run()`](plugins.panels.similarity_search.run_manager.md#plugins.panels.similarity_search.run_manager.RunManager.set_run) * [`RunManager.update_run()`](plugins.panels.similarity_search.run_manager.md#plugins.panels.similarity_search.run_manager.RunManager.update_run) * [`RunManager.set_operator_run_id()`](plugins.panels.similarity_search.run_manager.md#plugins.panels.similarity_search.run_manager.RunManager.set_operator_run_id) * [`RunManager.find_run_by_operator_id()`](plugins.panels.similarity_search.run_manager.md#plugins.panels.similarity_search.run_manager.RunManager.find_run_by_operator_id) * [`RunManager.delete_run()`](plugins.panels.similarity_search.run_manager.md#plugins.panels.similarity_search.run_manager.RunManager.delete_run) * [`RunManager.list_runs()`](plugins.panels.similarity_search.run_manager.md#plugins.panels.similarity_search.run_manager.RunManager.list_runs) ## 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](https://voxel51.com/)

**Classes:** | [`SimilaritySearchPanel`](#plugins.panels.similarity_search.SimilaritySearchPanel)([_builtin]) | Panel for running and managing similarity search queries. | |--------------------------------------------------------------------------------------------------|-------------------------------------------------------------| ### *class* plugins.panels.similarity_search.SimilaritySearchPanel(\_builtin=False) Bases: [`Panel`](../../api/fiftyone.operators.panel.md#fiftyone.operators.panel.Panel) Panel for running and managing similarity search queries. **Attributes:** | [`config`](#plugins.panels.similarity_search.SimilaritySearchPanel.config) | The `OperatorConfig` for the operator. | |------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| | [`builtin`](#plugins.panels.similarity_search.SimilaritySearchPanel.builtin) | Whether the operator is builtin. | | [`name`](#plugins.panels.similarity_search.SimilaritySearchPanel.name) | | | [`risk_level`](#plugins.panels.similarity_search.SimilaritySearchPanel.risk_level) | The effective risk level of the operator, which is used by guardrail systems of an agent to classify tool calls. | | [`uri`](#plugins.panels.similarity_search.SimilaritySearchPanel.uri) | The unique identifier of the operator: `plugin_name/operator_name`. | **Methods:** | [`on_load`](#plugins.panels.similarity_search.SimilaritySearchPanel.on_load)(ctx) | | |-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------| | [`on_unload`](#plugins.panels.similarity_search.SimilaritySearchPanel.on_unload)(ctx) | | | [`get_brain_keys`](#plugins.panels.similarity_search.SimilaritySearchPanel.get_brain_keys)(ctx) | Refresh available similarity brain keys. | | [`list_runs`](#plugins.panels.similarity_search.SimilaritySearchPanel.list_runs)(ctx) | Refresh the runs list. | | [`apply_run`](#plugins.panels.similarity_search.SimilaritySearchPanel.apply_run)(ctx) | Apply a completed run's results as the current view. | | [`delete_run`](#plugins.panels.similarity_search.SimilaritySearchPanel.delete_run)(ctx) | Delete a run from the store. | | [`bulk_delete_runs`](#plugins.panels.similarity_search.SimilaritySearchPanel.bulk_delete_runs)(ctx) | Delete multiple runs from the store. | | [`clone_run`](#plugins.panels.similarity_search.SimilaritySearchPanel.clone_run)(ctx) | Return a run's config for pre-filling the new search form. | | [`rename_run`](#plugins.panels.similarity_search.SimilaritySearchPanel.rename_run)(ctx) | Rename a run. | | [`on_change_view`](#plugins.panels.similarity_search.SimilaritySearchPanel.on_change_view)(ctx) | Called when the panel navigates between pages. | | [`get_sample_media`](#plugins.panels.similarity_search.SimilaritySearchPanel.get_sample_media)(ctx) | Return media URLs for the given sample IDs. | | [`render`](#plugins.panels.similarity_search.SimilaritySearchPanel.render)(ctx) | Defines the panel's layout and events. | | [`add_secrets`](#plugins.panels.similarity_search.SimilaritySearchPanel.add_secrets)(secrets) | Adds secrets to the operator. | | [`execute`](#plugins.panels.similarity_search.SimilaritySearchPanel.execute)(ctx) | Executes the operator. | | [`method_to_uri`](#plugins.panels.similarity_search.SimilaritySearchPanel.method_to_uri)(method_name) | Converts a method name to a URI. | | [`on_startup`](#plugins.panels.similarity_search.SimilaritySearchPanel.on_startup)(ctx) | | | [`resolve_delegation`](#plugins.panels.similarity_search.SimilaritySearchPanel.resolve_delegation)(ctx) | Returns the resolved *forced* delegation flag. | | [`resolve_execution_options`](#plugins.panels.similarity_search.SimilaritySearchPanel.resolve_execution_options)(ctx) | Returns the resolved execution options. | | [`resolve_input`](#plugins.panels.similarity_search.SimilaritySearchPanel.resolve_input)(ctx) | Returns the resolved input property. | | [`resolve_output`](#plugins.panels.similarity_search.SimilaritySearchPanel.resolve_output)(ctx) | Returns the resolved output property. | | [`resolve_panel_config`](#plugins.panels.similarity_search.SimilaritySearchPanel.resolve_panel_config)() | Returns the registration config for this panel. | | [`resolve_placement`](#plugins.panels.similarity_search.SimilaritySearchPanel.resolve_placement)(ctx) | Returns the resolved placement of the operator. | | [`resolve_run_name`](#plugins.panels.similarity_search.SimilaritySearchPanel.resolve_run_name)(ctx) | Returns the resolved run name of the operator. | | [`resolve_type`](#plugins.panels.similarity_search.SimilaritySearchPanel.resolve_type)(ctx, type) | Returns the resolved input or output property. | | [`to_json`](#plugins.panels.similarity_search.SimilaritySearchPanel.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. Accepts an optional `owner` param (`"mine"` or `"all"`) to filter runs server-side. Non-managers are always restricted to their own runs regardless of the requested filter. #### 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 media URLs for the given sample IDs. Filepaths are returned as-is by default. In FiftyOne Enterprise, cloud filepaths (e.g. `s3://...`, `gs://...`) are resolved to signed HTTPS URLs so the frontend can render them directly. #### 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`](../../api/fiftyone.operators.executor.md#fiftyone.operators.executor.ExecutionContext) * **Returns:** a [`fiftyone.operators.types.Property`](../../api/fiftyone.operators.types.md#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`](../../api/fiftyone.operators.executor.md#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) → [bool](../../api/fiftyone.core.stages.md#fiftyone.core.stages.Exists.bool) | None 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`](../../api/fiftyone.operators.executor.md#fiftyone.operators.executor.ExecutionContext) * **Returns:** whether the operation should be delegated (True), run immediately (False), or None to defer to [`resolve_execution_options()`](#plugins.panels.similarity_search.SimilaritySearchPanel.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`](../../api/fiftyone.operators.executor.md#fiftyone.operators.executor.ExecutionContext) * **Returns:** a [`fiftyone.operators.executor.ExecutionOptions`](../../api/fiftyone.operators.executor.md#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()`](#plugins.panels.similarity_search.SimilaritySearchPanel.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`](../../api/fiftyone.operators.executor.md#fiftyone.operators.executor.ExecutionContext) * **Returns:** a [`fiftyone.operators.types.Property`](../../api/fiftyone.operators.types.md#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`](../../api/fiftyone.operators.executor.md#fiftyone.operators.executor.ExecutionContext) * **Returns:** a [`fiftyone.operators.types.Property`](../../api/fiftyone.operators.types.md#fiftyone.operators.types.Property), or None #### resolve_panel_config() Returns the registration config for this panel. #### 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`](../../api/fiftyone.operators.executor.md#fiftyone.operators.executor.ExecutionContext) * **Returns:** a [`fiftyone.operators.types.Placement`](../../api/fiftyone.operators.types.md#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`](../../api/fiftyone.operators.executor.md#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`](../../api/fiftyone.operators.executor.md#fiftyone.operators.executor.ExecutionContext) * **type** – the type of property to resolve, either `"inputs"` or `"outputs"` * **Returns:** a [`fiftyone.operators.types.Property`](../../api/fiftyone.operators.types.md#fiftyone.operators.types.Property), or None #### *property* risk_level The effective risk level of the operator, which is used by guardrail systems of an agent to classify tool calls. #### 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`.