- class VectorDBResourceService[source]
Bases:
abc.ABCAbstract base class for a Vector Database Resource Service.
Methods
count(**kwargs)Returns number of rows/entities in the given resource. delete(expr, **kwargs)Delete data in the vector database. delete_by_keys(keys, **kwargs)Delete vectors by keys from the resource. describe(**kwargs)Provide a description of the vector database. insert(data, **kwargs)Insert data into the vector database. insert_dataframe(df, **kwargs)Insert a dataframe into the vector database. retrieve_by_keys(keys, **kwargs)Retrieve the inserted vectors using keys from the resource. similarity_search(embeddings[, k])Perform a similarity search within the vector database. update(data, **kwargs)Update data in the vector database. - abstract count(**kwargs)[source]
Returns number of rows/entities in the given resource.
- Parameters
- **kwargs
Extra keyword arguments specific to the vector database implementation.
- Returns
- int
Returns number of rows/entities in the given resource.
- abstract delete(expr, **kwargs)[source]
Delete data in the vector database.
- Parameters
- expr
- **kwargs
Delete expression.
Extra keyword arguments specific to the vector database implementation.
- Returns
- dict[str, typing.Any]
Returns result of the delete operation stats.
- abstract delete_by_keys(keys, **kwargs)[source]
Delete vectors by keys from the resource.
- Parameters
- keys
- **kwargs
Primary keys to delete vectors.
Extra keyword arguments specific to the vector database implementation.
- Returns
- typing.Any
Returns vectors of the given keys that are delete from the resource.
- abstract describe(**kwargs)[source]
Provide a description of the vector database.
- Parameters
- **kwargs
Extra keyword arguments specific to the vector database implementation.
- Returns
- dict
Returns response content as a dictionary.
- abstract insert(data, **kwargs)[source]
Insert data into the vector database.
- Parameters
- data
- **kwargs
Data to be inserted into the resource.
Extra keyword arguments specific to the vector database implementation.
- Returns
- dict
Returns response content as a dictionary.
- abstract insert_dataframe(df, **kwargs)[source]
Insert a dataframe into the vector database.
- Parameters
- df
- **kwargs
Dataframe to be inserted into the resource.
Extra keyword arguments specific to the vector database implementation.
- Returns
- dict
Returns response content as a dictionary.
- abstract retrieve_by_keys(keys, **kwargs)[source]
Retrieve the inserted vectors using keys from the resource.
- Parameters
- keys
- **kwargs
Primary keys to get vectors.
Extra keyword arguments specific to the vector database implementation.
- Returns
- list[typing.Any]
Returns rows of the given keys that exists in the resource.
- abstract async similarity_search(embeddings, k=4, **kwargs)[source]
Perform a similarity search within the vector database.
- Parameters
- embeddings
- k
- **kwargs
Embeddings for which to perform the similarity search.
The number of nearest neighbors to return, by default 4.
Extra keyword arguments specific to the vector database implementation.
- Returns
- list[list[dict]]
Returns a list of lists, where each inner list contains dictionaries representing the results of the similarity search.
- abstract update(data, **kwargs)[source]
Update data in the vector database.
- Parameters
- data
- **kwargs
Data to be updated in the resource.
Extra keyword arguments specific to the vector database implementation.
- Returns
- dict[str, typing.Any]
Returns result of the updated operation stats.
morpheus.service.vdb.vector_db_service.VectorDBResourceService
Previous
morpheus.service.vdb.vector_db_service
Next
morpheus.service.vdb.vector_db_service.VectorDBService