coveo.analytics 2.28.17 → 2.28.19

package/dist/definitions/searchPage/searchPageClient.d.ts

@@ -1,6 +1,6 @@
 import { ClientOptions, AnalyticsClient } from '../client/analytics';
 import { SearchEventRequest, SearchEventResponse, AnyEventResponse, ClickEventResponse, CustomEventResponse } from '../events';
-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 } from './searchPageEvents';
+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';
 export interface SearchPageClientProvider {
     getBaseMetadata: () => Record<string, any>;
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -15,6 +15,7 @@ export interface SearchPageClientProvider {
     getFacetState?: () => FacetStateMetadata[];
     getSplitTestRunName?: () => string | undefined;
     getSplitTestRunVersion?: () => string | undefined;
+    getGeneratedAnswerMetadata?: () => Record<string, any>;
 }
 export interface SearchPageClientOptions extends ClientOptions {
     enableAnalytics: boolean;
@@ -185,12 +186,24 @@ export declare class CoveoSearchPageClient {
     private getOrigins;
     private getClientId;
     private getSplitTestRun;
-    makeLikeGeneratedAnswer(metadata: GeneratedAnswerFeedbackMeta): Promise<EventBuilder<CustomEventResponse>>;
-    logLikeGeneratedAnswer(metadata: GeneratedAnswerFeedbackMeta): Promise<void | CustomEventResponse>;
-    makeDislikeGeneratedAnswer(metadata: GeneratedAnswerFeedbackMeta): Promise<EventBuilder<CustomEventResponse>>;
-    logDislikeGeneratedAnswer(metadata: GeneratedAnswerFeedbackMeta): Promise<void | CustomEventResponse>;
+    makeLikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logLikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
+    makeDislikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logDislikeGeneratedAnswer(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
     makeOpenGeneratedAnswerSource(metadata: GeneratedAnswerCitationMeta): Promise<EventBuilder<CustomEventResponse>>;
     logOpenGeneratedAnswerSource(metadata: GeneratedAnswerCitationMeta): Promise<void | CustomEventResponse>;
+    makeGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logGeneratedAnswerSourceHover(metadata: GeneratedAnswerSourceHoverMeta): Promise<void | CustomEventResponse>;
+    makeGeneratedAnswerCopyToClipboard(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logGeneratedAnswerCopyToClipboard(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
+    makeGeneratedAnswerHideAnswers(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logGeneratedAnswerHideAnswers(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
+    makeGeneratedAnswerShowAnswers(metadata: GeneratedAnswerBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logGeneratedAnswerShowAnswers(metadata: GeneratedAnswerBaseMeta): Promise<void | CustomEventResponse>;
+    makeGenerativeQuestionFeedbackSubmit(meta: GeneratedAnswerFeedbackMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logGenerativeQuestionFeedbackSubmit(meta: GeneratedAnswerFeedbackMeta): Promise<void | CustomEventResponse>;
+    makeRephraseGeneratedAnswer(meta: GeneratedAnswerRephraseMeta): Promise<EventBuilder<SearchEventResponse>>;
+    logRephraseGeneratedAnswer(meta: GeneratedAnswerRephraseMeta): Promise<void | SearchEventResponse>;
     makeRetryGeneratedAnswer(): Promise<EventBuilder<SearchEventResponse>>;
     logRetryGeneratedAnswer(): Promise<void | SearchEventResponse>;
     makeGeneratedAnswerStreamEnd(metadata: GeneratedAnswerStreamEndMeta): Promise<EventBuilder<CustomEventResponse>>;

package/dist/definitions/searchPage/searchPageEvents.d.ts

@@ -77,7 +77,13 @@ export declare enum SearchPageEvents {
     likeGeneratedAnswer = "likeGeneratedAnswer",
     dislikeGeneratedAnswer = "dislikeGeneratedAnswer",
     openGeneratedAnswerSource = "openGeneratedAnswerSource",
-    generatedAnswerStreamEnd = "generatedAnswerStreamEnd"
+    generatedAnswerStreamEnd = "generatedAnswerStreamEnd",
+    generatedAnswerSourceHover = "generatedAnswerSourceHover",
+    generatedAnswerCopyToClipboard = "generatedAnswerCopyToClipboard",
+    generatedAnswerHideAnswers = "generatedAnswerHideAnswers",
+    generatedAnswerShowAnswers = "generatedAnswerShowAnswers",
+    generativeQuestionFeedbackSubmit = "generativeQuestionFeedbackSubmit",
+    rephraseGeneratedAnswer = "rephraseGeneratedAnswer"
 }
 export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
 export interface StaticFilterMetadata {
@@ -185,17 +191,27 @@ export interface SmartSnippetDocumentIdentifier {
     contentIdValue: string;
 }
 export type PartialDocumentInformation = Omit<DocumentInformation, 'actionCause' | 'searchQueryUid'>;
-interface GeneratedAnswerBaseMeta {
+export interface GeneratedAnswerBaseMeta {
     generativeQuestionAnsweringId: string;
 }
-export interface GeneratedAnswerFeedbackMeta extends GeneratedAnswerBaseMeta {
-}
 export interface GeneratedAnswerStreamEndMeta extends GeneratedAnswerBaseMeta {
     answerGenerated: boolean;
 }
 export interface GeneratedAnswerCitationMeta {
     generativeQuestionAnsweringId: string;
     permanentId: string;
-    id: string;
+    citationId: string;
+}
+export type GeneratedAnswerFeedbackReason = 'irrelevant' | 'notAccurate' | 'outOfDate' | 'harmful' | 'other';
+export type GeneratedAnswerRephraseFormat = 'step' | 'bullet' | 'concise' | 'default';
+export interface GeneratedAnswerSourceHoverMeta extends GeneratedAnswerCitationMeta {
+    citationHoverTimeMs: number;
+}
+export interface GeneratedAnswerRephraseMeta extends GeneratedAnswerBaseMeta {
+    rephraseFormat: GeneratedAnswerRephraseFormat;
+}
+export interface GeneratedAnswerFeedbackMeta extends GeneratedAnswerBaseMeta {
+    reason: GeneratedAnswerFeedbackReason;
+    details?: string;
 }
 export {};

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.28.17";
+export declare const libVersion = "2.28.19";

package/dist/library.cjs

@@ -731,7 +731,7 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.28.17" ;
+var libVersion = "2.28.19" ;
 
 var getFormattedLocation = function (location) {
     return "".concat(location.protocol, "//").concat(location.hostname).concat(location.pathname.indexOf('/') === 0 ? location.pathname : "/".concat(location.pathname)).concat(location.search);
@@ -84285,6 +84285,12 @@ exports.SearchPageEvents = void 0;
     SearchPageEvents["dislikeGeneratedAnswer"] = "dislikeGeneratedAnswer";
     SearchPageEvents["openGeneratedAnswerSource"] = "openGeneratedAnswerSource";
     SearchPageEvents["generatedAnswerStreamEnd"] = "generatedAnswerStreamEnd";
+    SearchPageEvents["generatedAnswerSourceHover"] = "generatedAnswerSourceHover";
+    SearchPageEvents["generatedAnswerCopyToClipboard"] = "generatedAnswerCopyToClipboard";
+    SearchPageEvents["generatedAnswerHideAnswers"] = "generatedAnswerHideAnswers";
+    SearchPageEvents["generatedAnswerShowAnswers"] = "generatedAnswerShowAnswers";
+    SearchPageEvents["generativeQuestionFeedbackSubmit"] = "generativeQuestionFeedbackSubmit";
+    SearchPageEvents["rephraseGeneratedAnswer"] = "rephraseGeneratedAnswer";
 })(exports.SearchPageEvents || (exports.SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -84330,6 +84336,11 @@ var CustomEventsTypes = (_a = {},
     _a[exports.SearchPageEvents.dislikeGeneratedAnswer] = 'generatedAnswer',
     _a[exports.SearchPageEvents.openGeneratedAnswerSource] = 'generatedAnswer',
     _a[exports.SearchPageEvents.generatedAnswerStreamEnd] = 'generatedAnswer',
+    _a[exports.SearchPageEvents.generatedAnswerSourceHover] = 'generatedAnswer',
+    _a[exports.SearchPageEvents.generatedAnswerCopyToClipboard] = 'generatedAnswer',
+    _a[exports.SearchPageEvents.generatedAnswerHideAnswers] = 'generatedAnswer',
+    _a[exports.SearchPageEvents.generatedAnswerShowAnswers] = 'generatedAnswer',
+    _a[exports.SearchPageEvents.generativeQuestionFeedbackSubmit] = 'generatedAnswer',
     _a);
 
 var NoopAnalytics = (function () {
@@ -85568,14 +85579,15 @@ var CoveoSearchPageClient = (function () {
         });
     };
     CoveoSearchPageClient.prototype.getBaseSearchEventRequest = function (event, metadata) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
-            var _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
-                        _a = [{}];
-                        return [4, this.getBaseEventRequest(metadata)];
-                    case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _a.concat([(_b.sent())])), this.provider.getSearchEventRequestPayload()]), { queryPipeline: this.provider.getPipeline(), actionCause: event }])];
+                        _c = [{}];
+                        return [4, this.getBaseEventRequest(__assign(__assign({}, metadata), (_b = (_a = this.provider).getGeneratedAnswerMetadata) === null || _b === void 0 ? void 0 : _b.call(_a)))];
+                    case 1: return [2, __assign.apply(void 0, [__assign.apply(void 0, [__assign.apply(void 0, _c.concat([(_d.sent())])), this.provider.getSearchEventRequestPayload()]), { queryPipeline: this.provider.getPipeline(), actionCause: event }])];
                 }
             });
         });
@@ -85656,6 +85668,94 @@ var CoveoSearchPageClient = (function () {
             });
         });
     };
