clean code

apps/app/src/features/openai/server/models/ai-assistant.ts

@@ -3,34 +3,38 @@ import { type Model, type Document, Schema } from 'mongoose';
 
 import { getOrCreateModel } from '~/server/util/mongoose-utils';
 
+/*
+*  AiAssistant Objects
+*/
 const AiAssistantType = {
   KNOWLEDGE: 'knowledge',
 } as const;
 
-type AiAssistantType = typeof AiAssistantType[keyof typeof AiAssistantType];
-
 const AiAssistantSharingScope = {
   PUBLIC: 'public',
   ONLY_ME: 'onlyMe',
   USER_GROUP: 'userGroup',
 } as const;
 
-type AiAssistantSharingScope = typeof AiAssistantSharingScope[keyof typeof AiAssistantSharingScope];
-
-
 const AiAssistantLearningScope = {
   PUBLIC: 'public',
   ONLY_ME: 'onlyMe',
   USER_GROUP: 'userGroup',
 } as const;
 
+
+/*
+*  AiAssistant interfaces
+*/
+type AiAssistantType = typeof AiAssistantType[keyof typeof AiAssistantType];
+type AiAssistantSharingScope = typeof AiAssistantSharingScope[keyof typeof AiAssistantSharingScope];
 type AiAssistantLearningScope = typeof AiAssistantLearningScope[keyof typeof AiAssistantLearningScope];
 
 interface AiAssistant {
   name: string;
   description?: string
   instruction?: string
-  vectorStoreId: string
+  vectorStoreId: string // VectorStoreId of OpenAI Specify (https://platform.openai.com/docs/api-reference/vector-stores/object)
   type: AiAssistantType[]
   pages: mongoose.Types.ObjectId[]
   sharingScope: AiAssistantSharingScope
@@ -42,6 +46,9 @@ interface AiAssistantDocument extends AiAssistant, Document {}
 type AiAssistantModel = Model<AiAssistantDocument>
 
 
+/*
+*  AiAssistant Schema
+*/
 const schema = new Schema<AiAssistantDocument>(
   {
     name: {