Merge pull request #44 from oramasearch/feat/complete-interaction-event

Feat: introduces a new event to handle response completion

packages/client/src/answerSession.ts

@@ -27,6 +27,7 @@ export type AnswerParams<M extends boolean, UserContext = unknown> = {
     onRelatedQueries?: (relatedQueries: string[]) => void
     onNewInteractionStarted?: (interactionId: string) => void
     onStateChange?: (state: Interaction[]) => void
+    onInteractionDone?: (interaction: Interaction) => void
   }
   systemPrompts?: string[]
 }
@@ -38,6 +39,8 @@ export type Interaction<T = AnyDocument> = {
   relatedQueries: Nullable<string[]>
   sources: Nullable<Results<T>>
   translatedQuery: Nullable<SearchParams<AnyOrama>>
+  segment: Nullable<string>
+  trigger: Nullable<string>
   aborted: boolean
   loading: boolean
   error: boolean
@@ -166,6 +169,8 @@ export class AnswerSession<M extends boolean> {
       relatedQueries: null,
       sources: null,
       translatedQuery: null,
+      segment: null,
+      trigger: null,
       aborted: false,
       loading: true,
       error: false,
@@ -282,6 +287,21 @@ export class AnswerSession<M extends boolean> {
                 this.events.onStateChange(this.state)
               }
 
+              // MANAGE INCOMING METADATA
+            } else if (parsedMessage.type === 'conversation-metadata') {
+              const { segment, trigger } = parsedMessage.message
+              if (segment) {
+                this.state[currentStateIndex].segment = segment
+              }
+
+              if (trigger) {
+                this.state[currentStateIndex].trigger = trigger
+              }
+
+              if (this.events?.onStateChange) {
+                this.events.onStateChange(this.state)
+              }
+
               // MANAGE INCOMING RELATED QUERIES
             } else if (parsedMessage.type === 'related-queries') {
               this.state[currentStateIndex].relatedQueries = parsedMessage.message
@@ -344,6 +364,10 @@ export class AnswerSession<M extends boolean> {
         this.events.onStateChange(this.state)
       }
 
+      if (this.events?.onInteractionDone) {
+        this.events.onInteractionDone(this.state[currentStateIndex])
+      }
+
       if (this.events?.onMessageLoading) {
         this.events.onMessageLoading(false)
       }

packages/react-client/src/useAnswerSession.tsx

@@ -1,5 +1,5 @@
 import type { AnyDocument, AnyOrama, Nullable, Results, SearchParams } from '@orama/orama'
-import type { AnswerSessionParams, Message } from '@oramacloud/client'
+import type { AnswerSessionParams, Message, Interaction } from '@oramacloud/client'
 
 import { AnswerSession, OramaClient } from '@oramacloud/client'
 import { useCallback, useEffect, useRef, useState } from 'react'
@@ -14,6 +14,7 @@ export function useAnswerSession<Document = AnyDocument>(params: AnswerSessionHo
   const [error, setError] = useState<Nullable<Error>>(null)
   const [aborted, setAborted] = useState<boolean>(false)
   const [sources, setSources] = useState<Nullable<Results<Document>>>(null)
+  const [interaction, setInteraction] = useState<Nullable<Interaction>>(null)
   const [relatedQueries, setRelatedQueries] = useState<Nullable<string[]>>(null)
   //no support for multi index answer session yet
   const sessionRef = useRef<Nullable<AnswerSession<true>>>(null)
@@ -47,6 +48,9 @@ export function useAnswerSession<Document = AnyDocument>(params: AnswerSessionHo
         },
         onRelatedQueries: (relatedQueries) => {
           setRelatedQueries(relatedQueries)
+        },
+        onInteractionDone: (interaction) => {
+          setInteraction(interaction)
         }
       }
     })
@@ -83,6 +87,7 @@ export function useAnswerSession<Document = AnyDocument>(params: AnswerSessionHo
     error,
     sources,
     relatedQueries,
+    interaction,
     ask,
     clearSession
   }