feat: update get conversation info action

marian2js · marian2js · commit 265a25afd228 · 2023-08-29T14:07:16.000+01:00
diff --git a/apps/runner/src/utils/input.utils.ts b/apps/runner/src/utils/input.utils.ts
@@ -60,7 +60,7 @@ export function parseInput(input: unknown, outputs: Record<string, Record<string
  */
 export function calculateExpression(input: string, references: Record<string, Record<string, unknown>>): unknown {
   // each "[\w[\]]" group matches the allowed characters for variables, including array access (e.g. a.b[0].c)
-  const operatorsRegex = /[\w[\]]+\.[\w[\]]+(\.[\w[\]]+)*/g
+  const operatorsRegex = /[\w\s[\]]+(\.[\w\s[\]]+|\[\d+\])*/g
 
   const operators = [...input.matchAll(operatorsRegex)]
 
diff --git a/generated/graphql.ts b/generated/graphql.ts
@@ -1055,20 +1055,6 @@ export interface IntegrationTriggersConnection {
     edges: IntegrationTriggerEdge[];
 }
 
-export interface MenuItem {
-    name: string;
-    price: number;
-}
-
-export interface Menu {
-    id: string;
-    createdAt: DateTime;
-    name: string;
-    currency?: Nullable<string>;
-    items: MenuItem[];
-    order: Menu;
-}
-
 export interface Contact {
     id: string;
     createdAt: DateTime;
@@ -1086,6 +1072,20 @@ export interface AccountCredential {
     authExpired: boolean;
 }
 
+export interface MenuItem {
+    name: string;
+    price: number;
+}
+
+export interface Menu {
+    id: string;
+    createdAt: DateTime;
+    name: string;
+    currency?: Nullable<string>;
+    items: MenuItem[];
+    order: Menu;
+}
+
 export interface OrderItem {
     name: string;
     quantity: number;
diff --git a/generated/schema.graphql b/generated/schema.graphql
@@ -408,20 +408,6 @@ type IntegrationTriggersConnection {
   edges: [IntegrationTriggerEdge!]!
 }
 
-type MenuItem {
-  name: String!
-  price: Float!
-}
-
-type Menu {
-  id: ID!
-  createdAt: DateTime!
-  name: String!
-  currency: String
-  items: [MenuItem!]!
-  order: Menu!
-}
-
 type Contact {
   id: ID!
   createdAt: DateTime!
@@ -439,6 +425,20 @@ type AccountCredential {
   authExpired: Boolean!
 }
 
+type MenuItem {
+  name: String!
+  price: Float!
+}
+
+type Menu {
+  id: ID!
+  createdAt: DateTime!
+  name: String!
+  currency: String
+  items: [MenuItem!]!
+  order: Menu!
+}
+
 type OrderItem {
   name: String!
   quantity: Float!
diff --git a/libs/definitions/src/integration-definitions/chatbot/actions/get-info.action.ts b/libs/definitions/src/integration-definitions/chatbot/actions/get-info.action.ts
@@ -2,32 +2,155 @@ import { AuthenticationError } from '@app/common/errors/authentication-error'
 import { RunResponse } from '@app/definitions/definition'
 import { OperationAction } from '@app/definitions/opertion-action'
 import { getChatCompletion, getConversationInfo, getUserIntent, UserIntent } from '@chainjet/tools/dist/ai/ai'
-import { NotFoundException } from '@nestjs/common'
-import { Menu } from 'apps/api/src/chat/entities/menu'
-import { MenuService } from 'apps/api/src/chat/services/menu.service'
+import { BadRequestException } from '@nestjs/common'
+import { AccountCredential } from 'apps/api/src/account-credentials/entities/account-credential'
+import { ContactService } from 'apps/api/src/chat/services/contact.service'
+import { IntegrationAction } from 'apps/api/src/integration-actions/entities/integration-action'
+import { User } from 'apps/api/src/users/entities/user'
+import { WorkflowAction } from 'apps/api/src/workflow-actions/entities/workflow-action'
 import { OperationRunOptions } from 'apps/runner/src/services/operation-runner.service'
-import { JSONSchema7 } from 'json-schema'
+import { JSONSchema7, JSONSchema7Definition } from 'json-schema'
 import _ from 'lodash'
 import { XmtpLib } from '../../xmtp/xmtp.lib'
 
+interface Entity {
+  name: string
+  type: string
+  description?: string
+  required?: boolean
+  store?: boolean
+}
+
 export class GetInfoAction extends OperationAction {
   key = 'getInfo'
   name = 'Get Information'
   description = 'Extrac info from the conversation'
   version = '1.0.0'
 
   inputs: JSONSchema7 = {
-    required: ['conversationId'],
+    required: ['entities'],
     properties: {
       entities: {
+        title: 'List of Entities',
         type: 'array',
+        minItems: 1,
+        items: {
+          type: 'object',
+          required: ['name', 'type'],
+          properties: {
+            name: {
+              type: 'string',
+              title: 'Name',
+              examples: ['Job Title'],
+              'x-noInterpolation': true,
+            } as JSONSchema7Definition,
+            type: {
+              type: 'string',
+              title: 'Type',
+              default: '',
+              oneOf: [
+                {
+                  title: 'Text',
+                  const: 'text',
+                },
+                {
+                  title: 'Number',
+                  const: 'number',
+                },
+                {
+                  title: 'Date',
+                  const: 'date',
+                },
+                {
+                  title: 'Time',
+                  const: 'time',
+                },
+                {
+                  title: 'Ethereum Address',
+                  const: 'address',
+                },
+                {
+                  title: 'Email Address',
+                  const: 'email',
+                },
+              ],
+              'x-noInterpolation': true,
+            } as JSONSchema7Definition,
+            description: {
+              type: 'string',
+              title: 'Description',
+              examples: ['The job title of the user'],
+              description:
+                'Description of the information to extract. This helps the AI to understand what to look for. This is needed when the entity name is not intuitive enough.',
+              'x-noInterpolation': true,
+            } as JSONSchema7Definition,
+            required: {
+              type: 'boolean',
+              title: 'Is required?',
+              description:
+                "Whether the information is required to continue. If it's required and the user doesn't provide it, the AI will ask for it.",
+            },
+            store: {
+              type: 'boolean',
+              title: 'Store in contact?',
+              description: 'Whether the information should be stored in the contact.',
+            },
+          },
+        },
+      },
+      confirm: {
+        type: 'boolean',
+        title: 'Ask for confirmation?',
+        description: 'Ask the user to confirm that the information is correct before continuing?',
       },
     },
   }
   outputs: JSONSchema7 = {
     properties: {},
   }
 
+  async beforeCreate(
+    workflowAction: Partial<WorkflowAction>,
+    integrationAction: IntegrationAction,
+    accountCredential: AccountCredential | null,
+  ): Promise<Partial<WorkflowAction>> {
+    if (!Array.isArray(workflowAction.inputs?.entities) || !workflowAction.inputs?.entities.length) {
+      return workflowAction
+    }
+    const entities = workflowAction.inputs.entities as Entity[]
+
+    // Check for duplicate entity names
+    const entityNames = entities.map((entity) => entity.name.toLowerCase())
+    const entityNamesSet = new Set(entityNames)
+    if (entityNames.length !== entityNamesSet.size) {
+      throw new BadRequestException(`Duplicate entity names: ${entityNames.join(', ')}`)
+    }
+
+    // Update schema response
+    workflowAction.schemaResponse = {
+      type: 'object',
+      properties: entities.reduce((properties: Record<string, any>, entity) => {
+        properties[entity.name] = {
+          type: entity.type,
+          title: entity.name,
+          description: entity.description,
+        }
+        return properties
+      }, {}),
+    }
+
+    return workflowAction
+  }
+
+  async beforeUpdate(
+    update: Partial<WorkflowAction>,
+    prevWorkflowAction: WorkflowAction,
+    integrationAction: IntegrationAction,
+    accountCredential: AccountCredential | null,
+  ): Promise<Partial<WorkflowAction>> {
+    return this.beforeCreate(update, integrationAction, accountCredential)
+  }
+
   async run({ user, inputs, previousOutputs, credentials }: OperationRunOptions): Promise<RunResponse> {
     if (!credentials.keys) {
       throw new AuthenticationError(`Missing keys for XMTP`)
@@ -44,9 +167,7 @@ export class GetInfoAction extends OperationAction {
       content: message.content,
       role: message.from === 'user' ? 'user' : 'assistant',
     }))
-    const entities = inputs.entities
-    const menuIds = entities.filter((entity) => entity.type === 'order').map((entity) => entity.menu)
-    const menus = await MenuService.instance.find({ owner: user, _id: { $in: menuIds } })
+    const entities = inputs.entities as Entity[]
 
     // If we're confirming the order, check for the message intent
     if (latestOutputs.confirmingOrder) {
@@ -66,26 +187,17 @@ export class GetInfoAction extends OperationAction {
       ]
       const intent = await getUserIntent(confirmIntents, latestMessage?.content, messages)
       if (intent?.toLowerCase() === 'confirm') {
-        return {
-          outputs: {
-            ...this.getInfoOutputs(entities, latestOutputs.conversationInfo, menus),
-          },
-          learnResponseWorkflow: true,
-        }
+        return await this.completeAction(
+          entities,
+          latestOutputs.conversationInfo,
+          user as User,
+          previousOutputs?.contact?.address,
+        )
       }
     }
 
     const originalInputs = _.cloneDeep(inputs)
 
-    for (const entity of entities) {
-      if (entity.type === 'order') {
-        entity.menu = menus.find((menu) => menu._id.toString() === entity.menu.toString())
-        if (!entity.menu) {
-          throw new NotFoundException(`Menu ${entity.menu} not found`)
-        }
-      }
-    }
-
     const data = await getConversationInfo(entities, messages)
     if (data.FollowUp) {
       const client = await XmtpLib.getClient(credentials.keys, credentials.env ?? 'production')
@@ -101,11 +213,14 @@ export class GetInfoAction extends OperationAction {
     }
 
     if (inputs.confirm) {
-      const orderList = this.getOrderList(entities, data).trim()
-      const prompt = `Your task is to confirm with the user if the following order is correct.\n${orderList}`
+      const confirmList = entities
+        .filter((entity) => data[entity.name])
+        .map((entity) => `${entity.name}: ${data[entity.name]}`)
+        .join('\n')
+      const prompt = `Your task is to confirm with the user if the following information is correct.\n${confirmList}`
       let content = await getChatCompletion([{ role: 'system', content: prompt }, ...messages])
       if (!content) {
-        content = `Please confirm if the request is correct:\n${orderList}`
+        content = `Please confirm if this information is correct:\n${confirmList}`
       }
       const client = await XmtpLib.getClient(credentials.keys, credentials.env ?? 'production')
       const conversationId = previousOutputs?.trigger.conversation.id
@@ -122,51 +237,33 @@ export class GetInfoAction extends OperationAction {
       }
     }
 
-    return {
-      outputs: {
-        ...this.getInfoOutputs(entities, data, menus),
-      },
-      learnResponseWorkflow: true,
-    }
+    return await this.completeAction(entities, data, user as User, previousOutputs?.contact?.address)
   }
 
-  getOrderList(entities: any[], data: any) {
-    let orderList = ''
-    for (const entity of entities) {
-      if (!data[entity.name]) {
-        continue
-      }
-      if (entity.type === 'order') {
-        orderList += data[entity.name].map((item) => `${item.quantity ?? 1} ${item.item}`).join('\n') + '\n'
-      } else {
-        orderList += `${entity.name}: ${data[entity.name]}\n`
+  async completeAction(entities: Entity[], data: any, user: User, contactAddress?: string) {
+    const storeEntities = entities.filter((entity) => entity.store)
+    if (storeEntities.length && contactAddress) {
+      const entitiesData = storeEntities.reduce((fields: Record<string, any>, entity) => {
+        fields[entity.name] = data[entity.name]
+        return fields
+      }, {})
+      const contact = await ContactService.instance.findOne({ address: contactAddress, owner: user })
+      if (contact) {
+        await ContactService.instance.updateOne(contact.id, {
+          fields: {
+            ...(contact.fields ?? {}),
+            ...entitiesData,
+          },
+        })
       }
     }
-    return orderList
-  }
-
-  getInfoOutputs(entities: any[], data: any, menus: Menu[]) {
-    const outputs: Record<string, any> = {}
-    for (const entity of entities) {
-      if (data[entity.name]) {
-        if (entity.type === 'order') {
-          const menu = menus.find((menu) => menu._id.toString() === entity.menu.toString())
-          const total = data[entity.name].reduce((acc, item) => {
-            const menuItem = menu!.items.find((menuItem) => menuItem.name === item.item)
-            return acc + (menuItem?.price ?? 0) * (item.quantity ?? 1)
-          }, 0)
-          outputs[entity.name] = {
-            ...(total && { total, currency: menu?.currency }),
-            items: data[entity.name].map((item) => ({
-              name: item.item,
-              quantity: item.quantity,
-            })),
-          }
-        } else {
+    return {
+      outputs: entities.reduce((outputs: Record<string, any>, entity) => {
+        if (data[entity.name]) {
           outputs[entity.name] = data[entity.name]
         }
-      }
+        return outputs
+      }, {}),
     }
-    return outputs
   }
 }
diff --git a/package.json b/package.json
@@ -32,7 +32,7 @@
     "@aws-sdk/client-cloudwatch": "^3.146.0",
     "@aws-sdk/client-ses": "^3.145.0",
     "@celo-tools/celo-ethers-wrapper": "0.3.0",
-    "@chainjet/tools": "0.0.7",
+    "@chainjet/tools": "0.0.8",
     "@googleapis/drive": "^3.0.1",
     "@googleapis/sheets": "^3.0.2",
     "@mailchain/sdk": "0.18.6",
diff --git a/yarn.lock b/yarn.lock
