@coveo/relay-event-types 10.1.2 → 11.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/relay-event-types",
-  "version": "10.1.2",
+  "version": "11.0.0",
   "description": "Typescript types for Coveo Events, intended to be used with the Relay package.",
   "types": "./relay-event-types.d.ts",
   "author": "Coveo",

package/relay-event-types.d.ts

@@ -27,14 +27,6 @@ interface BaseItemClick extends Base {
     itemMetadata: ItemMetaData;
 }
 
-/**
- * A document suggestion.
- */
-interface DocumentSuggestion {
-    id: string;
-    responseId: string;
-}
-
 /**
  * Represents the Coveo Analytics Item Click Event. Use this schema when sending data related to a user's click on an item returned by Coveo.
  */
@@ -94,28 +86,6 @@ interface ProductQuantity {
     quantity: number;
 }
 
-interface QnaAnswer {
-    /**
-     * The id of the response associated with the service that delivered the answer (e.g. for the Search API, that would be `searchUid`).
-     */
-    responseId: string;
-    /**
-     * The type of the answer.
-     */
-    type: "SmartSnippet" | "SmartSnippetSuggestion" | "RGA";
-}
-
-interface QnaCitation {
-    /**
-     * The citation id. This value needs to match the unique identifier of the answer's citation.
-     */
-    id: string;
-    /**
-     * The type of the citation.
-     */
-    type: "Source" | "InlineLink";
-}
-
 /**
  * A support ticket.
  */
