moving the OpenAI Assistant code logic to an abstraction

Author: OvidijusParsiunas

component/src/services/openAI/assistant/openAIAssistantIO.ts

@@ -0,0 +1,31 @@
+import {DirectConnection} from '../../../types/directConnection';
+import {Response as ResponseI} from '../../../types/response';
+import {OpenAIAssistantIOI} from './openAIAssistantIOI';
+import {DeepChat} from '../../../deepChat';
+
+export class OpenAIAssistantIO extends OpenAIAssistantIOI {
+  fetchHistory?: () => Promise<ResponseI[]>;
+  private static readonly URL_SEGMENTS = {
+    threadsPrefix: 'https://api.openai.com/v1/threads',
+    threadsPosfix: '',
+    newAssistantUrl: 'https://api.openai.com/v1/assistants',
+    createMessagePostfix: '',
+    listMessagesPostfix: 'order=desc',
+    storeFiles: 'https://api.openai.com/v1/files',
+    getFilesPrefix: 'https://api.openai.com/v1/files/',
+    getFilesPostfix: '/content',
+  };
+
+  constructor(deepChat: DeepChat) {
+    const directConnectionCopy = JSON.parse(JSON.stringify(deepChat.directConnection)) as DirectConnection;
+    const apiKey = directConnectionCopy.openAI;
+    const config = directConnectionCopy.openAI?.assistant; // can be undefined as this is the default service
+    if (typeof directConnectionCopy.openAI?.assistant === 'boolean' && directConnectionCopy.openAI?.assistant === true) {
+      directConnectionCopy.openAI.assistant = config;
+    }
+    super(deepChat, config, OpenAIAssistantIO.URL_SEGMENTS, apiKey);
+    this.connectSettings.headers ??= {};
+    this.connectSettings.headers['OpenAI-Beta'] ??= 'assistants=v2'; // runs keep failing but keep trying
+    if (this.shouldFetchHistory && this.sessionId) this.fetchHistory = this.fetchHistoryFunc.bind(this);
+  }
+}

component/src/services/openAI/assistant/openAIAssistantIOI.ts

@@ -1,5 +1,5 @@
 import {AssistantFunctionHandler, OpenAI, OpenAIAssistant, OpenAINewAssistant} from '../../../types/openAI';
-import {OpenAIAssistantUtils, UploadedFile} from '../utils/openAIAssistantUtils';
+import {OpenAIAssistantUtils, UploadedFile} from './utils/openAIAssistantUtils';
 import {MessageStream} from '../../../views/chat/messages/stream/messageStream';
 import {FileMessageUtils} from '../../../views/chat/messages/fileMessageUtils';
 import {OpenAIConverseBodyInternal} from '../../../types/openAIInternal';
@@ -37,16 +37,15 @@ type FileAttachments = {
   tools: {type: OpenAIAssistant['files_tool_type']}[];
 }[];
 
