coveo.analytics 2.30.4 → 2.30.6

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.
@@ -1,6 +1,6 @@
1
1
  import { AnalyticsClient, ClientOptions } from '../client/analytics';
2
2
  import { SearchEventRequest } from '../events';
3
- import { DocumentIdentifier, FacetStateMetadata, GeneratedAnswerBaseMeta, GeneratedAnswerCitationMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerRephraseMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerStreamEndMeta, PartialDocumentInformation, SearchPageEvents, SmartSnippetDocumentIdentifier, SmartSnippetFeedbackReason, SmartSnippetLinkMeta, SmartSnippetSuggestionMeta } from '../searchPage/searchPageEvents';
3
+ import { DocumentIdentifier, FacetStateMetadata, GeneratedAnswerBaseMeta, GeneratedAnswerCitationMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerFeedbackMetaV2, GeneratedAnswerRephraseMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerStreamEndMeta, PartialDocumentInformation, SearchPageEvents, SmartSnippetDocumentIdentifier, SmartSnippetFeedbackReason, SmartSnippetLinkMeta, SmartSnippetSuggestionMeta } from '../searchPage/searchPageEvents';
4
4
  import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata, UserActionsDocumentMetadata, UserActionsPageViewMetadata, CreateArticleMetadata } from './insightEvents';
