better typing - discriminated unions

packages/builder/src/components/backend/DataTable/modals/CreateEditColumn.svelte

@@ -417,13 +417,13 @@
         FIELDS.BOOLEAN,
         FIELDS.DATETIME,
         FIELDS.LINK,
+        FIELDS.AI,
         FIELDS.LONGFORM,
         FIELDS.USER,
         FIELDS.USERS,
         FIELDS.ATTACHMENT_SINGLE,
         FIELDS.ATTACHMENTS,
         FIELDS.FORMULA,
-        FIELDS.AI,
         FIELDS.JSON,
         FIELDS.BARCODEQR,
         FIELDS.SIGNATURE_SINGLE,

packages/builder/src/components/common/AIFieldConfiguration.svelte

@@ -1,5 +1,5 @@
 <script>
-  import { Input, Multiselect, Select, TextArea } from "@budibase/bbui"
+  import { Input, Helpers, Multiselect, Select, TextArea } from "@budibase/bbui"
   import ServerBindingPanel from "components/common/bindings/ServerBindingPanel.svelte"
   import ModalBindableInput from "components/common/bindings/ModalBindableInput.svelte"
 
@@ -44,32 +44,26 @@
   const OperationFields = {
     SUMMARISE_TEXT: {
       columns: OperationFieldTypes.MULTI_COLUMN,
-      prompt: OperationFieldTypes.BINDABLE_TEXT,
     },
     CLEAN_DATA: {
       column: OperationFieldTypes.COLUMN,
-      prompt: OperationFieldTypes.BINDABLE_TEXT,
     },
     TRANSLATE: {
       column: OperationFieldTypes.COLUMN,
       language: OperationFieldTypes.BINDABLE_TEXT,
-      prompt: OperationFieldTypes.BINDABLE_TEXT,
     },
     CATEGORISE_TEXT: {
       columns: OperationFieldTypes.MULTI_COLUMN,
       categories: OperationFieldTypes.BINDABLE_TEXT,
-      prompt: OperationFieldTypes.BINDABLE_TEXT,
     },
     SENTIMENT_ANALYSIS: {
       column: OperationFieldTypes.COLUMN,
-      prompt: OperationFieldTypes.BINDABLE_TEXT,
     },
     PROMPT: {
       prompt: OperationFieldTypes.BINDABLE_TEXT,
     },
     SEARCH_WEB: {
       columns: OperationFieldTypes.MULTI_COLUMN,
-      prompt: OperationFieldTypes.BINDABLE_TEXT,
     }
   }
 
@@ -90,6 +84,7 @@
 </script>
 
 <Select
+  label={"Operation"}
   options={AIFieldConfigOptions}
   bind:value={aiField.operation}
 />
