chore: address pr comments, add notes

Author: kevinkim-ogp

packages/backend/src/apps/aisay/common/constants.ts

@@ -8,6 +8,6 @@ export const DOCUMENT_TYPES = [
 
 export const DEFAULT_GENERALISED_MODEL_TYPE = 'standard'
 export const GENERALISED_MODEL_OPTIONS = [
-  { label: 'Standard', value: DEFAULT_GENERALISED_MODEL_TYPE },
-  { label: 'Vision', value: 'DOC_EXTRACTION_V2' },
+  { label: 'Standard', value: DEFAULT_GENERALISED_MODEL_TYPE }, // LLM
+  { label: 'Vision', value: 'DOC_EXTRACTION_V2' }, // VLM
 ]

packages/backend/src/apps/aisay/common/schema.ts

@@ -40,17 +40,23 @@ export const generalisedModelSchema = z.object({
     })
     return result
   }),
+  /**
+   * NOTE: the custom model type is indicated by the 'additonal_features' field in the request body
+   * 1. this function returns null when using the standard model as it is not required by default.
+   * 2. it is only included when using the vision generalised model.
+   * API doc: https://app.swaggerhub.com/apis-docs/DAMIENSKTWORK/bgp-aisay_document_extraction_api/1.0.11#/DocumentParserRequestS3GenericV2
+   */
   modelType: z
     .string()
     .optional()
     .transform((value) => {
-      if (!value) {
+      if (!value || value === DEFAULT_GENERALISED_MODEL_TYPE) {
         return null
       }
 
       const allowedValues = GENERALISED_MODEL_OPTIONS.map(
         (option) => option.value,
-      ).filter((value) => value !== DEFAULT_GENERALISED_MODEL_TYPE)
+      )
 
       if (!allowedValues.includes(value)) {
         return null