5
5
  export interface InsightClientProvider {
6
6
  getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -85,6 +85,7 @@ export declare class CoveoInsightClient {
85
85
  logGeneratedAnswerExpand(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
86
86
  logGeneratedAnswerCollapse(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
87
87
  logGeneratedAnswerFeedbackSubmit(generatedAnswerFeedbackMetadata: GeneratedAnswerFeedbackMeta, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
88
+ logGeneratedAnswerFeedbackSubmitV2(generatedAnswerFeedbackMetadata: GeneratedAnswerFeedbackMetaV2, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
88
89
  logRephraseGeneratedAnswer(generatedAnswerRephraseMetadata: GeneratedAnswerRephraseMeta, metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
89
90
  logRetryGeneratedAnswer(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
90
91
  logGeneratedAnswerStreamEnd(generatedAnswerStreamEndMetadata: GeneratedAnswerStreamEndMeta, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
@@ -1,6 +1,6 @@
1
1
  import { ClientOptions, AnalyticsClient } from '../client/analytics';
2
2
  import { SearchEventRequest, SearchEventResponse, AnyEventResponse, ClickEventResponse, CustomEventResponse } from '../events';
3
- import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta, SmartSnippetDocumentIdentifier, StaticFilterMetadata, StaticFilterToggleValueMetadata, UndoTriggerRedirectMetadata, SmartSnippetLinkMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerCitationMeta, GeneratedAnswerStreamEndMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerBaseMeta, GeneratedAnswerRephraseMeta } from './searchPageEvents';
3
+ import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta, SmartSnippetDocumentIdentifier, StaticFilterMetadata, StaticFilterToggleValueMetadata, UndoTriggerRedirectMetadata, SmartSnippetLinkMeta, GeneratedAnswerFeedbackMeta, GeneratedAnswerCitationMeta, GeneratedAnswerStreamEndMeta, GeneratedAnswerSourceHoverMeta, GeneratedAnswerBaseMeta, GeneratedAnswerRephraseMeta, GeneratedAnswerFeedbackMetaV2 } from './searchPageEvents';
4
4
  export interface SearchPageClientProvider {
5
5
  getBaseMetadata: () => Record<string, any>;
6
6
  getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -206,6 +206,8 @@ export declare class CoveoSearchPageClient {
206
206
  logGeneratedAnswerCollapse(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
207
207
  makeGeneratedAnswerFeedbackSubmit(meta: GeneratedAnswerFeedbackMeta): Promise<EventBuilder<CustomEventResponse>>;
208
208
  logGeneratedAnswerFeedbackSubmit(meta: GeneratedAnswerFeedbackMeta): Promise<void | CustomEventResponse>;
209
+ makeGeneratedAnswerFeedbackSubmitV2(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
210
+ logGeneratedAnswerFeedbackSubmitV2(meta: GeneratedAnswerFeedbackMetaV2): Promise<void | CustomEventResponse>;
209
211
  makeRephraseGeneratedAnswer(meta: GeneratedAnswerRephraseMeta): Promise<EventBuilder<SearchEventResponse>>;
210
212
  logRephraseGeneratedAnswer(meta: GeneratedAnswerRephraseMeta): Promise<void | SearchEventResponse>;
211
213
  makeRetryGeneratedAnswer(): Promise<EventBuilder<SearchEventResponse>>;
@@ -85,7 +85,8 @@ export declare enum SearchPageEvents {
85
85
  generatedAnswerExpand = "generatedAnswerExpand",
86
86
  generatedAnswerCollapse = "generatedAnswerCollapse",
87
87
  generatedAnswerFeedbackSubmit = "generatedAnswerFeedbackSubmit",
88
- rephraseGeneratedAnswer = "rephraseGeneratedAnswer"
88
+ rephraseGeneratedAnswer = "rephraseGeneratedAnswer",
89
+ generatedAnswerFeedbackSubmitV2 = "generatedAnswerFeedbackSubmitV2"
89
90
  }
90
91
  export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
91
92
  export interface StaticFilterMetadata {
@@ -217,4 +218,14 @@ export interface GeneratedAnswerFeedbackMeta extends GeneratedAnswerBaseMeta {
217
218
  reason: GeneratedAnswerFeedbackReason;
218
219
  details?: string;
219
220
  }
221
+ export type GeneratedAnswerFeedbackReasonOption = 'yes' | 'unknown' | 'no';
222
+ export interface GeneratedAnswerFeedbackMetaV2 extends GeneratedAnswerBaseMeta {
223
+ helpful: boolean;
224
+ readable: GeneratedAnswerFeedbackReasonOption;
225
+ documented: GeneratedAnswerFeedbackReasonOption;
226
+ correctTopic: GeneratedAnswerFeedbackReasonOption;
227
+ hallucinationFree: GeneratedAnswerFeedbackReasonOption;
228
+ details?: string;
229
+ documentUrl?: string;
230
+ }
220
231
  export {};
@@ -1 +1 @@
1
- export declare const libVersion = "2.30.4";
1
+ export declare const libVersion = "2.30.6";
package/dist/library.cjs CHANGED
@@ -731,7 +731,7 @@ function sha1(bytes) {
731
731
  const v5 = v35('v5', 0x50, sha1);
732
732
  var uuidv5 = v5;
733
733
 
734
- var libVersion = "2.30.4" ;
734
+ var libVersion = "2.30.6" ;
735
735
 
736
736
  var getFormattedLocation = function (location) {
737
737
  return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84302,6 +84302,7 @@ exports.SearchPageEvents = void 0;
84302
84302
  SearchPageEvents["generatedAnswerCollapse"] = "generatedAnswerCollapse";
84303
84303
  SearchPageEvents["generatedAnswerFeedbackSubmit"] = "generatedAnswerFeedbackSubmit";
84304
84304
  SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
84305
+ SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
84305
84306
  })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
84306
84307
  var CustomEventsTypes = (_a = {},
84307
84308
  _a[exports.SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -84348,6 +84349,7 @@ var CustomEventsTypes = (_a = {},
84348
84349
  _a[exports.SearchPageEvents.generatedAnswerExpand] = 'generatedAnswer',
84349
84350
  _a[exports.SearchPageEvents.generatedAnswerCollapse] = 'generatedAnswer',
84350
84351
  _a[exports.SearchPageEvents.generatedAnswerFeedbackSubmit] = 'generatedAnswer',
84352
+ _a[exports.SearchPageEvents.generatedAnswerFeedbackSubmitV2] = 'generatedAnswer',
84351
84353
  _a[exports.InsightEvents.expandToFullUI] = 'interface',
84352
84354
  _a[exports.InsightEvents.openUserActions] = 'User Actions',
84353
84355
  _a[exports.InsightEvents.showPrecedingSessions] = 'User Actions',
@@ -85780,6 +85782,21 @@ var CoveoSearchPageClient = (function () {
85780
85782
  });
85781
85783
  });
85782
85784
  };
85785
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerFeedbackSubmitV2 = function (metadata) {
85786
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerFeedbackSubmitV2, metadata);
85787
+ };
85788
+ CoveoSearchPageClient.prototype.logGeneratedAnswerFeedbackSubmitV2 = function (meta) {
85789
+ return __awaiter(this, void 0, void 0, function () {
85790
+ return __generator(this, function (_a) {
85791
+ switch (_a.label) {
85792
+ case 0: return [4, this.makeGeneratedAnswerFeedbackSubmitV2(meta)];
85793
+ case 1: return [2, (_a.sent()).log({
85794
+ searchUID: this.provider.getSearchUID(),
85795
+ })];
85796
+ }
85797
+ });
85798
+ });
85799
+ };
85783
85800
  CoveoSearchPageClient.prototype.makeRephraseGeneratedAnswer = function (meta) {
85784
85801
  return this.makeSearchEvent(exports.SearchPageEvents.rephraseGeneratedAnswer, meta);
85785
85802
  };
@@ -86210,6 +86227,10 @@ var CoveoInsightClient = (function () {
86210
86227
  return this.logCustomEvent(exports.SearchPageEvents.generatedAnswerFeedbackSubmit, metadata
86211
86228
  ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerFeedbackMetadata) : generatedAnswerFeedbackMetadata);
86212
86229
  };
86230
+ CoveoInsightClient.prototype.logGeneratedAnswerFeedbackSubmitV2 = function (generatedAnswerFeedbackMetadata, metadata) {
86231
+ return this.logCustomEvent(exports.SearchPageEvents.generatedAnswerFeedbackSubmitV2, metadata
86232
+ ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerFeedbackMetadata) : generatedAnswerFeedbackMetadata);
86233
+ };
86213
86234
  CoveoInsightClient.prototype.logRephraseGeneratedAnswer = function (generatedAnswerRephraseMetadata, metadata) {
86214
86235
  return this.logSearchEvent(exports.SearchPageEvents.rephraseGeneratedAnswer, metadata
86215
86236
  ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerRephraseMetadata) : generatedAnswerRephraseMetadata);
@@ -596,7 +596,7 @@ function sha1(bytes) {
596
596
  const v5 = v35('v5', 0x50, sha1);
597
597
  var uuidv5 = v5;
598
598
 
599
- const libVersion = "2.30.4" ;
599
+ const libVersion = "2.30.6" ;
600
600
 
601
601
  const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
602
602
 
@@ -1784,6 +1784,7 @@ var SearchPageEvents;
1784
1784
  SearchPageEvents["generatedAnswerCollapse"] = "generatedAnswerCollapse";
1785
1785
  SearchPageEvents["generatedAnswerFeedbackSubmit"] = "generatedAnswerFeedbackSubmit";
1786
1786
  SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
1787
+ SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
1787
1788
  })(SearchPageEvents || (SearchPageEvents = {}));
1788
1789
  const CustomEventsTypes = {
1789
1790
  [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1830,6 +1831,7 @@ const CustomEventsTypes = {
1830
1831
  [SearchPageEvents.generatedAnswerExpand]: 'generatedAnswer',
1831
1832
  [SearchPageEvents.generatedAnswerCollapse]: 'generatedAnswer',
1832
1833
  [SearchPageEvents.generatedAnswerFeedbackSubmit]: 'generatedAnswer',
1834
+ [SearchPageEvents.generatedAnswerFeedbackSubmitV2]: 'generatedAnswer',
1833
1835
  [InsightEvents.expandToFullUI]: 'interface',
1834
1836
  [InsightEvents.openUserActions]: 'User Actions',
1835
1837
  [InsightEvents.showPrecedingSessions]: 'User Actions',
@@ -2728,6 +2730,16 @@ class CoveoSearchPageClient {
2728
2730
  });
2729
2731
  });
2730
2732
  }
2733
+ makeGeneratedAnswerFeedbackSubmitV2(metadata) {
2734
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmitV2, metadata);
2735
+ }
2736
+ logGeneratedAnswerFeedbackSubmitV2(meta) {
2737
+ return __awaiter(this, void 0, void 0, function* () {
2738
+ return (yield this.makeGeneratedAnswerFeedbackSubmitV2(meta)).log({
2739
+ searchUID: this.provider.getSearchUID(),
2740
+ });
2741
+ });
2742
+ }
2731
2743
  makeRephraseGeneratedAnswer(meta) {
2732
2744
  return this.makeSearchEvent(SearchPageEvents.rephraseGeneratedAnswer, meta);
2733
2745
  }
@@ -3209,6 +3221,10 @@ class CoveoInsightClient {
3209
3221
  return this.logCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmit, metadata
3210
3222
  ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerFeedbackMetadata) : generatedAnswerFeedbackMetadata);
3211
3223
  }
3224
+ logGeneratedAnswerFeedbackSubmitV2(generatedAnswerFeedbackMetadata, metadata) {
3225
+ return this.logCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmitV2, metadata
3226
+ ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerFeedbackMetadata) : generatedAnswerFeedbackMetadata);
3227
+ }
3212
3228
  logRephraseGeneratedAnswer(generatedAnswerRephraseMetadata, metadata) {
3213
3229
  return this.logSearchEvent(SearchPageEvents.rephraseGeneratedAnswer, metadata
3214
3230
  ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerRephraseMetadata) : generatedAnswerRephraseMetadata);
package/dist/library.js CHANGED
@@ -731,7 +731,7 @@ function sha1(bytes) {
731
731
  const v5 = v35('v5', 0x50, sha1);
732
732
  var uuidv5 = v5;
733
733
 
734
- var libVersion = "2.30.4" ;
734
+ var libVersion = "2.30.6" ;
735
735
 
736
736
  var getFormattedLocation = function (location) {
737
737
  return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84302,6 +84302,7 @@ exports.SearchPageEvents = void 0;
84302
84302
  SearchPageEvents["generatedAnswerCollapse"] = "generatedAnswerCollapse";
84303
84303
  SearchPageEvents["generatedAnswerFeedbackSubmit"] = "generatedAnswerFeedbackSubmit";
84304
84304
  SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
84305
+ SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
84305
84306
  })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
84306
84307
  var CustomEventsTypes = (_a = {},
84307
84308
  _a[exports.SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -84348,6 +84349,7 @@ var CustomEventsTypes = (_a = {},
84348
84349
  _a[exports.SearchPageEvents.generatedAnswerExpand] = 'generatedAnswer',
84349
84350
  _a[exports.SearchPageEvents.generatedAnswerCollapse] = 'generatedAnswer',
84350
84351
  _a[exports.SearchPageEvents.generatedAnswerFeedbackSubmit] = 'generatedAnswer',
84352
+ _a[exports.SearchPageEvents.generatedAnswerFeedbackSubmitV2] = 'generatedAnswer',
84351
84353
  _a[exports.InsightEvents.expandToFullUI] = 'interface',
84352
84354
  _a[exports.InsightEvents.openUserActions] = 'User Actions',
84353
84355
  _a[exports.InsightEvents.showPrecedingSessions] = 'User Actions',
@@ -85780,6 +85782,21 @@ var CoveoSearchPageClient = (function () {
85780
85782
  });
85781
85783
  });
85782
85784
  };
85785
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerFeedbackSubmitV2 = function (metadata) {
85786
+ return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerFeedbackSubmitV2, metadata);
85787
+ };
85788
+ CoveoSearchPageClient.prototype.logGeneratedAnswerFeedbackSubmitV2 = function (meta) {
85789
+ return __awaiter(this, void 0, void 0, function () {
85790
+ return __generator(this, function (_a) {
85791
+ switch (_a.label) {
85792
+ case 0: return [4, this.makeGeneratedAnswerFeedbackSubmitV2(meta)];
85793
+ case 1: return [2, (_a.sent()).log({
85794
+ searchUID: this.provider.getSearchUID(),
85795
+ })];
85796
+ }
85797
+ });
85798
+ });
85799
+ };
85783
85800
  CoveoSearchPageClient.prototype.makeRephraseGeneratedAnswer = function (meta) {
85784
85801
  return this.makeSearchEvent(exports.SearchPageEvents.rephraseGeneratedAnswer, meta);
85785
85802
  };
@@ -86210,6 +86227,10 @@ var CoveoInsightClient = (function () {
86210
86227
  return this.logCustomEvent(exports.SearchPageEvents.generatedAnswerFeedbackSubmit, metadata
86211
86228
  ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerFeedbackMetadata) : generatedAnswerFeedbackMetadata);
86212
86229
  };
86230
+ CoveoInsightClient.prototype.logGeneratedAnswerFeedbackSubmitV2 = function (generatedAnswerFeedbackMetadata, metadata) {
86231
+ return this.logCustomEvent(exports.SearchPageEvents.generatedAnswerFeedbackSubmitV2, metadata
86232
+ ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerFeedbackMetadata) : generatedAnswerFeedbackMetadata);
86233
+ };
86213
86234
  CoveoInsightClient.prototype.logRephraseGeneratedAnswer = function (generatedAnswerRephraseMetadata, metadata) {
86214
86235
  return this.logSearchEvent(exports.SearchPageEvents.rephraseGeneratedAnswer, metadata
86215
86236
  ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerRephraseMetadata) : generatedAnswerRephraseMetadata);
package/dist/library.mjs CHANGED
@@ -729,7 +729,7 @@ function sha1(bytes) {
729
729
  const v5 = v35('v5', 0x50, sha1);
730
730
  var uuidv5 = v5;
731
731
 
732
- var libVersion = "2.30.4" ;
732
+ var libVersion = "2.30.6" ;
733
733
 
734
734
  var getFormattedLocation = function (location) {
735
735
  return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84300,6 +84300,7 @@ var SearchPageEvents;
84300
84300
  SearchPageEvents["generatedAnswerCollapse"] = "generatedAnswerCollapse";
84301
84301
  SearchPageEvents["generatedAnswerFeedbackSubmit"] = "generatedAnswerFeedbackSubmit";
84302
84302
  SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
84303
+ SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
84303
84304
  })(SearchPageEvents || (SearchPageEvents = {}));
84304
84305
  var CustomEventsTypes = (_a = {},
84305
84306
  _a[SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -84346,6 +84347,7 @@ var CustomEventsTypes = (_a = {},
84346
84347
  _a[SearchPageEvents.generatedAnswerExpand] = 'generatedAnswer',
84347
84348
  _a[SearchPageEvents.generatedAnswerCollapse] = 'generatedAnswer',
84348
84349
  _a[SearchPageEvents.generatedAnswerFeedbackSubmit] = 'generatedAnswer',
84350
+ _a[SearchPageEvents.generatedAnswerFeedbackSubmitV2] = 'generatedAnswer',
84349
84351
  _a[InsightEvents.expandToFullUI] = 'interface',
84350
84352
  _a[InsightEvents.openUserActions] = 'User Actions',
84351
84353
  _a[InsightEvents.showPrecedingSessions] = 'User Actions',
@@ -85778,6 +85780,21 @@ var CoveoSearchPageClient = (function () {
85778
85780
  });
85779
85781
  });
85780
85782
  };
85783
+ CoveoSearchPageClient.prototype.makeGeneratedAnswerFeedbackSubmitV2 = function (metadata) {
85784
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmitV2, metadata);
85785
+ };
85786
+ CoveoSearchPageClient.prototype.logGeneratedAnswerFeedbackSubmitV2 = function (meta) {
85787
+ return __awaiter(this, void 0, void 0, function () {
85788
+ return __generator(this, function (_a) {
85789
+ switch (_a.label) {
85790
+ case 0: return [4, this.makeGeneratedAnswerFeedbackSubmitV2(meta)];
85791
+ case 1: return [2, (_a.sent()).log({
85792
+ searchUID: this.provider.getSearchUID(),
85793
+ })];
85794
+ }
85795
+ });
85796
+ });
85797
+ };
85781
85798
  CoveoSearchPageClient.prototype.makeRephraseGeneratedAnswer = function (meta) {
85782
85799
  return this.makeSearchEvent(SearchPageEvents.rephraseGeneratedAnswer, meta);
85783
85800
  };
