Building an OpenAI Assistant: A Step-by-Step Guide

mkdir openai-api-nodejs
cd openai-api-nodejs
npm init -y
npm install --save openai dotenv
npm install --save-dev typescript ts-node

npx tsc --init

class FileHandler {
  async createFile() {
    const file = await openai.files.create({
      file: fs.createReadStream(path.join(__dirname, "/data/cv.pdf")),
      purpose: "assistants",
    });
    console.log("Upload file for assistant: ", file.id);
    return file;
  }
}

class ThreadHandler {
  async createThread() {
    const thread = await openai.beta.threads.create({});
    console.log("Thread has been created: ", thread);
    return thread;
  }
}

class AssistantHandler {
  async createAssistant(file: OpenAI.Files.FileObject) {
    const assistantName = 'Recruiter assistant'; 
    const assistants = await openai.beta.assistants.list();
    const existingAssistant = assistants.data.find(a => a.name === assistantName);

    if (existingAssistant) {
      console.log(`Assistant '${assistantName}' exists: `, existingAssistant);
      return existingAssistant;
    } else {
      const assistant = await openai.beta.assistants.create({...});
      console.log('Assistant has been created: ', assistant);
      return assistant;
    }
  }
}

class App {
  fileHandler: FileHandler;
  threadHandler: ThreadHandler;
  assistantHandler: AssistantHandler;

  constructor() {
    this.fileHandler = new FileHandler();
    this.threadHandler = new ThreadHandler();
    this.assistantHandler = new AssistantHandler();
  }

  async checkRun(
    thread: OpenAI.Beta.Threads.Thread,
    run: OpenAI.Beta.Threads.Runs.Run
  ) {
    return new Promise((resolve, reject) => {
      const interval = setInterval(async () => {
        const retrieveRun = await openai.beta.threads.runs.retrieve(
          thread.id,
          run.id
        );

        console.log("Run status: ", retrieveRun.status);

        if (retrieveRun.status === "completed") {
          console.log("Run completed: ", retrieveRun);

          clearInterval(interval);
          resolve(retrieveRun);
        }
      }, 3000);
    });
  }

  async run() {
    const file = await this.fileHandler.createFile();

    const thread = await this.threadHandler.createThread();

    const assistant = await this.assistantHandler.createAssistant(file);

    const message = await openai.beta.threads.messages.create(thread.id, {
      role: "user",
      content:
        "Summarize technologies that the candidate has worked with in the past and how long they have worked with them without mention company name or the candidate name.",
    });

    console.log("Adding message to thread: ", message);

    const run = await openai.beta.threads.runs.create(thread.id, {
      assistant_id: assistant.id,
    });

    console.log("Run has been created: ", run);

    await this.checkRun(thread, run);

    const messages = await openai.beta.threads.messages.list(thread.id);

    const answer = (messages.data ?? []).find((m) => m?.role === "assistant")
      ?.content?.[0];

    console.log("Answer: ", answer);
  }
}

(async () => {
  console.log("Running job...⏳");

  const app = new App();
  await app.run();

  console.log("Successfully ran job! ✅");
})();

Running job...⏳

Upload file for assistant:  file-32s72Vwc2BYpn17UnkRcxGgq

Thread has been created:  {
  id: 'thread_bcyHijwiF8YEcuSeqMcaLavv',
  object: 'thread',
  created_at: 1710951432,
  metadata: {}
}

Assistant 'Recruiter assistant' exists:  {
  id: 'asst_bMVH8sFdXukwb7FQj0lCmHFm',
  object: 'assistant',
  created_at: 1710949980,
  name: 'Recruiter assistant',
  description: null,
  model: 'gpt-4-1106-preview',
  instructions: 'You are a recruiter support chatbot. Use your knowledge base to best respond to customer queries. Please also keep the answer short and concise.',
  tools: [ { type: 'retrieval' } ],
  file_ids: [ 'file-4aOJU56PzUfDkPTvpGPx2aSt' ],
  metadata: {}
}

