# fiftyone.brain.internal.core.pgvector
PGVector similarity backend.
Copyright 2017-2026, Voxel51, Inc.
[voxel51.com](https://voxel51.com/)
**Classes:**
| [`PgVectorSimilarityConfig`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig)([index_name, ...]) | Configuration for the PGVector similarity backend. |
|--------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
| [`PgVectorSimilarity`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity)(config) | PGVector similarity factory. |
| [`PgVectorSimilarityIndex`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex)(samples, config, ...) | Class for interacting with PGVector similarity indexes. |
### *class* fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig(index_name=None, table_name=None, metric='cosine', connection_string=None, ssl_cert=None, ssl_key=None, ssl_root_cert=None, work_mem='64MB', maintenance_work_mem=None, vector_type='vector', index_type='hnsw', hnsw_m=16, hnsw_ef_construction=64, hnsw_ef_search=None, ivfflat_lists=None, ivfflat_probes=None, \*\*kwargs)
Bases: [`SimilarityConfig`](fiftyone.brain.similarity.md#fiftyone.brain.similarity.SimilarityConfig)
Configuration for the PGVector similarity backend.
* **Parameters:**
* **index_name** (*None*) – the name of the PGVector index to use or create.
If none is provided, a default index name will be used.
* **table_name** (*None*) – the name of the table to use or create. If none is
provided, a default table name will be used.
* **metric** ( *"cosine"*) – the similarity metric to use. Supported values are
`("cosine", "dotproduct", "euclidean", "l1")`
* **connection_string** (*None*) – the connection string to the PostgreSQL database
* **ssl_cert** (*None*) – the path to the SSL certificate file
* **ssl_key** (*None*) – the path to the secret key used for the client certificate
* **ssl_root_cert** (*None*) – the path to the file containing SSL certificate
authority (CA) certificate(s).
* **work_mem** ( *"64MB"*) – the base maximum amount of memory to be used by a query operation
(such as a sort or hash table) before writing to temporary disk files
* **maintenance_work_mem** (*None*) – an optional maximum amount of memory to
be used by index builds. If not provided, the server default
(typically 64MB) is used. Increase this for high-dimensional
embeddings or IVFFlat indexes with many lists
* **vector_type** ( *"vector"*) – the pgvector column type to use for storing
embeddings. Supported values are `("vector", "halfvec")`.
`"halfvec"` stores half-precision (float16) vectors and
supports indexes with up to 4000 dimensions, versus 2000 for
`"vector"`, and requires pgvector >= 0.7.0
* **index_type** ( *"hnsw"*) – the type of index to use. Supported values are
`("hnsw", "ivfflat")`. Note that IVFFlat indexes only support
the `("cosine", "dotproduct", "euclidean")` metrics
* **hnsw_m** (*16*) – the max number of connections per layer in the HNSW index
* **hnsw_ef_construction** (*64*) – the size of the dynamic candidate list for constructing the graph for the HNSW index
* **hnsw_ef_search** (*None*) – an optional size of the dynamic candidate list
for HNSW searches. If not provided, the server default (40) is
used
* **ivfflat_lists** (*None*) – the number of inverted lists in the IVFFlat
index. By default, this is derived from the number of embeddings
in the index following pgvector’s guidance of `rows / 1000` for
up to 1M rows and `sqrt(rows)` beyond that
* **ivfflat_probes** (*None*) – the number of lists to probe during IVFFlat
searches. By default, this is derived from the number of lists
following pgvector’s `sqrt(lists)` guidance. Larger values
improve recall at the cost of speed
* **\*\*kwargs** – keyword arguments for
[`fiftyone.brain.similarity.SimilarityConfig`](fiftyone.brain.similarity.md#fiftyone.brain.similarity.SimilarityConfig)
**Attributes:**
| [`method`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.method) | The name of the similarity backend. |
|--------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| [`connection_string`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.connection_string) | |
| [`max_k`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.max_k) | A maximum k value for nearest neighbor queries, or None if there is no limit. |
| [`supports_least_similarity`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.supports_least_similarity) | Whether this backend supports least similarity queries. |
| [`supported_aggregations`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.supported_aggregations) | A tuple of supported values for the `aggregation` parameter of the backend's `sort_by_similarity()` and `_kneighbors()` methods. |
| [`cls`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.cls) | The fully-qualified name of this `BaseRunConfig` class. |
| [`run_cls`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.run_cls) | The `BaseRun` class associated with this config. |
| [`type`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.type) | The type of run. |
**Methods:**
| [`load_credentials`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.load_credentials)([connection_string]) | Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config. |
|----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`attributes`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.attributes)() | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.serialize). |
| [`base_config_cls`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.base_config_cls)(type) | Returns the config class for the given run type. |
| [`build`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.build)() | Builds the `BaseRun` instance associated with this config. |
| [`builder`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.builder)() | Returns a ConfigBuilder instance for this class. |
| [`copy`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.copy)() | Returns a deep copy of the object. |
| [`custom_attributes`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. |
| [`default`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.default)() | Returns the default config instance. |
| [`from_dict`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.from_dict)(d) | Constructs a `BaseRunConfig` from a serialized JSON dict representation of it. |
| [`from_json`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.from_json)(path, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON file. |
| [`from_kwargs`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.from_kwargs)(\*\*kwargs) | Constructs a Config object from keyword arguments. |
| [`from_str`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. |
| [`get_class_name`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.get_class_name)() | Returns the fully-qualified class name string of this object. |
| [`load_default`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.load_default)() | Loads the default config instance from file. |
| [`parse_array`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_array)(d, key[, default]) | Parses a raw array attribute. |
| [`parse_bool`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_bool)(d, key[, default]) | Parses a boolean value. |
| [`parse_categorical`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_categorical)(d, key, choices[, default]) | Parses a categorical JSON field, which must take a value from among the given choices. |
| [`parse_dict`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_dict)(d, key[, default]) | Parses a dictionary attribute. |
| [`parse_int`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_int)(d, key[, default]) | Parses an integer attribute. |
| [`parse_mutually_exclusive_fields`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_mutually_exclusive_fields)(fields) | Parses a mutually exclusive dictionary of pre-parsed fields, which must contain exactly one field with a truthy value. |
| [`parse_number`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_number)(d, key[, default]) | Parses a number attribute. |
| [`parse_object`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_object)(d, key, cls[, default]) | Parses an object attribute. |
| [`parse_object_array`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_object_array)(d, key, cls[, default]) | Parses an array of objects. |
| [`parse_object_dict`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_object_dict)(d, key, cls[, default]) | Parses a dictionary whose values are objects. |
| [`parse_path`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_path)(d, key[, default]) | Parses a path attribute. |
| [`parse_raw`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_raw)(d, key[, default]) | Parses a raw (arbitrary) JSON field. |
| [`parse_string`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.parse_string)(d, key[, default]) | Parses a string attribute. |
| [`serialize`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.serialize)([reflective]) | Serializes the object into a dictionary. |
| [`to_str`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.to_str)([pretty_print]) | Returns a string representation of this object. |
| [`validate_all_or_nothing_fields`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.validate_all_or_nothing_fields)(fields) | Validates a dictionary of pre-parsed fields checking that either all or none of the fields have a truthy value. |
| [`write_json`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. |
#### *property* method
The name of the similarity backend.
#### *property* connection_string
#### *property* max_k
A maximum k value for nearest neighbor queries, or None if there is
no limit.
#### *property* supports_least_similarity
Whether this backend supports least similarity queries.
#### *property* supported_aggregations
A tuple of supported values for the `aggregation` parameter of the
backend’s
`sort_by_similarity()` and
`_kneighbors()` methods.
#### load_credentials(connection_string=None)
Loads any necessary credentials from the given keyword arguments or
the relevant FiftyOne config.
* **Parameters:**
**\*\*kwargs** – subclass-specific credentials
#### attributes()
Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig.serialize).
* **Returns:**
a list of attributes
#### *static* base_config_cls(type)
Returns the config class for the given run type.
* **Parameters:**
**type** – a `BaseRunConfig.type`
* **Returns:**
a `BaseRunConfig` subclass
#### build()
Builds the `BaseRun` instance associated with this config.
* **Returns:**
a `BaseRun` instance
#### *classmethod* builder()
Returns a ConfigBuilder instance for this class.
#### *property* cls
The fully-qualified name of this `BaseRunConfig` class.
#### copy()
Returns a deep copy of the object.
* **Returns:**
a Serializable instance
#### custom_attributes(dynamic=False, private=False)
Returns a customizable list of class attributes.
By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).
* **Parameters:**
* **dynamic** – whether to include dynamic properties, e.g., those defined
by getter/setter methods or the `@property` decorator. By
default, this is False
* **private** – whether to include private properties, i.e., those
starting with “_”. By default, this is False
* **Returns:**
a list of class attributes
#### *classmethod* default()
Returns the default config instance.
By default, this method instantiates the class from an empty
dictionary, which will only succeed if all attributes are optional.
Otherwise, subclasses should override this method to provide the
desired default configuration.
#### *classmethod* from_dict(d)
Constructs a `BaseRunConfig` from a serialized JSON dict
representation of it.
* **Parameters:**
**d** – a JSON dict
* **Returns:**
a `BaseRunConfig`
#### *classmethod* from_json(path, \*args, \*\*kwargs)
Constructs a Serializable object from a JSON file.
Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.
* **Parameters:**
* **path** – the path to the JSON file on disk
* **\*args** – optional positional arguments for `self.from_dict()`
* **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
an instance of the Serializable class
#### *classmethod* from_kwargs(\*\*kwargs)
Constructs a Config object from keyword arguments.
* **Parameters:**
**\*\*kwargs** – keyword arguments that define the fields expected by cls
* **Returns:**
an instance of cls
#### *classmethod* from_str(s, \*args, \*\*kwargs)
Constructs a Serializable object from a JSON string.
Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.
* **Parameters:**
* **s** – a JSON string representation of a Serializable object
* **\*args** – optional positional arguments for `self.from_dict()`
* **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
an instance of the Serializable class
#### *classmethod* get_class_name()
Returns the fully-qualified class name string of this object.
#### *classmethod* load_default()
Loads the default config instance from file.
Subclasses must implement this method if they intend to support
default instances.
#### *static* parse_array(d, key, default=)
Parses a raw array attribute.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default list to return if key is not present
* **Returns:**
a list of raw (untouched) values
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_bool(d, key, default=)
Parses a boolean value.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default bool to return if key is not present
* **Returns:**
True/False
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_categorical(d, key, choices, default=)
Parses a categorical JSON field, which must take a value from among
the given choices.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **choices** – either an iterable of possible values or an enum-like
class whose attributes define the possible values
* **default** – a default value to return if key is not present
* **Returns:**
the raw (untouched) value of the given field, which is equal to a
value from `choices`
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the key was present in the dictionary but its value
was not an allowed choice, or if no default value was provided
and the key was not found in the dictionary
#### *static* parse_dict(d, key, default=)
Parses a dictionary attribute.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default dict to return if key is not present
* **Returns:**
a dictionary
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_int(d, key, default=)
Parses an integer attribute.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default integer value to return if key is not present
* **Returns:**
an int
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_mutually_exclusive_fields(fields)
Parses a mutually exclusive dictionary of pre-parsed fields, which
must contain exactly one field with a truthy value.
* **Parameters:**
**fields** – a dictionary of pre-parsed fields
* **Returns:**
the (field, value) that was set
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if zero or more than one truthy value was found
#### *static* parse_number(d, key, default=)
Parses a number attribute.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default numeric value to return if key is not present
* **Returns:**
a number (e.g. int, float)
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_object(d, key, cls, default=)
Parses an object attribute.
The value of d[key] can be either an instance of cls or a serialized
dict from an instance of cls.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **cls** – the class of d[key]
* **default** – a default cls instance to return if key is not present
* **Returns:**
an instance of cls
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_object_array(d, key, cls, default=)
Parses an array of objects.
The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **cls** – the class of the elements of list d[key]
* **default** – the default list to return if key is not present
* **Returns:**
a list of cls instances
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_object_dict(d, key, cls, default=)
Parses a dictionary whose values are objects.
The values in d[key] can be either instances of cls or serialized
dicts from instances of cls.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **cls** – the class of the values of dictionary d[key]
* **default** – the default dict of cls instances to return if key is not
present
* **Returns:**
a dictionary whose values are cls instances
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_path(d, key, default=)
Parses a path attribute.
The path is converted to an absolute path if necessary via
`os.path.abspath(os.path.expanduser(value))`.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default string to return if key is not present
* **Returns:**
a path string
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *static* parse_raw(d, key, default=)
Parses a raw (arbitrary) JSON field.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default value to return if key is not present
* **Returns:**
the raw (untouched) value of the given field
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if no default value was provided and the key was not
found in the dictionary
#### *static* parse_string(d, key, default=)
Parses a string attribute.
* **Parameters:**
* **d** – a JSON dictionary
* **key** – the key to parse
* **default** – a default string to return if key is not present
* **Returns:**
a string
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default
value was provided and the key was not found in the dictionary
#### *property* run_cls
The `BaseRun` class associated with this config.
#### serialize(reflective=False)
Serializes the object into a dictionary.
Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.
* **Parameters:**
**reflective** – whether to include reflective attributes when
serializing the object. By default, this is False
* **Returns:**
a JSON dictionary representation of the object
#### to_str(pretty_print=True, \*\*kwargs)
Returns a string representation of this object.
* **Parameters:**
* **pretty_print** – whether to render the JSON in human readable format
with newlines and indentations. By default, this is True
* **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
a string representation of the object
#### *property* type
The type of run.
#### *static* validate_all_or_nothing_fields(fields)
Validates a dictionary of pre-parsed fields checking that either
all or none of the fields have a truthy value.
* **Parameters:**
**fields** – a dictionary of pre-parsed fields
* **Raises:**
[**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if some values are truth and some are not
#### write_json(path, pretty_print=False, \*\*kwargs)
Serializes the object and writes it to disk.
* **Parameters:**
* **path** – the output path
* **pretty_print** – whether to render the JSON in human readable format
with newlines and indentations. By default, this is False
* **\*\*kwargs** – optional keyword arguments for `self.serialize()`
### *class* fiftyone.brain.internal.core.pgvector.PgVectorSimilarity(config)
Bases: [`Similarity`](fiftyone.brain.similarity.md#fiftyone.brain.similarity.Similarity)
PGVector similarity factory.
* **Parameters:**
**config** – a [`PgVectorSimilarityConfig`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityConfig)
**Methods:**
| [`ensure_requirements`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.ensure_requirements)() | Ensures that any necessary packages to execute this run are installed. |
|------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| [`ensure_usage_requirements`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.ensure_usage_requirements)() | Ensures that any necessary packages to use existing results for this run are installed. |
| [`initialize`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.initialize)(samples, brain_key) | Initializes a similarity index. |
| [`cleanup`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.cleanup)(samples, key) | Cleans up the results of the run with the given key from the collection. |
| [`delete_run`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.delete_run)(samples, key[, cleanup]) | Deletes the results associated with the given run key from the collection. |
| [`delete_runs`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.delete_runs)(samples[, cleanup]) | Deletes all runs from the collection. |
| [`from_config`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.from_config)(config) | Instantiates a Configurable class from a Config instance. |
| [`from_dict`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.from_dict)(d) | Instantiates a Configurable class from a Config dict. |
| [`from_json`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.from_json)(json_path) | Instantiates a Configurable class from a Config JSON file. |
| [`from_kwargs`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.from_kwargs)(\*\*kwargs) | Instantiates a Configurable class from keyword arguments defining the attributes of a Config. |
| [`get_fields`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.get_fields)(samples, brain_key) | Gets the fields that were involved in the given run. |
| [`get_run_info`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.get_run_info)(samples, key) | Gets the `BaseRunInfo` for the given key on the collection. |
| [`has_cached_run_results`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.has_cached_run_results)(samples, key) | Determines whether `BaseRunResults` for the given key are cached on the collection. |
| [`list_runs`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.list_runs)(samples[, type, method]) | Returns the list of run keys on the given collection. |
| [`load_run_results`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.load_run_results)(samples, key[, cache, ...]) | Loads the `BaseRunResults` for the given key on the collection. |
| [`load_run_view`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.load_run_view)(samples, key[, select_fields]) | Loads the view on which the specified run was performed. |
| [`parse`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.parse)(class_name[, module_name]) | Parses a Configurable subclass name string. |
| [`register_run`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.register_run)(samples, key[, overwrite, cleanup]) | Registers a run of this method under the given key on the given collection. |
| [`rename`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.rename)(samples, key, new_key) | Performs any necessary operations required to rename this run's key. |
| [`run_info_cls`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.run_info_cls)() | The `BaseRunInfo` class associated with this class. |
| [`save_run_info`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.save_run_info)(samples, run_info[, ...]) | Saves the run information on the collection. |
| [`save_run_results`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.save_run_results)(samples, key, run_results) | Saves the run results on the collection. |
| [`update_run_config`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.update_run_config)(samples, key, config) | Updates the `BaseRunConfig` for the given run on the collection. |
| [`update_run_key`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.update_run_key)(samples, key, new_key) | Replaces the key for the given run with a new key. |
| [`validate`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.validate)(config) | Validates that the given config is an instance of Config. |
| [`validate_run`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarity.validate_run)(samples, key[, overwrite]) | Validates that the collection can accept this run. |
#### ensure_requirements()
Ensures that any necessary packages to execute this run are
installed.
Runs should respect `fiftyone.config.requirement_error_level` when
handling errors.
#### ensure_usage_requirements()
Ensures that any necessary packages to use existing results for this
run are installed.
Runs should respect `fiftyone.config.requirement_error_level` when
handling errors.
#### initialize(samples, brain_key)
Initializes a similarity index.
* **Parameters:**
* **samples** – a `fiftyone.core.collections.SampleColllection`
* **brain_key** – the brain key
* **Returns:**
a `SimilarityIndex`
#### cleanup(samples, key)
Cleans up the results of the run with the given key from the
collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
#### *classmethod* delete_run(samples, key, cleanup=True)
Deletes the results associated with the given run key from the
collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **cleanup** (*True*) – whether to execute the run’s
`BaseRun.cleanup()` method
#### *classmethod* delete_runs(samples, cleanup=True)
Deletes all runs from the collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **cleanup** (*True*) – whether to execute the run’s
`BaseRun.cleanup()` methods
#### *classmethod* from_config(config)
Instantiates a Configurable class from a Config instance.
#### *classmethod* from_dict(d)
Instantiates a Configurable class from a Config dict.
* **Parameters:**
**d** – a dict to construct a Config
* **Returns:**
an instance of cls
#### *classmethod* from_json(json_path)
Instantiates a Configurable class from a Config JSON file.
* **Parameters:**
**json_path** – path to a JSON file for type Config
* **Returns:**
an instance of cls
#### *classmethod* from_kwargs(\*\*kwargs)
Instantiates a Configurable class from keyword arguments defining
the attributes of a Config.
* **Parameters:**
**\*\*kwargs** – keyword arguments that define the fields of a
Config dict
* **Returns:**
an instance of cls
#### get_fields(samples, brain_key)
Gets the fields that were involved in the given run.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **Returns:**
a list of fields
#### *classmethod* get_run_info(samples, key)
Gets the `BaseRunInfo` for the given key on the collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **Returns:**
a `BaseRunInfo`
#### *classmethod* has_cached_run_results(samples, key)
Determines whether `BaseRunResults` for the given key are
cached on the collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **Returns:**
True/False
#### *classmethod* list_runs(samples, type=None, method=None, \*\*kwargs)
Returns the list of run keys on the given collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **type** (*None*) –
a specific run type to match, which can be:
- a string [`fiftyone.core.runs.BaseRunConfig.type`](fiftyone.core.runs.md#fiftyone.core.runs.BaseRunConfig.type)
- a [`fiftyone.core.runs.BaseRun`](fiftyone.core.runs.md#fiftyone.core.runs.BaseRun) class or its
fully-qualified class name string
* **method** (*None*) – a specific
[`fiftyone.core.runs.BaseRunConfig.method`](fiftyone.core.runs.md#fiftyone.core.runs.BaseRunConfig.method) string to match
* **\*\*kwargs** – optional config parameters to match
* **Returns:**
a list of run keys
#### *classmethod* load_run_results(samples, key, cache=True, load_view=True, \*\*kwargs)
Loads the `BaseRunResults` for the given key on the
collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **cache** (*True*) – whether to cache the results on the collection
* **load_view** (*True*) – whether to load the run view in the results
(True) or the full dataset (False)
* **\*\*kwargs** – keyword arguments for the run’s
`BaseRunConfig.load_credentials()` method
* **Returns:**
a `BaseRunResults`, or None if the run did not save results
#### *classmethod* load_run_view(samples, key, select_fields=False)
Loads the view on which the specified run was performed.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **select_fields** (*False*) – whether to exclude fields involved in other
runs of the same type
* **Returns:**
a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
#### *static* parse(class_name, module_name=None)
Parses a Configurable subclass name string.
Assumes both the Configurable class and the Config class are defined
in the same module. The module containing the classes will be loaded
if necessary.
* **Parameters:**
* **class_name** – a string containing the name of the Configurable class,
e.g. “ClassName”, or a fully-qualified class name, e.g.
“eta.core.config.ClassName”
* **module_name** – a string containing the fully-qualified module name,
e.g. “eta.core.config”, or None if class_name includes the
module name. Set module_name = \_\_name_\_ to load a class from
the calling module
* **Returns:**
the Configurable class
config_cls: the Config class associated with cls
* **Return type:**
[cls](fiftyone.brain.internal.core.elasticsearch.md#fiftyone.brain.internal.core.elasticsearch.ElasticsearchSimilarityConfig.cls)
#### register_run(samples, key, overwrite=True, cleanup=True)
Registers a run of this method under the given key on the given
collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **overwrite** (*True*) – whether to allow overwriting an existing run of
the same type
* **cleanup** (*True*) – whether to execute an existing run’s
`BaseRun.cleanup()` method when overwriting it
#### rename(samples, key, new_key)
Performs any necessary operations required to rename this run’s key.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **new_key** – a new run key
#### *classmethod* run_info_cls()
The `BaseRunInfo` class associated with this class.
#### *classmethod* save_run_info(samples, run_info, overwrite=True, cleanup=True)
Saves the run information on the collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **run_info** – a `BaseRunInfo`
* **overwrite** (*True*) – whether to overwrite an existing run with the
same key
* **cleanup** (*True*) – whether to execute an existing run’s
`BaseRun.cleanup()` method when overwriting it
#### *classmethod* save_run_results(samples, key, run_results, overwrite=True, cache=True)
Saves the run results on the collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **run_results** – a `BaseRunResults`, or None
* **overwrite** (*True*) – whether to overwrite an existing result with the
same key
* **cache** (*True*) – whether to cache the results on the collection
#### *classmethod* update_run_config(samples, key, config)
Updates the `BaseRunConfig` for the given run on the
collection.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **config** – a `BaseRunConfig`
#### *classmethod* update_run_key(samples, key, new_key)
Replaces the key for the given run with a new key.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **new_key** – a new run key
#### *classmethod* validate(config)
Validates that the given config is an instance of Config.
* **Raises:**
**ConfigurableError** – if config is not an instance of Config
#### validate_run(samples, key, overwrite=True)
Validates that the collection can accept this run.
The run may be invalid if, for example, a run of a different type has
already been run under the same key and thus overwriting it would cause
ambiguity on how to cleanup the results.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **key** – a run key
* **overwrite** (*True*) – whether to allow overwriting an existing run of
the same type
* **Raises:**
**ValueError** – if the run is invalid
### *class* fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex(samples, config, brain_key, backend=None)
Bases: [`SimilarityIndex`](fiftyone.brain.similarity.md#fiftyone.brain.similarity.SimilarityIndex)
Class for interacting with PGVector similarity indexes.
* **Parameters:**
* **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) used
* **config** – the `PGVectorSimilarityConfig` used
* **brain_key** – the brain key
* **backend** (*None*) – a `PGVectorSimilarity` instance
**Attributes:**
| [`total_index_size`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.total_index_size) | The total number of data points in the index. |
|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`backend`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.backend) | The `BaseRun` for these results. |
| [`cls`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.cls) | The fully-qualified name of this `BaseRunResults` class. |
| [`config`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.config) | The `SimilarityConfig` for these results. |
| [`current_label_ids`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.current_label_ids) | The label IDs of the currently active data points in the index, or `None` if not applicable. |
| [`current_sample_ids`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.current_sample_ids) | The sample IDs of the currently active data points in the index. |
| [`has_view`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.has_view) | Whether the index is currently restricted to a view. |
| [`index_size`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.index_size) | The number of active data points in the index. |
| [`is_external`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.is_external) | Whether this similarity index manages its own embeddings (True) or loads them directly from the `embeddings_field` of the dataset (False). |
| [`key`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.key) | The run key for these results. |
| [`label_ids`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.label_ids) | The label IDs of the full index, or `None` if not applicable or not supported. |
| [`missing_size`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.missing_size) | The total number of data points in [`view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.view) that are missing from this index, or `None` if unknown. |
| [`sample_ids`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.sample_ids) | The sample IDs of the full index, or `None` if not supported. |
| [`samples`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.samples) | The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated with these results. |
| [`supports_prompts`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.supports_prompts) | Whether this similarity index supports prompt queries. |
| [`view`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.view) | The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) against which results are currently being generated. |
**Methods:**
| [`create_index`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.create_index)() | |
|----------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`create_hnsw_index`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.create_hnsw_index)() | Deprecated alias for [`create_index()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.create_index). |
| [`add_to_index`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.add_to_index)(embeddings, sample_ids[, ...]) | Adds the given embeddings to the index. |
| [`remove_from_index`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.remove_from_index)([sample_ids, label_ids, ...]) | Removes the specified embeddings from the index. |
| [`close_connections`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.close_connections)() | |
| [`get_embeddings_by_id`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.get_embeddings_by_id)([sample_ids, label_ids]) | |
| [`get_embeddings`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.get_embeddings)([sample_ids, label_ids, ...]) | Retrieves the embeddings for the given IDs from the index. |
| [`cleanup`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.cleanup)([drop_table]) | Clean up the database by dropping the vector index and optionally the embeddings table. |
| [`attributes`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.attributes)() | Returns the list of class attributes that will be serialized by [`serialize()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.serialize). |
| [`base_results_cls`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.base_results_cls)(type) | Returns the results class for the given run type. |
| [`clear_view`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.clear_view)() | Clears the view set by [`use_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.use_view), if any. |
| [`compute_embeddings`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.compute_embeddings)(samples[, model, ...]) | Computes embeddings for the given samples using this backend's model. |
| [`copy`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.copy)() | Returns a deep copy of the object. |
| [`custom_attributes`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. |
| [`from_dict`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.from_dict)(d, samples, config, key) | Builds a `BaseRunResults` from a JSON dict representation of it. |
| [`from_json`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.from_json)(path, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON file. |
| [`from_str`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. |
| [`get_class_name`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.get_class_name)() | Returns the fully-qualified class name string of this object. |
| [`get_meta`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.get_meta)() | Small facts that DESCRIBE these results, stored beside the run so callers can read them without loading the results. |
| [`get_model`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.get_model)() | Returns the stored model for this index. |
| [`reload`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.reload)() | Reloads the index for the current view. |
| [`save`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.save)() | Saves the results to the database. |
| [`save_config`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.save_config)() | Saves these results config to the database. |
| [`serialize`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.serialize)([reflective]) | Serializes the object into a dictionary. |
| [`sort_by_similarity`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.sort_by_similarity)(query[, k, reverse, ...]) | Returns a view that sorts the samples/labels in [`view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.view) by similarity to the specified query. |
| [`to_str`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.to_str)([pretty_print]) | Returns a string representation of this object. |
| [`use_view`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.use_view)(samples[, allow_missing, warn_missing]) | Restricts the index to the provided view. |
| [`values`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.values)(path_or_expr) | Extracts a flat list of values from the given field or expression corresponding to the current [`view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.view). |
| [`write_json`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. |
#### *property* total_index_size
The total number of data points in the index.
If [`use_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.use_view) has been called to restrict the index, this value
may be larger than the current [`index_size()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.index_size).
#### create_index()
#### create_hnsw_index()
Deprecated alias for [`create_index()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.create_index).
#### add_to_index(embeddings, sample_ids, label_ids=None, overwrite=True, allow_existing=True, warn_existing=False, reload=True, batch_size=5000, close_conn=True)
Adds the given embeddings to the index.
* **Parameters:**
* **embeddings** – a `num_embeddings x num_dims` array of embeddings
* **sample_ids** – a `num_embeddings` array of sample IDs
* **label_ids** (*None*) – a `num_embeddings` array of label IDs, if
applicable
* **overwrite** (*True*) – whether to replace (True) or ignore (False)
existing embeddings with the same sample/label IDs
* **allow_existing** (*True*) – whether to ignore (True) or raise an error
(False) when `overwrite` is False and a provided ID already
exists in the
* **warn_existing** (*False*) – whether to log a warning if an embedding is
not added to the index because its ID already exists
* **reload** (*True*) – whether to call [`reload()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.reload) to refresh the
current view after the update
#### remove_from_index(sample_ids=None, label_ids=None, allow_missing=True, warn_missing=False, reload=True)
Removes the specified embeddings from the index.
* **Parameters:**
* **sample_ids** (*None*) – an array of sample IDs
* **label_ids** (*None*) – an array of label IDs, if applicable
* **allow_missing** (*True*) – whether to allow the index to not contain IDs
that you provide (True) or whether to raise an error in this
case (False)
* **warn_missing** (*False*) – whether to log a warning if the index does
not contain IDs that you provide
* **reload** (*True*) – whether to call [`reload()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.reload) to refresh the
current view after the update
#### close_connections()
#### get_embeddings_by_id(sample_ids=None, label_ids=None)
#### get_embeddings(sample_ids=None, label_ids=None, allow_missing=True, warn_missing=False)
Retrieves the embeddings for the given IDs from the index.
If no IDs are provided, the entire index is returned.
* **Parameters:**
* **sample_ids** (*None*) – a sample ID or list of sample IDs for which to
retrieve embeddings
* **label_ids** (*None*) – a label ID or list of label IDs for which to
retrieve embeddings
* **allow_missing** (*True*) – whether to allow the index to not contain IDs
that you provide (True) or whether to raise an error in this
case (False)
* **warn_missing** (*False*) – whether to log a warning if the index does
not contain IDs that you provide
* **Returns:**
- a `num_embeddings x num_dims` array of embeddings
- a `num_embeddings` array of sample IDs
- a `num_embeddings` array of label IDs, if applicable, or else
`None`
* **Return type:**
a tuple of
#### cleanup(drop_table=False)
Clean up the database by dropping the vector index and optionally the embeddings table.
#### attributes()
Returns the list of class attributes that will be serialized by
[`serialize()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.serialize).
* **Returns:**
a list of attributes
#### *property* backend
The `BaseRun` for these results.
#### *static* base_results_cls(type)
Returns the results class for the given run type.
* **Parameters:**
**type** – a `BaseRunConfig.type`
* **Returns:**
a `BaseRunResults` subclass
#### clear_view()
Clears the view set by [`use_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.use_view), if any.
Subsequent operations will be performed on the full index.
#### *property* cls
The fully-qualified name of this `BaseRunResults` class.
#### compute_embeddings(samples, model=None, batch_size=None, num_workers=None, skip_failures=True, skip_existing=False, warn_existing=False, force_square=False, alpha=None, progress=None)
Computes embeddings for the given samples using this backend’s
model.
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **model** (*None*) – a [`fiftyone.core.models.Model`](fiftyone.core.models.md#fiftyone.core.models.Model) to apply. If
not provided, these results must have been created with a
stored model, which will be used by default
* **batch_size** (*None*) – an optional batch size to use when computing
embeddings. Only applicable when a `model` is provided
* **num_workers** (*None*) – the number of workers to use when loading
images. Only applicable when a Torch-based model is being used
to compute embeddings
* **skip_failures** (*True*) – whether to gracefully continue without
raising an error if embeddings cannot be generated for a sample
* **skip_existing** (*False*) – whether to skip generating embeddings for
sample/label IDs that are already in the index
* **warn_existing** (*False*) – whether to log a warning if any IDs already
exist in the index
* **force_square** (*False*) – whether to minimally manipulate the patch
bounding boxes into squares prior to extraction. Only
applicable when a `model` and `patches_field` are specified
* **alpha** (*None*) – an optional expansion/contraction to apply to the
patches before extracting them, in `[-1, inf)`. If provided,
the length and width of the box are expanded (or contracted,
when `alpha < 0`) by `(100 * alpha)%`. For example, set
`alpha = 0.1` to expand the boxes by 10%, and set
`alpha = -0.1` to contract the boxes by 10%. Only applicable
when a `model` and `patches_field` are specified
* **progress** (*None*) – whether to render a progress bar (True/False), use
the default value `fiftyone.config.show_progress_bars`
(None), or a progress callback function to invoke instead
* **Returns:**
- a `num_embeddings x num_dims` array of embeddings
- a `num_embeddings` array of sample IDs
- a `num_embeddings` array of label IDs, if applicable, or else
`None`
* **Return type:**
a tuple of
#### *property* config
The `SimilarityConfig` for these results.
#### copy()
Returns a deep copy of the object.
* **Returns:**
a Serializable instance
#### *property* current_label_ids
The label IDs of the currently active data points in the index, or
`None` if not applicable.
If [`use_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.use_view) has been called, this may be a subset of the full
index.
If the index does not support full label ID lists (ie if
[`label_ids()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.label_ids) is `None`), then this will be all label IDs in
the current [`view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.view) regardless of whether all labels are indexed.
#### *property* current_sample_ids
The sample IDs of the currently active data points in the index.
If [`use_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.use_view) has been called, this may be a subset of the full
index.
If the index does not support full sample ID lists (ie if
[`sample_ids()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.sample_ids) is `None`), then this will be all sample IDs in
the current [`view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.view) regardless of whether all samples are indexed.
#### custom_attributes(dynamic=False, private=False)
Returns a customizable list of class attributes.
By default, all attributes in vars(self) are returned, minus private
attributes (those starting with “_”).
* **Parameters:**
* **dynamic** – whether to include dynamic properties, e.g., those defined
by getter/setter methods or the `@property` decorator. By
default, this is False
* **private** – whether to include private properties, i.e., those
starting with “_”. By default, this is False
* **Returns:**
a list of class attributes
#### *classmethod* from_dict(d, samples, config, key)
Builds a `BaseRunResults` from a JSON dict representation of
it.
* **Parameters:**
* **d** – a JSON dict
* **samples** – the [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
for the run
* **config** – the `BaseRunConfig` for the run
* **key** – the run key
* **Returns:**
a `BaseRunResults`
#### *classmethod* from_json(path, \*args, \*\*kwargs)
Constructs a Serializable object from a JSON file.
Subclasses may override this method, but, by default, this method
simply reads the JSON and calls from_dict(), which subclasses must
implement.
* **Parameters:**
* **path** – the path to the JSON file on disk
* **\*args** – optional positional arguments for `self.from_dict()`
* **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
an instance of the Serializable class
#### *classmethod* from_str(s, \*args, \*\*kwargs)
Constructs a Serializable object from a JSON string.
Subclasses may override this method, but, by default, this method
simply parses the string and calls from_dict(), which subclasses must
implement.
* **Parameters:**
* **s** – a JSON string representation of a Serializable object
* **\*args** – optional positional arguments for `self.from_dict()`
* **\*\*kwargs** – optional keyword arguments for `self.from_dict()`
* **Returns:**
an instance of the Serializable class
#### *classmethod* get_class_name()
Returns the fully-qualified class name string of this object.
#### get_meta()
Small facts that DESCRIBE these results, stored beside the run so
callers can read them without loading the results.
The results themselves are a blob in GridFS whose arrays can run to
hundreds of MB; a count or a path is a few bytes. Anything returned
here is written when the results are saved (see
`BaseRun.save_run_results()`), so no read path has to load — or
write — to answer for it.
* **Returns:**
a JSON-serializable dict
#### get_model()
Returns the stored model for this index.
* **Returns:**
a [`fiftyone.core.models.Model`](fiftyone.core.models.md#fiftyone.core.models.Model)
#### *property* has_view
Whether the index is currently restricted to a view.
Use [`use_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.use_view) to restrict the index to a view, and use
[`clear_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.clear_view) to reset to the full index.
#### *property* index_size
The number of active data points in the index.
If [`use_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.use_view) has been called to restrict the index, this
property will reflect the size of the active index.
#### *property* is_external
Whether this similarity index manages its own embeddings (True) or
loads them directly from the `embeddings_field` of the dataset
(False).
#### *property* key
The run key for these results.
#### *property* label_ids
The label IDs of the full index, or `None` if not applicable or
not supported.
#### *property* missing_size
The total number of data points in [`view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.view) that are missing
from this index, or `None` if unknown.
This property is only applicable when [`use_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.use_view) has been called,
and it will be `None` if no data points are missing or when the
backend does not support it.
#### reload()
Reloads the index for the current view.
Subclasses may override this method, but by default this method simply
passes the current [`view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.view) back into [`use_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.use_view), which
updates the index’s current ID set based on any changes to the view
since the index was last loaded.
#### *property* sample_ids
The sample IDs of the full index, or `None` if not supported.
#### *property* samples
The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) associated
with these results.
#### save()
Saves the results to the database.
#### save_config()
Saves these results config to the database.
#### serialize(reflective=False)
Serializes the object into a dictionary.
Serialization is applied recursively to all attributes in the object,
including element-wise serialization of lists and dictionary values.
* **Parameters:**
**reflective** – whether to include reflective attributes when
serializing the object. By default, this is False
* **Returns:**
a JSON dictionary representation of the object
#### sort_by_similarity(query, k=None, reverse=False, aggregation='mean', dist_field=None, \_mongo=False)
Returns a view that sorts the samples/labels in [`view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.view) by
similarity to the specified query.
When querying by IDs, the query can be any ID(s) in the full index of
this instance, even if the current [`view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.view) contains a subset of
the full index.
* **Parameters:**
* **query** –
the query, which can be any of the following:
- an ID or iterable of IDs
- a `num_dims` vector or `num_queries x num_dims` array
of vectors
- a prompt or iterable of prompts (if supported by the index)
* **k** (*None*) – the number of matches to return. Some backends may
support `None`, in which case all samples will be sorted
* **reverse** (*False*) – whether to sort by least similarity (True) or
greatest similarity (False). Some backends may not support
least similarity
* **aggregation** ( *"mean"*) – the aggregation method to use when multiple
queries are provided. The default is `"mean"`, which means
that the query vectors are averaged prior to searching. Some
backends may support additional options
* **dist_field** (*None*) – the name of a float field in which to store the
distance of each example to the specified query. The field is
created if necessary
* **Returns:**
a [`fiftyone.core.view.DatasetView`](fiftyone.core.view.md#fiftyone.core.view.DatasetView)
#### *property* supports_prompts
Whether this similarity index supports prompt queries.
#### to_str(pretty_print=True, \*\*kwargs)
Returns a string representation of this object.
* **Parameters:**
* **pretty_print** – whether to render the JSON in human readable format
with newlines and indentations. By default, this is True
* **\*\*kwargs** – optional keyword arguments for `self.serialize()`
* **Returns:**
a string representation of the object
#### use_view(samples, allow_missing=True, warn_missing=False)
Restricts the index to the provided view.
Subsequent calls to methods on this instance will only contain results
from the specified view rather than the full index.
Use [`clear_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.clear_view) to reset to the full index. Or, equivalently,
use the context manager interface as demonstrated below to
automatically reset the view when the context exits.
Example usage:
```default
import fiftyone as fo
import fiftyone.brain as fob
import fiftyone.zoo as foz
dataset = foz.load_zoo_dataset("quickstart")
results = fob.compute_similarity(dataset)
print(results.index_size) # 200
view = dataset.take(50)
with results.use_view(view):
print(results.index_size) # 50
results.find_unique(10)
print(results.unique_ids)
plot = results.visualize_unique()
plot.show()
```
* **Parameters:**
* **samples** – a [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection)
* **allow_missing** (*True*) – whether to allow the provided collection to
contain data points that this index does not contain (True) or
whether to raise an error in this case (False)
* **warn_missing** (*False*) – whether to log a warning if the provided
collection contains data points that this index does not
contain
* **Returns:**
self
#### values(path_or_expr)
Extracts a flat list of values from the given field or expression
corresponding to the current [`view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.view).
This method always returns values in the same order as
[`current_sample_ids()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.current_sample_ids) and [`current_label_ids()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.current_label_ids).
* **Parameters:**
**path_or_expr** –
the values to extract, which can be:
- the name of a sample field or `embedded.field.name` from
which to extract numeric or string values
- a [`fiftyone.core.expressions.ViewExpression`](fiftyone.core.expressions.md#fiftyone.core.expressions.ViewExpression)
defining numeric or string values to compute via
[`fiftyone.core.collections.SampleCollection.values()`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection.values)
* **Returns:**
a list of values
#### *property* view
The [`fiftyone.core.collections.SampleCollection`](fiftyone.core.collections.md#fiftyone.core.collections.SampleCollection) against
which results are currently being generated.
If [`use_view()`](#fiftyone.brain.internal.core.pgvector.PgVectorSimilarityIndex.use_view) has been called, this view may be different than
the collection on which the full index was generated.
#### write_json(path, pretty_print=False, \*\*kwargs)
Serializes the object and writes it to disk.
* **Parameters:**
* **path** – the output path
* **pretty_print** – whether to render the JSON in human readable format
with newlines and indentations. By default, this is False
* **\*\*kwargs** – optional keyword arguments for `self.serialize()`