@@ -86208,6 +86225,10 @@ var CoveoInsightClient = (function () {
86208
86225
  return this.logCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmit, metadata
86209
86226
  ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerFeedbackMetadata) : generatedAnswerFeedbackMetadata);
86210
86227
  };
86228
+ CoveoInsightClient.prototype.logGeneratedAnswerFeedbackSubmitV2 = function (generatedAnswerFeedbackMetadata, metadata) {
86229
+ return this.logCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmitV2, metadata
86230
+ ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerFeedbackMetadata) : generatedAnswerFeedbackMetadata);
86231
+ };
86211
86232
  CoveoInsightClient.prototype.logRephraseGeneratedAnswer = function (generatedAnswerRephraseMetadata, metadata) {
86212
86233
  return this.logSearchEvent(SearchPageEvents.rephraseGeneratedAnswer, metadata
86213
86234
  ? __assign(__assign({}, generateMetadataToSend(metadata, false)), generatedAnswerRephraseMetadata) : generatedAnswerRephraseMetadata);
@@ -665,7 +665,7 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
665
665
  yield store.addElementAsync(historyElement);
666
666
  });
667
667
 
668
- const libVersion = "2.30.4" ;
668
+ const libVersion = "2.30.6" ;
669
669
 
670
670
  const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
671
671
 