+    CoveoSearchPageClient.prototype.makeGeneratedAnswerSourceHover = function (metadata) {
+        return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerSourceHover, metadata);
+    };
+    CoveoSearchPageClient.prototype.logGeneratedAnswerSourceHover = function (metadata) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.makeGeneratedAnswerSourceHover(metadata)];
+                    case 1: return [2, (_a.sent()).log({
+                            searchUID: this.provider.getSearchUID(),
+                        })];
+                }
+            });
+        });
+    };
+    CoveoSearchPageClient.prototype.makeGeneratedAnswerCopyToClipboard = function (metadata) {
+        return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerCopyToClipboard, metadata);
+    };
+    CoveoSearchPageClient.prototype.logGeneratedAnswerCopyToClipboard = function (metadata) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.makeGeneratedAnswerCopyToClipboard(metadata)];
+                    case 1: return [2, (_a.sent()).log({
+                            searchUID: this.provider.getSearchUID(),
+                        })];
+                }
+            });
+        });
+    };
+    CoveoSearchPageClient.prototype.makeGeneratedAnswerHideAnswers = function (metadata) {
+        return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerHideAnswers, metadata);
+    };
+    CoveoSearchPageClient.prototype.logGeneratedAnswerHideAnswers = function (metadata) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.makeGeneratedAnswerHideAnswers(metadata)];
+                    case 1: return [2, (_a.sent()).log({
+                            searchUID: this.provider.getSearchUID(),
+                        })];
+                }
+            });
+        });
+    };
+    CoveoSearchPageClient.prototype.makeGeneratedAnswerShowAnswers = function (metadata) {
+        return this.makeCustomEvent(exports.SearchPageEvents.generatedAnswerShowAnswers, metadata);
+    };
+    CoveoSearchPageClient.prototype.logGeneratedAnswerShowAnswers = function (metadata) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.makeGeneratedAnswerShowAnswers(metadata)];
+                    case 1: return [2, (_a.sent()).log({
+                            searchUID: this.provider.getSearchUID(),
+                        })];
+                }
+            });
+        });
+    };
+    CoveoSearchPageClient.prototype.makeGenerativeQuestionFeedbackSubmit = function (meta) {
+        return this.makeCustomEvent(exports.SearchPageEvents.generativeQuestionFeedbackSubmit, meta);
+    };
+    CoveoSearchPageClient.prototype.logGenerativeQuestionFeedbackSubmit = function (meta) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.makeGenerativeQuestionFeedbackSubmit(meta)];
+                    case 1: return [2, (_a.sent()).log({
+                            searchUID: this.provider.getSearchUID(),
+                        })];
+                }
+            });
+        });
+    };
+    CoveoSearchPageClient.prototype.makeRephraseGeneratedAnswer = function (meta) {
+        return this.makeSearchEvent(exports.SearchPageEvents.rephraseGeneratedAnswer, meta);
+    };
+    CoveoSearchPageClient.prototype.logRephraseGeneratedAnswer = function (meta) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.makeRephraseGeneratedAnswer(meta)];
+                    case 1: return [2, (_a.sent()).log({ searchUID: this.provider.getSearchUID() })];
+                }
+            });
+        });
+    };
     CoveoSearchPageClient.prototype.makeRetryGeneratedAnswer = function () {
         return this.makeSearchEvent(exports.SearchPageEvents.retryGeneratedAnswer);
     };