@@ -143,11 +113,6 @@ interface Ticket {
 }
 
 export namespace CaseAssist {
-    /**
-     * The caseAssist.start event is emitted when a user initiates a Case Assist flow.
-     */
-    export type Start = Base;
-    
     /**
      * The caseAssist.cancel event is emitted when a user cancels the Case Assist flow.
      */
@@ -169,14 +134,26 @@ export namespace CaseAssist {
      * The caseAssist.documentSuggestionClick event is emitted when a user clicks on a Case Assist document suggestion.
      */
     export interface DocumentSuggestionClick extends Base {
-        documentSuggestion: DocumentSuggestion;
+        /**
+         * Response ID linked to the Case Assist API request that returned the clicked suggestion.
+         */
+        responseId: UuidNotNull;
+        /**
+         * Indicates the clicked suggestion's 1-based position within the returned results.
+         */
+        position: number;
+        itemMetadata: ItemMetaData;
     }
     
     /**
      * The caseAssist.documentSuggestionFeedback event is emitted when a user gives feedback on a Case Assist document suggestion.
      */
     export interface DocumentSuggestionFeedback extends Base {
-        documentSuggestion: DocumentSuggestion;
+        /**
+         * Response ID linked to the Case Assist API request that returned the document suggestion.
+         */
+        responseId: UuidNotNull;
+        itemMetadata: ItemMetaData;
         /**
          * Whether the user liked the document suggestion or not.
          */
@@ -187,22 +164,26 @@ export namespace CaseAssist {
      * The caseAssist.selectFieldClassification event is emitted when a user selects a Case Assist field recommendation.
      */
     export interface SelectFieldClassification extends Base {
-        fieldClassification: {
-            /**
-             * The unique identifier of the field classification.
-             */
-            id: string;
-            /**
-             * The unique identifier of the response that contains the field classification.
-             */
-            responseId: string;
-        };
+        /**
+         * The unique identifier of the response that contains the field classification.
+         */
+        responseId: string;
+        /**
+         * The unique identifier of the field classification.
+         */
+        classificationId: string;
         /**
          * Whether the field classification was automatically selected by Coveo Case Assist.
          */
         autoselected: boolean;
     }
     
+    /**
+     * The caseAssist.start event is emitted when a user initiates a Case Assist flow.
+     */
+    export interface Start extends Base {
+    }
+    
     /**
      * The caseAssist.updateField event is emitted when a user edits a Case Assist form field.
      */
@@ -347,46 +328,84 @@ export namespace InsightPanel {
     }
 }
 
-export namespace Qna {
+export namespace Rga {
     /**
-     * Event to emit when interacting with a Q&A answer.
+     * Event to emit when interacting with a generated answer.
      */
     export interface AnswerAction extends Base {
-        answer: QnaAnswer;
+        /**
+         * The id of the response associated with the service that delivered the answer.
+         */
+        responseId: string;
+        /**
+         * The action taken on the answer.
+         */
         action: "copyToClipboard" | "hide" | "show" | "expand" | "collapse" | "like" | "dislike";
     }
     
     /**
-     * Event to emit when a Q&A answer citation item has been clicked.
+     * Event to emit when a generated answer citation item has been clicked.
      */
     export interface CitationClick extends Base {
-        answer: QnaAnswer;
-        citation: QnaCitation;
+        /**
+         * The id of the response associated with the service that delivered the answer.
+         */
+        responseId: string;
+        /**
+         * The citation id. This value needs to match the unique identifier of the answer's citation.
+         */
+        citationId: string;
+        itemMetadata: ItemMetaData;
     }
     
     /**
-     * Event to emit when a Q&A answer citation has been hovered.
+     * Event to emit when a generated answer citation has been hovered.
      */
     export interface CitationHover extends Base {
-        answer: QnaAnswer;
-        citation: QnaCitation;
-        citationHoverTimeInMs?: number;
+        /**
+         * The id of the response associated with the service that delivered the answer.
+         */
+        responseId: string;
+        /**
+         * The citation id. This value needs to match the unique identifier of the answer's citation.
+         */
+        citationId: string;
+        itemMetadata: ItemMetaData;
+        /**
+         * The time in milliseconds the citation was hovered.
+         */
+        citationHoverTimeInMs: number;
+    }
+    
+    /**
+     * Event to emit when a generated answer stream has ended.
+     */
+    export interface StreamEnd extends Base {
+        /**
+         * The id of the response associated with the service that delivered the answer.
+         */
+        responseId: string;
+        /**
+         * Indicates if the answer was generated or not.
+         */
+        answerGenerated: boolean;
     }
     
     /**
      * Event to emit when submitting feedback following the evaluation rubric for a generated answer.
      */
-    export interface SubmitRgaFeedback extends Base {
-        answer: {
-            /**
-             * The id of the response associated with the service that delivered the answer.
-             */
-            responseId: string;
-        };
+    export interface SubmitFeedback extends Base {
+        /**
+         * The id of the response associated with the service that delivered the answer.
+         */
+        responseId: string;
         /**
          * Whether or not the answer is helpful.
          */
         helpful: boolean;
+        /**
+         * Details about the evaluation of the answer.
+         */
         details: {
             /**
              * Whether or not the answer is clear and easy to read.
@@ -405,24 +424,69 @@ export namespace Qna {
              */
             hallucinationFree?: boolean;
         };
+        /**
+         * Additional notes about the evaluation.
+         */
         additionalNotes?: string;
+        /**
+         * The URL of the correct answer.
+         */
         correctAnswerUrl?: string;
     }
+}
+
+export namespace SmartSnippets {
+    /**
+     * Event to emit when interacting with a snippet.
+     */
+    export interface AnswerAction extends Base {
+        /**
+         * The id of the response associated with the service that delivered the snippet.
+         */
+        responseId: string;
+        /**
+         * The type of snippet the answer belongs to.
+         */
+        snippetType: "SmartSnippet" | "SmartSnippetSuggestion";
+        itemMetadata: ItemMetaData;
+        /**
+         * The action taken on the snippet.
+         */
+        action: "expand" | "collapse" | "like" | "dislike";
+    }
     
     /**
-     * Event to emit when submitting the reason of a negative feedback for a Smart Snippet answer.
+     * Event to emit when a snippet source has been clicked.
      */
-    export interface SubmitSmartSnippetFeedback extends Base {
-        answer: {
-            /**
-             * The id of the response associated with the service that delivered the answer.
-             */
-            responseId: string;
-        };
+    export interface SourceClick extends Base {
+        /**
+         * The id of the response associated with the service that delivered the snippet.
+         */
+        responseId: string;
+        /**
+         * The type of snippet the answer belongs to.
+         */
+        snippetType: "SmartSnippet" | "SmartSnippetSuggestion";
+        itemMetadata: ItemMetaData;
+    }
+    
+    /**
+     * Event to emit when submitting the reason of a negative feedback on a snippet.
+     */
+    export interface SubmitFeedback extends Base {
+        /**
+         * The id of the response associated with the service that delivered the snippet.
+         */
+        responseId: string;
+        /**
+         * The type of snippet the answer belongs to.
+         */
+        snippetType: "SmartSnippet" | "SmartSnippetSuggestion";
+        itemMetadata: ItemMetaData;
         /**
          * The reason for the negative feedback.
          */
-        reason: "irrelevant" | "notAccurate" | "outOfDate" | "harmful" | "other";
+        reason: "doesNotAnswer" | "partiallyAnswers" | "wasNotAQuestion" | "other";
         /**
          * Additional details written in free text.
          */