mseep-txtai 9.1.1__py3-none-any.whl

mseep_txtai-9.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2020- NeuML LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mseep_txtai-9.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+txtai

txtai/__init__.py

@@ -0,0 +1,16 @@
+"""
+Base imports
+"""
+
+import logging
+
+# Top-level imports
+from .agent import Agent
+from .app import Application
+from .embeddings import Embeddings
+from .pipeline import LLM, RAG
+from .workflow import Workflow
+
+# Configure logging per standard Python library recommendations
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())

txtai/agent/__init__.py

@@ -0,0 +1,12 @@
+"""
+Agent imports
+"""
+
+# Conditional import
+try:
+    from .base import Agent
+    from .factory import ProcessFactory
+    from .model import PipelineModel
+    from .tool import *
+except ImportError:
+    from .placeholder import Agent

txtai/agent/base.py

@@ -0,0 +1,54 @@
+"""
+Agent module
+"""
+
+from .factory import ProcessFactory
+
+
+class Agent:
+    """
+    An agent automatically creates workflows to answer multi-faceted user requests. Agents iteratively prompt and/or interface with tools to
+    step through a process and ultimately come to an answer for a request.
+
+    Agents excel at complex tasks where multiple tools and/or methods are required. They incorporate a level of randomness similar to different
+    people working on the same task. When the request is simple and/or there is a rule-based process, other methods such as RAG and Workflows
+    should be explored.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Creates a new Agent.
+
+        Args:
+            kwargs: arguments to pass to the underlying Agent backend and LLM pipeline instance
+        """
+
+        # Ensure backwards compatibility
+        if "max_iterations" in kwargs:
+            kwargs["max_steps"] = kwargs.pop("max_iterations")
+
+        # Create agent process runner
+        self.process = ProcessFactory.create(kwargs)
+
+        # Tools dictionary
+        self.tools = self.process.tools
+
+    def __call__(self, text, maxlength=8192, stream=False, **kwargs):
+        """
+        Runs an agent loop.
+
+        Args:
+            text: instructions to run
+            maxlength: maximum sequence length
+            stream: stream response if True, defaults to False
+            kwargs: additional keyword arguments
+
+        Returns:
+            result
+        """
+
+        # Process parameters
+        self.process.model.parameters(maxlength)
+
+        # Run agent loop
+        return self.process.run(text, stream=stream, **kwargs)

txtai/agent/factory.py

@@ -0,0 +1,39 @@
+"""
+Factory module
+"""
+
+from smolagents import CodeAgent, ToolCallingAgent
+
+from .model import PipelineModel
+from .tool import ToolFactory
+
+
+class ProcessFactory:
+    """
+    Methods to create agent processes.
+    """
+
+    @staticmethod
+    def create(config):
+        """
+        Create an agent process runner. The agent process runner takes a list of tools and an LLM
+        and executes an agent process flow.
+
+        Args:
+            config: agent configuration
+
+        Returns:
+            agent process runner
+        """
+
+        constructor = ToolCallingAgent
+        method = config.pop("method", None)
+        if method == "code":
+            constructor = CodeAgent
+
+        # Create model backed by LLM pipeline
+        model = config.pop("model", config.pop("llm", None))
+        model = PipelineModel(**model) if isinstance(model, dict) else PipelineModel(model)
+
+        # Create the agent process
+        return constructor(tools=ToolFactory.create(config), model=model, **config)

txtai/agent/model.py

