@scout9/app 1.0.0-alpha.0.5.9 → 1.0.0-alpha.0.6.0

package/src/public.d.ts

@@ -543,6 +543,14 @@ export type IntentWorkflowEvent = {
     initial: string | null;
 };
 
+export type MessageEntity = {
+    start: number;
+    end: number;
+    type: string;
+    option?: string | null;
+    text?: string | null;
+}
+
 export type Message = {
     /** Unique ID for the message */
     id: string;
@@ -561,6 +569,8 @@ export type Message = {
     intentScore?: (number | null) | undefined;
     /** How long to delay the message manually in seconds */
     delayInSeconds?: (number | null) | undefined;
+    /** Entities related to the message */
+    entities?: MessageEntity[] | null;
 };
 
 export type PersonaConfiguration = AgentConfiguration;
@@ -704,7 +714,6 @@ export type WorkflowResponseMessageApiResponse = string | {
     };
 };
 
-
 export type WorkflowsConfiguration = {
     /** Workflow id association, used to handle route params */
     entities: string[];

package/src/runtime/schemas/message.js

@@ -1,6 +1,14 @@
 import { z } from 'zod';
 import { zId } from './utils.js';
 
+export const MessageEntitySchema = z.object({
+  start: z.number(),
+  end: z.number(),
+  type: z.string(),
+  option: z.string().optional().nullable(),
+  text: z.string().optional().nullable()
+});
+
 export const MessageSchema = z.object({
   id: zId('Message ID', {description: 'Unique ID for the message'}),
   role: z.enum(['agent', 'customer', 'system']),
@@ -11,5 +19,6 @@ export const MessageSchema = z.object({
   context: z.any({description: 'The context generated from the message'}).optional(),
   intent: z.string({description: 'Detected intent'}).optional().nullable(),
   intentScore: z.number({description: 'Confidence score of the assigned intent'}).nullable().optional(),
-  delayInSeconds: z.number({description: 'How long to delay the message manually in seconds'}).nullable().optional()
+  delayInSeconds: z.number({description: 'How long to delay the message manually in seconds'}).nullable().optional(),
+  entities: z.array(MessageEntitySchema).optional().nullable()
 });

package/src/runtime/schemas/users.js

@@ -50,6 +50,9 @@ export const AgentSchema = z.object({
     tag: z.string().optional(),
     ingress: z.enum(["auto", "manual", "app", "workflow"]),
     llm: z.string().optional(),
+    webhookUri: z.string().optional(),
+    watermarkEnabled: z.boolean().optional(),
+    watermark: z.string().optional()
   }).optional()
 });
 

package/src/testing-tools/spirits.js

@@ -19,6 +19,7 @@
  * @property {Array<import('@scout9/app').Message>} messages
  * @property {import('@scout9/app').Message} message - the message sent by the customer (should exist in messages)
  * @property {import('@scout9/app').Customer} customer
+ * @property {import('@scout9/app').ConversationProgress} progress - progress checklist for manual/auto ingress workflows (needed if conversation progress is not managed by external webhooks or @scout9 apps (ingress app/webhook)
  * @property {any} context
  */
 
@@ -46,6 +47,14 @@
  * @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
@@ -76,6 +85,7 @@
  * @param {import('@scout9/app').Message['role']} prefix
  * @returns {string}
  */
+
 /**
  * @callback StatusCallback
  * @param {string} message
@@ -273,6 +283,7 @@ export const Spirits = {
       message.intentScore = parsePayload.intentScore;
     }
     message.context = parsePayload.context;
+    message.entities = parsePayload.entities;
     const index = messages.findIndex(m => m.content === message.content || m.id === message.id);
     if (index === -1) {
       const _message = {
@@ -280,6 +291,7 @@ export const Spirits = {
         role: 'customer',
         content: message,
         context: parsePayload.context,
+        entities: parsePayload.entities,
         time: new Date().toISOString()
       };
       if (parsePayload.intent) {
@@ -293,6 +305,7 @@ export const Spirits = {
       progress('Added message', 'info', 'ADD_MESSAGE', _message);
     } else {
       messages[index].context = parsePayload.context;
+      messages[index].entities = parsePayload.entities;
       if (parsePayload.intent) {
         messages[index].intent = parsePayload.intent;
       }