fix: include_metadata logic

semantic_router/index/base.py

@@ -86,7 +86,7 @@ class BaseIndex(BaseModel):
         if self.index is None:
             logger.warning("Index is None, could not retrieve utterances.")
             return []
-        _, metadata = self._get_all(include_metadata=True)
+        _, metadata = self._get_all(include_metadata=True)  # include_metadata required
         route_tuples = parse_route_info(metadata=metadata)
         if not include_metadata:
             # we remove the metadata from the tuples (ie only keep 0, 1 items)

semantic_router/index/hybrid_local.py

@@ -61,13 +61,12 @@ class HybridLocalIndex(LocalIndex):
         """Gets a list of route and utterance objects currently stored in the index.
 
         :param include_metadata: Whether to include function schemas and metadata in
-        the returned Utterance objects - HybridLocalIndex only supports False.
+        the returned Utterance objects - HybridLocalIndex doesn't include metadata so
+        this parameter is ignored.
         :type include_metadata: bool
         :return: A list of Utterance objects.
         :rtype: List[Utterance]
         """
-        if include_metadata:
-            raise ValueError("include_metadata is not supported for HybridLocalIndex.")
         if self.routes is None or self.utterances is None:
             return []
         return [Utterance.from_tuple(x) for x in zip(self.routes, self.utterances)]

semantic_router/index/local.py

@@ -68,13 +68,11 @@ class LocalIndex(BaseIndex):
         """Gets a list of route and utterance objects currently stored in the index.
 
         :param include_metadata: Whether to include function schemas and metadata in
-        the returned Utterance objects - HybridLocalIndex only supports False.
-        :type include_metadata: bool
+        the returned Utterance objects - LocalIndex doesn't include metadata so this
+        parameter is ignored.
         :return: A list of Utterance objects.
         :rtype: List[Utterance]
         """
-        if include_metadata:
-            raise ValueError("include_metadata is not supported for HybridLocalIndex.")
         if self.routes is None or self.utterances is None:
             return []
         return [Utterance.from_tuple(x) for x in zip(self.routes, self.utterances)]

semantic_router/index/qdrant.py

@@ -192,17 +192,13 @@ class QdrantIndex(BaseIndex):
         """Gets a list of route and utterance objects currently stored in the index.
 
         :param include_metadata: Whether to include function schemas and metadata in
-        the returned Utterance objects - QdrantIndex only supports False.
+        the returned Utterance objects - QdrantIndex does not currently support this
+        parameter so it is ignored. If required for your use-case please reach out to
+        semantic-router maintainers on GitHub via an issue or PR.
         :type include_metadata: bool
         :return: A list of Utterance objects.
         :rtype: List[Utterance]
         """
-        if include_metadata:
-            raise NotImplementedError(
-                "include_metadata is not supported for QdrantIndex. If required please "
-                "reach out to maintainers on GitHub via an issue or PR."
-            )
-
         # Check if collection exists first
         if not self.client.collection_exists(self.index_name):
             return []