chore: rename parameter to prompts

Author: kevinkim-ogp

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

@@ -12,12 +12,12 @@ describe('AISAY schema', () => {
   beforeEach(() => {
     generalisedModelPayload = {
       file: 's3:plumber-test-bucket:123456/789abc/plumber-logo.jpg',
-      infoToExtract: [
+      prompts: [
         {
-          infoToExtract: 'What is your name?',
+          prompt: 'What is your name?',
         },
         {
-          infoToExtract: 'What is your age?',
+          prompt: 'What is your age?',
         },
       ],
     }
@@ -36,13 +36,13 @@ describe('AISAY schema', () => {
         result.data.file ===
           's3:plumber-test-bucket:123456/789abc/plumber-logo.jpg',
       )
-      assert(Object.keys(result.data.infoToExtract).length === 2)
+      assert(Object.keys(result.data.prompts).length === 2)
       assert(
-        result.data.infoToExtract['additionalProp0'].description ===
+        result.data.prompts['additionalProp0'].description ===
           'Extract the What is your name?',
       )
       assert(
-        result.data.infoToExtract['additionalProp1'].description ===
+        result.data.prompts['additionalProp1'].description ===
           'Extract the What is your age?',
       )
     })

packages/backend/src/apps/aisay/actions/use-generalised-model/get-data-out-metadata.ts

@@ -1,6 +1,6 @@
 import { IDataOutMetadata, IExecutionStep } from '@plumber/types'
 
-import { getInfoToExtract } from '../../common/info-to-extract'
+import { getPrompts } from '../../common/get-prompts'
 
 async function getDataOutMetadata(
   executionStep: IExecutionStep,
@@ -11,23 +11,29 @@ async function getDataOutMetadata(
     return null
   }
 
-  const infoToExtract = await getInfoToExtract(stepId)
+  const prompts = await getPrompts(stepId)
 
   const fieldsMetadata: Record<string, IDataOutMetadata> = {}
   Object.keys(dataOut.fields).forEach((key) => {
     const index = parseInt(key.split('additionalProp')[1])
-    const fieldName = infoToExtract[index]
+    const fieldName = prompts[index]
     fieldsMetadata[key] = {
       label: fieldName,
     }
   })
 
+  const otherMetadata: Record<string, IDataOutMetadata> = {}
+  Object.keys(dataOut).forEach((key) => {
+    if (key !== 'fields') {
+      otherMetadata[key] = {
+        isHidden: true,
+      }
+    }
+  })
+
   return {
-    quota: {
-      label: 'Quota',
-      isHidden: true,
-    },
     fields: fieldsMetadata,
+    ...otherMetadata,
   }
 }
 

packages/backend/src/apps/aisay/actions/use-generalised-model/index.ts

@@ -28,15 +28,15 @@ const action: IRawAction = {
       label: 'Prompts',
       description:
         'Enter prompts to specify how the data should be interpreted and extracted',
-      key: 'infoToExtract',
+      key: 'prompts',
       type: 'multirow' as const,
       required: true,
       variables: true,
       addRowButtonText: 'Add prompt',
       subFields: [
         {
           placeholder: 'E.g. Return the price of individual line items',
-          key: 'infoToExtract',
+          key: 'prompt',
           type: 'string' as const,
           required: true,
           variables: false,
@@ -50,9 +50,9 @@ const action: IRawAction = {
   getDataOutMetadata,
 
   async run($) {
-    const { file, infoToExtract } = $.step.parameters as {
+    const { file, prompts } = $.step.parameters as {
       file: string
-      infoToExtract: Array<{ infoToExtract: string }>
+      prompts: Array<{ prompt: string }>
     }
 
     if (!$.auth.data?.clientId || !$.auth.data?.clientSecret) {
@@ -64,7 +64,7 @@ const action: IRawAction = {
       )
     }
 
-    const result = generalisedModelSchema.safeParse({ file, infoToExtract })
+    const result = generalisedModelSchema.safeParse({ file, prompts })
     if (!result.success) {
       const { stepErrorName, stepErrorSolution } = getValidationError(result)
 
@@ -93,7 +93,7 @@ const action: IRawAction = {
           Authorization: `Bearer ${token}`,
         },
         data: {
-          gpt_query: result.data.infoToExtract,
+          gpt_query: result.data.prompts,
           image: attachment.data,
         },
       })

packages/backend/src/apps/aisay/common/get-prompts.ts

@@ -0,0 +1,9 @@
+import Step from '@/models/step'
+
+export const getPrompts = async (stepId: string) => {
+  const step = await Step.query().findById(stepId)
+  if (!Array.isArray(step.parameters.prompts)) {
+    return []
+  }
+  return step.parameters.prompts.map((i: { prompt: string }) => i.prompt)
+}

packages/backend/src/apps/aisay/common/info-to-extract.ts

@@ -26,18 +26,16 @@ export const fileSchema = z.string().transform((value, context) => {
 
 export const generalisedModelSchema = z.object({
   file: fileSchema,
-  infoToExtract: z
-    .array(z.object({ infoToExtract: z.string() }))
-    .transform((array) => {
-      const result: Record<string, { description: string; type: string }> = {}
-      array.forEach((a, index) => {
-        result[`additionalProp${index}`] = {
-          description: `Extract the ${a.infoToExtract}`,
-          type: 'string',
-        }
-      })
-      return result
-    }),
+  prompts: z.array(z.object({ prompt: z.string() })).transform((array) => {
+    const result: Record<string, { description: string; type: string }> = {}
+    array.forEach((a, index) => {
+      result[`additionalProp${index}`] = {
+        description: `Extract the ${a.prompt}`,
+        type: 'string',
+      }
+    })
+    return result
+  }),
 })
 
 export const documentTypeEnum = z.enum(DOCUMENT_TYPES as [string, ...string[]])