Allow assistant to be found by id, name, then recreated.

TODO.md

@@ -1,6 +1,5 @@
 * Create a beforeInit event/hook vs. an override.
 * Can citations be removed from vector store QnA?
-* Make sure the assistant find by id works using something like a `process.env.ID`
 * Remove the Assistant#messages. Is even `Message` needed?
 * TODO: Revisit this and assistantsToolsOutputs.
 * Is `addAssistantTool` the right name now?

src/experts/assistant.js

@@ -39,7 +39,10 @@ class Assistant {
 
   async init() {
     if (!this.llm) return;
-    this.assistant = await this.reCreate();
+    this.assistant =
+      (await this.findByID()) ||
+      (await this.findByName()) ||
+      (await this.reCreate());
     for (const [_name, tool] of Object.entries(this.assistantsTools)) {
       await tool.init();
     }
@@ -134,14 +137,15 @@ class Assistant {
   async findByID() {
     if (!this.id) return;
     const assistant = await openai.beta.assistants.retrieve(this.id);
+    debug(`💁‍♂️  Found by id ${this.agentName} assistant ${this.id}`);
     return assistant;
   }
 
   async findByName() {
     const assistant = (
       await openai.beta.assistants.list({ limit: "100" })
     ).data.find((a) => a.name === this.agentName);
-    debug(`💁‍♂️  Found assistant: ${this.agentName}`);
+    debug(`💁‍♂️  Found by name ${this.agentName} assistant`);
     return assistant;
   }
 
@@ -158,7 +162,7 @@ class Assistant {
       metadata: this._metadata,
       response_format: this.response_format,
     });
-    debug(`💁‍♂️ Created ${this.agentName} assistant ${assistant.id}...`);
+    debug(`💁‍♂️ Created ${this.agentName} assistant ${assistant.id}`);
     return assistant;
   }
 

test/experts/assistant.test.js

@@ -10,10 +10,15 @@ import {
 import {
   TestAssistant,
   EchoAssistant,
+  EchoAssistantWithSetNameAndIdOption,
   OddFactsAssistant,
   RouterAssistant,
 } from "../fixtures.js";
 
+beforeEach(() => {
+  delete process.env.TEST_ECHO_TOOL_ID;
+});
+
 test("assistant as tool", async () => {
   const assistant = await RouterAssistant.create();
   const threadID = await helperThreadID();
@@ -47,6 +52,17 @@ test("can ask the assistant a question using a thread id", async () => {
   expect(output).toBe("hello 123");
 });
 
+test("can use environment variables to find an assistant by id", async () => {
+  const assistant = await EchoAssistantWithSetNameAndIdOption.create();
+  // Will find the same assistant by name.
+  const assistant2 = await EchoAssistantWithSetNameAndIdOption.create();
+  expect(assistant.id).toBe(assistant2.id);
+  // Will find by id.
+  process.env.TEST_ECHO_TOOL_ID = assistant2.id;
+  const assistant3 = await EchoAssistantWithSetNameAndIdOption.create();
+  expect(assistant2.id).toBe(assistant3.id);
+});
+
 test("can configure various options", async () => {
   const path = helperPath("test/fixtures/data.csv");
   const file = await openai.files.create({

test/fixtures.js

@@ -1,4 +1,7 @@
-export { EchoAssistant } from "./fixtures/echoAssistant.js";
+export {
+  EchoAssistant,
+  EchoAssistantWithSetNameAndIdOption,
+} from "./fixtures/echoAssistant.js";
 export { OddFactsAssistant } from "./fixtures/oddFactsAssistant.js";
 export { TestAssistant } from "./fixtures/testAssistant.js";
 export { DataTool } from "./fixtures/dataTool.js";

test/fixtures/echoAssistant.js

@@ -10,4 +10,15 @@ class EchoAssistant extends Assistant {
   }
 }
 
-export { EchoAssistant };
+class EchoAssistantWithSetNameAndIdOption extends Assistant {
+  constructor() {
+    const name = helperName("Echo", { rand: false });
+    const description = "Echo";
+    const instructions = "Echo the same text back to the user";
+    super(name, description, instructions, {
+      id: process.env.TEST_ECHO_TOOL_ID,
+    });
+  }
+}
+
+export { EchoAssistant, EchoAssistantWithSetNameAndIdOption };

test/helpers.js

@@ -4,8 +4,10 @@ const __filename = url.fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 import { openai } from "../src/openai.js";
 
-const helperName = (use) => {
+const helperName = (use, options = {}) => {
+  const rand = options.rand !== undefined ? options.rand : true;
   const name = `Experts.js (${use})`;
+  if (!rand) return name;
   return `${name} ${Math.random().toString(36).substring(4)}`;
 };