@botonic/plugin-flow-builder 0.27.0-alpha.0 → 0.27.0-alpha.2

package/src/functions/conditional-queue-status.ts

@@ -1,8 +1,6 @@
 import { ActionRequest } from '@botonic/react'
 import axios from 'axios'
 
-// import { EventAction, trackEvent } from '../tracking'
-
 const HUBTYPE_API_URL = process.env.HUBTYPE_API_URL || 'https://api.hubtype.com'
 
 type ConditionalQueueStatusArgs = {
@@ -19,16 +17,10 @@ enum QueueStatusResult {
 }
 
 export async function conditionalQueueStatus({
-  // request,
   queue_id,
-  // queue_name,
   check_available_agents,
 }: ConditionalQueueStatusArgs): Promise<QueueStatusResult> {
   const data = await getQueueAvailability(queue_id, check_available_agents)
-  // await trackEvent(request, EventAction.handoffOption, {
-  //   queueId: queue_id,
-  //   queueName: queue_name,
-  // })
   if (check_available_agents && data.open && data.available_agents === 0) {
     return QueueStatusResult.OPEN_WITHOUT_AGENTS
   }

package/src/index.ts

@@ -30,7 +30,7 @@ import {
   HtNodeWithContentType,
 } from './content-fields/hubtype-fields'
 import { DEFAULT_FUNCTIONS } from './functions'
-import { EventAction, getNodeEventArgs, trackEvent } from './tracking'
+import { trackFlowContent } from './tracking'
 import {
   BotonicPluginFlowBuilderOptions,
   FlowBuilderJSONVersion,
@@ -118,7 +118,7 @@ export default class BotonicPluginFlowBuilder implements Plugin {
     return payload.split(SOURCE_INFO_SEPARATOR)[0]
   }
 
-  private replacePayload(payload: string): string {
+  public replacePayload(payload: string): string {
     const botActionId = payload.split(SEPARATOR)[1]
     const botActionNode = this.cmsApi.getNodeById<HtBotActionNode>(botActionId)
     return this.cmsApi.createPayloadWithParams(botActionNode)
@@ -151,16 +151,13 @@ export default class BotonicPluginFlowBuilder implements Plugin {
     const resolvedLocale = this.cmsApi.getResolvedLocale(locale)
     const startNode = this.cmsApi.getStartNode()
     this.currentRequest.session.flow_thread_id = uuid()
-    const eventArgs = getNodeEventArgs(
-      this.currentRequest as unknown as ActionRequest,
-      startNode
-    )
-    await trackEvent(
+    const contents = await this.getContentsByNode(startNode, resolvedLocale)
+
+    await trackFlowContent(
       this.currentRequest as unknown as ActionRequest,
-      EventAction.flowNode,
-      eventArgs
+      contents
     )
-    return await this.getContentsByNode(startNode, resolvedLocale)
+    return contents
   }
 
   async getContentsByNode(
@@ -283,6 +280,7 @@ export default class BotonicPluginFlowBuilder implements Plugin {
 }
 
 export * from './action'
+export { BOT_ACTION_PAYLOAD_PREFIX } from './constants'
 export * from './content-fields'
 export {
   BotonicPluginFlowBuilderOptions,

package/src/tracking.ts

@@ -1,8 +1,23 @@
 import { ActionRequest } from '@botonic/react'
 
+import { FlowContent } from './content-fields'
 import { HtNodeWithContent } from './content-fields/hubtype-fields'
 import { getFlowBuilderPlugin } from './helpers'
 
+export enum EventAction {
+  FlowNode = 'flow_node',
+  Keyword = 'nlu_keyword',
+  Intent = 'nlu_intent',
+  IntentSmart = 'nlu_intent_smart',
+  Knowledgebase = 'knowledgebase',
+  Fallback = 'fallback',
+}
+
+export enum KnowledgebaseFailReason {
+  NoKnowledge = 'no_knowledge',
+  Hallucination = 'hallucination',
+}
+
 export async function trackEvent(
   request: ActionRequest,
   eventAction: EventAction,
@@ -15,29 +30,39 @@ export async function trackEvent(
   return
 }
 
-export function getNodeEventArgs(
+export async function trackFlowContent(
+  request: ActionRequest,
+  contents: FlowContent[]
+) {
+  const flowBuilderPlugin = getFlowBuilderPlugin(request.plugins)
+  const cmsApi = flowBuilderPlugin.cmsApi
+  const firstNodeContent = cmsApi.getNodeById<HtNodeWithContent>(contents[0].id)
+  const flowName = flowBuilderPlugin.getFlowName(firstNodeContent.flow_id)
+  const eventArgs = getContentEventArgs(request, {
+    code: firstNodeContent.code,
+    flowId: firstNodeContent.flow_id,
+    flowName,
+    id: firstNodeContent.id,
+  })
+  await trackEvent(request, EventAction.FlowNode, eventArgs)
+}
+
+export function getContentEventArgs(
   request: ActionRequest,
-  node: HtNodeWithContent
+  contentInfo: {
+    code: string
+    flowId: string
+    flowName: string
+    id: string
+  }
 ) {
   const flowBuilderPlugin = getFlowBuilderPlugin(request.plugins)
   return {
     flowThreadId: request.session.flow_thread_id,
-    flowId: node.flow_id,
-    flowName: flowBuilderPlugin.getFlowName(node.flow_id),
-    flowNodeId: node.id,
-    flowNodeContentId: node.code,
+    flowId: contentInfo.flowId,
+    flowName: flowBuilderPlugin.getFlowName(contentInfo.flowId),
+    flowNodeId: contentInfo.id,
+    flowNodeContentId: contentInfo.code,
     flowNodeIsMeaningful: undefined, //node?.isMeaningful,
   }
 }
-
-export enum EventAction {
-  flowNode = 'flow_node',
-  handoffOption = 'handoff_option',
-  handoffSuccess = 'handoff_success',
-  handoffFail = 'handoff_fail',
-  keyword = 'nlu_keyword',
-  intent = 'nlu_intent',
-  intentSmart = 'nlu_intent_smart',
-  knowledgebase = 'knowledgebase',
-  fallback = 'fallback',
-}

package/src/types.ts

@@ -39,11 +39,15 @@ export enum FlowBuilderJSONVersion {
 }
 
 export interface KnowledgeBaseResponse {
+  inferenceId: string
+  question: string
   answer: string
   hasKnowledge: boolean
+  isFaithuful: boolean
   sources: {
+    knowledgeBaseId: string
     knowledgeSourceId: string
-    page?: number
+    knowledgeChunkId: string
   }[]
 }
 

package/src/user-input/index.ts

@@ -30,7 +30,7 @@ export async function getNodeByUserInput(
       request,
       smartIntentsConfig
     )
-    const smartIntentNode = smartIntentsApi.getNodeByInput()
+    const smartIntentNode = await smartIntentsApi.getNodeByInput()
     if (smartIntentNode) return smartIntentNode
 
     const intentNode = await getIntentNodeByInput(cmsApi, locale, request)

package/src/user-input/intent.ts

@@ -32,7 +32,7 @@ async function trackIntentEvent(
     nluIntentThreshold: intentNode?.content.confidence,
     nluIntentMessageId: request.input.message_id,
   }
-  await trackEvent(request, EventAction.intent, eventArgs)
+  await trackEvent(request, EventAction.Intent, eventArgs)
 }
 
 function isIntentValid(

package/src/user-input/keyword.ts

@@ -39,15 +39,11 @@ export class KeywordMatcher {
     userInput: string,
     keywordNodes: HtKeywordNode[]
   ): HtKeywordNode | undefined {
-    const matchedKeywordNodes = keywordNodes.filter(node =>
+    const matchedKeywordNode = keywordNodes.find(node =>
       this.matchKeywords(userInput, node)
     )
 
-    if (matchedKeywordNodes.length > 0 && matchedKeywordNodes[0].target) {
-      return matchedKeywordNodes[0]
-    }
-
-    return undefined
+    return matchedKeywordNode?.target ? matchedKeywordNode : undefined
   }
 
   private matchKeywords(userInput: string, node: HtKeywordNode): boolean {
@@ -96,6 +92,6 @@ export class KeywordMatcher {
       nluKeywordIsRegex: this.isRegExp,
       nluKeywordMessageId: this.request.input.message_id,
     }
-    await trackEvent(this.request, EventAction.keyword, eventArgs)
+    await trackEvent(this.request, EventAction.Keyword, eventArgs)
   }
 }

package/src/user-input/smart-intent.ts

@@ -44,9 +44,9 @@ export class SmartIntentsApi {
           smartIntentNode.content.title === response.data.smart_intent_title
       )
       if (smartIntentNode) {
-        trackEvent(this.currentRequest, EventAction.intentSmart, {
+        trackEvent(this.currentRequest, EventAction.IntentSmart, {
           nluIntentSmartTitle: response.data.smart_intent_title,
-          nluIntentSmartNumUsed: response.data.smart_intents_used,
+          nluIntentSmartNumUsed: response.data.smart_intents_used.length,
           nluIntentSmartMessageId: this.currentRequest.input.message_id,
         })
         return smartIntentNode