semantic_router.index.local

​

LocalIndex Objects

class LocalIndex(BaseIndex)

​

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]] = [],
        **kwargs)

• embeddings (List[List[float]]): List of embeddings to add to the index.
• routes (List[str]): List of routes to add to the index.
• utterances (List[str]): List of utterances to add to the index.
• function_schemas (Optional[List[Dict[str, Any]]]): List of function schemas to add to the index.
• metadata_list (List[Dict[str, Any]]): List of metadata to add to the index.

​

get_utterances

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

• include_metadata: Whether to include function schemas and metadata in the returned Utterance objects - LocalIndex now includes metadata if present.

​

describe

def describe() -> IndexConfig

​

is_ready

def is_ready() -> bool

​

ais_ready

async def ais_ready() -> bool

​

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]]

• vector (np.ndarray): The vector to search for.
• top_k (int): The number of results to return.
• route_filter (Optional[List[str]]): The routes to filter the search by.
• sparse_vector (dict[int, float] | SparseEmbedding | None): The sparse vector to search for.

​

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]]

• vector (np.ndarray): The vector to search for.
• top_k (int): The number of results to return.
• route_filter (Optional[List[str]]): The routes to filter the search by.
• sparse_vector (dict[int, float] | SparseEmbedding | None): The sparse vector to search for.

​

aget_routes

async def aget_routes()

​

delete

def delete(route_name: str)

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

​

adelete

async def adelete(route_name: str)

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

​

delete_index

def delete_index()

​

adelete_index

async def adelete_index()