Camel.storages.vectordb storages.base

​

VectorRecord

class VectorRecord(BaseModel):

• vector (List[float]): The numerical representation of the vector.
• id (str, optional): A unique identifier for the vector. If not provided, an random uuid will be assigned.
• payload (Optional[Dict[str, Any]], optional): Any additional metadata or information related to the vector. (default: :obj:None)

​

VectorDBQuery

class VectorDBQuery(BaseModel):

• query_vector (List[float]): The numerical representation of the query vector.
• top_k (int, optional): The number of top similar vectors to retrieve from the database. (default: :obj:1)

​

init

def __init__(
    self,
    query_vector: List[float],
    top_k: int,
    **kwargs: Any
):

• query_vector (List[float]): The numerical representation of the query vector.
• top_k (int, optional): The number of top similar vectors to retrieve from the database. (default: :obj:1)

​

VectorDBQueryResult

class VectorDBQueryResult(BaseModel):

• record (VectorRecord): The target vector record.
• similarity (float): The similarity score between the query vector and the record.

​

create

def create(
    cls,
    similarity: float,
    vector: List[float],
    id: str,
    payload: Optional[Dict[str, Any]] = None
):

​

VectorDBStatus

class VectorDBStatus(BaseModel):

• vector_dim (int): The dimension of stored vectors.
• vector_count (int): The number of stored vectors.

​

BaseVectorStorage

class BaseVectorStorage(ABC):

​

add

def add(self, records: List[VectorRecord], **kwargs: Any):

• records (List[VectorRecord]): List of vector records to be saved. **kwargs (Any): Additional keyword arguments.

​

delete

def delete(self, ids: List[str], **kwargs: Any):

• ids (List[str]): List of unique identifiers for the vectors to be deleted. **kwargs (Any): Additional keyword arguments.

​

status

def status(self):

​

query

def query(self, query: VectorDBQuery, **kwargs: Any):

• query (VectorDBQuery): The query object containing the search vector and the number of top similar vectors to retrieve. **kwargs (Any): Additional keyword arguments.

​

clear

def clear(self):

​

load

def load(self):

​

client

def client(self):

​

get_payloads_by_vector

def get_payloads_by_vector(self, vector: List[float], top_k: int):

• vector (List[float]): The search vector.
• top_k (int): The number of top similar vectors.