README.md

Bee Agent Framework Examples

This repository contains examples demonstrating the usage of the Bee Agent Framework, a toolkit for building AI agents and applications.

Table of Contents

1. Agents
2. Cache
3. Errors
4. Helpers
5. LLMs (Language Models)
6. Logger
7. Memory
8. Serialization
9. Templates
10. Tools

Agents

• bee.ts: Basic Bee Agent implementation
• bee_advanced.ts: Advanced Bee Agent with custom configurations
• bee_reusable.ts: Demonstration of serializing and reusing Bee Agents
• custom_agent.ts: Example of creating a custom agent
• granite_bee.ts: Basic Bee Agent using an IBM Granite LLM
• granite_wiki_bee.ts: Advanced Bee Agent using an IBM Granite LLM with wikipedia retrieval
• simple.ts: Simple agent implementation
• sql.ts: Agent for SQL-related tasks

Cache

• cacheFn.ts: Function caching example
• custom.ts: Custom cache implementation
• decoratorCache.ts: Cache decorator usage
• decoratorCacheComplex.ts: Complex cache decorator example
• fileCache.ts: File-based caching
• fileCacheCustomProvider.ts: Custom provider for file cache
• llmCache.ts: Caching for language models
• slidingCache.ts: Sliding window cache implementation
• toolCache.ts: Caching for tools
• unconstrainedCache.ts: Unconstrained cache example
• unconstrainedCacheFunction.ts: Function using unconstrained cache

Errors

• base.ts: Basic error handling
• cast.ts: Error casting example
• tool.ts: Tool-specific error handling

Helpers

• io.ts: Input/Output helpers
• setup.ts: Setup utilities

LLMs (Language Models)

• chat.ts: Chat-based language model usage
• chatCallback.ts: Callbacks for chat models
• chatStream.ts: Streaming with chat models
• structured.ts: Structured output from language models
• text.ts: Text-based language model usage

LLM Providers

• bam.ts: BAM language model integration
• bam_verbose.ts: Verbose BAM model usage
• customChatProvider.ts: Custom chat provider implementation
• customProvider.ts: Custom language model provider
• groq.ts: Groq language model integration
• ibm-vllm.ts: IBM vLLM integration
• langchain.ts: LangChain integration
• ollama.ts: Ollama model usage
• openai.ts: OpenAI integration
• watsonx.ts: WatsonX integration
• watsonx_verbose.ts: Verbose WatsonX usage

Logger

• agent.ts: Agent-specific logging
• base.ts: Basic logging setup
• pino.ts: Pino logger integration

Memory

• agentMemory.ts: Memory management for agents
• custom.ts: Custom memory implementation
• llmMemory.ts: Memory for language models
• slidingMemory.ts: Sliding window memory
• summarizeMemory.ts: Memory with summarization
• tokenMemory.ts: Token-based memory
• unconstrainedMemory.ts: Unconstrained memory example

Serialization

• base.ts: Basic serialization
• context.ts: Context serialization
• customExternal.ts: Custom external serialization
• customInternal.ts: Custom internal serialization
• memory.ts: Memory serialization

Templates

• arrays.ts: Array-based templates
• forking.ts: Template forking
• functions.ts: Function-based templates
• objects.ts: Object-based templates
• primitives.ts: Primitive data type templates

Tools

• advanced.ts: Advanced tool usage
• agent.ts: Agent-specific tools
• base.ts: Basic tool implementation

Custom Tools

• base.ts: Custom tool base implementation

• dynamic.ts: Dynamic tool creation

• openLibrary.ts: OpenLibrary API tool

• python.ts: Python-based custom tool

• langchain.ts: LangChain tool integration

Additional Files

• tsconfig.json: TypeScript configuration
• version.ts: Framework version information

Usage

To run these examples, make sure you have the Bee Agent Framework cloned and properly configured. Each file demonstrates a specific feature or use case of the framework. You can run individual examples using Node.js with TypeScript support.

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 file (from .env.template) and fill in missing values (if any).

4. Run an arbitrary example, use the following command:

   yarn start examples/path/to/example.ts
   

For more detailed information on the Bee Agent Framework, please refer to the documentation.

Tip

To run examples that use Ollama, be sure that you have installed Ollama with the llama3.1 model downloaded.