Metadata-Version: 2.4
Name: flowllm
Version: 0.1.0
Summary: build llm flow
License:                                  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
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright 2024 Alibaba Group
        
           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.
        
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dashscope>=1.19.1
Requires-Dist: elasticsearch>=8.14.0
Requires-Dist: fastapi>=0.115.13
Requires-Dist: fastmcp>=2.10.6
Requires-Dist: loguru>=0.7.3
Requires-Dist: mcp>=1.9.4
Requires-Dist: numpy>=2.3.0
Requires-Dist: openai>=1.88.0
Requires-Dist: pydantic>=2.11.7
Requires-Dist: PyYAML>=6.0.2
Requires-Dist: Requests>=2.32.4
Requires-Dist: uvicorn>=0.34.3
Requires-Dist: setuptools>=75.0
Dynamic: license-file

# LLMFlow

[![Python](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)

LLMFlow is a flexible large language model workflow framework that provides a modular pipeline architecture for building complex AI applications. The framework supports multiple LLM providers, vector storage backends, and tool integrations, enabling you to easily build Retrieval-Augmented Generation (RAG), intelligent agents, and other AI-powered applications.

## 🚀 Key Features

### 🔧 Modular Architecture
- **Pipeline System**: Flexible pipeline configuration supporting both serial and parallel operations
- **Operation Registry**: Extensible operation registry with support for custom operations
- **Configuration-Driven**: Manage entire applications through YAML configuration files

### 🤖 LLM Support
- **Multi-Provider Compatible**: Support for OpenAI-compatible APIs
- **Streaming Responses**: Real-time streaming output support
- **Tool Calling**: Built-in tool calling and parallel execution support
- **Reasoning Mode**: Chain-of-thought reasoning support

### 📚 Vector Storage
- **Multi-Backend Support**: 
  - Elasticsearch
  - ChromaDB
  - Local file storage
- **Embedding Models**: Support for multiple embedding models
- **Workspace Management**: Multi-tenant vector storage management

### 🛠️ Rich Tool Ecosystem
- **Code Execution**: Python code execution tool
- **Web Search**: Integrated Tavily and DashScope search
- **MCP Protocol**: Model Context Protocol support
- **Termination Control**: Intelligent conversation termination management

### 🌐 API Services
- **RESTful API**: FastAPI-powered HTTP services
- **MCP Server**: Model Context Protocol server support
- **Multiple Endpoints**: Retriever, summarizer, vector store, agent APIs

## 📦 Installation

### Prerequisites
- Python 3.12+
- pip or poetry

### Installation Steps

```bash
# Clone the repository
git clone https://github.com/your-username/llmflow.git
cd llmflow

# Install dependencies
pip install -e .

# Or using poetry
poetry install
```

### Environment Configuration

Copy the environment template:
```bash
cp example.env .env
```

Edit the `.env` file to configure necessary API keys:

```bash
# LLM Configuration
LLM_API_KEY=sk-your-llm-api-key
LLM_BASE_URL=https://your-llm-endpoint/v1

# Embedding Model Configuration
EMBEDDING_API_KEY=sk-your-embedding-api-key
EMBEDDING_BASE_URL=https://your-embedding-endpoint/v1

# Elasticsearch (Optional)
ES_HOSTS=http://localhost:9200

# DashScope Search (Optional)
DASHSCOPE_API_KEY=sk-your-dashscope-key
```

## 🏃 Quick Start

### 1. Start HTTP Service

```bash
llmflow \
  http_service.port=8001 \
  llm.default.model_name=qwen3-32b \
  embedding_model.default.model_name=text-embedding-v4 \
  vector_store.default.backend=local_file
```

### 2. Start MCP Server

```bash
llmflow_mcp \
  mcp_transport=stdio \
  http_service.port=8001 \
  llm.default.model_name=qwen3-32b \
  embedding_model.default.model_name=text-embedding-v4 \
  vector_store.default.backend=local_file
```

### 3. API Usage Examples

#### Retriever API
```python
import requests

response = requests.post('http://localhost:8001/retriever', json={
    "query": "What is artificial intelligence?",
    "top_k": 5,
    "workspace_id": "default",
    "config": {}
})
print(response.json())
```

#### Agent API
```python
response = requests.post('http://localhost:8001/agent', json={
    "query": "Help me search for the latest AI technology trends",
    "workspace_id": "default",
    "config": {}
})
print(response.json())
```

## ⚙️ Configuration Guide

### Pipeline Configuration Syntax

LLMFlow uses an intuitive string syntax to define operation pipelines:

```yaml
api:
  # Serial execution: op1 -> op2 -> op3
  retriever: recall_vector_store_op->summarizer_op
  
  # Parallel execution: [op1 | op2] runs in parallel
  summarizer: mock1_op->[mock4_op->mock2_op|mock5_op]->mock3_op
  
  # Mixed mode: combination of serial and parallel
  agent: react_v1_op
```

### Complete Configuration Example

```yaml
# HTTP Service Configuration
http_service:
  host: "0.0.0.0"
  port: 8001
  timeout_keep_alive: 600
  limit_concurrency: 64

# Thread Pool Configuration
thread_pool:
  max_workers: 10

# API Pipeline Definitions
api:
  retriever: recall_vector_store_op
  summarizer: update_vector_store_op
  vector_store: vector_store_action_op
  agent: react_v1_op

# Operation Configuration
op:
  react_v1_op:
    backend: react_v1_op
    llm: default
    params:
      max_steps: 10
      tool_names: "code_tool,tavily_search_tool,terminate_tool"

# LLM Configuration
llm:
  default:
    backend: openai_compatible
    model_name: qwen3-32b
    params:
      temperature: 0.6
      max_retries: 5

# Embedding Model Configuration
embedding_model:
  default:
    backend: openai_compatible
    model_name: text-embedding-v4
    params:
      dimensions: 1024

# Vector Store Configuration
vector_store:
  default:
    backend: local_file  # or elasticsearch, chroma
    embedding_model: default
    params:
      store_dir: "./vector_store_data"
```

## 🧩 Architecture Design

### Core Components

```
┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   FastAPI App   │    │   MCP Server    │    │  Configuration  │
│                 │    │                 │    │     Parser      │
└─────────────────┘    └─────────────────┘    └─────────────────┘
         │                       │                       │
         └───────────────────────┼───────────────────────┘
                                 │
                    ┌─────────────────┐
                    │  LLMFlow Service │
                    └─────────────────┘
                             │
                    ┌─────────────────┐
                    │    Pipeline     │
                    │    Context      │
                    └─────────────────┘
                             │
         ┌───────────────────┼───────────────────┐
         │                   │                   │
┌─────────────┐    ┌─────────────┐    ┌─────────────┐
│ Operations  │    │    Tools    │    │Vector Stores│
│             │    │             │    │             │
│ • ReAct     │    │ • Code      │    │ • File      │
│ • Recall    │    │ • Search    │    │ • ES        │
│ • Update    │    │ • MCP       │    │ • Chroma    │
│ • Mock      │    │ • Terminate │    │             │
└─────────────┘    └─────────────┘    └─────────────┘
```

### Data Flow

```
Request → Configuration → Pipeline → Operations → Tools/VectorStore → Response
```

## 🔧 Development Guide

### Custom Operations

```python
from llmflow.op import OP_REGISTRY
from llmflow.op.base_op import BaseOp

@OP_REGISTRY.register()
class CustomOp(BaseOp):
    def execute(self):
        # Implement your custom logic
        request = self.context.request
        response = self.context.response
        
        # Process request
        result = self.process_data(request.query)
        
        # Update response
        response.metadata["custom_result"] = result
```

### Custom Tools

```python
from llmflow.tool import TOOL_REGISTRY
from llmflow.tool.base_tool import BaseTool

@TOOL_REGISTRY.register()
class CustomTool(BaseTool):
    name: str = "custom_tool"
    description: str = "Custom tool description"
    parameters: dict = {
        "type": "object",
        "properties": {
            "input": {"type": "string", "description": "Input parameter"}
        },
        "required": ["input"]
    }
    
    def _execute(self, input: str, **kwargs):
        # Implement tool logic
        return f"Processing result: {input}"
```

### Custom Vector Stores

```python
from llmflow.vector_store import VECTOR_STORE_REGISTRY
from llmflow.vector_store.base_vector_store import BaseVectorStore

@VECTOR_STORE_REGISTRY.register("custom_store")
class CustomVectorStore(BaseVectorStore):
    def search(self, query: str, top_k: int = 10, **kwargs):
        # Implement search logic
        pass
    
    def insert(self, nodes: List[VectorNode], **kwargs):
        # Implement insertion logic
        pass
```

## 🧪 Testing

```bash
# Run tests
pytest

# Run specific tests
pytest tests/test_pipeline.py

# Generate coverage report
pytest --cov=llmflow tests/
```

## 🤝 Contributing

We welcome community contributions! Please follow these steps:

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

### Development Environment Setup

```bash
# Install development dependencies
pip install -e ".[dev]"

# Install pre-commit hooks
pre-commit install

# Run code formatting
black llmflow/
isort llmflow/

# Run type checking
mypy llmflow/
```

## 📚 Documentation

- [API Documentation](docs/api.md)
- [Configuration Guide](docs/configuration.md)
- [Operations Development](docs/operations.md)
- [Tools Development](docs/tools.md)
- [Deployment Guide](docs/deployment.md)

## 🐛 Bug Reports

If you find bugs or have feature requests, please create an issue on [GitHub Issues](https://github.com/your-username/llmflow/issues).

## 📄 License

This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.

## 🙏 Acknowledgments

Thanks to all developers and community members who have contributed to the LLMFlow project.

---

**LLMFlow** - Making AI workflow development simple and powerful 🚀
