@botonic/plugin-flow-builder 0.54.0 → 0.55.0

package/lib/esm/content-fields/hubtype-fields/knowledge-base.d.ts

@@ -1,17 +0,0 @@
-import type { HtBaseNode } from './common';
-import type { HtNodeWithContentType } from './node-types';
-interface SourceData {
-    id: string;
-    name: string;
-}
-export interface HtKnowledgeBaseNode extends HtBaseNode {
-    type: HtNodeWithContentType.KNOWLEDGE_BASE;
-    content: {
-        feedback_enabled: boolean;
-        sources_data: SourceData[];
-        instructions: string;
-        has_memory: boolean;
-        memory_length?: number;
-    };
-}
-export {};

package/lib/esm/content-fields/hubtype-fields/knowledge-base.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=knowledge-base.js.map

package/lib/esm/content-fields/hubtype-fields/knowledge-base.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"knowledge-base.js","sourceRoot":"","sources":["../../../../src/content-fields/hubtype-fields/knowledge-base.ts"],"names":[],"mappings":""}

package/src/action/knowledge-bases.ts

@@ -1,164 +0,0 @@
-import {
-  type BotContext,
-  EventAction,
-  type EventKnowledgeBase,
-  type KnowledgeBasesResponse,
-  KnowledgebaseFailReason,
-  type ResolvedPlugins,
-} from '@botonic/core'
-
-import {
-  DISABLED_MEMORY_LENGTH,
-  type FlowContent,
-  FlowKnowledgeBase,
-} from '../content-fields'
-import {
-  getCommonFlowContentEventArgsForContentId,
-  trackEvent,
-} from '../tracking'
-import type { KnowledgeBaseFunction } from '../types'
-import {
-  inputHasTextOrTranscript,
-  isKnowledgeBasesAllowed,
-} from '../utils/input'
-import type { FlowBuilderContext } from './context'
-
-export async function getContentsByKnowledgeBase({
-  cmsApi,
-  flowBuilderPlugin,
-  request,
-}: FlowBuilderContext): Promise<FlowContent[]> {
-  if (isKnowledgeBasesAllowed(request)) {
-    const startNodeKnowledgeBaseFlow = cmsApi.getStartNodeKnowledgeBaseFlow()
-    const isKnowledgeBaseEnabled = cmsApi.isKnowledgeBaseEnabled()
-
-    if (!startNodeKnowledgeBaseFlow || !isKnowledgeBaseEnabled) {
-      return []
-    }
-
-    const contents = await flowBuilderPlugin.getContentsByNode(
-      startNodeKnowledgeBaseFlow
-    )
-
-    const knowledgeBaseContent = contents.find(
-      content => content instanceof FlowKnowledgeBase
-    ) as FlowKnowledgeBase
-
-    if (!knowledgeBaseContent) {
-      return contents
-    }
-
-    const sourceIds = knowledgeBaseContent.sourcesData.map(source => source.id)
-
-    if (
-      flowBuilderPlugin.getKnowledgeBaseResponse &&
-      inputHasTextOrTranscript(request.input) &&
-      sourceIds.length > 0
-    ) {
-      const contentsWithKnowledgeResponse =
-        await getContentsWithKnowledgeResponse(
-          flowBuilderPlugin.getKnowledgeBaseResponse,
-          request,
-          contents,
-          knowledgeBaseContent
-        )
-
-      if (contentsWithKnowledgeResponse) {
-        return contentsWithKnowledgeResponse
-      }
-    }
-  }
-
-  return []
-}
-
-async function getContentsWithKnowledgeResponse<
-  T extends ResolvedPlugins = ResolvedPlugins,
->(
-  getKnowledgeBaseResponse: KnowledgeBaseFunction<T>,
-  request: BotContext<T>,
-  contents: FlowContent[],
-  knowledgeBaseContent: FlowKnowledgeBase
-): Promise<FlowContent[] | undefined> {
-  const sourceIds = knowledgeBaseContent.sourcesData.map(source => source.id)
-  const instructions = knowledgeBaseContent.instructions
-  const messageId = request.input.message_id
-  const memoryLength = knowledgeBaseContent.hasMemory
-    ? knowledgeBaseContent.memoryLength
-    : DISABLED_MEMORY_LENGTH
-
-  const knowledgeBaseResponse = await getKnowledgeBaseResponse(
-    request,
-    sourceIds,
-    instructions,
-    messageId,
-    memoryLength
-  )
-  await trackKnowledgeBase(knowledgeBaseResponse, request, knowledgeBaseContent)
-
-  if (
-    !knowledgeBaseResponse.hasKnowledge ||
-    !knowledgeBaseResponse.isFaithful
-  ) {
-    return undefined
-  }
-
-  return updateContentsWithResponse(contents, knowledgeBaseResponse)
-}
-
-function updateContentsWithResponse(
-  contents: FlowContent[],
-  response: KnowledgeBasesResponse
-): FlowContent[] {
-  return contents.map(content => {
-    if (content instanceof FlowKnowledgeBase) {
-      content.text = response.answer
-      content.inferenceId = response.inferenceId
-    }
-
-    return content
-  })
-}
-
-async function trackKnowledgeBase(
-  response: KnowledgeBasesResponse,
-  request: BotContext,
-  knowledgeBaseContent: FlowKnowledgeBase
-) {
-  const getKnowledgeFailReason = (): KnowledgebaseFailReason | undefined => {
-    let knowledgebaseFailReason: KnowledgebaseFailReason | undefined
-
-    if (!response.isFaithful) {
-      knowledgebaseFailReason = KnowledgebaseFailReason.Hallucination
-    }
-
-    if (!response.hasKnowledge) {
-      knowledgebaseFailReason = KnowledgebaseFailReason.NoKnowledge
-    }
-    return knowledgebaseFailReason
-  }
-
-  const { flowId, flowName, flowNodeId, flowNodeContentId } =
-    getCommonFlowContentEventArgsForContentId(request, knowledgeBaseContent.id)
-
-  const event: EventKnowledgeBase = {
-    action: EventAction.Knowledgebase,
-    knowledgebaseInferenceId: response.inferenceId,
-    knowledgebaseFailReason: getKnowledgeFailReason(),
-    knowledgebaseSourcesIds: knowledgeBaseContent.sourcesData.map(
-      source => source.id
-    ),
-    knowledgebaseChunksIds: response.chunkIds,
-    knowledgebaseMessageId: request.input.message_id,
-    userInput: request.input.data as string,
-    flowThreadId: request.session.flow_thread_id as string,
-    flowId,
-    flowName,
-    flowNodeId,
-    flowNodeContentId,
-  }
-
-  const { action, ...eventArgs } = event
-
-  await trackEvent(request, action, eventArgs)
-}