@@ -1805,6 +1805,7 @@ var SearchPageEvents;
1805
1805
  SearchPageEvents["generatedAnswerCollapse"] = "generatedAnswerCollapse";
1806
1806
  SearchPageEvents["generatedAnswerFeedbackSubmit"] = "generatedAnswerFeedbackSubmit";
1807
1807
  SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
1808
+ SearchPageEvents["generatedAnswerFeedbackSubmitV2"] = "generatedAnswerFeedbackSubmitV2";
1808
1809
  })(SearchPageEvents || (SearchPageEvents = {}));
1809
1810
  const CustomEventsTypes = {
1810
1811
  [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1851,6 +1852,7 @@ const CustomEventsTypes = {
1851
1852
  [SearchPageEvents.generatedAnswerExpand]: 'generatedAnswer',
1852
1853
  [SearchPageEvents.generatedAnswerCollapse]: 'generatedAnswer',
1853
1854
  [SearchPageEvents.generatedAnswerFeedbackSubmit]: 'generatedAnswer',
1855
+ [SearchPageEvents.generatedAnswerFeedbackSubmitV2]: 'generatedAnswer',
1854
1856
  [InsightEvents.expandToFullUI]: 'interface',
1855
1857
  [InsightEvents.openUserActions]: 'User Actions',
1856
1858
  [InsightEvents.showPrecedingSessions]: 'User Actions',
@@ -2749,6 +2751,16 @@ class CoveoSearchPageClient {
2749
2751
  });
2750
2752
  });
