@scout9/app 1.0.0-alpha.0.6.7 → 1.0.0-alpha.0.6.9

package/src/public.d.ts

@@ -560,6 +560,10 @@ export type IntentWorkflowEvent = {
     initial: string | null;
 };
 
+/**
+ * metadata relationship for the <entity-context>/<entity> element in transcripts and instructions
+ * @ingress auto/manual
+ */
 export type EntityToken = {
     start: number;
     end: number;
@@ -568,6 +572,38 @@ export type EntityToken = {
     text?: string | null;
 }
 
+/**
+ * metadata relationship for the <entity-api> element in transcripts and instructions
+ * @ingress auto/manual
+ */
+export type EntityApi = {
+
+    /**
+     * REST URI to hit
+     */
+    uri: string;
+
+    /**
+     * Method to use to call the api, defaults to "POST"
+     */
+    method?: string;
+
+    /**
+     * Additional payload to include to the api
+     */
+    body?: ConversationContext;
+
+    /**
+     * Headers to apply to the call
+     */
+    headers?: Record<string, string>;
+
+    /**
+     * Separate URI to establish OAuth 2.0/JWT tokens
+     */
+    auth?: Omit<EntityApi, 'auth'>;
+}
+
 export type Message = {
     /** Unique ID for the message */
     id: string;
@@ -696,6 +732,14 @@ export type DirectMessage = Partial<Omit<Message, 'id' | 'entities' | 'time' | '
  * Workflow Response Slot, can use for both PMT workflow event and event macro runtimes
  */
 export type WorkflowResponseSlotBase = {
+    /** Context to upsert to the conversation */
+    contextUpsert?: {
+        [x: string]: any;
+    } | undefined;
+
+    /** Information to follow up to the client */
+    followup?: Followup | undefined;
+
     /** Forward input information of a conversation */
     forward?: Forward | undefined;
 
@@ -705,11 +749,14 @@ export type WorkflowResponseSlotBase = {
     /** Instructions to send to the PMT on how to steer the conversation */
     instructions?: Instruction[] | undefined;
 
+    /** If provided, sends a direct message to the user */
+    message?: string | DirectMessage | undefined;
+
     /** Remove instructions from memory (requires set instructions to have ids) */
     removeInstructions?: string[] | undefined;
 
-    /** If provided, sends a direct message to the user */
-    message?: string | DirectMessage | undefined;
+    /** If true, resets the conversations intent value to undefined or to its initial value */
+    resetIntent?: boolean | undefined;
 
     /** Delays in seconds of instructions (if provided) to PMT and direct message (if provided) to user */
     secondsDelay?: number | undefined;
@@ -717,16 +764,6 @@ export type WorkflowResponseSlotBase = {
     /** unix time of when to send instructions or message */
     scheduled?: number | undefined;
 
-    /** Context to upsert to the conversation */
-    contextUpsert?: {
-        [x: string]: any;
-    } | undefined;
-
-    /** If true, resets the conversations intent value to undefined or to its initial value */
-    resetIntent?: boolean | undefined;
-
-    /** Information to follow up to the client */
-    followup?: Followup | undefined;
 };
 
 /**
@@ -745,6 +782,12 @@ export type WorkflowResponseSlot = WorkflowResponseSlotBase & {
      * @ingress auto/manual only
      */
     entityContextUpsert?: Array<EntityContextUpsert> | undefined;
+
+    /**
+     * If provided, it will send the user's workflow tasks to the PMT to execute custom business logic
+     * @ingress auto/manual only
+     */
+    tasks?: string[] | undefined;
 };
 
 /**

package/src/runtime/schemas/workflow.js

@@ -4,7 +4,7 @@ import { z } from 'zod';
 import { zId } from './utils.js';
 import { AgentConfigurationSchema, CustomerSchema } from './users.js';
 import { MessageSchema } from './message.js';
-import { ConversationSchema, ConversationContext } from './conversation.js';
+import { ConversationContext, ConversationSchema } from './conversation.js';
 
 
 export const ForwardSchema = z.union([
@@ -89,7 +89,8 @@ export const InstructionSchema = z.union([
 export const FollowupBaseSchema = z.object({
   scheduled: z.number(),
   cancelIf: ConversationContext.optional(),
-  overrideLock: z.boolean({description: 'This will still run even if the conversation is locked, defaults to false'}).optional()
+  overrideLock: z.boolean({description: 'This will still run even if the conversation is locked, defaults to false'})
+    .optional()
 });
 
 /**
@@ -97,7 +98,7 @@ export const FollowupBaseSchema = z.object({
  */
 export const FollowupSchema = z.union([
   FollowupBaseSchema.extend({
-    message: z.string({description: 'Manual message sent to client'}),
+    message: z.string({description: 'Manual message sent to client'})
   }),
   FollowupBaseSchema.extend({
     instructions: InstructionSchema
@@ -143,23 +144,23 @@ export const WorkflowEventSchema = z.object({
   note: z.string({description: 'Any developer notes to provide'}).optional()
 });
 
-export const DirectMessageSchema = MessageSchema.partial().omit({id: true, entities: true, time: true, role: true})
+export const DirectMessageSchema = MessageSchema.partial().omit({id: true, entities: true, time: true, role: true});
 
 /**
  * The workflow response object slot
  */
 export const WorkflowResponseSlotBaseSchema = z.object({
+  contextUpsert: ConversationContext.optional(),
+  followup: FollowupSchema.optional(),
   forward: ForwardSchema.optional(),
   forwardNote: z.string({description: 'Note to provide to the agent, recommend using forward object api instead'})
     .optional(),
   instructions: InstructionSchema.optional(),
-  removeInstructions: z.array(z.string()).optional(),
   message: z.union([z.string(), DirectMessageSchema]).optional(),
-  secondsDelay: z.number().optional(),
-  scheduled: z.number().optional(),
-  contextUpsert: ConversationContext.optional(),
+  removeInstructions: z.array(z.string()).optional(),
   resetIntent: z.boolean().optional(),
-  followup: FollowupSchema.optional()
+  secondsDelay: z.number().optional(),
+  scheduled: z.number().optional()
 });
 
 
@@ -205,7 +206,10 @@ export const WorkflowResponseSlotSchema = WorkflowResponseSlotBaseSchema.extend(
     }))
   ]).optional(),
 
-  entityContextUpsert: z.array(EntityContextUpsertSchema).optional()
+  entityContextUpsert: z.array(EntityContextUpsertSchema).optional(),
+
+  tasks: z.array(z.string({description: '@ingress=auto/manual only, If provided, it will send the user\'s workflow tasks to the PMT to execute custom business logic'}))
+    .optional()
 });
 
 /**

package/src/testing-tools/spirits.js

@@ -46,14 +46,6 @@
  * @property {any} context
  */
 
-/**
- * @typedef {Object} GenerateOutput
- * @property {import('@scout9/admin').GenerateResponse | undefined} generate
- * @property {Array<import('@scout9/app').Message>} messages
- * @property {import('@scout9/app').Conversation} conversation
- * @property {any} context
- */
-
 /**
  * @callback ParseFun
  * @param {string} message - message to send
@@ -69,7 +61,7 @@
 
 /**
  * @callback GenerateFun
- * @param {import('@scout9/admin').GenerateRequestOneOf} data - data to generate from
+ * @param {import('@scout9/admin').GenerateRequestOneOf1} data - data to generate from
  * @returns {Promise<import('@scout9/admin').GenerateResponse>}
  */
 
@@ -104,9 +96,13 @@
  * @property {StatusCallback | undefined} [progress]
  */
 
+
 /**
  * @typedef {Object} ConversationEvent
- * @property {Change<import('@scout9/app').Conversation> & {forwardNote?: string; forward?: import('@scout9/app').WorkflowResponseSlot['forward']}} conversation
+ * @property {(Change<import('@scout9/app').Conversation> & {
+ *   forwardNote?: string;
+ *   forward?: import('@scout9/app').WorkflowResponseSlot['forward'];
+ * })} conversation
  * @property {Change<Array<import('@scout9/app').Message>>} messages
  * @property {Change<any>} context
  * @property {Change<import('@scout9/app').Message>} message
@@ -389,6 +385,9 @@ export const Spirits = {
     let _forward;
     let _forwardNote;
 
+    /** @type {Array<string> | undefined} */
+    let _tasks;
+
     for (const {
       forward,
       forwardNote,
@@ -401,7 +400,8 @@ export const Spirits = {
       contextUpsert,
       anticipate,
       followup: slotFollowup,
-      entityContextUpsert: slotEntityContextUpsert
+      entityContextUpsert: slotEntityContextUpsert,
+      tasks
     } of slots) {
 
       // Anticipate customer response
@@ -439,6 +439,12 @@ export const Spirits = {
         }
       }
 
+      // tasks from auto/manual ingress to execute
+      if (!!tasks && Array.isArray(tasks) && !!tasks.length) {
+        if (!_tasks) _tasks = [];
+        _tasks.push(...tasks);
+      }
+
       if (slotFollowup) {
         followup.push(slotFollowup);
       }
@@ -585,13 +591,17 @@ export const Spirits = {
       if ((!conversation.locked || !hasNoInstructions) && !!hasNoCustomMessage) {
         try {
           progress('Generating message', 'info', 'SET_PROCESSING', 'system');
-          const generatorPayload = await generator({
+          const generatorInput = {
             messages,
             persona,
             context,
             llm: config.llm,
             pmt: config.pmt
-          });
+          }
+          if (!!_tasks && Array.isArray(_tasks) && !!_tasks.length) {
+            generatorInput.tasks = _tasks;
+          }
+          const generatorPayload = await generator(generatorInput);
           if (!generatorPayload.send) {
             progress('Generated response', 'failed', undefined, {error: generatorPayload.error || 'Unknown Reason'});
             console.error(