From 8ebe5807667b8881bfa08a1e70a96a01e61f9674 Mon Sep 17 00:00:00 2001 From: Edwin Jose Date: Tue, 14 Jan 2025 10:17:06 -0500 Subject: [PATCH] feat: adds test cases for loop component compatibility with the APIs, Loop component updates to support API (#5615) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * add loop component 🎁🎄 * [autofix.ci] apply automated fixes * fix: add loop component to init * [autofix.ci] apply automated fixes * refactor(loop): rename loop input variable and improve code quality - Renamed 'loop' input to 'loop_input' for clarity. - Simplified logic for checking loop input and aggregating results. - Enhanced type hints for better code readability and maintainability. * refactor(loop): add type hint to initialize_data method for improved clarity * adding test * test cases added * Update test_loop.py * adding test * test cases added * Update test_loop.py * update with the new test case method! * Update test_loop.py * tests updates * Update loop.py * update fix * issues loop issues * reverting debug mode params * solves lint errors and fix the tests * fix: mypy error incompatible return value type * [autofix.ci] apply automated fixes --------- Co-authored-by: Rodrigo Nader Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Gabriel Luiz Freitas Almeida Co-authored-by: italojohnny --- .../base/langflow/components/logic/loop.py | 81 +- .../custom_component/custom_component.py | 15 + src/backend/tests/conftest.py | 7 + src/backend/tests/data/LoopTest.json | 1624 +++++++++++++++++ .../tests/unit/components/logic/__init__.py | 0 .../tests/unit/components/logic/test_loop.py | 90 + 6 files changed, 1787 insertions(+), 30 deletions(-) create mode 100644 src/backend/tests/data/LoopTest.json create mode 100644 src/backend/tests/unit/components/logic/__init__.py create mode 100644 src/backend/tests/unit/components/logic/test_loop.py diff --git a/src/backend/base/langflow/components/logic/loop.py b/src/backend/base/langflow/components/logic/loop.py index 528ab4ec15fa..258ccac7468f 100644 --- a/src/backend/base/langflow/components/logic/loop.py +++ b/src/backend/base/langflow/components/logic/loop.py @@ -26,16 +26,7 @@ def initialize_data(self) -> None: return # Ensure data is a list of Data objects - if isinstance(self.data, Data): - data_list: list[Data] = [self.data] - elif isinstance(self.data, list): - if not all(isinstance(item, Data) for item in self.data): - msg = "All items in the data list must be Data objects." - raise TypeError(msg) - data_list = self.data - else: - msg = "The 'data' input must be a list of Data objects or a single Data object." - raise TypeError(msg) + data_list = self._validate_data(self.data) # Store the initial data and context variables self.update_ctx( @@ -47,25 +38,62 @@ def initialize_data(self) -> None: } ) + def _validate_data(self, data): + """Validate and return a list of Data objects.""" + if isinstance(data, Data): + return [data] + if isinstance(data, list) and all(isinstance(item, Data) for item in data): + return data + msg = "The 'data' input must be a list of Data objects or a single Data object." + raise TypeError(msg) + + def evaluate_stop_loop(self) -> bool: + """Evaluate whether to stop item or done output.""" + current_index = self.ctx.get(f"{self._id}_index", 0) + data_length = len(self.ctx.get(f"{self._id}_data", [])) + return current_index > data_length + def item_output(self) -> Data: - """Output the next item in the list.""" + """Output the next item in the list or stop if done.""" self.initialize_data() + current_item = Data(text="") - # Get data list and current index - data_list: list[Data] = self.ctx.get(f"{self._id}_data", []) - current_index: int = self.ctx.get(f"{self._id}_index", 0) + if self.evaluate_stop_loop(): + self.stop("item") + return Data(text="") + # Get data list and current index + data_list, current_index = self.loop_variables() if current_index < len(data_list): # Output current item and increment index - current_item: Data = data_list[current_index] - self.update_ctx({f"{self._id}_index": current_index + 1}) - return current_item - - # No more items to output - self.stop("item") - return None # type: ignore [return-value] + try: + current_item = data_list[current_index] + except IndexError: + current_item = Data(text="") + self.aggregated_output() + self.update_ctx({f"{self._id}_index": current_index + 1}) + return current_item def done_output(self) -> Data: + """Trigger the done output when iteration is complete.""" + self.initialize_data() + + if self.evaluate_stop_loop(): + self.stop("item") + self.start("done") + + return self.ctx.get(f"{self._id}_aggregated", []) + self.stop("done") + return Data(text="") + + def loop_variables(self): + """Retrieve loop variables from context.""" + return ( + self.ctx.get(f"{self._id}_data", []), + self.ctx.get(f"{self._id}_index", 0), + ) + + def aggregated_output(self) -> Data: """Return the aggregated list once all items are processed.""" self.initialize_data() @@ -74,14 +102,7 @@ def done_output(self) -> Data: aggregated = self.ctx.get(f"{self._id}_aggregated", []) # Check if loop input is provided and append to aggregated list - if self.loop_input is not None: + if self.loop_input is not None and not isinstance(self.loop_input, str) and len(aggregated) <= len(data_list): aggregated.append(self.loop_input) self.update_ctx({f"{self._id}_aggregated": aggregated}) - - # Check if aggregation is complete - if len(aggregated) >= len(data_list): - return aggregated - - # Not all items have been processed yet - self.stop("done") - return None # type: ignore [return-value] + return aggregated diff --git a/src/backend/base/langflow/custom/custom_component/custom_component.py b/src/backend/base/langflow/custom/custom_component/custom_component.py index 9cb9e152322a..9107dcc54a5d 100644 --- a/src/backend/base/langflow/custom/custom_component/custom_component.py +++ b/src/backend/base/langflow/custom/custom_component/custom_component.py @@ -138,6 +138,21 @@ def stop(self, output_name: str | None = None) -> None: msg = f"Error stopping {self.display_name}: {e}" raise ValueError(msg) from e + def start(self, output_name: str | None = None) -> None: + if not output_name and self._vertex and len(self._vertex.outputs) == 1: + output_name = self._vertex.outputs[0]["name"] + elif not output_name: + msg = "You must specify an output name to call start" + raise ValueError(msg) + if not self._vertex: + msg = "Vertex is not set" + raise ValueError(msg) + try: + self.graph.mark_branch(vertex_id=self._vertex.id, output_name=output_name, state="ACTIVE") + except Exception as e: + msg = f"Error starting {self.display_name}: {e}" + raise ValueError(msg) from e + def append_state(self, name: str, value: Any) -> None: if not self._vertex: msg = "Vertex is not set" diff --git a/src/backend/tests/conftest.py b/src/backend/tests/conftest.py index 5e67b7196004..1b77e8b838e1 100644 --- a/src/backend/tests/conftest.py +++ b/src/backend/tests/conftest.py @@ -103,6 +103,7 @@ def pytest_configure(config): pytest.VECTOR_STORE_PATH = data_path / "Vector_store.json" pytest.SIMPLE_API_TEST = data_path / "SimpleAPITest.json" pytest.MEMORY_CHATBOT_NO_LLM = data_path / "MemoryChatbotNoLLM.json" + pytest.LOOP_TEST = data_path / "LoopTest.json" pytest.CODE_WITH_SYNTAX_ERROR = """ def get_text(): retun "Hello World" @@ -121,6 +122,7 @@ def get_text(): pytest.TWO_OUTPUTS, pytest.VECTOR_STORE_PATH, pytest.MEMORY_CHATBOT_NO_LLM, + pytest.LOOP_TEST, ]: assert path.exists(), f"File {path} does not exist. Available files: {list(data_path.iterdir())}" @@ -324,6 +326,11 @@ def json_memory_chatbot_no_llm(): return pytest.MEMORY_CHATBOT_NO_LLM.read_text(encoding="utf-8") +@pytest.fixture +def json_loop_test(): + return pytest.LOOP_TEST.read_text(encoding="utf-8") + + @pytest.fixture(autouse=True) def deactivate_tracing(monkeypatch): monkeypatch.setenv("LANGFLOW_DEACTIVATE_TRACING", "true") diff --git a/src/backend/tests/data/LoopTest.json b/src/backend/tests/data/LoopTest.json new file mode 100644 index 000000000000..ed31ebe8d04c --- /dev/null +++ b/src/backend/tests/data/LoopTest.json @@ -0,0 +1,1624 @@ +{ + "id": "713390de-f9b7-4c4b-b3c4-2678a9973ea3", + "data": { + "nodes": [ + { + "id": "ParseData-HI264", + "type": "genericNode", + "position": { + "x": 1519.4837108212814, + "y": 724.0614553725009 + }, + "data": { + "node": { + "template": { + "_type": "Component", + "data": { + "tool_mode": false, + "trace_as_metadata": true, + "list": true, + "trace_as_input": true, + "required": false, + "placeholder": "", + "show": true, + "name": "data", + "value": "", + "display_name": "Data", + "advanced": false, + "input_types": [ + "Data" + ], + "dynamic": false, + "info": "The data to convert to text.", + "title_case": false, + "type": "other", + "_input_type": "DataInput" + }, + "code": { + "type": "code", + "required": true, + "placeholder": "", + "list": false, + "show": true, + "multiline": true, + "value": "from langflow.custom import Component\nfrom langflow.helpers.data import data_to_text, data_to_text_list\nfrom langflow.io import DataInput, MultilineInput, Output, StrInput\nfrom langflow.schema import Data\nfrom langflow.schema.message import Message\n\n\nclass ParseDataComponent(Component):\n display_name = \"Parse Data\"\n description = \"Convert Data into plain text following a specified template.\"\n icon = \"braces\"\n name = \"ParseData\"\n\n inputs = [\n DataInput(name=\"data\", display_name=\"Data\", info=\"The data to convert to text.\", is_list=True),\n MultilineInput(\n name=\"template\",\n display_name=\"Template\",\n info=\"The template to use for formatting the data. \"\n \"It can contain the keys {text}, {data} or any other key in the Data.\",\n value=\"{text}\",\n ),\n StrInput(name=\"sep\", display_name=\"Separator\", advanced=True, value=\"\\n\"),\n ]\n\n outputs = [\n Output(\n display_name=\"Text\",\n name=\"text\",\n info=\"Data as a single Message, with each input Data separated by Separator\",\n method=\"parse_data\",\n ),\n Output(\n display_name=\"Data List\",\n name=\"data_list\",\n info=\"Data as a list of new Data, each having `text` formatted by Template\",\n method=\"parse_data_as_list\",\n ),\n ]\n\n def _clean_args(self) -> tuple[list[Data], str, str]:\n data = self.data if isinstance(self.data, list) else [self.data]\n template = self.template\n sep = self.sep\n return data, template, sep\n\n def parse_data(self) -> Message:\n data, template, sep = self._clean_args()\n result_string = data_to_text(template, data, sep)\n self.status = result_string\n return Message(text=result_string)\n\n def parse_data_as_list(self) -> list[Data]:\n data, template, _ = self._clean_args()\n text_list, data_list = data_to_text_list(template, data)\n for item, text in zip(data_list, text_list, strict=True):\n item.set_text(text)\n self.status = data_list\n return data_list\n", + "fileTypes": [], + "file_path": "", + "password": false, + "name": "code", + "advanced": true, + "dynamic": true, + "info": "", + "load_from_db": false, + "title_case": false + }, + "sep": { + "tool_mode": false, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "sep", + "value": "\n", + "display_name": "Separator", + "advanced": true, + "dynamic": false, + "info": "", + "title_case": false, + "type": "str", + "_input_type": "StrInput" + }, + "template": { + "tool_mode": false, + "trace_as_input": true, + "multiline": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "template", + "value": "{text}", + "display_name": "Template", + "advanced": false, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The template to use for formatting the data. It can contain the keys {text}, {data} or any other key in the Data.", + "title_case": false, + "type": "str", + "_input_type": "MultilineInput" + } + }, + "description": "Convert Data into plain text following a specified template.", + "icon": "braces", + "base_classes": [ + "Data", + "Message" + ], + "display_name": "Parse Data", + "documentation": "", + "minimized": false, + "custom_fields": {}, + "output_types": [], + "pinned": false, + "conditional_paths": [], + "frozen": false, + "outputs": [ + { + "types": [ + "Message" + ], + "selected": "Message", + "name": "text", + "display_name": "Text", + "method": "parse_data", + "value": "__UNDEFINED__", + "cache": true + }, + { + "types": [ + "Data" + ], + "selected": "Data", + "name": "data_list", + "display_name": "Data List", + "method": "parse_data_as_list", + "value": "__UNDEFINED__", + "cache": true, + "hidden": true + } + ], + "field_order": [ + "data", + "template", + "sep" + ], + "beta": false, + "legacy": false, + "edited": false, + "metadata": {}, + "tool_mode": false, + "category": "processing", + "key": "ParseData", + "score": 0.007568328950209746, + "lf_version": "1.1.1" + }, + "showNode": true, + "type": "ParseData", + "id": "ParseData-HI264" + }, + "selected": false, + "measured": { + "width": 320, + "height": 294 + }, + "dragging": false + }, + { + "id": "MessagetoData-02q2m", + "type": "genericNode", + "position": { + "x": 828.0748930410606, + "y": 444.7212170217783 + }, + "data": { + "node": { + "template": { + "_type": "Component", + "code": { + "type": "code", + "required": true, + "placeholder": "", + "list": false, + "show": true, + "multiline": true, + "value": "from loguru import logger\n\nfrom langflow.custom import Component\nfrom langflow.io import MessageInput, Output\nfrom langflow.schema import Data\nfrom langflow.schema.message import Message\n\n\nclass MessageToDataComponent(Component):\n display_name = \"Message to Data\"\n description = \"Convert a Message object to a Data object\"\n icon = \"message-square-share\"\n beta = True\n name = \"MessagetoData\"\n\n inputs = [\n MessageInput(\n name=\"message\",\n display_name=\"Message\",\n info=\"The Message object to convert to a Data object\",\n ),\n ]\n\n outputs = [\n Output(display_name=\"Data\", name=\"data\", method=\"convert_message_to_data\"),\n ]\n\n def convert_message_to_data(self) -> Data:\n if isinstance(self.message, Message):\n # Convert Message to Data\n return Data(data=self.message.data)\n\n msg = \"Error converting Message to Data: Input must be a Message object\"\n logger.opt(exception=True).debug(msg)\n self.status = msg\n return Data(data={\"error\": msg})\n", + "fileTypes": [], + "file_path": "", + "password": false, + "name": "code", + "advanced": true, + "dynamic": true, + "info": "", + "load_from_db": false, + "title_case": false + }, + "message": { + "trace_as_input": true, + "tool_mode": false, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "message", + "value": "", + "display_name": "Message", + "advanced": false, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The Message object to convert to a Data object", + "title_case": false, + "type": "str", + "_input_type": "MessageInput" + } + }, + "description": "Convert a Message object to a Data object", + "icon": "message-square-share", + "base_classes": [ + "Data" + ], + "display_name": "Message to Data", + "documentation": "", + "minimized": false, + "custom_fields": {}, + "output_types": [], + "pinned": false, + "conditional_paths": [], + "frozen": false, + "outputs": [ + { + "types": [ + "Data" + ], + "selected": "Data", + "name": "data", + "display_name": "Data", + "method": "convert_message_to_data", + "value": "__UNDEFINED__", + "cache": true + } + ], + "field_order": [ + "message" + ], + "beta": true, + "legacy": false, + "edited": false, + "metadata": {}, + "tool_mode": false, + "lf_version": "1.1.1" + }, + "showNode": true, + "type": "MessagetoData", + "id": "MessagetoData-02q2m" + }, + "selected": false, + "measured": { + "width": 320, + "height": 230 + }, + "dragging": false + }, + { + "id": "MessagetoData-dHnzn", + "type": "genericNode", + "position": { + "x": -334.897840488358, + "y": 553.0914016416309 + }, + "data": { + "node": { + "template": { + "_type": "Component", + "code": { + "type": "code", + "required": true, + "placeholder": "", + "list": false, + "show": true, + "multiline": true, + "value": "from loguru import logger\n\nfrom langflow.custom import Component\nfrom langflow.io import MessageInput, Output\nfrom langflow.schema import Data\nfrom langflow.schema.message import Message\n\n\nclass MessageToDataComponent(Component):\n display_name = \"Message to Data\"\n description = \"Convert a Message object to a Data object\"\n icon = \"message-square-share\"\n beta = True\n name = \"MessagetoData\"\n\n inputs = [\n MessageInput(\n name=\"message\",\n display_name=\"Message\",\n info=\"The Message object to convert to a Data object\",\n ),\n ]\n\n outputs = [\n Output(display_name=\"Data\", name=\"data\", method=\"convert_message_to_data\"),\n ]\n\n def convert_message_to_data(self) -> Data:\n if isinstance(self.message, Message):\n # Convert Message to Data\n return Data(data=self.message.data)\n\n msg = \"Error converting Message to Data: Input must be a Message object\"\n logger.opt(exception=True).debug(msg)\n self.status = msg\n return Data(data={\"error\": msg})\n", + "fileTypes": [], + "file_path": "", + "password": false, + "name": "code", + "advanced": true, + "dynamic": true, + "info": "", + "load_from_db": false, + "title_case": false + }, + "message": { + "trace_as_input": true, + "tool_mode": false, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "message", + "value": "", + "display_name": "Message", + "advanced": false, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The Message object to convert to a Data object", + "title_case": false, + "type": "str", + "_input_type": "MessageInput" + } + }, + "description": "Convert a Message object to a Data object", + "icon": "message-square-share", + "base_classes": [ + "Data" + ], + "display_name": "Message to Data", + "documentation": "", + "minimized": false, + "custom_fields": {}, + "output_types": [], + "pinned": false, + "conditional_paths": [], + "frozen": false, + "outputs": [ + { + "types": [ + "Data" + ], + "selected": "Data", + "name": "data", + "display_name": "Data", + "method": "convert_message_to_data", + "value": "__UNDEFINED__", + "cache": true + } + ], + "field_order": [ + "message" + ], + "beta": true, + "legacy": false, + "edited": false, + "metadata": {}, + "tool_mode": false, + "lf_version": "1.1.1" + }, + "showNode": true, + "type": "MessagetoData", + "id": "MessagetoData-dHnzn" + }, + "selected": false, + "measured": { + "width": 320, + "height": 230 + }, + "dragging": false + }, + { + "id": "ChatInput-dOD8A", + "type": "genericNode", + "position": { + "x": -780.5070511367146, + "y": 477.3880139482486 + }, + "data": { + "node": { + "template": { + "_type": "Component", + "files": { + "trace_as_metadata": true, + "file_path": "", + "fileTypes": [ + "txt", + "md", + "mdx", + "csv", + "json", + "yaml", + "yml", + "xml", + "html", + "htm", + "pdf", + "docx", + "py", + "sh", + "sql", + "js", + "ts", + "tsx", + "jpg", + "jpeg", + "png", + "bmp", + "image" + ], + "list": true, + "required": false, + "placeholder": "", + "show": true, + "name": "files", + "value": "", + "display_name": "Files", + "advanced": true, + "dynamic": false, + "info": "Files to be sent with the message.", + "title_case": false, + "type": "file", + "_input_type": "FileInput" + }, + "background_color": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "background_color", + "value": "", + "display_name": "Background Color", + "advanced": true, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The background color of the icon.", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + }, + "chat_icon": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "chat_icon", + "value": "", + "display_name": "Icon", + "advanced": true, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The icon of the message.", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + }, + "code": { + "type": "code", + "required": true, + "placeholder": "", + "list": false, + "show": true, + "multiline": true, + "value": "from langflow.base.data.utils import IMG_FILE_TYPES, TEXT_FILE_TYPES\nfrom langflow.base.io.chat import ChatComponent\nfrom langflow.inputs import BoolInput\nfrom langflow.io import (\n DropdownInput,\n FileInput,\n MessageTextInput,\n MultilineInput,\n Output,\n)\nfrom langflow.schema.message import Message\nfrom langflow.utils.constants import (\n MESSAGE_SENDER_AI,\n MESSAGE_SENDER_NAME_USER,\n MESSAGE_SENDER_USER,\n)\n\n\nclass ChatInput(ChatComponent):\n display_name = \"Chat Input\"\n description = \"Get chat inputs from the Playground.\"\n icon = \"MessagesSquare\"\n name = \"ChatInput\"\n minimized = True\n\n inputs = [\n MultilineInput(\n name=\"input_value\",\n display_name=\"Text\",\n value=\"\",\n info=\"Message to be passed as input.\",\n input_types=[],\n ),\n BoolInput(\n name=\"should_store_message\",\n display_name=\"Store Messages\",\n info=\"Store the message in the history.\",\n value=True,\n advanced=True,\n ),\n DropdownInput(\n name=\"sender\",\n display_name=\"Sender Type\",\n options=[MESSAGE_SENDER_AI, MESSAGE_SENDER_USER],\n value=MESSAGE_SENDER_USER,\n info=\"Type of sender.\",\n advanced=True,\n ),\n MessageTextInput(\n name=\"sender_name\",\n display_name=\"Sender Name\",\n info=\"Name of the sender.\",\n value=MESSAGE_SENDER_NAME_USER,\n advanced=True,\n ),\n MessageTextInput(\n name=\"session_id\",\n display_name=\"Session ID\",\n info=\"The session ID of the chat. If empty, the current session ID parameter will be used.\",\n advanced=True,\n ),\n FileInput(\n name=\"files\",\n display_name=\"Files\",\n file_types=TEXT_FILE_TYPES + IMG_FILE_TYPES,\n info=\"Files to be sent with the message.\",\n advanced=True,\n is_list=True,\n ),\n MessageTextInput(\n name=\"background_color\",\n display_name=\"Background Color\",\n info=\"The background color of the icon.\",\n advanced=True,\n ),\n MessageTextInput(\n name=\"chat_icon\",\n display_name=\"Icon\",\n info=\"The icon of the message.\",\n advanced=True,\n ),\n MessageTextInput(\n name=\"text_color\",\n display_name=\"Text Color\",\n info=\"The text color of the name\",\n advanced=True,\n ),\n ]\n outputs = [\n Output(display_name=\"Message\", name=\"message\", method=\"message_response\"),\n ]\n\n async def message_response(self) -> Message:\n background_color = self.background_color\n text_color = self.text_color\n icon = self.chat_icon\n\n message = await Message.create(\n text=self.input_value,\n sender=self.sender,\n sender_name=self.sender_name,\n session_id=self.session_id,\n files=self.files,\n properties={\n \"background_color\": background_color,\n \"text_color\": text_color,\n \"icon\": icon,\n },\n )\n if self.session_id and isinstance(message, Message) and self.should_store_message:\n stored_message = await self.send_message(\n message,\n )\n self.message.value = stored_message\n message = stored_message\n\n self.status = message\n return message\n", + "fileTypes": [], + "file_path": "", + "password": false, + "name": "code", + "advanced": true, + "dynamic": true, + "info": "", + "load_from_db": false, + "title_case": false + }, + "input_value": { + "tool_mode": false, + "trace_as_input": true, + "multiline": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "input_value", + "value": "Sentence 1. Sentence 2. Sentence 3", + "display_name": "Text", + "advanced": false, + "input_types": [], + "dynamic": false, + "info": "Message to be passed as input.", + "title_case": false, + "type": "str", + "_input_type": "MultilineInput" + }, + "sender": { + "tool_mode": false, + "trace_as_metadata": true, + "options": [ + "Machine", + "User" + ], + "combobox": false, + "required": false, + "placeholder": "", + "show": true, + "name": "sender", + "value": "User", + "display_name": "Sender Type", + "advanced": true, + "dynamic": false, + "info": "Type of sender.", + "title_case": false, + "type": "str", + "_input_type": "DropdownInput" + }, + "sender_name": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "sender_name", + "value": "User", + "display_name": "Sender Name", + "advanced": true, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "Name of the sender.", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + }, + "session_id": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "session_id", + "value": "", + "display_name": "Session ID", + "advanced": true, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The session ID of the chat. If empty, the current session ID parameter will be used.", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + }, + "should_store_message": { + "tool_mode": false, + "trace_as_metadata": true, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "should_store_message", + "value": true, + "display_name": "Store Messages", + "advanced": true, + "dynamic": false, + "info": "Store the message in the history.", + "title_case": false, + "type": "bool", + "_input_type": "BoolInput" + }, + "text_color": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "text_color", + "value": "", + "display_name": "Text Color", + "advanced": true, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The text color of the name", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + } + }, + "description": "Get chat inputs from the Playground.", + "icon": "MessagesSquare", + "base_classes": [ + "Message" + ], + "display_name": "Chat Input", + "documentation": "", + "minimized": true, + "custom_fields": {}, + "output_types": [], + "pinned": false, + "conditional_paths": [], + "frozen": false, + "outputs": [ + { + "types": [ + "Message" + ], + "selected": "Message", + "name": "message", + "display_name": "Message", + "method": "message_response", + "value": "__UNDEFINED__", + "cache": true + } + ], + "field_order": [ + "input_value", + "should_store_message", + "sender", + "sender_name", + "session_id", + "files", + "background_color", + "chat_icon", + "text_color" + ], + "beta": false, + "legacy": false, + "edited": false, + "metadata": {}, + "tool_mode": false, + "lf_version": "1.1.1" + }, + "showNode": true, + "type": "ChatInput", + "id": "ChatInput-dOD8A" + }, + "selected": false, + "measured": { + "width": 320, + "height": 230 + }, + "dragging": false + }, + { + "id": "SplitText-d7abl", + "type": "genericNode", + "position": { + "x": 37.5698068780533, + "y": 627.736322287764 + }, + "data": { + "node": { + "template": { + "_type": "Component", + "data_inputs": { + "trace_as_metadata": true, + "list": true, + "required": true, + "placeholder": "", + "show": true, + "name": "data_inputs", + "value": "", + "display_name": "Data Inputs", + "advanced": false, + "input_types": [ + "Data" + ], + "dynamic": false, + "info": "The data to split.", + "title_case": false, + "type": "other", + "_input_type": "HandleInput" + }, + "chunk_overlap": { + "tool_mode": false, + "trace_as_metadata": true, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "chunk_overlap", + "value": 0, + "display_name": "Chunk Overlap", + "advanced": false, + "dynamic": false, + "info": "Number of characters to overlap between chunks.", + "title_case": false, + "type": "int", + "_input_type": "IntInput" + }, + "chunk_size": { + "tool_mode": false, + "trace_as_metadata": true, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "chunk_size", + "value": 10, + "display_name": "Chunk Size", + "advanced": false, + "dynamic": false, + "info": "The maximum number of characters in each chunk.", + "title_case": false, + "type": "int", + "_input_type": "IntInput" + }, + "code": { + "type": "code", + "required": true, + "placeholder": "", + "list": false, + "show": true, + "multiline": true, + "value": "from langchain_text_splitters import CharacterTextSplitter\n\nfrom langflow.custom import Component\nfrom langflow.io import HandleInput, IntInput, MessageTextInput, Output\nfrom langflow.schema import Data, DataFrame\nfrom langflow.utils.util import unescape_string\n\n\nclass SplitTextComponent(Component):\n display_name: str = \"Split Text\"\n description: str = \"Split text into chunks based on specified criteria.\"\n icon = \"scissors-line-dashed\"\n name = \"SplitText\"\n\n inputs = [\n HandleInput(\n name=\"data_inputs\",\n display_name=\"Data Inputs\",\n info=\"The data to split.\",\n input_types=[\"Data\"],\n is_list=True,\n required=True,\n ),\n IntInput(\n name=\"chunk_overlap\",\n display_name=\"Chunk Overlap\",\n info=\"Number of characters to overlap between chunks.\",\n value=200,\n ),\n IntInput(\n name=\"chunk_size\",\n display_name=\"Chunk Size\",\n info=\"The maximum number of characters in each chunk.\",\n value=1000,\n ),\n MessageTextInput(\n name=\"separator\",\n display_name=\"Separator\",\n info=\"The character to split on. Defaults to newline.\",\n value=\"\\n\",\n ),\n ]\n\n outputs = [\n Output(display_name=\"Chunks\", name=\"chunks\", method=\"split_text\"),\n Output(display_name=\"DataFrame\", name=\"dataframe\", method=\"as_dataframe\"),\n ]\n\n def _docs_to_data(self, docs):\n return [Data(text=doc.page_content, data=doc.metadata) for doc in docs]\n\n def split_text(self) -> list[Data]:\n separator = unescape_string(self.separator)\n\n documents = [_input.to_lc_document() for _input in self.data_inputs if isinstance(_input, Data)]\n\n splitter = CharacterTextSplitter(\n chunk_overlap=self.chunk_overlap,\n chunk_size=self.chunk_size,\n separator=separator,\n )\n docs = splitter.split_documents(documents)\n data = self._docs_to_data(docs)\n self.status = data\n return data\n\n def as_dataframe(self) -> DataFrame:\n return DataFrame(self.split_text())\n", + "fileTypes": [], + "file_path": "", + "password": false, + "name": "code", + "advanced": true, + "dynamic": true, + "info": "", + "load_from_db": false, + "title_case": false + }, + "separator": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "separator", + "value": ".", + "display_name": "Separator", + "advanced": false, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The character to split on. Defaults to newline.", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + } + }, + "description": "Split text into chunks based on specified criteria.", + "icon": "scissors-line-dashed", + "base_classes": [ + "Data", + "DataFrame" + ], + "display_name": "Split Text", + "documentation": "", + "minimized": false, + "custom_fields": {}, + "output_types": [], + "pinned": false, + "conditional_paths": [], + "frozen": false, + "outputs": [ + { + "types": [ + "Data" + ], + "selected": "Data", + "name": "chunks", + "display_name": "Chunks", + "method": "split_text", + "value": "__UNDEFINED__", + "cache": true + }, + { + "types": [ + "DataFrame" + ], + "selected": "DataFrame", + "name": "dataframe", + "display_name": "DataFrame", + "method": "as_dataframe", + "value": "__UNDEFINED__", + "cache": true + } + ], + "field_order": [ + "data_inputs", + "chunk_overlap", + "chunk_size", + "separator" + ], + "beta": false, + "legacy": false, + "edited": false, + "metadata": {}, + "tool_mode": false, + "lf_version": "1.1.1" + }, + "showNode": true, + "type": "SplitText", + "id": "SplitText-d7abl" + }, + "selected": false, + "measured": { + "width": 320, + "height": 507 + }, + "dragging": false + }, + { + "id": "ParseData-Jsbbl", + "type": "genericNode", + "position": { + "x": 1515, + "y": 1290 + }, + "data": { + "node": { + "template": { + "_type": "Component", + "data": { + "tool_mode": false, + "trace_as_metadata": true, + "list": true, + "trace_as_input": true, + "required": false, + "placeholder": "", + "show": true, + "name": "data", + "value": "", + "display_name": "Data", + "advanced": false, + "input_types": [ + "Data" + ], + "dynamic": false, + "info": "The data to convert to text.", + "title_case": false, + "type": "other", + "_input_type": "DataInput" + }, + "code": { + "type": "code", + "required": true, + "placeholder": "", + "list": false, + "show": true, + "multiline": true, + "value": "from langflow.custom import Component\nfrom langflow.helpers.data import data_to_text, data_to_text_list\nfrom langflow.io import DataInput, MultilineInput, Output, StrInput\nfrom langflow.schema import Data\nfrom langflow.schema.message import Message\n\n\nclass ParseDataComponent(Component):\n display_name = \"Parse Data\"\n description = \"Convert Data into plain text following a specified template.\"\n icon = \"braces\"\n name = \"ParseData\"\n\n inputs = [\n DataInput(name=\"data\", display_name=\"Data\", info=\"The data to convert to text.\", is_list=True),\n MultilineInput(\n name=\"template\",\n display_name=\"Template\",\n info=\"The template to use for formatting the data. \"\n \"It can contain the keys {text}, {data} or any other key in the Data.\",\n value=\"{text}\",\n ),\n StrInput(name=\"sep\", display_name=\"Separator\", advanced=True, value=\"\\n\"),\n ]\n\n outputs = [\n Output(\n display_name=\"Text\",\n name=\"text\",\n info=\"Data as a single Message, with each input Data separated by Separator\",\n method=\"parse_data\",\n ),\n Output(\n display_name=\"Data List\",\n name=\"data_list\",\n info=\"Data as a list of new Data, each having `text` formatted by Template\",\n method=\"parse_data_as_list\",\n ),\n ]\n\n def _clean_args(self) -> tuple[list[Data], str, str]:\n data = self.data if isinstance(self.data, list) else [self.data]\n template = self.template\n sep = self.sep\n return data, template, sep\n\n def parse_data(self) -> Message:\n data, template, sep = self._clean_args()\n result_string = data_to_text(template, data, sep)\n self.status = result_string\n return Message(text=result_string)\n\n def parse_data_as_list(self) -> list[Data]:\n data, template, _ = self._clean_args()\n text_list, data_list = data_to_text_list(template, data)\n for item, text in zip(data_list, text_list, strict=True):\n item.set_text(text)\n self.status = data_list\n return data_list\n", + "fileTypes": [], + "file_path": "", + "password": false, + "name": "code", + "advanced": true, + "dynamic": true, + "info": "", + "load_from_db": false, + "title_case": false + }, + "sep": { + "tool_mode": false, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "sep", + "value": "\n", + "display_name": "Separator", + "advanced": true, + "dynamic": false, + "info": "", + "title_case": false, + "type": "str", + "_input_type": "StrInput" + }, + "template": { + "tool_mode": false, + "trace_as_input": true, + "multiline": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "template", + "value": "{text}", + "display_name": "Template", + "advanced": false, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The template to use for formatting the data. It can contain the keys {text}, {data} or any other key in the Data.", + "title_case": false, + "type": "str", + "_input_type": "MultilineInput" + } + }, + "description": "Convert Data into plain text following a specified template.", + "icon": "braces", + "base_classes": [ + "Data", + "Message" + ], + "display_name": "Parse Data", + "documentation": "", + "minimized": false, + "custom_fields": {}, + "output_types": [], + "pinned": false, + "conditional_paths": [], + "frozen": false, + "outputs": [ + { + "types": [ + "Message" + ], + "selected": "Message", + "name": "text", + "display_name": "Text", + "method": "parse_data", + "value": "__UNDEFINED__", + "cache": true + }, + { + "types": [ + "Data" + ], + "selected": "Data", + "name": "data_list", + "display_name": "Data List", + "method": "parse_data_as_list", + "value": "__UNDEFINED__", + "cache": true + } + ], + "field_order": [ + "data", + "template", + "sep" + ], + "beta": false, + "legacy": false, + "edited": false, + "metadata": {}, + "tool_mode": false, + "category": "processing", + "key": "ParseData", + "score": 0.007568328950209746, + "lf_version": "1.1.1" + }, + "showNode": true, + "type": "ParseData", + "id": "ParseData-Jsbbl" + }, + "selected": false, + "measured": { + "width": 320, + "height": 342 + } + }, + { + "id": "ChatOutput-HZiAI", + "type": "genericNode", + "position": { + "x": 1989.185022672821, + "y": 1327.6617206694202 + }, + "data": { + "node": { + "template": { + "_type": "Component", + "background_color": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "background_color", + "value": "", + "display_name": "Background Color", + "advanced": true, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The background color of the icon.", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + }, + "chat_icon": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "chat_icon", + "value": "", + "display_name": "Icon", + "advanced": true, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The icon of the message.", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + }, + "code": { + "type": "code", + "required": true, + "placeholder": "", + "list": false, + "show": true, + "multiline": true, + "value": "from langflow.base.io.chat import ChatComponent\nfrom langflow.inputs import BoolInput\nfrom langflow.io import DropdownInput, MessageInput, MessageTextInput, Output\nfrom langflow.schema.message import Message\nfrom langflow.schema.properties import Source\nfrom langflow.utils.constants import (\n MESSAGE_SENDER_AI,\n MESSAGE_SENDER_NAME_AI,\n MESSAGE_SENDER_USER,\n)\n\n\nclass ChatOutput(ChatComponent):\n display_name = \"Chat Output\"\n description = \"Display a chat message in the Playground.\"\n icon = \"MessagesSquare\"\n name = \"ChatOutput\"\n minimized = True\n\n inputs = [\n MessageInput(\n name=\"input_value\",\n display_name=\"Text\",\n info=\"Message to be passed as output.\",\n ),\n BoolInput(\n name=\"should_store_message\",\n display_name=\"Store Messages\",\n info=\"Store the message in the history.\",\n value=True,\n advanced=True,\n ),\n DropdownInput(\n name=\"sender\",\n display_name=\"Sender Type\",\n options=[MESSAGE_SENDER_AI, MESSAGE_SENDER_USER],\n value=MESSAGE_SENDER_AI,\n advanced=True,\n info=\"Type of sender.\",\n ),\n MessageTextInput(\n name=\"sender_name\",\n display_name=\"Sender Name\",\n info=\"Name of the sender.\",\n value=MESSAGE_SENDER_NAME_AI,\n advanced=True,\n ),\n MessageTextInput(\n name=\"session_id\",\n display_name=\"Session ID\",\n info=\"The session ID of the chat. If empty, the current session ID parameter will be used.\",\n advanced=True,\n ),\n MessageTextInput(\n name=\"data_template\",\n display_name=\"Data Template\",\n value=\"{text}\",\n advanced=True,\n info=\"Template to convert Data to Text. If left empty, it will be dynamically set to the Data's text key.\",\n ),\n MessageTextInput(\n name=\"background_color\",\n display_name=\"Background Color\",\n info=\"The background color of the icon.\",\n advanced=True,\n ),\n MessageTextInput(\n name=\"chat_icon\",\n display_name=\"Icon\",\n info=\"The icon of the message.\",\n advanced=True,\n ),\n MessageTextInput(\n name=\"text_color\",\n display_name=\"Text Color\",\n info=\"The text color of the name\",\n advanced=True,\n ),\n ]\n outputs = [\n Output(\n display_name=\"Message\",\n name=\"message\",\n method=\"message_response\",\n ),\n ]\n\n def _build_source(self, id_: str | None, display_name: str | None, source: str | None) -> Source:\n source_dict = {}\n if id_:\n source_dict[\"id\"] = id_\n if display_name:\n source_dict[\"display_name\"] = display_name\n if source:\n source_dict[\"source\"] = source\n return Source(**source_dict)\n\n async def message_response(self) -> Message:\n source, icon, display_name, source_id = self.get_properties_from_source_component()\n background_color = self.background_color\n text_color = self.text_color\n if self.chat_icon:\n icon = self.chat_icon\n message = self.input_value if isinstance(self.input_value, Message) else Message(text=self.input_value)\n message.sender = self.sender\n message.sender_name = self.sender_name\n message.session_id = self.session_id\n message.flow_id = self.graph.flow_id if hasattr(self, \"graph\") else None\n message.properties.source = self._build_source(source_id, display_name, source)\n message.properties.icon = icon\n message.properties.background_color = background_color\n message.properties.text_color = text_color\n if self.session_id and isinstance(message, Message) and self.should_store_message:\n stored_message = await self.send_message(\n message,\n )\n self.message.value = stored_message\n message = stored_message\n\n self.status = message\n return message\n", + "fileTypes": [], + "file_path": "", + "password": false, + "name": "code", + "advanced": true, + "dynamic": true, + "info": "", + "load_from_db": false, + "title_case": false + }, + "data_template": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "data_template", + "value": "{text}", + "display_name": "Data Template", + "advanced": true, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "Template to convert Data to Text. If left empty, it will be dynamically set to the Data's text key.", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + }, + "input_value": { + "trace_as_input": true, + "tool_mode": false, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "input_value", + "value": "", + "display_name": "Text", + "advanced": false, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "Message to be passed as output.", + "title_case": false, + "type": "str", + "_input_type": "MessageInput" + }, + "sender": { + "tool_mode": false, + "trace_as_metadata": true, + "options": [ + "Machine", + "User" + ], + "combobox": false, + "required": false, + "placeholder": "", + "show": true, + "name": "sender", + "value": "Machine", + "display_name": "Sender Type", + "advanced": true, + "dynamic": false, + "info": "Type of sender.", + "title_case": false, + "type": "str", + "_input_type": "DropdownInput" + }, + "sender_name": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "sender_name", + "value": "AI", + "display_name": "Sender Name", + "advanced": true, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "Name of the sender.", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + }, + "session_id": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "session_id", + "value": "", + "display_name": "Session ID", + "advanced": true, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The session ID of the chat. If empty, the current session ID parameter will be used.", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + }, + "should_store_message": { + "tool_mode": false, + "trace_as_metadata": true, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "should_store_message", + "value": true, + "display_name": "Store Messages", + "advanced": true, + "dynamic": false, + "info": "Store the message in the history.", + "title_case": false, + "type": "bool", + "_input_type": "BoolInput" + }, + "text_color": { + "tool_mode": false, + "trace_as_input": true, + "trace_as_metadata": true, + "load_from_db": false, + "list": false, + "required": false, + "placeholder": "", + "show": true, + "name": "text_color", + "value": "", + "display_name": "Text Color", + "advanced": true, + "input_types": [ + "Message" + ], + "dynamic": false, + "info": "The text color of the name", + "title_case": false, + "type": "str", + "_input_type": "MessageTextInput" + } + }, + "description": "Display a chat message in the Playground.", + "icon": "MessagesSquare", + "base_classes": [ + "Message" + ], + "display_name": "Chat Output", + "documentation": "", + "minimized": true, + "custom_fields": {}, + "output_types": [], + "pinned": false, + "conditional_paths": [], + "frozen": false, + "outputs": [ + { + "types": [ + "Message" + ], + "selected": "Message", + "name": "message", + "display_name": "Message", + "method": "message_response", + "value": "__UNDEFINED__", + "cache": true + } + ], + "field_order": [ + "input_value", + "should_store_message", + "sender", + "sender_name", + "session_id", + "data_template", + "background_color", + "chat_icon", + "text_color" + ], + "beta": false, + "legacy": false, + "edited": false, + "metadata": {}, + "tool_mode": false, + "category": "outputs", + "key": "ChatOutput", + "score": 0.003169567463043492, + "lf_version": "1.1.1" + }, + "showNode": true, + "type": "ChatOutput", + "id": "ChatOutput-HZiAI" + }, + "selected": true, + "measured": { + "width": 320, + "height": 230 + }, + "dragging": false + }, + { + "id": "LoopComponent-vFBJP", + "type": "genericNode", + "position": { + "x": 1015.8298592103808, + "y": 1230.6435424847218 + }, + "data": { + "node": { + "template": { + "_type": "Component", + "data": { + "tool_mode": false, + "trace_as_metadata": true, + "list": false, + "list_add_label": "Add More", + "trace_as_input": true, + "required": false, + "placeholder": "", + "show": true, + "name": "data", + "value": "", + "display_name": "Data", + "advanced": false, + "input_types": [ + "Data" + ], + "dynamic": false, + "info": "The initial list of Data objects to iterate over.", + "title_case": false, + "type": "other", + "_input_type": "DataInput" + }, + "loop_input": { + "tool_mode": false, + "trace_as_metadata": true, + "list": false, + "list_add_label": "Add More", + "trace_as_input": true, + "required": false, + "placeholder": "", + "show": true, + "name": "loop_input", + "value": "", + "display_name": "Loop Input", + "advanced": false, + "input_types": [ + "Data" + ], + "dynamic": false, + "info": "Data to aggregate during the iteration.", + "title_case": false, + "type": "other", + "_input_type": "DataInput" + }, + "code": { + "type": "code", + "required": true, + "placeholder": "", + "list": false, + "show": true, + "multiline": true, + "value": "from langflow.custom import Component\nfrom langflow.io import DataInput, Output\nfrom langflow.schema import Data\n\n\nclass LoopComponent(Component):\n display_name = \"Loop\"\n description = (\n \"Iterates over a list of Data objects, outputting one item at a time and aggregating results from loop inputs.\"\n )\n icon = \"infinity\"\n\n inputs = [\n DataInput(name=\"data\", display_name=\"Data\", info=\"The initial list of Data objects to iterate over.\"),\n DataInput(name=\"loop_input\", display_name=\"Loop Input\", info=\"Data to aggregate during the iteration.\"),\n ]\n\n outputs = [\n Output(display_name=\"Item\", name=\"item\", method=\"item_output\"),\n Output(display_name=\"Done\", name=\"done\", method=\"done_output\"),\n ]\n\n def initialize_data(self) -> None:\n \"\"\"Initialize the data list, context index, and aggregated list.\"\"\"\n if self.ctx.get(f\"{self._id}_initialized\", False):\n return\n\n # Ensure data is a list of Data objects\n data_list = self._validate_data(self.data)\n\n # Store the initial data and context variables\n self.update_ctx(\n {\n f\"{self._id}_data\": data_list,\n f\"{self._id}_index\": 0,\n f\"{self._id}_aggregated\": [],\n f\"{self._id}_initialized\": True,\n }\n )\n\n def _validate_data(self, data):\n \"\"\"Validate and return a list of Data objects.\"\"\"\n if isinstance(data, Data):\n return [data]\n if isinstance(data, list) and all(isinstance(item, Data) for item in data):\n return data\n msg = \"The 'data' input must be a list of Data objects or a single Data object.\"\n raise TypeError(msg)\n\n def evaluate_stop_loop(self) -> bool:\n \"\"\"Evaluate whether to stop item or done output.\"\"\"\n current_index = self.ctx.get(f\"{self._id}_index\", 0)\n data_length = len(self.ctx.get(f\"{self._id}_data\", []))\n return current_index > data_length\n\n def item_output(self) -> Data:\n \"\"\"Output the next item in the list or stop if done.\"\"\"\n self.initialize_data()\n current_item = Data(text=\"\")\n\n if self.evaluate_stop_loop():\n self.stop(\"item\")\n return Data(text=\"\")\n\n # Get data list and current index\n data_list, current_index = self.loop_variables()\n if current_index < len(data_list):\n # Output current item and increment index\n try:\n current_item = data_list[current_index]\n except IndexError:\n current_item = Data(text=\"\")\n self.aggregated_output()\n self.update_ctx({f\"{self._id}_index\": current_index + 1})\n return current_item\n\n def done_output(self) -> Data:\n \"\"\"Trigger the done output when iteration is complete.\"\"\"\n self.initialize_data()\n\n if self.evaluate_stop_loop():\n self.stop(\"item\")\n self.start(\"done\")\n\n return self.ctx.get(f\"{self._id}_aggregated\", [])\n self.stop(\"done\")\n return Data(text=\"\")\n\n def loop_variables(self):\n \"\"\"Retrieve loop variables from context.\"\"\"\n return (\n self.ctx.get(f\"{self._id}_data\", []),\n self.ctx.get(f\"{self._id}_index\", 0),\n )\n\n def aggregated_output(self) -> Data:\n \"\"\"Return the aggregated list once all items are processed.\"\"\"\n self.initialize_data()\n\n # Get data list and aggregated list\n data_list = self.ctx.get(f\"{self._id}_data\", [])\n aggregated = self.ctx.get(f\"{self._id}_aggregated\", [])\n\n # Check if loop input is provided and append to aggregated list\n if self.loop_input is not None and not isinstance(self.loop_input, str) and len(aggregated) <= len(data_list):\n aggregated.append(self.loop_input)\n self.update_ctx({f\"{self._id}_aggregated\": aggregated})\n\n return aggregated\n", + "fileTypes": [], + "file_path": "", + "password": false, + "name": "code", + "advanced": true, + "dynamic": true, + "info": "", + "load_from_db": false, + "title_case": false + } + }, + "description": "Iterates over a list of Data objects, outputting one item at a time and aggregating results from loop inputs.", + "icon": "infinity", + "base_classes": [ + "Data" + ], + "display_name": "Loop", + "documentation": "", + "minimized": false, + "custom_fields": {}, + "output_types": [], + "pinned": false, + "conditional_paths": [], + "frozen": false, + "outputs": [ + { + "types": [ + "Data" + ], + "selected": "Data", + "name": "item", + "display_name": "Item", + "method": "item_output", + "value": "__UNDEFINED__", + "cache": true + }, + { + "types": [ + "Data" + ], + "selected": "Data", + "name": "done", + "display_name": "Done", + "method": "done_output", + "value": "__UNDEFINED__", + "cache": true + } + ], + "field_order": [ + "data", + "loop_input" + ], + "beta": false, + "legacy": false, + "edited": false, + "metadata": {}, + "tool_mode": false, + "lf_version": "1.1.1" + }, + "showNode": true, + "type": "LoopComponent", + "id": "LoopComponent-vFBJP", + "description": "Iterates over a list of Data objects, outputting one item at a time and aggregating results from loop inputs.", + "display_name": "Loop" + }, + "selected": false, + "measured": { + "width": 320, + "height": 324 + }, + "dragging": false + } + ], + "edges": [ + { + "source": "ChatInput-dOD8A", + "sourceHandle": "{œdataTypeœ:œChatInputœ,œidœ:œChatInput-dOD8Aœ,œnameœ:œmessageœ,œoutput_typesœ:[œMessageœ]}", + "target": "MessagetoData-dHnzn", + "targetHandle": "{œfieldNameœ:œmessageœ,œidœ:œMessagetoData-dHnznœ,œinputTypesœ:[œMessageœ],œtypeœ:œstrœ}", + "data": { + "targetHandle": { + "fieldName": "message", + "id": "MessagetoData-dHnzn", + "inputTypes": [ + "Message" + ], + "type": "str" + }, + "sourceHandle": { + "dataType": "ChatInput", + "id": "ChatInput-dOD8A", + "name": "message", + "output_types": [ + "Message" + ] + } + }, + "id": "reactflow__edge-ChatInput-dOD8A{œdataTypeœ:œChatInputœ,œidœ:œChatInput-dOD8Aœ,œnameœ:œmessageœ,œoutput_typesœ:[œMessageœ]}-MessagetoData-dHnzn{œfieldNameœ:œmessageœ,œidœ:œMessagetoData-dHnznœ,œinputTypesœ:[œMessageœ],œtypeœ:œstrœ}", + "className": "", + "animated": false, + "selected": false + }, + { + "source": "MessagetoData-dHnzn", + "sourceHandle": "{œdataTypeœ:œMessagetoDataœ,œidœ:œMessagetoData-dHnznœ,œnameœ:œdataœ,œoutput_typesœ:[œDataœ]}", + "target": "SplitText-d7abl", + "targetHandle": "{œfieldNameœ:œdata_inputsœ,œidœ:œSplitText-d7ablœ,œinputTypesœ:[œDataœ],œtypeœ:œotherœ}", + "data": { + "targetHandle": { + "fieldName": "data_inputs", + "id": "SplitText-d7abl", + "inputTypes": [ + "Data" + ], + "type": "other" + }, + "sourceHandle": { + "dataType": "MessagetoData", + "id": "MessagetoData-dHnzn", + "name": "data", + "output_types": [ + "Data" + ] + } + }, + "id": "xy-edge__MessagetoData-dHnzn{œdataTypeœ:œMessagetoDataœ,œidœ:œMessagetoData-dHnznœ,œnameœ:œdataœ,œoutput_typesœ:[œDataœ]}-SplitText-d7abl{œfieldNameœ:œdata_inputsœ,œidœ:œSplitText-d7ablœ,œinputTypesœ:[œDataœ],œtypeœ:œotherœ}", + "animated": false, + "className": "" + }, + { + "source": "ParseData-HI264", + "sourceHandle": "{œdataTypeœ:œParseDataœ,œidœ:œParseData-HI264œ,œnameœ:œtextœ,œoutput_typesœ:[œMessageœ]}", + "target": "MessagetoData-02q2m", + "targetHandle": "{œfieldNameœ:œmessageœ,œidœ:œMessagetoData-02q2mœ,œinputTypesœ:[œMessageœ],œtypeœ:œstrœ}", + "data": { + "targetHandle": { + "fieldName": "message", + "id": "MessagetoData-02q2m", + "inputTypes": [ + "Message" + ], + "type": "str" + }, + "sourceHandle": { + "dataType": "ParseData", + "id": "ParseData-HI264", + "name": "text", + "output_types": [ + "Message" + ] + } + }, + "id": "xy-edge__ParseData-HI264{œdataTypeœ:œParseDataœ,œidœ:œParseData-HI264œ,œnameœ:œtextœ,œoutput_typesœ:[œMessageœ]}-MessagetoData-02q2m{œfieldNameœ:œmessageœ,œidœ:œMessagetoData-02q2mœ,œinputTypesœ:[œMessageœ],œtypeœ:œstrœ}", + "animated": false, + "className": "" + }, + { + "source": "ParseData-Jsbbl", + "sourceHandle": "{œdataTypeœ:œParseDataœ,œidœ:œParseData-Jsbblœ,œnameœ:œtextœ,œoutput_typesœ:[œMessageœ]}", + "target": "ChatOutput-HZiAI", + "targetHandle": "{œfieldNameœ:œinput_valueœ,œidœ:œChatOutput-HZiAIœ,œinputTypesœ:[œMessageœ],œtypeœ:œstrœ}", + "data": { + "targetHandle": { + "fieldName": "input_value", + "id": "ChatOutput-HZiAI", + "inputTypes": [ + "Message" + ], + "type": "str" + }, + "sourceHandle": { + "dataType": "ParseData", + "id": "ParseData-Jsbbl", + "name": "text", + "output_types": [ + "Message" + ] + } + }, + "id": "xy-edge__ParseData-Jsbbl{œdataTypeœ:œParseDataœ,œidœ:œParseData-Jsbblœ,œnameœ:œtextœ,œoutput_typesœ:[œMessageœ]}-ChatOutput-HZiAI{œfieldNameœ:œinput_valueœ,œidœ:œChatOutput-HZiAIœ,œinputTypesœ:[œMessageœ],œtypeœ:œstrœ}", + "animated": false, + "className": "" + }, + { + "source": "SplitText-d7abl", + "sourceHandle": "{œdataTypeœ:œSplitTextœ,œidœ:œSplitText-d7ablœ,œnameœ:œchunksœ,œoutput_typesœ:[œDataœ]}", + "target": "LoopComponent-vFBJP", + "targetHandle": "{œfieldNameœ:œdataœ,œidœ:œLoopComponent-vFBJPœ,œinputTypesœ:[œDataœ],œtypeœ:œotherœ}", + "data": { + "targetHandle": { + "fieldName": "data", + "id": "LoopComponent-vFBJP", + "inputTypes": [ + "Data" + ], + "type": "other" + }, + "sourceHandle": { + "dataType": "SplitText", + "id": "SplitText-d7abl", + "name": "chunks", + "output_types": [ + "Data" + ] + } + }, + "id": "xy-edge__SplitText-d7abl{œdataTypeœ:œSplitTextœ,œidœ:œSplitText-d7ablœ,œnameœ:œchunksœ,œoutput_typesœ:[œDataœ]}-LoopComponent-vFBJP{œfieldNameœ:œdataœ,œidœ:œLoopComponent-vFBJPœ,œinputTypesœ:[œDataœ],œtypeœ:œotherœ}", + "animated": false, + "className": "" + }, + { + "source": "MessagetoData-02q2m", + "sourceHandle": "{œdataTypeœ:œMessagetoDataœ,œidœ:œMessagetoData-02q2mœ,œnameœ:œdataœ,œoutput_typesœ:[œDataœ]}", + "target": "LoopComponent-vFBJP", + "targetHandle": "{œfieldNameœ:œloop_inputœ,œidœ:œLoopComponent-vFBJPœ,œinputTypesœ:[œDataœ],œtypeœ:œotherœ}", + "data": { + "targetHandle": { + "fieldName": "loop_input", + "id": "LoopComponent-vFBJP", + "inputTypes": [ + "Data" + ], + "type": "other" + }, + "sourceHandle": { + "dataType": "MessagetoData", + "id": "MessagetoData-02q2m", + "name": "data", + "output_types": [ + "Data" + ] + } + }, + "id": "xy-edge__MessagetoData-02q2m{œdataTypeœ:œMessagetoDataœ,œidœ:œMessagetoData-02q2mœ,œnameœ:œdataœ,œoutput_typesœ:[œDataœ]}-LoopComponent-vFBJP{œfieldNameœ:œloop_inputœ,œidœ:œLoopComponent-vFBJPœ,œinputTypesœ:[œDataœ],œtypeœ:œotherœ}", + "animated": false, + "className": "" + }, + { + "source": "LoopComponent-vFBJP", + "sourceHandle": "{œdataTypeœ:œLoopComponentœ,œidœ:œLoopComponent-vFBJPœ,œnameœ:œitemœ,œoutput_typesœ:[œDataœ]}", + "target": "ParseData-HI264", + "targetHandle": "{œfieldNameœ:œdataœ,œidœ:œParseData-HI264œ,œinputTypesœ:[œDataœ],œtypeœ:œotherœ}", + "data": { + "targetHandle": { + "fieldName": "data", + "id": "ParseData-HI264", + "inputTypes": [ + "Data" + ], + "type": "other" + }, + "sourceHandle": { + "dataType": "LoopComponent", + "id": "LoopComponent-vFBJP", + "name": "item", + "output_types": [ + "Data" + ] + } + }, + "id": "xy-edge__LoopComponent-vFBJP{œdataTypeœ:œLoopComponentœ,œidœ:œLoopComponent-vFBJPœ,œnameœ:œitemœ,œoutput_typesœ:[œDataœ]}-ParseData-HI264{œfieldNameœ:œdataœ,œidœ:œParseData-HI264œ,œinputTypesœ:[œDataœ],œtypeœ:œotherœ}", + "animated": false, + "className": "" + }, + { + "source": "LoopComponent-vFBJP", + "sourceHandle": "{œdataTypeœ:œLoopComponentœ,œidœ:œLoopComponent-vFBJPœ,œnameœ:œdoneœ,œoutput_typesœ:[œDataœ]}", + "target": "ParseData-Jsbbl", + "targetHandle": "{œfieldNameœ:œdataœ,œidœ:œParseData-Jsbblœ,œinputTypesœ:[œDataœ],œtypeœ:œotherœ}", + "data": { + "targetHandle": { + "fieldName": "data", + "id": "ParseData-Jsbbl", + "inputTypes": [ + "Data" + ], + "type": "other" + }, + "sourceHandle": { + "dataType": "LoopComponent", + "id": "LoopComponent-vFBJP", + "name": "done", + "output_types": [ + "Data" + ] + } + }, + "id": "xy-edge__LoopComponent-vFBJP{œdataTypeœ:œLoopComponentœ,œidœ:œLoopComponent-vFBJPœ,œnameœ:œdoneœ,œoutput_typesœ:[œDataœ]}-ParseData-Jsbbl{œfieldNameœ:œdataœ,œidœ:œParseData-Jsbblœ,œinputTypesœ:[œDataœ],œtypeœ:œotherœ}", + "animated": false, + "className": "" + } + ], + "viewport": { + "x": 398.35329389327603, + "y": 66.60635240558531, + "zoom": 0.4260501062620726 + } + }, + "description": "test loop", + "name": "LoopTest", + "last_tested_version": "1.1.1", + "endpoint_name": null, + "is_component": false +} \ No newline at end of file diff --git a/src/backend/tests/unit/components/logic/__init__.py b/src/backend/tests/unit/components/logic/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/src/backend/tests/unit/components/logic/test_loop.py b/src/backend/tests/unit/components/logic/test_loop.py new file mode 100644 index 000000000000..8cc6ca9d058c --- /dev/null +++ b/src/backend/tests/unit/components/logic/test_loop.py @@ -0,0 +1,90 @@ +from uuid import UUID + +import pytest +from httpx import AsyncClient +from langflow.components.logic.loop import LoopComponent +from langflow.memory import aget_messages +from langflow.schema.data import Data +from langflow.services.database.models.flow import FlowCreate +from orjson import orjson + +from tests.base import ComponentTestBaseWithClient + +TEXT = ( + "lorem ipsum dolor sit amet lorem ipsum dolor sit amet lorem ipsum dolor sit amet. " + "lorem ipsum dolor sit amet lorem ipsum dolor sit amet lorem ipsum dolor sit amet. " + "lorem ipsum dolor sit amet lorem ipsum dolor sit amet lorem ipsum dolor sit amet." +) + + +class TestLoopComponentWithAPI(ComponentTestBaseWithClient): + @pytest.fixture + def component_class(self): + """Return the component class to test.""" + return LoopComponent + + @pytest.fixture + def file_names_mapping(self): + """Return an empty list since this component doesn't have version-specific files.""" + return [] + + @pytest.fixture + def default_kwargs(self): + """Return the default kwargs for the component.""" + return { + "data": [[Data(text="Hello World")]], + "loop_input": [Data(text=TEXT)], + } + + def test_latest_version(self, default_kwargs) -> None: + """Test that the component works with the latest version.""" + result = LoopComponent(**default_kwargs) + assert result is not None, "Component returned None for the latest version." + + async def _create_flow(self, client, json_loop_test, logged_in_headers): + vector_store = orjson.loads(json_loop_test) + data = vector_store["data"] + vector_store = FlowCreate(name="Flow", description="description", data=data, endpoint_name="f") + response = await client.post("api/v1/flows/", json=vector_store.model_dump(), headers=logged_in_headers) + response.raise_for_status() + return response.json()["id"] + + async def check_messages(self, flow_id): + messages = await aget_messages(flow_id=UUID(flow_id), order="ASC") + assert len(messages) == 2 + assert messages[0].session_id == flow_id + assert messages[0].sender == "User" + assert messages[0].sender_name == "User" + assert messages[0].text != "" + assert messages[1].session_id == flow_id + assert messages[1].sender == "Machine" + assert messages[1].sender_name == "AI" + assert len(messages[1].text) > 0 + + async def test_build_flow_loop(self, client, json_loop_test, logged_in_headers): + flow_id = await self._create_flow(client, json_loop_test, logged_in_headers) + + async with client.stream("POST", f"api/v1/build/{flow_id}/flow", json={}, headers=logged_in_headers) as r: + async for line in r.aiter_lines(): + # httpx split by \n, but ndjson sends two \n for each line + if line: + # Process the line if needed + pass + + await self.check_messages(flow_id) + + async def test_run_flow_loop(self, client: AsyncClient, created_api_key, json_loop_test, logged_in_headers): + flow_id = await self._create_flow(client, json_loop_test, logged_in_headers) + headers = {"x-api-key": created_api_key.api_key} + payload = { + "input_value": TEXT, + "input_type": "chat", + "session_id": f"{flow_id}run", + "output_type": "chat", + "tweaks": {}, + } + response = await client.post(f"/api/v1/run/{flow_id}", json=payload, headers=headers) + data = response.json() + assert "outputs" in data + assert "session_id" in data + assert len(data["outputs"][-1]["outputs"]) > 0