feat(example): add bee advanced example

examples/agents/bee_advanced.ts

@@ -0,0 +1,120 @@
+import "dotenv/config.js";
+import { BeeAgent } from "bee-agent-framework/agents/bee/agent";
+import { createConsoleReader } from "../helpers/io.js";
+import { FrameworkError } from "bee-agent-framework/errors";
+import { Logger } from "bee-agent-framework/logger/logger";
+import {
+  DuckDuckGoSearchTool,
+  DuckDuckGoSearchToolSearchType,
+} from "bee-agent-framework/tools/search/duckDuckGoSearch";
+import { OpenMeteoTool } from "bee-agent-framework/tools/weather/openMeteo";
+import {
+  BeeSystemPrompt,
+  BeeToolErrorPrompt,
+  BeeToolInputErrorPrompt,
+  BeeToolNoResultsPrompt,
+} from "bee-agent-framework/agents/bee/prompts";
+import { PromptTemplate } from "bee-agent-framework/template";
+import { BAMChatLLM } from "bee-agent-framework/adapters/bam/chat";
+import { UnconstrainedMemory } from "bee-agent-framework/memory/unconstrainedMemory";
+
+Logger.root.level = "silent"; // disable internal logs
+const logger = new Logger({ name: "app", level: "trace" });
+
+const llm = BAMChatLLM.fromPreset("meta-llama/llama-3-1-70b-instruct");
+
+const agent = new BeeAgent({
+  llm,
+  memory: new UnconstrainedMemory(),
+  // You can override internal templates
+  templates: {
+    user: new PromptTemplate({
+      variables: ["input"],
+      template: `User: {{input}}`,
+    }),
+    system: BeeSystemPrompt.fork((old) => ({
+      ...old,
+      defaults: {
+        instructions: "You are a helpful assistant that uses tools to answer questions.",
+      },
+    })),
+    toolError: BeeToolErrorPrompt,
+    toolInputError: BeeToolInputErrorPrompt,
+    toolNoResultError: BeeToolNoResultsPrompt.fork((old) => ({
+      ...old,
+      template: `${old.template}\nPlease reformat your input.`,
+    })),
+    toolNotFoundError: new PromptTemplate({
+      variables: ["tools"],
+      template: `Tool does not exist!
+{{#tools.length}}
+Use one of the following tools: {{#trim}}{{#tools}}{{name}},{{/tools}}{{/trim}}
+{{/tools.length}}`,
+    }),
+  },
+  tools: [
+    new DuckDuckGoSearchTool({
+      maxResultsPerPage: 10,
+      search: {
+        safeSearch: DuckDuckGoSearchToolSearchType.STRICT,
+      },
+    }),
+    // new WebCrawlerTool(), // HTML web page crawler
+    // new WikipediaTool(),
+    new OpenMeteoTool(), // weather tool
+    // new ArXivTool(), // research papers
+    // new DynamicTool() // custom python tool
+  ],
+});
+
+const reader = createConsoleReader();
+
+try {
+  for await (const { prompt } of reader) {
+    const response = await agent
+      .run(
+        { prompt },
+        {
+          execution: {
+            maxRetriesPerStep: 3,
+            totalMaxRetries: 10,
+            maxIterations: 20,
+          },
+          signal: AbortSignal.timeout(2 * 60 * 1000),
+        },
+      )
+      .observe((emitter) => {
+        emitter.on("start", () => {
+          reader.write(`Agent 🤖 : `, "starting new iteration");
+        });
+        emitter.on("error", ({ error }) => {
+          reader.write(`Agent 🤖 : `, FrameworkError.ensure(error).dump());
+        });
+        emitter.on("retry", () => {
+          reader.write(`Agent 🤖 : `, "retrying the action...");
+        });
+        emitter.on("update", async ({ data, update, meta }) => {
+          // log 'data' to see the whole state
+          // to log only valid runs (no errors), check if meta.success === true
+          reader.write(`Agent (${update.key}) 🤖 : `, update.value);
+        });
+        emitter.on("partialUpdate", ({ data, update, meta }) => {
+          // ideal for streaming (line by line)
+          // log 'data' to see the whole state
+          // to log only valid runs (no errors), check if meta.success === true
+          // reader.write(`Agent (partial ${update.key}) 🤖 : `, update.value);
+        });
+
+        // To observe all events (uncomment following block)
+        // emitter.match("*.*", async (data: unknown, event) => {
+        //   logger.trace(event, `Received event "${event.path}"`);
+        // });
+      });
+
+    reader.write(`Agent 🤖 : `, response.result.text);
+  }
+} catch (error) {
+  logger.error(FrameworkError.ensure(error).dump());
+} finally {
+  process.exit(0);
+}

src/tools/search/duckDuckGoSearch.ts

@@ -29,6 +29,8 @@ import type { NeedleOptions } from "needle";
 import { z } from "zod";
 import { Cache } from "@/cache/decoratorCache.js";
 
+export { SafeSearchType as DuckDuckGoSearchToolSearchType };
+
 export interface DuckDuckGoSearchToolOptions extends SearchToolOptions {
   search?: SearchOptions;
   throttle?: ThrottleOptions | false;