-type URLSegments = {
-  prefix: string;
-  posfix: string;
+export type URLSegments = {
+  threadsPrefix: string;
+  threadsPosfix: string;
   newAssistantUrl: string;
-  createMessageUrlPostfix: string;
-  listMessagesUrlPostfix: string;
-  storeFilesUrl: string;
-  getFilesUrl: string;
-  getFilesPrefixUrl: string;
-  getFilesPostfixUrl: string;
+  createMessagePostfix: string;
+  listMessagesPostfix: string;
+  storeFiles: string;
+  getFilesPrefix: string;
+  getFilesPostfix: string;
 };
 
 export class OpenAIAssistantIOI extends DirectServiceIO {
@@ -179,12 +178,12 @@ export class OpenAIAssistantIOI extends DirectServiceIO {
     this.messages = messages;
     if (this.sessionId) {
       // https://platform.openai.com/docs/api-reference/messages/createMessage
-      this.url = `${this.urlSegments.prefix}/${this.sessionId}/messages${this.urlSegments.createMessageUrlPostfix}`;
+      this.url = `${this.urlSegments.threadsPrefix}/${this.sessionId}/messages${this.urlSegments.createMessagePostfix}`;
       const body = this.processMessage(pMessages, uploadedFiles);
       HTTPRequest.request(this, body, messages);
     } else {
       // https://platform.openai.com/docs/api-reference/runs/createThreadAndRun
-      this.url = `${this.urlSegments.prefix}/runs${this.urlSegments.prefix}`;
+      this.url = `${this.urlSegments.threadsPrefix}/runs${this.urlSegments.threadsPosfix}`;
       const body = this.createNewThreadMessages(this.rawBody, pMessages, uploadedFiles);
       if (this.isSSEStream) {
         this.createStreamRun(body);
@@ -200,7 +199,9 @@ export class OpenAIAssistantIOI extends DirectServiceIO {
     this.rawBody.assistant_id ??= this.config.assistant_id || (await this.createNewAssistant());
     // here instead of constructor as messages may be loaded later
     if (!this.searchedForThreadId) this.searchPreviousMessagesForThreadId(messages.messages);
-    const uploadedFiles = files ? await OpenAIAssistantUtils.storeFiles(this, messages, files) : undefined;
+    const uploadedFiles = files
+      ? await OpenAIAssistantUtils.storeFiles(this, messages, files, this.urlSegments.storeFiles)
+      : undefined;
     this.connectSettings.method = 'POST';
     this.callService(messages, pMessages, uploadedFiles);
   }
@@ -238,7 +239,7 @@ export class OpenAIAssistantIOI extends DirectServiceIO {
     }
     await this.assignThreadAndRun(result);
     // https://platform.openai.com/docs/api-reference/runs/getRun
-    const url = `${this.urlSegments.prefix}/${this.sessionId}/runs/${this.run_id}${this.urlSegments.posfix}`;
+    const url = `${this.urlSegments.threadsPrefix}/${this.sessionId}/runs/${this.run_id}${this.urlSegments.threadsPosfix}`;
     const requestInit = {method: 'GET', headers: this.connectSettings?.headers};
     HTTPRequest.executePollRequest(this, url, requestInit, this.messages as Messages); // poll for run status
     return {makingAnotherRequest: true};
@@ -247,7 +248,7 @@ export class OpenAIAssistantIOI extends DirectServiceIO {
   private async assignThreadAndRun(result: OpenAIAssistantInitReqResult) {
     if (this.sessionId) {
       // https://platform.openai.com/docs/api-reference/runs/createRun
-      this.url = `${this.urlSegments.prefix}/${this.sessionId}/runs${this.urlSegments.posfix}`;
+      this.url = `${this.urlSegments.threadsPrefix}/${this.sessionId}/runs${this.urlSegments.threadsPosfix}`;
       const runObj = await OpenAIUtils.directFetch(this, JSON.parse(JSON.stringify(this.rawBody)), 'POST');
       this.run_id = runObj.id;
     } else {
@@ -263,12 +264,12 @@ export class OpenAIAssistantIOI extends DirectServiceIO {
 
   private async getThreadMessages(thread_id: string, isHistory = false) {
     // https://platform.openai.com/docs/api-reference/messages/listMessages
-    this.url = `${this.urlSegments.prefix}/${thread_id}/messages?${this.urlSegments.listMessagesUrlPostfix}`;
+    this.url = `${this.urlSegments.threadsPrefix}/${thread_id}/messages?${this.urlSegments.listMessagesPostfix}`;
     let threadMessages = (await OpenAIUtils.directFetch(this, {}, 'GET')) as OpenAIAssistantMessagesResult;
     if (!isHistory && this.deepChat.responseInterceptor) {
       threadMessages = (await this.deepChat.responseInterceptor?.(threadMessages)) as OpenAIAssistantMessagesResult;
     }
-    return OpenAIAssistantUtils.processAPIMessages(this, threadMessages, isHistory);
+    return OpenAIAssistantUtils.processAPIMessages(this, threadMessages, isHistory, this.urlSegments);
   }
 
   async extractPollResultData(result: OpenAIRunResult): PollResult {
@@ -312,8 +313,8 @@ export class OpenAIAssistantIOI extends DirectServiceIO {
       return {tool_call_id: toolCalls[index].id, output: resp};
     });
     // https://platform.openai.com/docs/api-reference/runs/submitToolOutputs
-    const prefix = `${this.urlSegments.prefix}/${this.sessionId}`;
-    const postfix = `/runs/${this.run_id}/submit_tool_outputs${this.urlSegments.posfix}`;
+    const prefix = `${this.urlSegments.threadsPrefix}/${this.sessionId}`;
+    const postfix = `/runs/${this.run_id}/submit_tool_outputs${this.urlSegments.threadsPosfix}`;
     this.url = `${prefix}${postfix}`;
     if (this.isSSEStream) {
       await this.createStreamRun({tool_outputs});
@@ -334,7 +335,7 @@ export class OpenAIAssistantIOI extends DirectServiceIO {
     }
     if (this.isSSEStream && this.sessionId) {
       // https://platform.openai.com/docs/api-reference/runs/createRun
-      this.url = `${this.urlSegments.prefix}/${this.sessionId}/runs${this.urlSegments.posfix}`;
+      this.url = `${this.urlSegments.threadsPrefix}/${this.sessionId}/runs${this.urlSegments.threadsPosfix}`;
       const newBody = JSON.parse(JSON.stringify(this.rawBody));
       this.createStreamRun(newBody);
     }
@@ -349,7 +350,7 @@ export class OpenAIAssistantIOI extends DirectServiceIO {
       if (textContent?.text?.annotations && textContent.text.annotations.length > 0) {
         const textFileFirst = result.content.find((content) => !!content.text) || result.content[0];
         const downloadCb = OpenAIAssistantUtils.getFilesAndText.bind(this,
-          this, {role: 'assistant', content: result.content}, textFileFirst);
+          this, {role: 'assistant', content: result.content}, this.urlSegments, textFileFirst);
         this.messageStream?.endStreamAfterFileDownloaded(this.messages, downloadCb);
         return {text: ''};
       }
@@ -359,7 +360,7 @@ export class OpenAIAssistantIOI extends DirectServiceIO {
         // if file is included and there is no annotation/link in text, process during the stream
         const textContent = result.delta.content.find((content) => content.text);
         if (textContent?.text?.annotations && textContent.text.annotations.length === 0) {
-          const messages = await OpenAIAssistantUtils.processStreamMessages(this, result.delta.content);
+          const messages = await OpenAIAssistantUtils.processStreamMessages(this, result.delta.content, this.urlSegments);
           return {text: messages[0].text, files: messages[1].files};
         }
       }

…ces/openAI/utils/openAIAssistantUtils.ts …/assistant/utils/openAIAssistantUtils.tscomponent/src/services/openAI/utils/openAIAssistantUtils.ts renamed to component/src/services/openAI/assistant/utils/openAIAssistantUtils.ts component/src/services/openAI/utils/openAIAssistantUtils.ts renamed to component/src/services/openAI/assistant/utils/openAIAssistantUtils.ts

@@ -1,10 +1,11 @@
-import {OpenAIAssistantData, OpenAIAssistantContent, OpenAIAssistantMessagesResult} from '../../../types/openAIResult';
-import {MessageFileType, MessageFile} from '../../../types/messageFile';
-import {Messages} from '../../../views/chat/messages/messages';
-import {RequestUtils} from '../../../utils/HTTP/requestUtils';
-import {DirectServiceIO} from '../../utils/directServiceIO';
-import {OpenAIUtils} from './openAIUtils';
-import {ServiceIO} from '../../serviceIO';
+import {OpenAIAssistantData, OpenAIAssistantContent, OpenAIAssistantMessagesResult} from '../../../../types/openAIResult';
+import {MessageFileType, MessageFile} from '../../../../types/messageFile';
+import {Messages} from '../../../../views/chat/messages/messages';
+import {RequestUtils} from '../../../../utils/HTTP/requestUtils';
+import {DirectServiceIO} from '../../../utils/directServiceIO';
+import {OpenAIUtils} from '../../utils/openAIUtils';
+import {URLSegments} from '../openAIAssistantIOI';
+import {ServiceIO} from '../../../serviceIO';
 
 type FileDetails = {fileId: string; path?: string; name?: string}[];
 
@@ -18,10 +19,10 @@ export class OpenAIAssistantUtils {
     'Response must contain an array of strings for each individual function/tool_call, ' +
     'see https://deepchat.dev/docs/directConnection/OpenAI/#assistant-functions.';
 
-  public static async storeFiles(serviceIO: ServiceIO, messages: Messages, files: File[]) {
+  public static async storeFiles(serviceIO: ServiceIO, messages: Messages, files: File[], storeFilesUrl: string) {
     const headers = serviceIO.connectSettings.headers;
     if (!headers) return;
-    serviceIO.url = 'https://api.openai.com/v1/files'; // stores files
+    serviceIO.url = storeFilesUrl; // stores files
     const previousContentType = headers[RequestUtils.CONTENT_TYPE];
     delete headers[RequestUtils.CONTENT_TYPE];
     const requests = files.map(async (file) => {
@@ -54,10 +55,10 @@ export class OpenAIAssistantUtils {
     return 'any';
   }
 
-  private static async getFiles(serviceIO: ServiceIO, fileDetails: FileDetails) {
+  private static async getFiles(serviceIO: ServiceIO, fileDetails: FileDetails, urlPrefix: string, urlPosfix: string) {
     const fileRequests = fileDetails.map(({fileId}) => {
       // https://platform.openai.com/docs/api-reference/files/retrieve-contents
-      serviceIO.url = `https://api.openai.com/v1/files/${fileId}/content`;
+      serviceIO.url = `${urlPrefix}${fileId}${urlPosfix}`;
       return new Promise<Blob>((resolve) => {
         resolve(OpenAIUtils.directFetch(serviceIO, undefined, 'GET', false));
       });
@@ -86,10 +87,11 @@ export class OpenAIAssistantUtils {
 
   // prettier-ignore
   private static async getFilesAndNewText(io: ServiceIO, fileDetails: FileDetails,
-      role?: string, content?: OpenAIAssistantContent) {
+      urls: URLSegments, role?: string, content?: OpenAIAssistantContent) {
     let files: MessageFile[] | undefined;
+    const {getFilesPrefix, getFilesPostfix} = urls;
     if (fileDetails.length > 0) {
-      files = await OpenAIAssistantUtils.getFiles(io, fileDetails);
+      files = await OpenAIAssistantUtils.getFiles(io, fileDetails, getFilesPrefix, getFilesPostfix);
       if (content?.text?.value) {
         files.forEach((file, index) => {
           if (!file.src) return;
@@ -132,10 +134,12 @@ export class OpenAIAssistantUtils {
     return fileDetails;
   }
 
-  public static async getFilesAndText(io: ServiceIO, message: OpenAIAssistantData, content?: OpenAIAssistantContent) {
+  // prettier-ignore
+  public static async getFilesAndText(io: ServiceIO, message: OpenAIAssistantData,
+      urls: URLSegments, content?: OpenAIAssistantContent) {
     const fileDetails = OpenAIAssistantUtils.getFileDetails(message, content);
     // gets files and replaces hyperlinks with base64 file encodings
-    return await OpenAIAssistantUtils.getFilesAndNewText(io, fileDetails, message.role, content);
+    return await OpenAIAssistantUtils.getFilesAndNewText(io, fileDetails, urls, message.role, content);
   }
 
   private static parseResult(result: OpenAIAssistantMessagesResult, isHistory: boolean) {
@@ -157,7 +161,7 @@ export class OpenAIAssistantUtils {
 
   // test this using this prompt and it should give 2 text mesages and a file:
   // "give example data for a csv and create a suitable bar chart"
-  private static parseMessages(io: DirectServiceIO, messages: OpenAIAssistantData[]) {
+  private static parseMessages(io: DirectServiceIO, messages: OpenAIAssistantData[], urls: URLSegments) {
     const parsedContent: Promise<{text?: string; files?: MessageFile[]}>[] = [];
     messages.forEach(async (data) => {
       data.content
@@ -168,18 +172,20 @@ export class OpenAIAssistantUtils {
           return 0;
         })
         .forEach(async (content) => {
-          parsedContent.push(OpenAIAssistantUtils.getFilesAndText(io, data, content));
+          parsedContent.push(OpenAIAssistantUtils.getFilesAndText(io, data, urls, content));
         });
     });
     return Promise.all(parsedContent);
   }
 
-  public static async processStreamMessages(io: DirectServiceIO, content: OpenAIAssistantContent[]) {
-    return OpenAIAssistantUtils.parseMessages(io, [{content, role: 'assistant'}]);
+  public static async processStreamMessages(io: DirectServiceIO, content: OpenAIAssistantContent[], urls: URLSegments) {
+    return OpenAIAssistantUtils.parseMessages(io, [{content, role: 'assistant'}], urls);
   }
 
-  public static async processAPIMessages(io: DirectServiceIO, result: OpenAIAssistantMessagesResult, isHistory: boolean) {
+  // prettier-ignore
+  public static async processAPIMessages(
+      io: DirectServiceIO, result: OpenAIAssistantMessagesResult, isHistory: boolean, urls: URLSegments) {
     const messages = OpenAIAssistantUtils.parseResult(result, isHistory);
-    return OpenAIAssistantUtils.parseMessages(io, messages);
+    return OpenAIAssistantUtils.parseMessages(io, messages, urls);
   }
 }