semantic_router.index.qdrant

QdrantIndex Objects

class QdrantIndex(BaseIndex)

The name of the collection to use

add

def add(embeddings: List[List[float]],
        routes: List[str],
        utterances: List[str],
        function_schemas: Optional[List[Dict[str, Any]]] = None,
        metadata_list: List[Dict[str, Any]] = [],
        batch_size: int = DEFAULT_UPLOAD_BATCH_SIZE,
        **kwargs)

Add records to the index.

Arguments:

• embeddings (List[List[float]]): The embeddings to add.
• routes (List[str]): The routes to add.
• utterances (List[str]): The utterances to add.
• function_schemas (Optional[List[Dict[str, Any]]]): The function schemas to add.
• metadata_list (List[Dict[str, Any]]): The metadata to add.
• List[List[float]]0 (List[List[float]]1): The batch size to use for the upload.

get_utterances

def get_utterances(include_metadata: bool = False) -> List[Utterance]

Gets a list of route and utterance objects currently stored in the index.

Arguments:

• include_metadata (bool): Whether to include metadata in the returned Utterance objects.

Returns:

List[Utterance]: A list of Utterance objects.

delete

def delete(route_name: str)

Delete records from the index.

Arguments:

• route_name (str): The name of the route to delete.

describe

def describe() -> IndexConfig

Describe the index.

Returns:

IndexConfig: The index configuration.

is_ready

def is_ready() -> bool

Checks if the index is ready to be used.

Returns:

bool: True if the index is ready, False otherwise.

query

def query(
    vector: np.ndarray,
    top_k: int = 5,
    route_filter: Optional[List[str]] = None,
    sparse_vector: dict[int, float] | SparseEmbedding | None = None
) -> Tuple[np.ndarray, List[str]]

Query the index.

Arguments:

• vector (np.ndarray): The vector to query.
• top_k (int): The number of results to return.
• route_filter (Optional[List[str]]): The route filter to apply.
• sparse_vector (dict[int, float] | SparseEmbedding | None): The sparse vector to query.

Returns:

Tuple[np.ndarray, List[str]]: A tuple of the scores and route names.

aquery

async def aquery(
    vector: np.ndarray,
    top_k: int = 5,
    route_filter: Optional[List[str]] = None,
    sparse_vector: dict[int, float] | SparseEmbedding | None = None
) -> Tuple[np.ndarray, List[str]]

Asynchronously query the index.

Arguments:

• vector (np.ndarray): The vector to query.
• top_k (int): The number of results to return.
• route_filter (Optional[List[str]]): The route filter to apply.
• sparse_vector (dict[int, float] | SparseEmbedding | None): The sparse vector to query.

Returns:

Tuple[np.ndarray, List[str]]: A tuple of the scores and route names.

get_routes_tuples

def get_routes_tuples() -> list[tuple]

Synchronously get route and utterance objects as tuples.

Returns:

list[tuple]: A list of (route_name, utterance, function_schemas, metadata) tuples.

aget_routes

async def aget_routes() -> list[tuple]

Asynchronously get a list of route and utterance objects currently

stored in the index.

Returns:

list[tuple]: A list of (route_name, utterance, function_schemas, metadata) tuples.

delete_index

def delete_index()

Delete the index.

Returns:

None: None

convert_metric

def convert_metric(metric: Metric)

Convert the metric to a Qdrant distance metric.

Arguments:

• metric (Metric): The metric to convert.

Returns:

Distance: The converted metric.

__len__

def __len__()

Returns the total number of vectors in the index. If the index is not initialized

returns 0.

Returns:

int: The total number of vectors.

adelete

async def adelete(route_name: str) -> list[str]

Asynchronously delete records from the index by route name.

Arguments:

• route_name (str): The name of the route to delete.

Returns:

list[str]: List of IDs of the vectors deleted (empty list, as Qdrant does not return IDs).

adelete_index

async def adelete_index()

Asynchronously delete the index (collection) from Qdrant.

Returns:

None: None

ais_ready

async def ais_ready() -> bool

Checks if the index is ready to be used asynchronously.

aadd

async def aadd(embeddings: List[List[float]],
               routes: List[str],
               utterances: List[str],
               function_schemas: Optional[List[Dict[str, Any]]] = None,
               metadata_list: List[Dict[str, Any]] = [],
               batch_size: int = DEFAULT_UPLOAD_BATCH_SIZE,
               **kwargs)

Asynchronously add records to the index, including metadata in the payload.

aget_utterances

async def aget_utterances(include_metadata: bool = False) -> List[Utterance]

Asynchronously gets a list of route and utterance objects currently stored in the index.

Arguments:

• include_metadata (bool): Whether to include metadata in the returned Utterance objects.

Returns:

List[Utterance]: A list of Utterance objects.