lfx-nightly 0.2.0.dev25__py3-none-any.whl

lfx/components/datastax/astradb_graph.py

@@ -0,0 +1,217 @@
+import orjson
+
+from lfx.base.datastax.astradb_base import AstraDBBaseComponent
+from lfx.base.vectorstores.model import LCVectorStoreComponent, check_cached_vector_store
+from lfx.helpers.data import docs_to_data
+from lfx.inputs.inputs import (
+    DictInput,
+    DropdownInput,
+    FloatInput,
+    IntInput,
+    StrInput,
+)
+from lfx.schema.data import Data
+
+
+class AstraDBGraphVectorStoreComponent(AstraDBBaseComponent, LCVectorStoreComponent):
+    display_name: str = "Astra DB Graph"
+    description: str = "Implementation of Graph Vector Store using Astra DB"
+    name = "AstraDBGraph"
+    documentation: str = "https://docs.langflow.org/bundles-datastax"
+    icon: str = "AstraDB"
+    legacy: bool = True
+    replacement = ["datastax.GraphRAG"]
+
+    inputs = [
+        *AstraDBBaseComponent.inputs,
+        *LCVectorStoreComponent.inputs,
+        StrInput(
+            name="metadata_incoming_links_key",
+            display_name="Metadata incoming links key",
+            info="Metadata key used for incoming links.",
+            advanced=True,
+        ),
+        IntInput(
+            name="number_of_results",
+            display_name="Number of Results",
+            info="Number of results to return.",
+            advanced=True,
+            value=4,
+        ),
+        DropdownInput(
+            name="search_type",
+            display_name="Search Type",
+            info="Search type to use",
+            options=[
+                "Similarity",
+                "Similarity with score threshold",
+                "MMR (Max Marginal Relevance)",
+                "Graph Traversal",
+                "MMR (Max Marginal Relevance) Graph Traversal",
+            ],
+            value="MMR (Max Marginal Relevance) Graph Traversal",
+            advanced=True,
+        ),
+        FloatInput(
+            name="search_score_threshold",
+            display_name="Search Score Threshold",
+            info="Minimum similarity score threshold for search results. "
+            "(when using 'Similarity with score threshold')",
+            value=0,
+            advanced=True,
+        ),
+        DictInput(
+            name="search_filter",
+            display_name="Search Metadata Filter",
+            info="Optional dictionary of filters to apply to the search query.",
+            advanced=True,
+            is_list=True,
+        ),
+    ]
+
+    @check_cached_vector_store
+    def build_vector_store(self):
+        try:
+            from langchain_astradb import AstraDBGraphVectorStore
+            from langchain_astradb.utils.astradb import SetupMode
+        except ImportError as e:
+            msg = (
+                "Could not import langchain Astra DB integration package. "
+                "Please install it with `pip install langchain-astradb`."
+            )
+            raise ImportError(msg) from e
+
+        try:
+            if not self.setup_mode:
+                self.setup_mode = self._inputs["setup_mode"].options[0]
+
+            setup_mode_value = SetupMode[self.setup_mode.upper()]
+        except KeyError as e:
+            msg = f"Invalid setup mode: {self.setup_mode}"
+            raise ValueError(msg) from e
+
+        try:
+            self.log(f"Initializing Graph Vector Store {self.collection_name}")
+
+            vector_store = AstraDBGraphVectorStore(
+                embedding=self.embedding_model,
+                collection_name=self.collection_name,
+                metadata_incoming_links_key=self.metadata_incoming_links_key or "incoming_links",
+                token=self.token,
+                api_endpoint=self.get_api_endpoint(),
+                namespace=self.get_keyspace(),
+                environment=self.environment,
+                metric=self.metric or None,
+                batch_size=self.batch_size or None,
+                bulk_insert_batch_concurrency=self.bulk_insert_batch_concurrency or None,
+                bulk_insert_overwrite_concurrency=self.bulk_insert_overwrite_concurrency or None,
+                bulk_delete_concurrency=self.bulk_delete_concurrency or None,
+                setup_mode=setup_mode_value,
+                pre_delete_collection=self.pre_delete_collection,
+                metadata_indexing_include=[s for s in self.metadata_indexing_include if s] or None,
+                metadata_indexing_exclude=[s for s in self.metadata_indexing_exclude if s] or None,
+                collection_indexing_policy=orjson.loads(self.collection_indexing_policy.encode("utf-8"))
+                if self.collection_indexing_policy
+                else None,
+            )
+        except Exception as e:
+            msg = f"Error initializing AstraDBGraphVectorStore: {e}"
+            raise ValueError(msg) from e
+
+        self.log(f"Vector Store initialized: {vector_store.astra_env.collection_name}")
+        self._add_documents_to_vector_store(vector_store)
+
+        return vector_store
+
+    def _add_documents_to_vector_store(self, vector_store) -> None:
+        self.ingest_data = self._prepare_ingest_data()
+
+        documents = []
+        for _input in self.ingest_data or []:
+            if isinstance(_input, Data):
+                documents.append(_input.to_lc_document())
+            else:
+                msg = "Vector Store Inputs must be Data objects."
+                raise TypeError(msg)
+
+        if documents:
+            self.log(f"Adding {len(documents)} documents to the Vector Store.")
+            try:
+                vector_store.add_documents(documents)
+            except Exception as e:
+                msg = f"Error adding documents to AstraDBGraphVectorStore: {e}"
+                raise ValueError(msg) from e
+        else:
+            self.log("No documents to add to the Vector Store.")
+
+    def _map_search_type(self) -> str:
+        match self.search_type:
+            case "Similarity":
+                return "similarity"
+            case "Similarity with score threshold":
+                return "similarity_score_threshold"
+            case "MMR (Max Marginal Relevance)":
+                return "mmr"
+            case "Graph Traversal":
+                return "traversal"
+            case "MMR (Max Marginal Relevance) Graph Traversal":
+                return "mmr_traversal"
+            case _:
+                return "similarity"
+
+    def _build_search_args(self):
+        args = {
+            "k": self.number_of_results,
+            "score_threshold": self.search_score_threshold,
+        }
+
+        if self.search_filter:
+            clean_filter = {k: v for k, v in self.search_filter.items() if k and v}
+            if len(clean_filter) > 0:
+                args["filter"] = clean_filter
+        return args
+
+    def search_documents(self, vector_store=None) -> list[Data]:
+        if not vector_store:
+            vector_store = self.build_vector_store()
+
+        self.log("Searching for documents in AstraDBGraphVectorStore.")
+        self.log(f"Search query: {self.search_query}")
+        self.log(f"Search type: {self.search_type}")
+        self.log(f"Number of results: {self.number_of_results}")
+
+        if self.search_query and isinstance(self.search_query, str) and self.search_query.strip():
+            try:
+                search_type = self._map_search_type()
+                search_args = self._build_search_args()
+
+                docs = vector_store.search(query=self.search_query, search_type=search_type, **search_args)
+
+                # Drop links from the metadata. At this point the links don't add any value for building the
+                # context and haven't been restored to json which causes the conversion to fail.
+                self.log("Removing links from metadata.")
+                for doc in docs:
+                    if "links" in doc.metadata:
+                        doc.metadata.pop("links")
+
+            except Exception as e:
+                msg = f"Error performing search in AstraDBGraphVectorStore: {e}"
+                raise ValueError(msg) from e
+
+            self.log(f"Retrieved documents: {len(docs)}")
+
+            data = docs_to_data(docs)
+
+            self.log(f"Converted documents to data: {len(data)}")
+
+            self.status = data
+            return data
+        self.log("No search input provided. Skipping search.")
+        return []
+
+    def get_retriever_kwargs(self):
+        search_args = self._build_search_args()
+        return {
+            "search_type": self._map_search_type(),
+            "search_kwargs": search_args,
+        }

