Setup generateTimetable function call

Author: kevin-lann

course-matrix/backend/src/constants/availableFunctions.ts

@@ -5,7 +5,8 @@ import { Request } from "express";
 export type FunctionNames =
   | "getTimetables"
   | "updateTimetable"
-  | "deleteTimetable";
+  | "deleteTimetable"
+  | "generateTimetable";
 
 type AvailableFunctions = {
   [K in FunctionNames]: (args: any, req: Request) => Promise<any>;
@@ -168,4 +169,7 @@ export const availableFunctions: AvailableFunctions = {
       return { status: 500, error: error };
     }
   },
+  generateTimetable: async (args: any, req: Request) => {
+    
+  }
 };

course-matrix/backend/src/controllers/aiController.ts

@@ -39,6 +39,7 @@ import {
 import { z } from "zod";
 import { analyzeQuery } from "../utils/analyzeQuery";
 import { includeFilters } from "../utils/includeFilters";
+import { TimetableFormSchema } from "../models/timetable-form";
 
 const openai = createOpenAI({
   baseURL: process.env.OPENAI_BASE_URL,
@@ -281,6 +282,13 @@ export const chat = asyncHandler(async (req: Request, res: Response) => {
               return await availableFunctions.deleteTimetable(args, req);
             },
           }),
+          generateTimetable: tool({
+            description: "Generate a timetable based on selected courses and restrictions",
+            parameters: TimetableFormSchema,
+            execute: async (args) => {
+              return await availableFunctions.generateTimetable(args, req)
+            }
+          })
         },
         maxSteps: CHATBOT_TOOL_CALL_MAX_STEPS, // Controls how many back and forths the model can take with user or calling multiple tools
         experimental_repairToolCall: async ({

course-matrix/backend/src/models/timetable-form.ts

@@ -0,0 +1,85 @@
+import { z, ZodType } from "zod";
+
+export type TimetableForm = {
+  name: string;
+  date: Date;
+  semester: string;
+  search: string;
+  courses: {
+    id: number;
+    code: string;
+    name: string;
+  }[];
+  restrictions: RestrictionForm[];
+};
+
+export type RestrictionForm = {
+  type: string;
+  days?: string[];
+  numDays?: number;
+  startTime?: Date;
+  endTime?: Date;
+  disabled?: boolean;
+};
+
+export const daysOfWeek = [
+  {
+    id: "MO",
+    label: "Monday",
+  },
+  {
+    id: "TU",
+    label: "Tuesday",
+  },
+  {
+    id: "WE",
+    label: "Wednesday",
+  },
+  {
+    id: "TH",
+    label: "Thursday",
+  },
+  {
+    id: "FR",
+    label: "Friday",
+  },
+] as const;
+
+export const SemesterEnum = z.enum(["Summer 2025", "Fall 2025", "Winter 2026"]);
+
+export const CourseSchema = z.object({
+  id: z.number(),
+  code: z
+    .string()
+    .max(8, "Invalid course code")
+    .min(1, "Course code is required"),
+  name: z.string(),
+});
+
+export const RestrictionSchema = z
+  .object({
+    type: z.string().min(1, "Restriction type is required"),
+    days: z.array(z.string()).optional(),
+    numDays: z
+      .number()
+      .positive()
+      .max(4, "Cannot block all days of the week")
+      .optional(),
+    startTime: z.date().optional(),
+    endTime: z.date().optional(),
+    disabled: z.boolean().optional(),
+  })
+
+export const TimetableFormSchema = z
+  .object({
+    name: z
+      .string()
+      .max(100, "Name cannot exceed 100 characters")
+      .min(1, "Name cannot be empty"),
+    date: z.date(),
+    semester: SemesterEnum,
+    search: z.string(),
+    courses: z.array(CourseSchema),
+    restrictions: z.array(RestrictionSchema),
+  });
+