2751
2753
  }
2754
+ makeGeneratedAnswerFeedbackSubmitV2(metadata) {
2755
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmitV2, metadata);
2756
+ }
2757
+ logGeneratedAnswerFeedbackSubmitV2(meta) {
2758
+ return __awaiter(this, void 0, void 0, function* () {
2759
+ return (yield this.makeGeneratedAnswerFeedbackSubmitV2(meta)).log({
2760
+ searchUID: this.provider.getSearchUID(),
2761
+ });
2762
+ });
2763
+ }
2752
2764
  makeRephraseGeneratedAnswer(meta) {
2753
2765
  return this.makeSearchEvent(SearchPageEvents.rephraseGeneratedAnswer, meta);
2754
2766
  }
@@ -3230,6 +3242,10 @@ class CoveoInsightClient {
3230
3242
  return this.logCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmit, metadata
3231
3243
  ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerFeedbackMetadata) : generatedAnswerFeedbackMetadata);
3232
3244
  }
3245
+ logGeneratedAnswerFeedbackSubmitV2(generatedAnswerFeedbackMetadata, metadata) {
3246
+ return this.logCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmitV2, metadata
3247
+ ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerFeedbackMetadata) : generatedAnswerFeedbackMetadata);
3248
+ }
3233
3249
  logRephraseGeneratedAnswer(generatedAnswerRephraseMetadata, metadata) {
3234
3250
  return this.logSearchEvent(SearchPageEvents.rephraseGeneratedAnswer, metadata
3235
3251
  ? Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), generatedAnswerRephraseMetadata) : generatedAnswerRephraseMetadata);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "coveo.analytics",
