bee-observe-connector

Bee Observe Connector

Observability connector for Bee Agent Framework

This package allows you to easily join the Bee Agent Framework and Bee Observe with the one exported function.

Table of Contents

• 👩‍💻 Get started with Observe

• Installation
• Usage
• Limitations

• 🪑 Local set-up

• Prerequisites
• Steps

• 🚀 Run

• Run examples

• 🧪 Run tests
• Code of conduct
• Legal notice
• 📖 Docs

Getting started

Installation

npm install bee-observe-connector

or

yarn add bee-observe-connector

Usage

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";
import { createObserveConnector } from "@peri/bee-observe-connector";

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

const agent = new BeeAgent({
  llm,
  memory: new TokenMemory({ llm }),
  tools: [new DuckDuckGoSearchTool(), new OpenMeteoTool()],
});

const prompt = "What's the current weather in Las Vegas?";

await agent
  .run({ prompt })
  .middleware(createObserveConnector({
    api: {
      baseUrl: 'http://localhost:3001',
      apiAuthKey: 'xxx'
    },
    cb: async (err, data) => {
      if (err) {
        if (err instanceof ObserveError) {
          console.log(err.explain());
        } else {
          console.error(err);
        }
      } else {
        console.log(data);
      }
    },
  }));

For more information about Agent setting see the Bee Agent Framework README.md file or go to the Run examples section.

Limitations

• Max request time 10s = The connector sends the trace data to the Observe API. It uses the signal propagated from the Framework and the default signal with a timeout of 10 seconds.

Local set-up

Prerequisites

• Node.js (version managed using nvm)
• Yarn package manager (corepack)
• Git
• Docker distribution with support for compose is required, the following are supported:
  • Docker
  • Rancher - macOS users may want to use VZ instead of QEMU
  • Podman - requires compose and rootful machine (if your current machine is rootless, please create a new one)

Steps

• Clone the repository:

git clone [e-mail]:Incubation/bee-observe-connector.git
cd bee-observe-connector

• Use the appropriate Node.js version:

nvm use

• Install dependencies

yarn

• Run infra To start all necessary services like observe API, redis, mongo and mlflow run this command:

yarn start:infra

🚀 Run

Run examples

Base example:

yarn start:base

🧪 Run tests

yarn test:unit
yarn test:e2e

For the test coverage:

yarn coverage

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.

📖 Docs

Read all related document pages carefully to understand the Observer API architecture and limitations.

• Overview

Contributors

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