@coveo/relay-event-types 7.11.6 → 7.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/relay-event-types",
-  "version": "7.11.6",
+  "version": "7.12.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

@@ -35,18 +35,6 @@ interface DocumentSuggestion {
     responseId: string;
 }
 
-interface Feedback {
-    liked: boolean;
-    /**
-     * The reason for the feedback.
-     */
-    reason?: "irrelevant" | "notAccurate" | "outOfDate" | "harmful" | "other";
-    /**
-     * Additional details written in free text.
-     */
-    details?: 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.
  */
@@ -369,7 +357,7 @@ export namespace Qna {
      */
     export interface AnswerAction extends Base {
         answer: QnaAnswer;
-        action: "copyToClipboard" | "hide" | "show" | "expand" | "collapse";
+        action: "copyToClipboard" | "hide" | "show" | "expand" | "collapse" | "like" | "dislike";
     }
     
     /**
@@ -390,10 +378,61 @@ export namespace Qna {
     }
     
     /**
-     * Event to emit when submitting feedback for a Q&A answer.
+     * Event to emit when submitting feedback following the evaluation rubric for a Q&A answer.
      */
     export interface SubmitFeedback extends Base {
         answer: QnaAnswer;
-        feedback: Feedback;
+        feedback: {
+            /**
+             * Whether or not the answer helpful.
+             */
+            helpful: boolean;
+            /**
+             * Qualitative score for `Is the answer clear and easy to read?`.
+             */
+            readable: "yes" | "unknown" | "no";
+            correctness: {
+                /**
+                 * Qualitative score for `Is the question covered in the documentation?`.
+                 */
+                documented: "yes" | "unknown" | "no";
+                /**
+                 * Qualitative score for `Is the answer about the correct product or topic? `.
+                 */
+                correct_topic: "yes" | "unknown" | "no";
+                /**
+                 * Qualitative score for `Is the answer free of hallucinated content?`.
+                 */
+                hallucination_free: "yes" | "unknown" | "no";
+            };
+            /**
+             * Additional details to the evaluation.
+             */
+            details?: string;
+            /**
+             * URL of an indexed document that should be used to generate the answer (i.e. source of truth).
+             */
+            document_url?: string;
+        };
+    }
+    
+    /**
+     * Event to emit when submitting the reason of a negative feedback for a Smart Snippet answer.
+     */
+    export interface SubmitSmartSnippetFeedback extends Base {
+        /**
+         * 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;
+        feedback: {
+            /**
+             * The reason for the negative feedback.
+             */
+            reason: "irrelevant" | "notAccurate" | "outOfDate" | "harmful" | "other";
+            /**
+             * Additional details written in free text.
+             */
+            details?: string;
+        };
     }
 }