3
- "version": "2.30.4",
3
+ "version": "2.30.6",
4
4
  "description": "📈 Coveo analytics client (node and browser compatible) ",
5
5
  "main": "dist/library.cjs",
6
6
  "module": "dist/browser.mjs",
@@ -4,6 +4,7 @@ import {NoopAnalytics} from '../client/noopAnalytics';
4
4
  import {
5
5
  CustomEventsTypes,
6
6
  GeneratedAnswerFeedbackReason,
7
+ GeneratedAnswerFeedbackReasonOption,
7
8
  GeneratedAnswerRephraseFormat,
8
9
  PartialDocumentInformation,
9
10
  SearchPageEvents,
@@ -651,6 +652,25 @@ describe('InsightClient', () => {
651
652
  await client.logCreateArticle(exampleCreateArticleMetadata);
652
653
  expectMatchCustomEventPayload(InsightEvents.createArticle, exampleCreateArticleMetadata);
653
654
  });
655
+
656
+ it('should send proper payload for #generatedAnswerFeedbackSubmitV2', async () => {
657
+ const exampleGeneratedAnswerMetadata = {
658
+ generativeQuestionAnsweringId: '123',
659
+ helpful: true,
660
+ readable: <GeneratedAnswerFeedbackReasonOption>'yes',
661
+ documented: <GeneratedAnswerFeedbackReasonOption>'no',
662
+ correctTopic: <GeneratedAnswerFeedbackReasonOption>'unknown',
663
+ hallucinationFree: <GeneratedAnswerFeedbackReasonOption>'yes',
664
+ details: 'foo',
665
+ documentUrl: 'https://document.com',
666
+ };
667
+
668
+ await client.logGeneratedAnswerFeedbackSubmitV2(exampleGeneratedAnswerMetadata);
669
+ expectMatchCustomEventPayload(
670
+ SearchPageEvents.generatedAnswerFeedbackSubmitV2,
671
+ exampleGeneratedAnswerMetadata
672
+ );
673
+ });
654
674
  });