Adding message to thread:  {
  id: 'msg_U7rWdRXLAvZr1pjc1T9Mo7CF',
  object: 'thread.message',
  created_at: 1710951433,
  assistant_id: null,
  thread_id: 'thread_bcyHijwiF8YEcuSeqMcaLavv',
  run_id: null,
  role: 'user',
  content: [ { type: 'text', text: [Object] } ],
  file_ids: [],
  metadata: {}
}

Run has been created:  {
  id: 'run_PQ2Pqcfdyk8ZsLKTkfa2cfjW',
  object: 'thread.run',
  created_at: 1710951434,
  assistant_id: 'asst_bMVH8sFdXukwb7FQj0lCmHFm',
  thread_id: 'thread_bcyHijwiF8YEcuSeqMcaLavv',
  status: 'queued',
  started_at: null,
  expires_at: 1710952034,
  cancelled_at: null,
  failed_at: null,
  completed_at: null,
  required_action: null,
  last_error: null,
  model: 'gpt-4-1106-preview',
  instructions: 'You are a recruiter support chatbot. Use your knowledge base to best respond to customer queries. Please also keep the answer short and concise.',
  tools: [ { type: 'retrieval' } ],
  file_ids: [ 'file-4aOJU56PzUfDkPTvpGPx2aSt' ],
  metadata: {},
  usage: null
}

Run status:  in_progress
Run status:  in_progress
Run status:  in_progress
Run status:  in_progress
Run status:  completed
Run completed:  {
  id: 'run_PQ2Pqcfdyk8ZsLKTkfa2cfjW',
  object: 'thread.run',
  created_at: 1710951434,
  assistant_id: 'asst_bMVH8sFdXukwb7FQj0lCmHFm',
  thread_id: 'thread_bcyHijwiF8YEcuSeqMcaLavv',
  status: 'completed',
  started_at: 1710951434,
  expires_at: null,
  cancelled_at: null,
  failed_at: null,
  completed_at: 1710951448,
  required_action: null,
  last_error: null,
  model: 'gpt-4-1106-preview',
  instructions: 'You are a recruiter support chatbot. Use your knowledge base to best respond to customer queries. Please also keep the answer short and concise.',
  tools: [ { type: 'retrieval' } ],
  file_ids: [ 'file-4aOJU56PzUfDkPTvpGPx2aSt' ],
  metadata: {},
  usage: { prompt_tokens: 2934, completion_tokens: 278, total_tokens: 3212 }
}

Answer:  {
  type: 'text',
  text: {
    value: 'The candidate has experience with the following technologies:\n' +
      '\n' +
      '- **Microsoft Azure**: Used in current and previous roles, as well as for various side projects. The candidate is Microsoft Azure Developer Associate Certified (AZ-204, September 2023), Microsoft Azure Data Fundamentals Certified (DP-900, October 2023), and Microsoft Azure Fundamentals Certified (AZ-900, July 2021).\n' +
      '- **TypeScript & Angular**: Frequently used across different roles for full-stack development, and also in teaching within an academy.\n' +
      '- **RxJs & NgRx**: Implemented in current technical leadership and development role as well as in teaching.\n' +
      '- **.NET & C#**: Worked with since at least March 2019 as a full-stack developer and as an educator. The candidate is Microsoft Technology Associate: Software Development Fundamentals Certified (December 2021).\n' +
      '- **Node.js**: Used in the current full-stack development role and in an academy teaching role. Also certified with a Fincons Node.js – Nest.js course (July 2022).\n' +
      '- **Python**: Applied in the development of a logistic application during a previous role as a Software Developer Engineer.\n' +
      '- **SQL Server, Entity Framework**: Used for full-stack development in a previous role.\n' +
      '- **MATLAB**: Used for developing algorithms and models for CAE implementation in a junior engineer role.\n' +
      '- **React**: Utilized in developing side-projects such as a social network for events and a chat app.\n' +
      '- **SignalR**: Leveraged for real-time communication in a chat app side-project.\n' +
      '- **Chart.js**: Employed in a personal web app for monitoring blood pressure data.\n' +
      '\n' +
      'In terms of experience duration, it ranges from at least four to five years for most of the technologies, with teaching roles indicating a deep understanding and proficiency in some of them. The candidate 
has been leading teams and teaching since at least 2021, suggesting a strong command of the stack and best practices in software development.',
    annotations: []
  }
}

Successfully ran job! ✅