primisai 0.4.1

Nexus is a powerful and flexible Python package for managing AI agents and coordinating complex tasks using LLMs.

PrimisAI Nexus

PrimisAI Nexus is a powerful and flexible Python package for managing AI agents and coordinating complex tasks using LLMs. It provides a robust framework for creating, managing, and interacting with multiple specialized AI agents under the supervision of a central coordinator.

Features

• AI Base Class: A foundational class for AI interactions.
• Agent Class: Extends the AI base class with additional features for specialized tasks.
• Supervisor Class: Manages multiple agents, coordinates tasks, and handles user interactions.
• Debugger Utility: Integrated debugging capabilities for logging and troubleshooting.
• Flexible Configuration: Easy-to-use configuration options for language models and agents.
• Interactive Sessions: Built-in support for interactive chat sessions with the AI system.
• YAML Configuration: Define complex agent hierarchies using YAML files for easy setup and modification.

Installation

You can install PrimisAI Nexus directly from PyPI using pip:

pip install primisai

Building from Source

If you prefer to build the package from source, clone the repository and install it with pip:

git clone [e-mail]:PrimisAI/nexus.git
cd nexus
pip install -e .

Quick Start

Here's a simple example to get you started with Nexus:

from primisai.nexus.core import AI, Agent, Supervisor
from primisai.nexus.utils.debugger import Debugger

# Configure your OpenAI API key
llm_config = {
    "api_key": "your-api-key-here",
    "model": "gpt-4o",
    "base_url": "https://api.openai.com/v1",
}

# Create a supervisor
supervisor = Supervisor("MainSupervisor", llm_config)

# Create and register agents
agent1 = Agent("Agent1", llm_config, system_message="You are a helpful assistant.")
agent2 = Agent("Agent2", llm_config, system_message="You are a creative writer.")

supervisor.register_agent(agent1)
supervisor.register_agent(agent2)

# Start an interactive session
supervisor.display_agent_graph()
supervisor.start_interactive_session()

YAML Configuration

PrimisAI Nexus supports defining complex agent hierarchies using YAML configuration files. This feature allows for easy setup and modification of agent structures without changing the Python code.

Example YAML Configuration

Here's a simple example of a YAML configuration file:

supervisor:
  name: TaskManager
  type: supervisor
  llm_config:
    model: ${LLM_MODEL}
    api_key: ${LLM_API_KEY}
    base_url: ${LLM_BASE_URL}
  system_message: "You are the task management supervisor."
  children:
    - name: TaskCreator
      type: agent
      llm_config:
        model: ${LLM_MODEL}
        api_key: ${LLM_API_KEY}
        base_url: ${LLM_BASE_URL}
      system_message: "You are responsible for creating new tasks."
      tools:
        - name: add_task
          type: function
          python_path: examples.task_management_with_yaml.task_tools.add_task

To use this YAML configuration:

from primisai.nexus.config import load_yaml_config, AgentFactory

# Load the YAML configuration
config = load_yaml_config('path/to/your/config.yaml')

# Create the agent structure
factory = AgentFactory()
task_manager = factory.create_from_config(config)

# Start an interactive session
task_manager.start_interactive_session()

For a more detailed example of YAML configuration, check out the task management example.

Benefits of YAML Configuration

• Flexibility: Easily modify agent structures without changing Python code.
• Readability: YAML configurations are human-readable and easy to understand.
• Scalability: Define complex hierarchies of supervisors and agents in a clear, structured manner.
• Separation of Concerns: Keep agent definitions separate from application logic.

Documentation

For detailed documentation on each module and class, please refer to the inline docstrings in the source code.

Advanced Usage

PrimisAI Nexus allows for complex interactions between multiple agents. You can create specialized agents for different tasks, register them with a supervisor, and let the supervisor manage the flow of information and task delegation.

# Example of creating a specialized agent with tools
tools = [
    {
        "metadata": {
            "name": "search_tool",
            "description": "Searches the internet for information"
        },
        "tool": some_search_function
    }
]

research_agent = Agent("Researcher", llm_config, tools=tools, system_message="You are a research assistant.", use_tools=True)
supervisor.register_agent(research_agent)

Citation

If you find Nexus useful, please consider citing our preprint.

@article{sami2025nexus,
  title={Nexus: A Lightweight and Scalable Multi-Agent Framework for Complex Tasks Automation},
  author={Sami, Humza and ul Islam, Mubashir and Charas, Samy and Gandhi, Asav and Gaillardon, Pierre-Emmanuel and Tenace, Valerio},
  journal={arXiv preprint arXiv:2502.19091},
  year={2025}
}

License

This project is licensed under the MIT License.