@@ -0,0 +1,107 @@
+"""
+Model module
+"""
+
+import re
+
+from enum import Enum
+
+from smolagents import ChatMessage, Model, get_clean_message_list, tool_role_conversions
+from smolagents.models import get_tool_call_from_text, remove_stop_sequences
+
+from ..pipeline import LLM
+
+
+class PipelineModel(Model):
+    """
+    Model backed by a LLM pipeline.
+    """
+
+    def __init__(self, path=None, method=None, **kwargs):
+        """
+        Creates a new LLM model.
+
+        Args:
+            path: model path or instance
+            method: llm model framework, infers from path if not provided
+            kwargs: model keyword arguments
+        """
+
+        self.llm = path if isinstance(path, LLM) else LLM(path, method, **kwargs)
+        self.maxlength = 8192
+
+        # Set base class parameters
+        self.model_id = self.llm.generator.path
+
+        # Call parent constructor
+        super().__init__(flatten_messages_as_text=not self.llm.isvision(), **kwargs)
+
+    # pylint: disable=W0613
+    def generate(self, messages, stop_sequences=None, response_format=None, tools_to_call_from=None, **kwargs):
+        """
+        Runs LLM inference. This method signature must match the smolagents specification.
+
+        Args:
+            messages: list of messages to run
+            stop_sequences: optional list of stop sequences
+            response_format: response format to use in the model's response.
+            tools_to_call_from: list of tools that the model can use to generate responses.
+            kwargs: additional keyword arguments
+
+        Returns:
+            result
+        """
+
+        # Get clean message list
+        messages = self.clean(messages)
+
+        # Get LLM output
+        response = self.llm(messages, maxlength=self.maxlength, stop=stop_sequences, **kwargs)
+
+        # Remove stop sequences from LLM output
+        if stop_sequences is not None:
+            response = remove_stop_sequences(response, stop_sequences)
+
+        # Load response into a chat message
+        message = ChatMessage(role="assistant", content=response)
+
+        # Extract first tool action, if necessary
+        if tools_to_call_from:
+            message.tool_calls = [
+                get_tool_call_from_text(
+                    re.sub(r".*?Action:(.*?\n\}).*", r"\1", response, flags=re.DOTALL), self.tool_name_key, self.tool_arguments_key
+                )
+            ]
+
+        return message
+
+    def parameters(self, maxlength):
+        """
+        Set LLM inference parameters.
+
+        Args:
+            maxlength: maximum sequence length
+        """
+
+        self.maxlength = maxlength
+
+    def clean(self, messages):
+        """
+        Gets a clean message list.
+
+        Args:
+            messages: input messages
+
+        Returns:
+            clean messages
+        """
+
+        # Get clean message list
+        messages = get_clean_message_list(messages, role_conversions=tool_role_conversions, flatten_messages_as_text=self.flatten_messages_as_text)
+
+        # Ensure all roles are strings and not enums for compability across LLM frameworks
+        for message in messages:
+            if "role" in message:
+                message["role"] = message["role"].value if isinstance(message["role"], Enum) else message["role"]
+
+        return messages

txtai/agent/placeholder.py

@@ -0,0 +1,16 @@
+"""
+Placeholder module
+"""
+
+
+class Agent:
+    """
+    Agent placeholder stub for when smolagents isn't installed
+    """
+
+    def __init__(self, *args, **kwargs):
+        """
+        Raises an exception that smolagents isn't installed.
+        """
+
+        raise ImportError('smolagents is not available - install "agent" extra to enable')

txtai/agent/tool/__init__.py

@@ -0,0 +1,7 @@
+"""
+Tool imports
+"""
+
+from .embeddings import EmbeddingsTool
+from .factory import ToolFactory
+from .function import FunctionTool

txtai/agent/tool/embeddings.py

@@ -0,0 +1,69 @@
+"""
+Embeddings module
+"""
+
+from smolagents import Tool
+
+from ...embeddings import Embeddings
+
+
+class EmbeddingsTool(Tool):
+    """
+    Tool to execute an Embeddings search.
+    """
+
+    def __init__(self, config):
+        """
+        Creates a new EmbeddingsTool.
+
+        Args:
+            config: embeddings tool configuration
+        """
+
+        # Tool parameters
+        self.name = config["name"]
+        self.description = f"""{config['description']}. Results are returned as a list of dict elements.
+Each result has keys 'id', 'text', 'score'."""
+
+        # Input and output descriptions
+        self.inputs = {"query": {"type": "string", "description": "The search query to perform."}}
+        self.output_type = "any"
+
+        # Load embeddings instance
+        self.embeddings = self.load(config)
+
+        # Validate parameters and initialize tool
+        super().__init__()
+
+    # pylint: disable=W0221
+    def forward(self, query):
+        """
+        Runs a search.
+
+        Args:
+            query: input query
+
+        Returns:
+            search results
+        """
+
+        return self.embeddings.search(query, 5)
+
+    def load(self, config):
+        """
+        Loads an embeddings instance from config.
+
+        Args:
+            config: embeddings tool configuration
+
+        Returns:
+            Embeddings
+        """
+
+        if "target" in config:
+            return config["target"]
+
+        embeddings = Embeddings()
+        embeddings.load(**config)
+
+        return embeddings

