refactor chatV2 responses API config for courseId and lint fix

Author: sutigit

src/client/components/Chat/ModelSelector.tsx

@@ -31,6 +31,4 @@ const ModelSelector = ({ currentModel, setModel, models }: { currentModel: strin
   )
 }
 
-
-
-export default ModelSelector
+export default ModelSelector

src/client/components/Chat/Status.tsx

@@ -1,7 +1,7 @@
 import { useTranslation } from 'react-i18next'
 import { Box, Typography, MenuItem, FormControl, Select, SelectChangeEvent, InputLabel } from '@mui/material'
 import { FREE_MODEL } from '../../../config'
-import ModelSelector from './ModelSelector';
+import ModelSelector from './ModelSelector'
 
 const Status = ({ model, setModel, models, usage, limit }: { model: string; setModel: (model: string) => void; models: string[]; usage: number; limit: number }) => {
   const { t } = useTranslation()

src/client/components/ChatV2/ChatBox.tsx

@@ -1,9 +1,9 @@
 import { Send } from '@mui/icons-material'
 import { Box, Container, IconButton, Paper, TextField, Typography } from '@mui/material'
 import { useEffect, useState } from 'react'
-import useUserStatus from '../../hooks/useUserStatus';
-import { useParams } from 'react-router-dom';
-import { useTranslation } from 'react-i18next';
+import useUserStatus from '../../hooks/useUserStatus'
+import { useParams } from 'react-router-dom'
+import { useTranslation } from 'react-i18next'
 
 export const ChatBox = ({ disabled, onSubmit }: { disabled: boolean; onSubmit: (message: string) => void }) => {
   const { courseId } = useParams()
@@ -23,8 +23,8 @@ export const ChatBox = ({ disabled, onSubmit }: { disabled: boolean; onSubmit: (
     console.log('userStatus', userStatus)
   })
 
-  if(statusLoading) {
-    return (<p>loading</p>)
+  if (statusLoading) {
+    return <p>loading</p>
   }
   return (
     <Container
@@ -73,13 +73,12 @@ export const ChatBox = ({ disabled, onSubmit }: { disabled: boolean; onSubmit: (
             },
           }}
         />
-        
+
         <Box>
           <Typography variant="body1" style={{ padding: '0.5rem', fontSize: '0.875rem' }}>
             {userStatus.usage} / {userStatus.limit} {t('status:tokensUsed')}
           </Typography>
         </Box>
-
       </Paper>
     </Container>
   )

src/client/components/ChatV2/ChatV2.tsx

@@ -168,7 +168,6 @@ export const ChatV2 = () => {
         flexDirection: 'column',
       }}
     >
-    
       <SettingsModal open={settingsModalOpen} setOpen={setSettingsModalOpen}></SettingsModal>
       <Box sx={{ display: 'flex', gap: '1rem' }}>
         {disclaimerInfo && <Disclaimer disclaimer={disclaimerInfo} />}
@@ -177,7 +176,6 @@ export const ChatV2 = () => {
         <IconButton onClick={() => setSettingsModalOpen(true)} title="Settings">
           <Settings></Settings>
         </IconButton>
-
       </Box>
       <Box ref={chatContainerRef}>
         <Conversation messages={messages} completion={completion} />

src/client/components/ChatV2/SettingsModal.tsx

@@ -1,14 +1,10 @@
-import { Close } from "@mui/icons-material"
-import { Box, IconButton, Modal, Typography } from "@mui/material"
+import { Close } from '@mui/icons-material'
+import { Box, IconButton, Modal, Typography } from '@mui/material'
 
-
-
-
-
-export const SettingsModal = ({open, setOpen}) => {
-  return(
+export const SettingsModal = ({ open, setOpen }) => {
+  return (
     <Modal open={open} onClose={() => setOpen(false)}>
-    <Box
+      <Box
         sx={{
           position: 'absolute',
           top: '50%',
@@ -21,18 +17,13 @@ export const SettingsModal = ({open, setOpen}) => {
           p: 4,
         }}
       >
-        <IconButton
-          onClick={() => setOpen(false)}
-          sx={{ position: 'absolute', top: 8, right: 8, color: 'grey.500' }}
-        >
+        <IconButton onClick={() => setOpen(false)} sx={{ position: 'absolute', top: 8, right: 8, color: 'grey.500' }}>
           <Close></Close>
         </IconButton>
         <Typography id="modal-title" variant="h6" component="h2">
           Settings
         </Typography>
-        
-      
       </Box>
     </Modal>
   )
-}
+}

src/server/routes/openai.ts

@@ -5,7 +5,7 @@ import { CourseChatRequest, RequestWithUser } from '../types'
 import { isError } from '../util/parser'
 import { calculateUsage, incrementUsage, checkUsage, checkCourseUsage, incrementCourseUsage } from '../services/chatInstances/usage'
 import { getCompletionEvents, streamCompletion } from '../util/azure/client'
-import { ResponsesClient } from '../util/azure/clientV2'
+import { ResponsesClient } from '../util/azure/ResponsesAPI'
 import { getMessageContext, getModelContextLimit, getCourseModel, getAllowedModels } from '../util/util'
 import getEncoding from '../util/tiktoken'
 import logger from '../util/logger'
@@ -100,7 +100,9 @@ openaiRouter.post('/stream/:version?', upload.single('file'), async (r, res) =>
     return
   }
 
-  const responsesClient = new ResponsesClient(model)
+  const responsesClient = new ResponsesClient({
+    model,
+  })
 
   let events
   if (version === 'v2') {
@@ -119,7 +121,6 @@ openaiRouter.post('/stream/:version?', upload.single('file'), async (r, res) =>
   if (version === 'v2') {
     completion = await responsesClient.handleResponse({
       events,
-      prevMessages: options.messages,
       encoding,
       res,
     })
@@ -216,7 +217,10 @@ openaiRouter.post('/stream/:courseId/:version?', upload.single('file'), async (r
     return
   }
 
-  const responsesClient = new ResponsesClient(model)
+  const responsesClient = new ResponsesClient({
+    model,
+    courseId,
+  })
 
   let events
   if (version === 'v2') {
@@ -236,7 +240,6 @@ openaiRouter.post('/stream/:courseId/:version?', upload.single('file'), async (r
   if (version === 'v2') {
     completion = await responsesClient.handleResponse({
       events,
-      prevMessages: options.messages,
       encoding,
       res,
     })

src/server/util/azure/clientV2.ts renamed to src/server/util/azure/ResponsesAPI.ts

@@ -1,6 +1,6 @@
 import { Tiktoken } from '@dqbd/tiktoken'
 import { Response } from 'express'
-import { isError } from '../../util/parser'
+import { isError } from '../parser'
 
 import { AZURE_RESOURCE, AZURE_API_KEY } from '../config'
 import { validModels, inProduction } from '../../../config'
@@ -11,16 +11,10 @@ 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 { FileSearchTool, FunctionTool, ResponseInput, ResponseInputItem, ResponseStreamEvent } from 'openai/resources/responses/responses'
 
-// import { ohtuRAGTest } from './functionTools'
-import { fileSearchTest } from './fileSearchTools'
+import { courseAssistants, type CourseAssistant } from './courseAssistants'
+import { createFileSearchTool } from './util'
 
 const endpoint = `https://${AZURE_RESOURCE}.openai.azure.com/`
 
@@ -37,31 +31,36 @@ const client = getAzureOpenAIClient(process.env.GPT_4O)
 export class ResponsesClient {
   model: string
   instructions: string
-  tools: (FunctionTool | FileSearchTool)[]
+  tools: FileSearchTool[]
 
-  constructor(model: string, instructions?: string) {
+  constructor({ model, courseId }: { model: string; courseId?: string }) {
     const deploymentId = validModels.find((m) => m.name === model)?.deployment
 
-    if (!deploymentId)
-      throw new Error(
-        `Invalid model: ${model}, not one of ${validModels.map((m) => m.name).join(', ')}`
-      )
+    if (!deploymentId) throw new Error(`Invalid model: ${model}, not one of ${validModels.map((m) => m.name).join(', ')}`)
+
+    let courseAssistant: CourseAssistant
+
+    if (courseId) {
+      courseAssistant = courseAssistants.find((assistant) => assistant.course_id === courseId)
+
+      if (!courseAssistant) throw new Error(`No course assistant found for course ID: ${courseId}`)
+    } else {
+      courseAssistant = courseAssistants.find((assistant) => assistant.name === 'default')
+    }
 
     this.model = deploymentId
-    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,
-    ]
+    this.instructions = courseAssistant.assistant_instruction
+
+    const fileSearchTool = courseId
+      ? createFileSearchTool({
+          vectorStoreId: courseAssistant.vector_store_id,
+        })
+      : null
+
+    this.tools = [fileSearchTool]
   }
 
-  async createResponse({
-    input,
-  }: {
-    input: ResponseInput
-  }): Promise<Stream<ResponseStreamEvent> | APIError> {
+  async createResponse({ input }: { input: ResponseInput }): Promise<Stream<ResponseStreamEvent> | APIError> {
     try {
       return await client.responses.create({
         model: this.model,
@@ -79,17 +78,7 @@ export class ResponsesClient {
     }
   }
 
-  async handleResponse({
-    events,
-    prevMessages,
-    encoding,
-    res,
-  }: {
-    events: Stream<ResponseStreamEvent>
-    prevMessages: ResponseInput
-    encoding: Tiktoken
-    res: Response
-  }) {
+  async handleResponse({ events, encoding, res }: { events: Stream<ResponseStreamEvent>; encoding: Tiktoken; res: Response }) {
     let tokenCount = 0
     const contents = []
 

src/server/util/azure/courseAssistants.ts

@@ -0,0 +1,23 @@
+export interface CourseAssistant {
+  course_id: string
+  name: string
+  assistant_instruction: string
+  vector_store_id: string
+}
+
+export const courseAssistants = [
+  {
+    // default assistant, without course
+    course_id: null,
+    name: 'default',
+    assistant_instruction: 'Olet avualias avustaja.',
+    vector_store_id: null,
+  },
+  {
+    course_id: '123',
+    name: 'ohtu-kurssi',
+    assistant_instruction:
+      '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.',
+    vector_store_id: 'vs_Lsyd0uMbgeT8lS9pnxZQEl3c',
+  },
+] as const satisfies CourseAssistant[]

src/server/util/azure/functionTools.ts

@@ -10,8 +10,7 @@ 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',
+    description: 'Test tool for knowledge retrieval. Always call this when user says TEST-RAG',
     parameters: {
       type: 'object',
       properties: {
@@ -25,15 +24,11 @@ export const functionCallTest: functionCallObject = {
     },
     strict: true, // or true, depending on your requirements
   },
-  function: async (
-    client: AzureOpenAI,
-    query: string
-  ): Promise<{ query: string; result: string }> => {
+  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',
+      result: 'This is a test result from the test tool. The secret is: Chili kastike',
     }
   },
 }
@@ -43,8 +38,7 @@ export const ohtuRAGTest: functionCallObject = {
   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ä.',
+    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: {

src/server/util/azure/util.ts

@@ -0,0 +1,32 @@
+import { FileSearchTool } from 'openai/resources/responses/responses'
+import { ComparisonFilter, CompoundFilter } from 'openai/resources/shared'
+
+/**
+ * Creates a file search tool configuration for Azure OpenAI for a specific vector store.
+ *
+ * @param vectorStoreId - The ID of the vector store to search.
+ * @param maxResults - The maximum number of results to return. Default is 5.
+ * @param filters - Optional filters to apply to the search results. Check types for `ComparisonFilter` and `CompoundFilter` from OpenAI resources.
+ * @param rankingOptions - Optional ranking options to apply to the search results. Check `FileSearchTool.RankingOptions` from OpenAI resources.
+ *
+ * @returns An object representing the file search tool configuration.
+ */
+export const createFileSearchTool = ({
+  vectorStoreId,
+  maxResults = 5,
+  filters,
+  rankingOptions,
+}: {
+  vectorStoreId: string
+  maxResults?: number
+  filters?: ComparisonFilter | CompoundFilter
+  rankingOptions?: FileSearchTool.RankingOptions
+}): FileSearchTool => {
+  return {
+    type: 'file_search',
+    vector_store_ids: [vectorStoreId],
+    max_num_results: maxResults,
+    filters,
+    ranking_options: rankingOptions,
+  }
+}