[AI Search] Support conversation_id in AISearchResultEvent and SurveyEvent (#55102)

Author: ashishkeshan

Diff for: src/events/lib/schema.ts

@@ -418,8 +418,6 @@ const aiSearchResult = {
   required: [
     'type',
     'context',
-    'ai_search_result_query',
-    'ai_search_result_response',
     'ai_search_result_links_json',
     'ai_search_result_provided_answer',
     'ai_search_result_response_status',
@@ -430,14 +428,6 @@ const aiSearchResult = {
       type: 'string',
       pattern: '^aiSearchResult$',
     },
-    ai_search_result_query: {
-      type: 'string',
-      description: 'The query the user searched for.',
-    },
-    ai_search_result_response: {
-      type: 'string',
-      description: "The GPT's response to the query.",
-    },
     ai_search_result_links_json: {
       type: 'string',
       description:
@@ -451,6 +441,10 @@ const aiSearchResult = {
       type: 'number',
       description: 'The status code of the GPT response.',
     },
+    ai_search_result_connected_event_id: {
+      type: 'string',
+      description: 'The id of the corresponding CSE copilot conversation event.',
+    },
   },
 }
 
@@ -487,6 +481,10 @@ const survey = {
       description:
         'The guessed language of the survey comment. The guessed language is very inaccurate when the string contains fewer than 3 or 4 words.',
     },
+    survey_connected_event_id: {
+      type: 'string',
+      description: 'The id of the corresponding CSE copilot conversation event.',
+    },
   },
 }
 

Diff for: src/events/types.ts

@@ -55,13 +55,12 @@ export type EventProps = {
 
 export type EventPropsByType = {
   [EventType.aiSearchResult]: {
-    ai_search_result_query: string
-    ai_search_result_response: string
     // Dynamic JSON string of an array of "link" objects in the form:
     // [{ "type": "reference" | "inline", "url": "https://..", "product": "issues" | "pages" | ... }, ...]
     ai_search_result_links_json: string
     ai_search_result_provided_answer: boolean
     ai_search_result_response_status: number
+    ai_search_result_connected_event_id?: string
   }
   [EventType.clipboard]: {
     clipboard_operation: string
@@ -119,5 +118,6 @@ export type EventPropsByType = {
     survey_email?: string
     survey_rating?: number
     survey_comment_language?: string
+    survey_connected_event_id?: string
   }
 }

Diff for: src/search/components/input/AskAIResults.tsx

@@ -38,6 +38,7 @@ type AISearchResultEventParams = {
   eventGroupId: string
   couldNotAnswer?: boolean
   status: number
+  connectedEventId?: string
 }
 
 export function AskAIResults({
@@ -67,11 +68,14 @@ export function AskAIResults({
     message: string
     sources: AIReference[]
     aiCouldNotAnswer: boolean
+    connectedEventId?: string
   }>('ai-query-cache', 1000, 7)
 
   const [isCopied, setCopied] = useClipboard(message, { successDuration: 1400 })
   const [feedbackSelected, setFeedbackSelected] = useState<null | 'up' | 'down'>(null)
 
+  const [conversationId, setConversationId] = useState<string>('')
+
   const handleAICannotAnswer = () => {
     setInitialLoading(false)
     setResponseLoading(false)
@@ -129,6 +133,7 @@ export function AskAIResults({
         eventGroupId: askAIEventGroupId.current,
         couldNotAnswer: cachedData.aiCouldNotAnswer,
         status: cachedData.aiCouldNotAnswer ? 400 : 200,
+        connectedEventId: cachedData.connectedEventId,
       })
 
       setTimeout(() => {
@@ -141,6 +146,7 @@ export function AskAIResults({
     async function fetchData() {
       let messageBuffer = ''
       let sourcesBuffer: AIReference[] = []
+      let conversationIdBuffer = ''
 
       try {
         const response = await executeAISearch(router, version, query, debug)
@@ -212,6 +218,9 @@ export function AskAIResults({
                   messageBuffer += parsedLine.text
                   setMessage(messageBuffer)
                 }
+              } else if (parsedLine.chunkType === 'CONVERSATION_ID') {
+                conversationIdBuffer = parsedLine.conversation_id
+                setConversationId(parsedLine.conversation_id)
               }
               if (!isCancelled) {
                 setAnnouncement('Copilot Response Loading...')
@@ -233,6 +242,7 @@ export function AskAIResults({
               message: messageBuffer,
               sources: sourcesBuffer,
               aiCouldNotAnswer: false,
+              connectedEventId: conversationIdBuffer,
             },
             version,
             router.locale || 'en',
@@ -245,6 +255,7 @@ export function AskAIResults({
             eventGroupId: askAIEventGroupId.current,
             couldNotAnswer: false,
             status: 200,
+            connectedEventId: conversationIdBuffer,
           })
         }
       }
@@ -299,6 +310,7 @@ export function AskAIResults({
                 survey_vote: true,
                 eventGroupKey: ASK_AI_EVENT_GROUP,
                 eventGroupId: askAIEventGroupId.current,
+                survey_connected_event_id: conversationId,
               })
             }}
           ></IconButton>
@@ -320,6 +332,7 @@ export function AskAIResults({
                 survey_vote: false,
                 eventGroupKey: ASK_AI_EVENT_GROUP,
                 eventGroupId: askAIEventGroupId.current,
+                survey_connected_event_id: conversationId,
               })
             }}
           ></IconButton>
@@ -409,6 +422,7 @@ function sendAISearchResultEvent({
   eventGroupId,
   couldNotAnswer = false,
   status,
+  connectedEventId,
 }: AISearchResultEventParams) {
   let searchResultLinksJson = '[]'
   try {
@@ -418,12 +432,10 @@ function sendAISearchResultEvent({
   }
   sendEvent({
     type: EventType.aiSearchResult,
-    // TODO: Remove PII so we can include the actual data
-    ai_search_result_query: 'REDACTED',
-    ai_search_result_response: 'REDACTED',
     ai_search_result_links_json: searchResultLinksJson,
     ai_search_result_provided_answer: couldNotAnswer ? false : true,
     ai_search_result_response_status: status,
+    ai_search_result_connected_event_id: connectedEventId,
     eventGroupKey: ASK_AI_EVENT_GROUP,
     eventGroupId: eventGroupId,
   })

Diff for: src/search/components/input/SearchOverlay.tsx

@@ -313,7 +313,7 @@ export function SearchOverlay({
     sendEvent({
       type: EventType.search,
       // TODO: Remove PII so we can include the actual query
-      search_query: 'REDACTED',
+      search_query: urlSearchInputQuery,
       search_context: GENERAL_SEARCH_CONTEXT,
       eventGroupKey: SEARCH_OVERLAY_EVENT_GROUP,
       eventGroupId: searchEventGroupId.current,
@@ -343,7 +343,6 @@ export function SearchOverlay({
       // Fire event from onSelect instead of inside the API request function (executeAISearch), because the result could be cached and not trigger an event
       sendEvent({
         type: EventType.search,
-        // TODO: Remove PII so we can include the actual query
         search_query: 'REDACTED',
         search_context: AI_SEARCH_CONTEXT,
         eventGroupKey: ASK_AI_EVENT_GROUP,