clean up for responses api: update context state management

Author: sutigit

src/server/util/azure/clientV2.ts

@@ -8,16 +8,19 @@ import logger from '../logger'
 
 import { APIError } from '../../types'
 import { AzureOpenAI } from 'openai'
+
 // import { EventStream } from '@azure/openai'
 import { Stream } from 'openai/streaming'
 import {
+  FileSearchTool,
   FunctionTool,
   ResponseInput,
   ResponseInputItem,
   ResponseStreamEvent,
 } from 'openai/resources/responses/responses'
 
-import { testTool } from './tools'
+// import { ohtuRAGTest } from './functionTools'
+import { fileSearchTest } from './fileSearchTools'
 
 const endpoint = `https://${AZURE_RESOURCE}.openai.azure.com/`
 
@@ -34,7 +37,7 @@ const client = getAzureOpenAIClient(process.env.GPT_4O)
 export class ResponsesClient {
   model: string
   instructions: string
-  tools: FunctionTool[]
+  tools: (FunctionTool | FileSearchTool)[]
 
   constructor(model: string, instructions?: string) {
     const deploymentId = validModels.find((m) => m.name === model)?.deployment
@@ -45,8 +48,13 @@ export class ResponsesClient {
       )
 
     this.model = deploymentId
-    this.instructions = instructions || 'Olet avulias apuri.'
-    this.tools = [testTool.definition]
+    this.instructions =
+      instructions ||
+      'Olet ohjelmistotuotanto kurssin avustaja. Jos käyttäjä kysyy jotain, niin arvioi ensin liittyykö se ohjelmistotuotannon kurssiin. Jos liittyy, niin toteuta file_search. jos et löydä sopivia tiedostoja, niin sano että haulla ei löytynyt mitään. Jos käyttäjän viesti ei liittynyt ohjelmistotuotannon kurssiin, niin kysy ystävällisesti voitko auttaa jotenkin muuten kurssimateriaalien suhteen.'
+    this.tools = [
+      // ohtuRAGTest.definition,
+      fileSearchTest.definition,
+    ]
   }
 
   async createResponse({
@@ -57,10 +65,12 @@ export class ResponsesClient {
     try {
       return await client.responses.create({
         model: this.model,
+        // previous_response_id=response.id // THIS MIGHT BE IT!!!!!!1
         instructions: this.instructions,
         input,
         stream: true,
         tools: this.tools,
+        tool_choice: 'auto',
       })
     } catch (error: any) {
       logger.error(error)
@@ -75,7 +85,7 @@ export class ResponsesClient {
     encoding,
     res,
   }: {
-    events: Stream<any>
+    events: Stream<ResponseStreamEvent>
     prevMessages: ResponseInput
     encoding: Tiktoken
     res: Response
@@ -94,27 +104,20 @@ export class ResponsesClient {
           tokenCount += encoding.encode(event.delta).length ?? 0
           break
 
+        case 'response.file_search_call.completed':
+          console.log('file search completed')
+          break
+
+        case 'response.output_item.done':
+          console.log('OUTPUT_ITEM DONE???', JSON.stringify(event, null, 2))
+          break
+
+        case 'response.output_text.annotation.added':
+          console.log('ANNOTATIONS ADDED', JSON.stringify(event, null, 2))
+          break
+
         case 'response.function_call_arguments.done':
-          // WORK IN PROGRESS
-
-          // const augRetrieval = await this.callToolFunction(
-          //   event.arguments,
-          //   event.call_id
-          // )
-          // const newEvents = await this.createResponse({
-          //   input: [...prevMessages, augRetrieval],
-          // })
-
-          // if (isError(events)) {
-          //   throw new Error(`Error creating response from function call`)
-          // }
-
-          // await this.handleResponse({
-          //   events: newEvents as Stream<ResponseStreamEvent>,
-          //   prevMessages: [...prevMessages, augRetrieval],
-          //   encoding,
-          //   res,
-          // })
+          // Listen to file_search instead
           break
       }
     }
@@ -141,29 +144,4 @@ export class ResponsesClient {
       }
     })
   }
-
-  private async callToolFunction(
-    args: string,
-    callId: string
-  ): Promise<ResponseInputItem[]> {
-    const { query } = JSON.parse(args)
-    try {
-      const retrieval = await testTool.function(query)
-
-      return [
-        {
-          role: 'user',
-          content: retrieval.query,
-        },
-        {
-          type: 'function_call_output',
-          call_id: callId,
-          output: retrieval.result,
-        },
-      ]
-    } catch (error) {
-      logger.error('Error calling tool function:', error)
-      return null
-    }
-  }
 }

src/server/util/azure/fileSearchTools.ts

@@ -0,0 +1,15 @@
+import { FileSearchTool } from 'openai/resources/responses/responses'
+
+interface FileSearchObject {
+  definition: FileSearchTool
+}
+
+export const fileSearchTest: FileSearchObject = {
+  definition: {
+    type: 'file_search',
+    vector_store_ids: ['vs_Lsyd0uMbgeT8lS9pnxZQEl3c'], // vector store ID for ohtu-test
+    max_num_results: 5,
+    // filters: "",
+    // ranking_options: ""
+  },
+}

src/server/util/azure/functionTools.ts

@@ -0,0 +1,79 @@
+import { AzureOpenAI } from 'openai'
+import { FunctionTool } from 'openai/resources/responses/responses'
+
+interface functionCallObject {
+  definition: FunctionTool
+  function: (client: AzureOpenAI, query: string) => Promise<any>
+}
+
+export const functionCallTest: functionCallObject = {
+  definition: {
+    type: 'function',
+    name: 'test_knowledge_retrieval',
+    description:
+      'Test tool for knowledge retrieval. Always call this when user says TEST-RAG',
+    parameters: {
+      type: 'object',
+      properties: {
+        query: {
+          type: 'string',
+          description: 'Users query for knowledge retrieval',
+        },
+      },
+      required: ['query'],
+      additionalProperties: false,
+    },
+    strict: true, // or true, depending on your requirements
+  },
+  function: async (
+    client: AzureOpenAI,
+    query: string
+  ): Promise<{ query: string; result: string }> => {
+    // Simulate a tool function that returns a simple message
+    return {
+      query,
+      result:
+        'This is a test result from the test tool. The secret is: Chili kastike',
+    }
+  },
+}
+
+export const ohtuRAGTest: functionCallObject = {
+  // FUNCITON TOOL CALL FOR VECTOR DB /search ENDPOINT IS NOT CURRENTLY SUPPORTED BY OPENAI
+  definition: {
+    type: 'function',
+    name: 'ohtu_retrieval',
+    description:
+      'Helsingin yliopiston ohjelmistotuotannon kurssimateriaalin haku funktio. Kutsu tätä kun käyttäjä haluaa tietoa kurssiin liittyen. Muuten älä kutsu tätä.',
+    parameters: {
+      type: 'object',
+      properties: {
+        query: {
+          type: 'string',
+          description: 'Käyttäjän kysymys kurssimateriaalista',
+        },
+      },
+      required: ['query'],
+      additionalProperties: false,
+    },
+    strict: true, // or true, depending on your requirements
+  },
+  function: async (client: AzureOpenAI, query: string): Promise<any> => {
+    // Simulate a tool function that returns a simple message
+
+    // console.log('KUTSUTAAN RAG FUNKTIOTA')
+
+    // const indexit = await client.vectorStores.list()
+    // const vs = indexit.data.filter((index) => index.name === 'ohtu-test')[0]
+
+    // console.log('INDEX', vs)
+
+    // const results = await client.vectorStores.search(vs.id, {
+    //   query,
+    //   max_num_results: 10,
+    //   rewrite_query: true,
+    // })
+
+    return null
+  },
+}