txtai/agent/tool/factory.py

@@ -0,0 +1,130 @@
+"""
+Factory module
+"""
+
+import inspect
+
+from types import FunctionType, MethodType
+
+import mcpadapt.core
+
+from mcpadapt.smolagents_adapter import SmolAgentsAdapter
+from smolagents import PythonInterpreterTool, Tool, tool as CreateTool, VisitWebpageTool, WebSearchTool
+from transformers.utils import chat_template_utils, TypeHintParsingException
+
+from ...embeddings import Embeddings
+from .embeddings import EmbeddingsTool
+from .function import FunctionTool
+
+
+class ToolFactory:
+    """
+    Methods to create tools.
+    """
+
+    # Default toolkit
+    DEFAULTS = {"python": PythonInterpreterTool(), "websearch": WebSearchTool(), "webview": VisitWebpageTool()}
+
+    @staticmethod
+    def create(config):
+        """
+        Creates a new list of tools. This method iterates of the `tools` configuration option and creates a Tool instance
+        for each entry. This supports the following:
+
+          - Tool instance
+          - Dictionary with `name`, `description`, `inputs`, `output` and `target` function configuration
+          - String with a tool alias name
+
+        Returns:
+            list of tools
+        """
+
+        tools = []
+        for tool in config.pop("tools", []):
+            # Create tool from function and it's documentation
+            if not isinstance(tool, Tool) and (isinstance(tool, (FunctionType, MethodType)) or hasattr(tool, "__call__")):
+                tool = ToolFactory.createtool(tool)
+
+            # Create tool from input dictionary
+            elif isinstance(tool, dict):
+                # Get target function
+                target = tool.get("target")
+
+                # Create tool from input dictionary
+                tool = (
+                    EmbeddingsTool(tool)
+                    if isinstance(target, Embeddings) or any(x in tool for x in ["container", "path"])
+                    else ToolFactory.createtool(target, tool)
+                )
+
+            # Get default tool, if applicable
+            elif isinstance(tool, str) and tool in ToolFactory.DEFAULTS:
+                tool = ToolFactory.DEFAULTS[tool]
+
+            # Support importing MCP tool collections
+            elif isinstance(tool, str) and tool.startswith("http"):
+                tools.extend(mcpadapt.core.MCPAdapt({"url": tool}, SmolAgentsAdapter()).tools())
+                tool = None
+
+            # Add tool
+            if tool:
+                tools.append(tool)
+
+        return tools
+
+    @staticmethod
+    def createtool(target, config=None):
+        """
+        Creates a new Tool.
+
+        Args:
+            target: target object or function
+            config: optional tool configuration
+
+        Returns:
+            Tool
+        """
+
+        try:
+            # Try to create using CreateTool function - this fails when no annotations are available
+            return CreateTool(target)
+        except (TypeHintParsingException, TypeError):
+            return ToolFactory.fromdocs(target, config if config else {})
+
+    @staticmethod
+    def fromdocs(target, config):
+        """
+        Creates a tool from method documentation.
+
+        Args:
+            target: target object or function
+            config: tool configuration
+
+        Returns:
+            Tool
+        """
+
+        # Get function name and target - use target if it's a function or method, else use target.__call__
+        name = target.__name__ if isinstance(target, (FunctionType, MethodType)) or not hasattr(target, "__call__") else target.__class__.__name__
+        target = target if isinstance(target, (FunctionType, MethodType)) or not hasattr(target, "__call__") else target.__call__
+
+        # Extract target documentation
+        doc = inspect.getdoc(target)
+        description, parameters, _ = chat_template_utils.parse_google_format_docstring(doc.strip()) if doc else (None, {}, None)
+
+        # Get list of required parameters
+        signature = inspect.signature(target)
+        inputs = {}
+        for pname, param in signature.parameters.items():
+            if param.default == inspect.Parameter.empty and pname in parameters:
+                inputs[pname] = {"type": "any", "description": parameters[pname]}
+
+        # Create function tool
+        return FunctionTool(
+            {
+                "name": config.get("name", name.lower()),
+                "description": config.get("description", description),
+                "inputs": config.get("inputs", inputs),
+                "target": config.get("target", target),
+            }
+        )