Ctrl+K

Vector Store

Vector Store#

The Dataherald Engine uses a Vector store for retrieving similar few shot examples from previous Natural Language to SQL pairs that have been marked as correct. Currently Pinecone, AstraDB, and ChromaDB are the supported vector stores, though developers can easily add support for other vector stores by implementing the abstract VectorStore class.

Abstract Vector Store Class#

AstraDB, ChromaDB and Pinecone are implemented as subclasses of the abstract VectorStore class. This abstract class provides a unified interface for working with different vector store implementations.

VectorStore#

This abstract class defines the common methods that AstraDB, ChromaDB, and Pinecone vector stores should implement.

__init__(self, system: System)

Initializes the vector store instance.

Parameters:

system (System) – The system object.

query(self, query_texts: List[str], db_connection_id: str, collection: str, num_results: int) → list

Executes a query to retrieve similar vectors from the vector store.

Parameters:

  • query_texts (List[str]) – A list of query texts.

  • db_connection_id (str) – The db connection id.

  • collection (str) – The name of the collection.

  • num_results (int) – The number of results to retrieve.

Returns:

A list of retrieved vectors.

Return type:

list

create_collection(self, collection: str)

Creates a new collection within the vector store.

Parameters:

collection (str) – The name of the new collection.

add_record(self, documents: str, collection: str, metadata: Any, ids: List = None)

Adds vectors along with metadata to a specified collection.

Parameters:

  • documents (str) – The vector documents.

  • collection (str) – The name of the collection to which vectors are added.

  • metadata (Any) – Metadata associated with the vectors.

  • ids (List, optional) – (Optional) A list of identifiers for the records.

delete_record(self, collection: str, id: str)

Deletes a vector record from a collection.

Parameters:

  • collection (str) – The name of the collection.

  • id (str) – The identifier of the record to delete.

delete_collection(self, collection: str)

Deletes a collection from the vector store.

Parameters:

collection (str) – The name of the collection to delete.

By utilizing the VectorStore abstract class, you can seamlessly switch between different vector store implementations while maintaining consistent interaction with the underlying systems.

For detailed implementation guidelines and further assistance, consult our official documentation or reach out to our dedicated support team.

Contents