@coveo/relay-event-types 7.14.1 → 8.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 +1 -1
- package/relay-event-types.d.ts +26 -21
package/package.json
CHANGED
package/relay-event-types.d.ts
CHANGED
|
@@ -378,10 +378,15 @@ export namespace Qna {
|
|
|
378
378
|
}
|
|
379
379
|
|
|
380
380
|
/**
|
|
381
|
-
* Event to emit when submitting feedback following the evaluation rubric for a
|
|
381
|
+
* Event to emit when submitting feedback following the evaluation rubric for a generated answer.
|
|
382
382
|
*/
|
|
383
|
-
export interface
|
|
384
|
-
answer:
|
|
383
|
+
export interface SubmitRgaFeedback extends Base {
|
|
384
|
+
answer: {
|
|
385
|
+
/**
|
|
386
|
+
* The id of the response associated with the service that delivered the answer.
|
|
387
|
+
*/
|
|
388
|
+
responseId: string;
|
|
389
|
+
};
|
|
385
390
|
feedback: {
|
|
386
391
|
/**
|
|
387
392
|
* Whether or not the answer helpful.
|
|
@@ -391,20 +396,18 @@ export namespace Qna {
|
|
|
391
396
|
* Qualitative score for `Is the answer clear and easy to read?`.
|
|
392
397
|
*/
|
|
393
398
|
readable: "yes" | "unknown" | "no";
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
hallucination_free: "yes" | "unknown" | "no";
|
|
407
|
-
};
|
|
399
|
+
/**
|
|
400
|
+
* Qualitative score for `Is the question covered in the documentation?`.
|
|
401
|
+
*/
|
|
402
|
+
documented: "yes" | "unknown" | "no";
|
|
403
|
+
/**
|
|
404
|
+
* Qualitative score for `Is the answer about the correct product or topic? `.
|
|
405
|
+
*/
|
|
406
|
+
correct_topic: "yes" | "unknown" | "no";
|
|
407
|
+
/**
|
|
408
|
+
* Qualitative score for `Is the answer free of hallucinated content?`.
|
|
409
|
+
*/
|
|
410
|
+
hallucination_free: "yes" | "unknown" | "no";
|
|
408
411
|
/**
|
|
409
412
|
* Additional details to the evaluation.
|
|
410
413
|
*/
|
|
@@ -420,10 +423,12 @@ export namespace Qna {
|
|
|
420
423
|
* Event to emit when submitting the reason of a negative feedback for a Smart Snippet answer.
|
|
421
424
|
*/
|
|
422
425
|
export interface SubmitSmartSnippetFeedback extends Base {
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
426
|
+
answer: {
|
|
427
|
+
/**
|
|
428
|
+
* The id of the response associated with the service that delivered the answer.
|
|
429
|
+
*/
|
|
430
|
+
responseId: string;
|
|
431
|
+
};
|
|
427
432
|
feedback: {
|
|
428
433
|
/**
|
|
429
434
|
* The reason for the negative feedback.
|