@@ -97,7 +92,7 @@
   {#each Object.keys(OperationField) as key}
     {#if OperationField[key] === OperationFieldTypes.BINDABLE_TEXT}
       <ModalBindableInput
-        label={key}
+        label={Helpers.capitalise(key)}
         panel={ServerBindingPanel}
         title="Prompt"
         on:change={e => aiField[key] = e.detail}
@@ -109,13 +104,13 @@
     {:else if OperationField[key] === OperationFieldTypes.MULTI_COLUMN}
       <Multiselect
         bind:value={aiField[key]}
-        label={key}
+        label={Helpers.capitalise(key)}
         options={schemaWithoutRelations}
       />
     {:else if OperationField[key] === OperationFieldTypes.COLUMN}
       <Select
         bind:value={aiField[key]}
-        label={key}
+        label={Helpers.capitalise(key)}
         options={schemaWithoutRelations}
       />
     {/if}

packages/pro

@@ -1 +1 @@
-Subproject commit dcc9e50b8064a2097d408771462ad80f48de7ff6
+Subproject commit d194be2339a1ee2e5b2ed1fe59d103249f2d8d2c

packages/server/src/api/controllers/table/bulkFormula.ts

@@ -198,7 +198,7 @@ export async function runAIColumnChecks(
   table: Table,
   { oldTable }: { oldTable?: Table }
 ) {
-  // look to see if any formula values have changed
+  // look to see if any AI column values have changed
   const shouldUpdate = Object.values(table.schema).find(
     column =>
       column.type === FieldType.AI &&
@@ -206,7 +206,7 @@ export async function runAIColumnChecks(
         !oldTable.schema[column.name] ||
         !isEqual(oldTable.schema[column.name], column))
   )
-  // if a static formula column has updated, then need to run the update
+  // if an AI column has updated, then need to run the update
   if (shouldUpdate != null) {
     await updateAllAIColumnsInTable(table)
   }

packages/types/src/documents/app/ai.ts

@@ -0,0 +1,105 @@
+
+export enum AIOperationEnum {
+  SUMMARISE_TEXT = "SUMMARISE_TEXT",
+  CLEAN_DATA = "CLEAN_DATA",
+  TRANSLATE = "TRANSLATE",
+  CATEGORISE_TEXT = "CATEGORISE_TEXT",
+  SENTIMENT_ANALYSIS = "SENTIMENT_ANALYSIS",
+  PROMPT = "PROMPT",
+  SEARCH_WEB = "SEARCH_WEB",
+}
+
+
+enum OperationFieldTypeEnum {
+  MULTI_COLUMN = "columns",
+  COLUMN = "column",
+  BINDABLE_TEXT = "prompt",
+}
+
+
+type OperationFieldsType = {
+  [AIOperationEnum.SUMMARISE_TEXT]: {
+    columns: OperationFieldTypeEnum.MULTI_COLUMN
+  }
+  [AIOperationEnum.CLEAN_DATA]: {
+    column: OperationFieldTypeEnum.COLUMN
+  }
+  [AIOperationEnum.TRANSLATE]: {
+    column: OperationFieldTypeEnum.COLUMN
+    language: OperationFieldTypeEnum.BINDABLE_TEXT
+  }
+  [AIOperationEnum.CATEGORISE_TEXT]: {
+    columns: OperationFieldTypeEnum.MULTI_COLUMN
+    categories: OperationFieldTypeEnum.BINDABLE_TEXT
+  }
+  [AIOperationEnum.SENTIMENT_ANALYSIS]: {
+    column: OperationFieldTypeEnum.COLUMN
+  }
+  [AIOperationEnum.PROMPT]: {
+    prompt: OperationFieldTypeEnum.BINDABLE_TEXT
+  }
+  [AIOperationEnum.SEARCH_WEB]: {
+    columns: OperationFieldTypeEnum.MULTI_COLUMN
+  }
+}
+
+// Define the AI operations with just their labels (no need for separate 'value' property)
+const AIOperations: { [key in AIOperationEnum]: string } = {
+  [AIOperationEnum.SUMMARISE_TEXT]: "Summarise Text",
+  [AIOperationEnum.CLEAN_DATA]: "Clean Data",
+  [AIOperationEnum.TRANSLATE]: "Translate",
+  [AIOperationEnum.CATEGORISE_TEXT]: "Categorise Text",
+  [AIOperationEnum.SENTIMENT_ANALYSIS]: "Sentiment Analysis",
+  [AIOperationEnum.PROMPT]: "Prompt",
+  [AIOperationEnum.SEARCH_WEB]: "Search Web",
+}
+
+type BaseSchema = {
+  operation: AIOperationEnum
+}
+
+type SummariseTextSchema = BaseSchema & {
+  operation: AIOperationEnum.SUMMARISE_TEXT
+  columns: string[]
+}
+
+type CleanDataSchema = BaseSchema & {
+  operation: AIOperationEnum.CLEAN_DATA
+  column: string
+}
+
+type TranslateSchema = BaseSchema & {
+  operation: AIOperationEnum.TRANSLATE
+  column: string
+  language: string
+}
+
+type CategoriseTextSchema = BaseSchema & {
+  operation: AIOperationEnum.CATEGORISE_TEXT
+  columns: string[]
+  categories: string
+}
+
+type SentimentAnalysisSchema = BaseSchema & {
+  operation: AIOperationEnum.SENTIMENT_ANALYSIS
+  column: string
+}
+
+type PromptSchema = BaseSchema & {
+  operation: AIOperationEnum.PROMPT
+  prompt: string
+}
+
+type SearchWebSchema = BaseSchema & {
+  operation: AIOperationEnum.SEARCH_WEB
+  columns: string[]
+}
+
+export type AIColumnSchema =
+  | SummariseTextSchema
+  | CleanDataSchema
+  | TranslateSchema
+  | CategoriseTextSchema
+  | SentimentAnalysisSchema
+  | PromptSchema
+  | SearchWebSchema

packages/types/src/documents/app/index.ts

@@ -1,3 +1,4 @@
+export * from "./ai"
 export * from "./app"
 export * from "./automation"
 export * from "./datasource"

packages/types/src/documents/app/table/schema.ts

@@ -9,6 +9,7 @@ import {
   JsonFieldSubType,
   RelationshipType,
 } from "./constants"
+import { AIOperationEnum } from "../ai"
 
 export interface UIFieldMetadata {
   order?: number
@@ -119,10 +120,10 @@ export interface FormulaFieldMetadata extends BaseFieldSchema {
 export interface AIFieldMetadata extends BaseFieldSchema {
   type: FieldType.AI
   formula: string
-  // TODO: needs better types
-  operation: string
+  operation: AIOperationEnum
   columns?: string[]
   column?: string
+  categories?: string
   prompt?: string
   language?: string
 }