Skip to content

Latest commit

 

History

History
161 lines (114 loc) · 8.72 KB

README.md

File metadata and controls

161 lines (114 loc) · 8.72 KB
Raw

Bee Framework logo

Bee Agent Framework

Project Status: Alpha

Open-source framework for building, deploying, and serving powerful agentic workflows at scale.

The Bee Agent Framework makes it easy to build scalable agent-based workflows with your model of choice. The framework is been designed to perform robustly with IBM Granite and Llama 3.x models, and we're actively working on optimizing its performance with other popular LLMs.

Our goal is to empower developers to adopt the latest open-source and proprietary models with minimal changes to their current agent implementation.

Key Features

Getting started

Tip

🚀 Would you like a fully set-up TypeScript project with Bee, Code Interpreter, and Observability? Check out our Bee Framework Starter.

Tip

🚀 Would you like to work with Bee in your web browser? See Bee Stack

Installation

npm install bee-agent-framework

or

yarn add bee-agent-framework

Example

import { BeeAgent } from "bee-agent-framework/agents/bee/agent";
import { OllamaChatLLM } from "bee-agent-framework/adapters/ollama/chat";
import { TokenMemory } from "bee-agent-framework/memory/tokenMemory";
import { DuckDuckGoSearchTool } from "bee-agent-framework/tools/search/duckDuckGoSearch";
import { OpenMeteoTool } from "bee-agent-framework/tools/weather/openMeteo";

const llm = new OllamaChatLLM(); // default is llama3.1 (8B), it is recommended to use 70B model

const agent = new BeeAgent({
  llm, // for more explore 'bee-agent-framework/adapters'
  memory: new TokenMemory({ llm }), // for more explore 'bee-agent-framework/memory'
  tools: [new DuckDuckGoSearchTool(), new OpenMeteoTool()], // for more explore 'bee-agent-framework/tools'
});

const response = await agent
  .run({ prompt: "What's the current weather in Las Vegas?" })
  .observe((emitter) => {
    emitter.on("update", async ({ data, update, meta }) => {
      console.log(`Agent (${update.key}) 🤖 : `, update.value);
    });
  });

console.log(`Agent 🤖 : `, response.result.text);

➡️ See a more advanced example.

➡️ you can run this example after local installation, using the command yarn start examples/agents/simple.ts

Tip

To run this example, be sure that you have installed ollama with the llama3.1 model downloaded.

Tip

Documentation is available at https://i-am-bee.github.io/bee-agent-framework/

Local Installation

Note

yarn should be installed via Corepack (tutorial)

  1. Clone the repository git clone git@github.com:i-am-bee/bee-agent-framework.
  2. Install dependencies yarn install --immutable && yarn prepare.
  3. Create .env (from .env.template) and fill in missing values (if any).
  4. Start the agent yarn run start:bee (it runs /examples/agents/bee.ts file).

➡️ All examples can be found in the examples directory.

➡️ To run an arbitrary example, use the following command yarn start examples/agents/bee.ts (just pass the appropriate path to the desired example).

📦 Modules

The source directory (src) provides numerous modules that one can use.

Name Description
agents Base classes defining the common interface for agent.
llms Base classes defining the common interface for text inference (standard or chat).
template Prompt Templating system based on Mustache with various improvements.
memory Various types of memories to use with agent.
tools Tools that an agent can use.
cache Preset of different caching approaches that can be used together with tools.
errors Error classes and helpers to catch errors fast.
adapters Concrete implementations of given modules for different environments.
logger Core component for logging all actions within the framework.
serializer Core component for the ability to serialize/deserialize modules into the serialized format.
version Constants representing the framework (e.g., latest version)
emitter Bringing visibility to the system by emitting events.
internals Modules used by other modules within the framework.

To see more in-depth explanation see overview.

Tutorials

🚧 Coming soon 🚧

Roadmap

  • Bee agent performance optimization with additional models
  • Examples, tutorials, and docs
  • Improvements to building custom agents
  • Multi-agent orchestration

Contribution guidelines

The Bee Agent Framework is an open-source project and we ❤️ contributions.

If you'd like to contribute to Bee, please take a look at our contribution guidelines.

Bugs

We are using GitHub Issues to manage our public bugs. We keep a close eye on this, so before filing a new issue, please check to make sure it hasn't already been logged.

Code of conduct

This project and everyone participating in it are governed by the Code of Conduct. By participating, you are expected to uphold this code. Please read the full text so that you can read which actions may or may not be tolerated.

Legal notice

All content in these repositories including code has been provided by IBM under the associated open source software license and IBM is under no obligation to provide enhancements, updates, or support. IBM developers produced this code as an open source project (not as an IBM product), and IBM makes no assertions as to the level of quality nor security, and will not be maintaining this code going forward.

Contributors

Special thanks to our contributors for helping us improve Bee Agent Framework.

Contributors list