lfx/components/datastax/astradb_tool.py

@@ -0,0 +1,378 @@
+from datetime import datetime, timezone
+from typing import Any
+
+from astrapy import Collection, DataAPIClient, Database
+from langchain_core.tools import StructuredTool, Tool
+from pydantic import BaseModel, Field, create_model
+
+from lfx.base.datastax.astradb_base import AstraDBBaseComponent
+from lfx.base.langchain_utilities.model import LCToolComponent
+from lfx.io import BoolInput, DictInput, IntInput, StrInput, TableInput
+from lfx.log.logger import logger
+from lfx.schema.data import Data
+from lfx.schema.table import EditMode
+
+
+class AstraDBToolComponent(AstraDBBaseComponent, LCToolComponent):
+    display_name: str = "Astra DB Tool"
+    description: str = "Tool to run hybrid vector and metadata search on DataStax Astra DB Collection"
+    documentation: str = "https://docs.langflow.org/bundles-datastax"
+    icon: str = "AstraDB"
+    legacy: bool = True
+    name = "AstraDBTool"
+    replacement = ["datastax.AstraDB"]
+
+    inputs = [
+        *AstraDBBaseComponent.inputs,
+        StrInput(
+            name="tool_name",
+            display_name="Tool Name",
+            info="The name of the tool to be passed to the LLM.",
+            required=True,
+        ),
+        StrInput(
+            name="tool_description",
+            display_name="Tool Description",
+            info="Describe the tool to LLM. Add any information that can help the LLM to use the tool.",
+            required=True,
+        ),
+        StrInput(
+            name="projection_attributes",
+            display_name="Projection Attributes",
+            info="Attributes to be returned by the tool separated by comma.",
+            required=True,
+            value="*",
+            advanced=True,
+        ),
+        TableInput(
+            name="tools_params_v2",
+            display_name="Tools Parameters",
+            info="Define the structure for the tool parameters. Describe the parameters "
+            "in a way the LLM can understand how to use them.",
+            required=False,
+            table_schema=[
+                {
+                    "name": "name",
+                    "display_name": "Name",
+                    "type": "str",
+                    "description": "Specify the name of the output field/parameter for the model.",
+                    "default": "field",
+                    "edit_mode": EditMode.INLINE,
+                },
+                {
+                    "name": "attribute_name",
+                    "display_name": "Attribute Name",
+                    "type": "str",
+                    "description": "Specify the attribute name to be filtered on the collection. "
+                    "Leave empty if the attribute name is the same as the name of the field.",
+                    "default": "",
+                    "edit_mode": EditMode.INLINE,
+                },
+                {
+                    "name": "description",
+                    "display_name": "Description",
+                    "type": "str",
+                    "description": "Describe the purpose of the output field.",
+                    "default": "description of field",
+                    "edit_mode": EditMode.POPOVER,
+                },
+                {
+                    "name": "metadata",
+                    "display_name": "Is Metadata",
+                    "type": "boolean",
+                    "edit_mode": EditMode.INLINE,
+                    "description": ("Indicate if the field is included in the metadata field."),
+                    "options": ["True", "False"],
+                    "default": "False",
+                },
+                {
+                    "name": "mandatory",
+                    "display_name": "Is Mandatory",
+                    "type": "boolean",
+                    "edit_mode": EditMode.INLINE,
+                    "description": ("Indicate if the field is mandatory."),
+                    "options": ["True", "False"],
+                    "default": "False",
+                },
+                {
+                    "name": "is_timestamp",
+                    "display_name": "Is Timestamp",
+                    "type": "boolean",
+                    "edit_mode": EditMode.INLINE,
+                    "description": ("Indicate if the field is a timestamp."),
+                    "options": ["True", "False"],
+                    "default": "False",
+                },
+                {
+                    "name": "operator",
+                    "display_name": "Operator",
+                    "type": "str",
+                    "description": "Set the operator for the field. "
+                    "https://docs.datastax.com/en/astra-db-serverless/api-reference/documents.html#operators",
+                    "default": "$eq",
+                    "options": ["$gt", "$gte", "$lt", "$lte", "$eq", "$ne", "$in", "$nin", "$exists", "$all", "$size"],
+                    "edit_mode": EditMode.INLINE,
+                },
+            ],
+            value=[],
+        ),
+        DictInput(
+            name="tool_params",
+            info="DEPRECATED: Attributes to filter and description to the model. "
+            "Add ! for mandatory (e.g: !customerId)",
+            display_name="Tool params",
+            is_list=True,
+            advanced=True,
+        ),
+        DictInput(
+            name="static_filters",
+            info="Attributes to filter and correspoding value",
+            display_name="Static filters",
+            advanced=True,
+            is_list=True,
+        ),
+        IntInput(
+            name="number_of_results",
+            display_name="Number of Results",
+            info="Number of results to return.",
+            advanced=True,
+            value=5,
+        ),
+        BoolInput(
+            name="use_search_query",
+            display_name="Semantic Search",
+            info="When this parameter is activated, the search query parameter will be used to search the collection.",
+            advanced=False,
+            value=False,
+        ),
+        BoolInput(
+            name="use_vectorize",
+            display_name="Use Astra DB Vectorize",
+            info="When this parameter is activated, Astra DB Vectorize method will be used to generate the embeddings.",
+            advanced=False,
+            value=False,
+        ),
+        StrInput(
+            name="semantic_search_instruction",
+            display_name="Semantic Search Instruction",
+            info="The instruction to use for the semantic search.",
+            required=True,
+            value="Search query to find relevant documents.",
+            advanced=True,
+        ),
+    ]
+
+    _cached_client: DataAPIClient | None = None
+    _cached_db: Database | None = None
+    _cached_collection: Collection | None = None
+
+    def create_args_schema(self) -> dict[str, BaseModel]:
+        """DEPRECATED: This method is deprecated. Please use create_args_schema_v2 instead.
+
+        It is keep only for backward compatibility.
+        """
+        logger.warning("This is the old way to define the tool parameters. Please use the new way.")
+        args: dict[str, tuple[Any, Field] | list[str]] = {}
+
+        for key in self.tool_params:
+            if key.startswith("!"):  # Mandatory
+                args[key[1:]] = (str, Field(description=self.tool_params[key]))
+            else:  # Optional
+                args[key] = (str | None, Field(description=self.tool_params[key], default=None))
+
+        if self.use_search_query:
+            args["search_query"] = (
+                str | None,
+                Field(description="Search query to find relevant documents.", default=None),
+            )
+
+        model = create_model("ToolInput", **args, __base__=BaseModel)
+        return {"ToolInput": model}
+
+    def create_args_schema_v2(self) -> dict[str, BaseModel]:
+        """Create the tool input schema using the new tool parameters configuration."""
+        args: dict[str, tuple[Any, Field] | list[str]] = {}
+
+        for tool_param in self.tools_params_v2:
+            if tool_param["mandatory"]:
+                args[tool_param["name"]] = (str, Field(description=tool_param["description"]))
+            else:
+                args[tool_param["name"]] = (str | None, Field(description=tool_param["description"], default=None))
+
+        if self.use_search_query:
+            args["search_query"] = (
+                str,
+                Field(description=self.semantic_search_instruction),
+            )
+
+        model = create_model("ToolInput", **args, __base__=BaseModel)
+        return {"ToolInput": model}
+
+    def build_tool(self) -> Tool:
+        """Builds an Astra DB Collection tool.
+
+        Returns:
+            Tool: The built Astra DB tool.
+        """
+        schema_dict = self.create_args_schema() if len(self.tool_params.keys()) > 0 else self.create_args_schema_v2()
+
+        tool = StructuredTool.from_function(
+            name=self.tool_name,
+            args_schema=schema_dict["ToolInput"],
+            description=self.tool_description,
+            func=self.run_model,
+            return_direct=False,
+        )
+        self.status = "Astra DB Tool created"
+
+        return tool
+
+    def projection_args(self, input_str: str) -> dict | None:
+        """Build the projection arguments for the Astra DB query."""
+        elements = input_str.split(",")
+        result = {}
+
+        if elements == ["*"]:
+            return None
+
+        # Force the projection to exclude the $vector field as it is not required by the tool
+        result["$vector"] = False
+
+        # Fields with ! as prefix should be removed from the projection
+        for element in elements:
+            if element.startswith("!"):
+                result[element[1:]] = False
+            else:
+                result[element] = True
+
+        return result
+
+    def parse_timestamp(self, timestamp_str: str) -> datetime:
+        """Parse a timestamp string into Astra DB REST API format.
+
+        Args:
+            timestamp_str (str): Input timestamp string
+
+        Returns:
+            datetime: Datetime object
+
+        Raises:
+            ValueError: If the timestamp cannot be parsed
+        """
+        # Common datetime formats to try
+        formats = [
+            "%Y-%m-%d",  # 2024-03-21
+            "%Y-%m-%dT%H:%M:%S",  # 2024-03-21T15:30:00
+            "%Y-%m-%dT%H:%M:%S%z",  # 2024-03-21T15:30:00+0000
+            "%Y-%m-%d %H:%M:%S",  # 2024-03-21 15:30:00
+            "%d/%m/%Y",  # 21/03/2024
+            "%Y/%m/%d",  # 2024/03/21
+        ]
+
+        for fmt in formats:
+            try:
+                # Parse the date string
+                date_obj = datetime.strptime(timestamp_str, fmt).astimezone()
+
+                # If the parsed date has no timezone info, assume UTC
+                if date_obj.tzinfo is None:
+                    date_obj = date_obj.replace(tzinfo=timezone.utc)
+
+                # Convert to UTC and format
+                return date_obj.astimezone(timezone.utc)
+
+            except ValueError:
+                continue
+
+        msg = f"Could not parse date: {timestamp_str}"
+        logger.error(msg)
+        raise ValueError(msg)
+
+    def build_filter(self, args: dict, filter_settings: list) -> dict:
+        """Build filter dictionary for Astra DB query.
+
+        Args:
+            args: Dictionary of arguments from the tool
+            filter_settings: List of filter settings from tools_params_v2
+        Returns:
+            Dictionary containing the filter conditions
+        """
+        filters = {**self.static_filters}
+
+        for key, value in args.items():
+            # Skip search_query as it's handled separately
+            if key == "search_query":
+                continue
+
+            filter_setting = next((x for x in filter_settings if x["name"] == key), None)
+            if filter_setting and value is not None:
+                field_name = filter_setting["attribute_name"] if filter_setting["attribute_name"] else key
+                filter_key = field_name if not filter_setting["metadata"] else f"metadata.{field_name}"
+                if filter_setting["operator"] == "$exists":
+                    filters[filter_key] = {**filters.get(filter_key, {}), filter_setting["operator"]: True}
+                elif filter_setting["operator"] in ["$in", "$nin", "$all"]:
+                    filters[filter_key] = {
+                        **filters.get(filter_key, {}),
+                        filter_setting["operator"]: value.split(",") if isinstance(value, str) else value,
+                    }
+                elif filter_setting["is_timestamp"] == True:  # noqa: E712
+                    try:
+                        filters[filter_key] = {
+                            **filters.get(filter_key, {}),
+                            filter_setting["operator"]: self.parse_timestamp(value),
+                        }
+                    except ValueError as e:
+                        msg = f"Error parsing timestamp: {e} - Use the prompt to specify the date in the correct format"
+                        logger.error(msg)
+                        raise ValueError(msg) from e
+                else:
+                    filters[filter_key] = {**filters.get(filter_key, {}), filter_setting["operator"]: value}
+        return filters
+
+    def run_model(self, **args) -> Data | list[Data]:
+        """Run the query to get the data from the Astra DB collection."""
+        sort = {}
+
+        # Build filters using the new method
+        filters = self.build_filter(args, self.tools_params_v2)
+
+        # Build the vector search on
+        if self.use_search_query and args["search_query"] is not None and args["search_query"] != "":
+            if self.use_vectorize:
+                sort["$vectorize"] = args["search_query"]
+            else:
+                if self.embedding is None:
+                    msg = "Embedding model is not set. Please set the embedding model or use Astra DB Vectorize."
+                    logger.error(msg)
+                    raise ValueError(msg)
+                embedding_query = self.embedding.embed_query(args["search_query"])
+                sort["$vector"] = embedding_query
+            del args["search_query"]
+
+        find_options = {
+            "filter": filters,
+            "limit": self.number_of_results,
+            "sort": sort,
+        }
+
+        projection = self.projection_args(self.projection_attributes)
+        if projection and len(projection) > 0:
+            find_options["projection"] = projection
+
+        try:
+            database = self.get_database_object(api_endpoint=self.get_api_endpoint())
+            collection = database.get_collection(
+                name=self.collection_name,
+                keyspace=self.get_keyspace(),
+            )
+            results = collection.find(**find_options)
+        except Exception as e:
+            msg = f"Error on Astra DB Tool {self.tool_name} request: {e}"
+            logger.error(msg)
+            raise ValueError(msg) from e
+
+        logger.info(f"Tool {self.tool_name} executed`")
+
+        data: list[Data] = [Data(data=doc) for doc in results]
+        self.status = data
+        return data