symposium 1.0.5 → 1.2.0

package/Agent.js

@@ -4,6 +4,10 @@ import BufferedEventEmitter from "./BufferedEventEmitter.js";
 
 import Symposium from "./Symposium.js";
 import Thread from "./Thread.js";
+import Tool from "./Tool.js";
+import Context from "./Context.js";
+import Text from "./Contexts/Text.js";
+import GetContextTool from "./GetContextTool.js";
 
 export default class Agent {
 	name = 'Agent';
@@ -12,6 +16,7 @@ export default class Agent {
 	threads;
 	functions = null;
 	tools = new Map();
+	context = [];
 	default_model = 'gpt-4o';
 	max_retries = 5;
 	type = 'chat'; // chat, utility
@@ -61,11 +66,76 @@ export default class Agent {
 	}
 
 	addTool(tool) {
+		if (!(tool instanceof Tool) || !tool.name)
+			throw new Error('Tool must be an instance of Tool class');
+		if (this.tools.has(tool.name))
+			throw new Error('Tool with name ' + tool.name + ' already exists in agent');
+
 		this.tools.set(tool.name, tool);
 	}
 
+	async addContext(context, options = {}) {
+		if (typeof context === 'string')
+			context = new Text(context);
+		if (!(context instanceof Context))
+			throw new Error('Context must be an instance of Context class');
+
+		options = {
+			type: 'always', // always, on_request
+			description: null,
+			...options,
+		};
+
+		// TODO: summarization based on tokens
+		// TODO: RAG
+
+		const title = await context.getTitle();
+		this.context.push({title, context, options});
+	}
+
 	async initThread(thread) {
 		await this.doInitThread(thread);
+
+		let context_texts = [], is_there_on_request = false;
+		for (let {title, context, options} of this.context) {
+			switch (options.type) {
+				case 'always':
+					const text = await context.getText();
+					if (text)
+						context_texts.push('<context>' + text + '</context>');
+					break;
+
+				case 'on_request':
+					is_there_on_request = true;
+					context_texts.push('<context_on_request><name>' + title + '</name><description>' + options.description + '</description></context_on_request>');
+					break;
+
+				default:
+					throw new Error('Bad context option type ' + options.type);
+			}
+		}
+
+		if (context_texts.length) {
+			let context_string = context_texts.join('\n');
+			if (is_there_on_request) {
+				context_string = '<important>Some of the context is available to you immediately here, while longer texts may be available only on request; you are provided with a title and a description. If you think it may be useful for your current task, you can request the text via the get_context tool</important>';
+				if (!this.tools.has('get_context'))
+					this.addTool(new GetContextTool(this));
+			}
+			context_string = '\n<context_info>' + context_string + '</context_info>';
+
+			let system_message_found = null;
+			for (let messages of thread.messages) {
+				if (messages.role === 'system')
+					system_message_found = messages;
+			}
+
+			if (system_message_found)
+				system_message_found.content[0].content += context_string;
+			else
+				thread.addMessage('system', context_string);
+		}
+
 		await thread.storeState();
 	}
 

package/Context.js

@@ -0,0 +1,15 @@
+export default class Context {
+	/**
+	 * @returns {Promise<string|null>}
+	 */
+	async getTitle() {
+		return null;
+	}
+
+	/**
+	 * @returns {Promise<string|null>}
+	 */
+	async getText() {
+		return null;
+	}
+}

package/Contexts/File.js

@@ -0,0 +1,27 @@
+import fs from "fs";
+import Context from "../Context.js";
+
+export default class File extends Context {
+	constructor(file) {
+		super();
+		this.file = file;
+	}
+
+	async getTitle() {
+		if (this.file.startsWith('http://') || this.file.startsWith('https://'))
+			return this.file;
+		else
+			return this.file.split('/').pop();
+	}
+
+	async getText() {
+		if (this.file.startsWith('http://') || this.file.startsWith('https://')) {
+			return fetch(this.file);
+		} else {
+			if (fs.existsSync(this.file))
+				return fs.promises.readFile(this.file, "utf8");
+			else
+				throw new Error(`File not found: ${this.file}`);
+		}
+	}
+}

package/Contexts/Text.js

@@ -0,0 +1,17 @@
+import Context from "../Context.js";
+
+export default class Text extends Context {
+	constructor(text, title = null) {
+		super();
+		this.text = text;
+		this.title = title;
+	}
+
+	async getTitle() {
+		return this.title;
+	}
+
+	async getText() {
+		return this.text;
+	}
+}

package/GetContextTool.js

@@ -0,0 +1,42 @@
+import Tool from "./Tool.js";
+
+export default class GetContextTool extends Tool {
+	name = 'get_context';
+
+	constructor(agent) {
+		super();
+		this.agent = agent;
+	}
+
+	async getFunctions() {
+		return [
+			{
+				name: 'get_context',
+				description: 'Get the text from a specific context snippet',
+				parameters: {
+					type: 'object',
+					properties: {
+						title: {
+							type: 'string',
+						},
+					},
+					required: ['title'],
+				},
+			}
+		];
+	}
+
+	async callFunction(thread, name, payload) {
+		if (name !== 'get_context')
+			return {error: `Function ${name} not found`};
+
+		const title = payload.title;
+		const context = this.agent.context.find(c => c.title === title && c.options.type === 'on_request');
+		if (!context)
+			return {error: `Context with title ${title} not found`};
+
+		return {
+			context: await context.context.getText(),
+		};
+	}
+}

package/README.md

@@ -62,9 +62,41 @@ async function main() {
 main();
 ```
 
-### 2. Create your Agent
+### 2. One shot prompts
 
-Create a new class that extends `Agent`. At a minimum, you'll want to define a name and a system prompt.
+You can also use the static `Symposium.prompt()` method for one-off prompts without creating an agent.
+
+```javascript
+import { Symposium } from 'symposium';
+await Symposium.init();
+
+const response = await Symposium.prompt('Translate the text from English to French.', 'Hello, how are you?');
+console.log(response); // "Bonjour, comment ça va?"
+
+const structured_response = await Symposium.prompt('Extract name and emails from the following email', email_text, {
+	response: {
+		type: 'json',
+        function: {
+            name: 'extract_data',
+            parameters: {
+                type: 'array',
+                items: {
+	                type: 'object',
+	                properties: {
+		                name: {type: 'string'},
+		                email: {type: 'string'},
+	                },
+	                required: ['name', 'email'],
+                },
+            },
+        },
+    },
+});
+```
+
+### 3. Create your Agent
+
+For more structured and/or reusable tasks, create a new class that extends `Agent`. At a minimum, you'll want to define a name and a system prompt.
 
 ```javascript
 // MyChatAgent.js
@@ -80,7 +112,7 @@ export default class MyChatAgent extends Agent {
 }
 ```
 
-### 3. Start a Conversation
+### 4. Start a Conversation
 
 Now you can instantiate your agent and start a conversation.
 

package/Symposium.js

@@ -116,7 +116,7 @@ export default class Symposium {
 		return mimeToExt[mime] || null;
 	}
 
-	static async oneShot(system, prompt, options = {}) {
+	static async prompt(system, prompt, options = {}) {
 		const agent = new Agent(options.agent || {});
 		agent.type = 'utility';
 		agent.utility = options.response || {

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "symposium",
-  "version": "1.0.5",
+  "version": "1.2.0",
   "description": "Agents",
   "main": "index.js",
   "author": "Domenico Giambra",