655
675
 
656
676
  describe('when the case metadata is included', () => {
@@ -1399,6 +1419,26 @@ describe('InsightClient', () => {
1399
1419
  expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerFeedbackSubmit, expectedMetadata);
1400
1420
  });
1401
1421
 
1422
+ it('should send proper payload for #generatedAnswerFeedbackSubmitV2', async () => {
1423
+ const exampleGeneratedAnswerMetadata = {
1424
+ generativeQuestionAnsweringId: '123',
1425
+ helpful: true,
1426
+ readable: <GeneratedAnswerFeedbackReasonOption>'yes',
1427
+ documented: <GeneratedAnswerFeedbackReasonOption>'no',
1428
+ correctTopic: <GeneratedAnswerFeedbackReasonOption>'unknown',
1429
+ hallucinationFree: <GeneratedAnswerFeedbackReasonOption>'yes',
1430
+ details: 'foo',
1431
+ documentUrl: 'https://document.com',
1432
+ };
1433
+ const expectedMetadata = {
1434
+ ...exampleGeneratedAnswerMetadata,
1435
+ ...expectedBaseCaseMetadata,
1436
+ };
1437
+
1438
+ await client.logGeneratedAnswerFeedbackSubmitV2(exampleGeneratedAnswerMetadata, baseCaseMetadata);
1439
+ expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerFeedbackSubmitV2, expectedMetadata);
1440
+ });
1441
+
1402
1442
  it('should send proper payload for #rephraseGeneratedAnswer', async () => {
1403
1443
  const exampleGeneratedAnswerMetadata = {
1404
1444
  generativeQuestionAnsweringId: '123',
@@ -9,6 +9,7 @@ import {
9
9
  GeneratedAnswerBaseMeta,
10
10
  GeneratedAnswerCitationMeta,
11
11
  GeneratedAnswerFeedbackMeta,
12
+ GeneratedAnswerFeedbackMetaV2,
12
13
  GeneratedAnswerRephraseMeta,
13
14
  GeneratedAnswerSourceHoverMeta,
14
15
  GeneratedAnswerStreamEndMeta,
@@ -590,6 +591,18 @@ export class CoveoInsightClient {
590
591
  );
591
592
  }
592
593
 
594
+ public logGeneratedAnswerFeedbackSubmitV2(
595
+ generatedAnswerFeedbackMetadata: GeneratedAnswerFeedbackMetaV2,
596
+ metadata?: CaseMetadata
597
+ ) {
598
+ return this.logCustomEvent(
599
+ SearchPageEvents.generatedAnswerFeedbackSubmitV2,
600
+ metadata
601
+ ? {...generateMetadataToSend(metadata, false), ...generatedAnswerFeedbackMetadata}
602
+ : generatedAnswerFeedbackMetadata
603
+ );
604
+ }
605
+
593
606
  public logRephraseGeneratedAnswer(
594
607
  generatedAnswerRephraseMetadata: GeneratedAnswerRephraseMeta,
595
608
  metadata?: CaseMetadata
@@ -7,6 +7,7 @@ import {
7
7
  StaticFilterToggleValueMetadata,
8
8
  GeneratedAnswerFeedbackReason,
9
9
  GeneratedAnswerRephraseFormat,
10
+ GeneratedAnswerFeedbackReasonOption,
10
11
  } from './searchPageEvents';
11
12
  import CoveoAnalyticsClient from '../client/analytics';
12
13
  import {NoopAnalytics} from '../client/noopAnalytics';
@@ -1601,6 +1602,21 @@ describe('SearchPageClient', () => {
1601
1602
  expectMatchDescription(built.description, SearchPageEvents.generatedAnswerCollapse, meta);
1602
1603
  });
1603
1604
 
1605
+ it('should send proper payload for #logGeneratedAnswerFeedbackSubmitV2', async () => {
1606
+ const meta = {
1607
+ generativeQuestionAnsweringId: fakeStreamId,
1608
+ helpful: true,
1609
+ readable: <GeneratedAnswerFeedbackReasonOption>'yes',
1610
+ documented: <GeneratedAnswerFeedbackReasonOption>'no',
1611
+ correctTopic: <GeneratedAnswerFeedbackReasonOption>'unknown',
1612
+ hallucinationFree: <GeneratedAnswerFeedbackReasonOption>'yes',
1613
+ details: 'a few additional details',
1614
+ documentUrl: 'https://document.com',
1615
+ };
1616
+ await client.logGeneratedAnswerFeedbackSubmitV2(meta);
1617
+ expectMatchCustomEventPayload(SearchPageEvents.generatedAnswerFeedbackSubmitV2, meta);
1618
+ });
1619
+
1604
1620
  it('should send proper payload for #logGeneratedAnswerFeedbackSubmit', async () => {
1605
1621
  const meta = {
1606
1622
  generativeQuestionAnsweringId: fakeStreamId,
@@ -42,6 +42,7 @@ import {
42
42
  GeneratedAnswerSourceHoverMeta,
43
43
  GeneratedAnswerBaseMeta,
44
44
  GeneratedAnswerRephraseMeta,
45
+ GeneratedAnswerFeedbackMetaV2,
45
46
  } from './searchPageEvents';
46
47
  import {NoopAnalytics} from '../client/noopAnalytics';
47
48
  import {formatOmniboxMetadata} from '../formatting/format-omnibox-metadata';
@@ -977,6 +978,15 @@ export class CoveoSearchPageClient {
977
978
  });
978
979
  }
979
980
 
981
+ public makeGeneratedAnswerFeedbackSubmitV2(metadata: GeneratedAnswerBaseMeta) {
982
+ return this.makeCustomEvent(SearchPageEvents.generatedAnswerFeedbackSubmitV2, metadata);
983
+ }
984
+ public async logGeneratedAnswerFeedbackSubmitV2(meta: GeneratedAnswerFeedbackMetaV2) {
985
+ return (await this.makeGeneratedAnswerFeedbackSubmitV2(meta)).log({
986
+ searchUID: this.provider.getSearchUID(),
987
+ });
988
+ }
989
+
980
990
  public makeRephraseGeneratedAnswer(meta: GeneratedAnswerRephraseMeta) {
981
991
  return this.makeSearchEvent(SearchPageEvents.rephraseGeneratedAnswer, meta);
982
992
  }
@@ -346,6 +346,10 @@ export enum SearchPageEvents {
346
346
  * Identifies the search event that gets logged when a user clicks the rephrase button in a generated answer.
347
347
  */
348
348
  rephraseGeneratedAnswer = 'rephraseGeneratedAnswer',
349
+ /**
350
+ * Identifies the new version of custom event that gets logged when a user submits a feedback of a generated answer.
351
+ */
352
+ generatedAnswerFeedbackSubmitV2 = 'generatedAnswerFeedbackSubmitV2',
349
353
  }
350
354
 
351
355
  export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>> = {
@@ -393,6 +397,7 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents,
393
397
  [SearchPageEvents.generatedAnswerExpand]: 'generatedAnswer',
394
398
  [SearchPageEvents.generatedAnswerCollapse]: 'generatedAnswer',
395
399
  [SearchPageEvents.generatedAnswerFeedbackSubmit]: 'generatedAnswer',
400
+ [SearchPageEvents.generatedAnswerFeedbackSubmitV2]: 'generatedAnswer',
396
401
  [InsightEvents.expandToFullUI]: 'interface',
397
402
  [InsightEvents.openUserActions]: 'User Actions',
398
403
  [InsightEvents.showPrecedingSessions]: 'User Actions',
@@ -565,3 +570,15 @@ export interface GeneratedAnswerFeedbackMeta extends GeneratedAnswerBaseMeta {
565
570
  reason: GeneratedAnswerFeedbackReason;
566
571
  details?: string;
567
572
  }
573
+
574
+ export type GeneratedAnswerFeedbackReasonOption = 'yes' | 'unknown' | 'no';
575
+
576
+ export interface GeneratedAnswerFeedbackMetaV2 extends GeneratedAnswerBaseMeta {
577
+ helpful: boolean;
578
+ readable: GeneratedAnswerFeedbackReasonOption;
579
+ documented: GeneratedAnswerFeedbackReasonOption;
580
+ correctTopic: GeneratedAnswerFeedbackReasonOption;
581
+ hallucinationFree: GeneratedAnswerFeedbackReasonOption;
582
+ details?: string;
583
+ documentUrl?: string;
584
+ }