@coveo/relay-event-types 9.5.0 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/relay-event-types",
3
- "version": "9.5.0",
3
+ "version": "10.0.0",
4
4
  "description": "Typescript types for Coveo Events, intended to be used with the Relay package.",
5
5
  "types": "./relay-event-types.d.ts",
6
6
  "author": "Coveo",
@@ -383,36 +383,30 @@ export namespace Qna {
383
383
  */
384
384
  responseId: string;
385
385
  };
386
- feedback: {
387
- /**
388
- * Whether or not the answer helpful.
389
- */
390
- helpful: boolean;
391
- /**
392
- * Qualitative score for `Is the answer clear and easy to read?`.
393
- */
394
- readable: "yes" | "unknown" | "no";
395
- /**
396
- * Qualitative score for `Is the question covered in the documentation?`.
397
- */
398
- documented: "yes" | "unknown" | "no";
386
+ /**
387
+ * Whether or not the answer is helpful.
388
+ */
389
+ helpful: boolean;
390
+ details: {
399
391
  /**
400
- * Qualitative score for `Is the answer about the correct product or topic? `.
392
+ * Whether or not the answer is clear and easy to read.
401
393
  */
402
- correct_topic: "yes" | "unknown" | "no";
394
+ readable?: boolean;
403
395
  /**
404
- * Qualitative score for `Is the answer free of hallucinated content?`.
396
+ * Whether or not the question is covered in the documentation.
405
397
  */
406
- hallucination_free: "yes" | "unknown" | "no";
398
+ documented?: boolean;
407
399
  /**
408
- * Additional details to the evaluation.
400
+ * Whether or not the answer is about the correct product or topic.
409
401
  */
410
- details?: string;
402
+ correctTopic?: boolean;
411
403
  /**
412
- * URL of an indexed document that should be used to generate the answer (i.e. source of truth).
404
+ * Whether or not the answer is free of hallucinated content.
413
405
  */
414
- document_url?: string;
406
+ hallucinationFree?: boolean;
415
407
  };
408
+ additionalNotes?: string;
409
+ correctAnswerUrl?: string;
416
410
  }
417
411
 
418
412
  /**
@@ -425,15 +419,13 @@ export namespace Qna {
425
419
  */
426
420
  responseId: string;
427
421
  };
428
- feedback: {
429
- /**
430
- * The reason for the negative feedback.
431
- */
432
- reason: "irrelevant" | "notAccurate" | "outOfDate" | "harmful" | "other";
433
- /**
434
- * Additional details written in free text.
435
- */
436
- details?: string;
437
- };
422
+ /**
423
+ * The reason for the negative feedback.
424
+ */
425
+ reason: "irrelevant" | "notAccurate" | "outOfDate" | "harmful" | "other";
426
+ /**
427
+ * Additional details written in free text.
428
+ */
429
+ additionalNotes?: string;
438
430
  }
439
431
  }