package/src/content-fields/flow-knowledge-base.tsx

@@ -1,58 +0,0 @@
-import type { BotContext } from '@botonic/core'
-import { Text } from '@botonic/react'
-
-import { ContentFieldsBase } from './content-fields-base'
-import type { HtKnowledgeBaseNode } from './hubtype-fields'
-
-export const DISABLED_MEMORY_LENGTH = 1
-
-export class FlowKnowledgeBase extends ContentFieldsBase {
-  public feedbackEnabled: boolean = false
-  public sources: string[] = []
-  public text: string = ''
-  public inferenceId?: string
-  public sourcesData: { id: string; name: string }[] = []
-  public instructions: string
-  public hasMemory: boolean
-  public memoryLength: number
-
-  static fromHubtypeCMS(component: HtKnowledgeBaseNode): FlowKnowledgeBase {
-    const newKnowledgeBase = new FlowKnowledgeBase(component.id)
-    newKnowledgeBase.code = component.code
-    newKnowledgeBase.feedbackEnabled = component.content.feedback_enabled
-    newKnowledgeBase.sourcesData = component.content.sources_data
-    newKnowledgeBase.instructions = component.content.instructions
-    newKnowledgeBase.hasMemory = component.content.has_memory || false
-    newKnowledgeBase.memoryLength =
-      component.content.memory_length || DISABLED_MEMORY_LENGTH
-    newKnowledgeBase.followUp = component.follow_up
-
-    return newKnowledgeBase
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  async trackFlow(_botContext: BotContext): Promise<void> {
-    // TODO: Review how we can track here the knowledge base event here.
-    // We should store event args in an attribute of FlowKnowledgeBase
-    // when knowledge base is resolved inside the flow builder action
-  }
-
-  async processContent(botContext: BotContext): Promise<void> {
-    await this.filterContent(botContext, this)
-    await this.trackFlow(botContext)
-    return
-  }
-
-  toBotonic(botContext: BotContext): JSX.Element {
-    return (
-      <Text
-        key={this.id}
-        feedbackEnabled={this.feedbackEnabled}
-        inferenceId={this.inferenceId}
-        botInteractionId={botContext.input.bot_interaction_id}
-      >
-        {this.text}
-      </Text>
-    )
-  }
-}

package/src/content-fields/hubtype-fields/knowledge-base.ts

@@ -1,18 +0,0 @@
-import type { HtBaseNode } from './common'
-import type { HtNodeWithContentType } from './node-types'
-
-interface SourceData {
-  id: string
-  name: string
-}
-
-export interface HtKnowledgeBaseNode extends HtBaseNode {
-  type: HtNodeWithContentType.KNOWLEDGE_BASE
-  content: {
-    feedback_enabled: boolean
-    sources_data: SourceData[]
-    instructions: string
-    has_memory: boolean
-    memory_length?: number
-  }
-}