@coveo/quantic 3.37.7 → 3.37.9

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-core-interactive-generated-answer-inline-link.d.ts

@@ -0,0 +1,44 @@
+import type { CoreEngine } from '../../../app/engine.js';
+import type { CustomAction } from '../../../features/analytics/analytics-utils.js';
+import type { InlineLink } from '../../../utils/inline-link.js';
+import { type InteractiveResultCore, type InteractiveResultCoreOptions, type InteractiveResultCoreProps } from '../../core/interactive-result/headless-core-interactive-result.js';
+export interface InteractiveGeneratedAnswerInlineLinkOptions extends InteractiveResultCoreOptions {
+    /**
+     * The generated answer inline link.
+     */
+    link: InlineLink;
+    /**
+     * The unique identifier of the generated answer associated with the inline link.
+     */
+    answerId: string;
+}
+export interface InteractiveGeneratedAnswerInlineLinkProps extends InteractiveResultCoreProps {
+    /**
+     * The options for the `InteractiveGeneratedAnswerInlineLink` controller.
+     */
+    options: InteractiveGeneratedAnswerInlineLinkOptions;
+}
+/**
+ * The `InteractiveGeneratedAnswerInlineLink` controller provides an interface
+ * for triggering desirable side effects, such as logging UA events to the
+ * Coveo Platform, when a user selects a generated answer inline link.
+ *
+ * @group Controllers
+ * @category InteractiveGeneratedAnswerInlineLink
+ */
+export interface InteractiveGeneratedAnswerInlineLink extends InteractiveResultCore {
+}
+interface InteractiveGeneratedAnswerInlineLinkAnalyticsClient {
+    logGeneratedAnswerOpenInlineLink(link: InlineLink, answerId: string): CustomAction;
+}
+/**
+ * Creates a core `InteractiveGeneratedAnswerInlineLink` controller instance.
+ *
+ * @param engine - The headless engine.
+ * @param analyticsClient - The analytics client.
+ * @param props - The configurable `InteractiveGeneratedAnswerInlineLink`
+ * properties.
+ * @returns An `InteractiveGeneratedAnswerInlineLink` controller instance.
+ */
+export declare function buildInteractiveGeneratedAnswerInlineLinkCore(engine: CoreEngine, analyticsClient: InteractiveGeneratedAnswerInlineLinkAnalyticsClient, props: InteractiveGeneratedAnswerInlineLinkProps): InteractiveGeneratedAnswerInlineLink;
+export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/generated-answer/headless-interactive-generated-answer-inline-link.d.ts

@@ -0,0 +1,15 @@
+import type { SearchEngine } from '../../app/search-engine/search-engine.js';
+import { type InteractiveGeneratedAnswerInlineLink, type InteractiveGeneratedAnswerInlineLinkOptions, type InteractiveGeneratedAnswerInlineLinkProps } from '../core/generated-answer/headless-core-interactive-generated-answer-inline-link.js';
+export type { InteractiveGeneratedAnswerInlineLink, InteractiveGeneratedAnswerInlineLinkOptions, InteractiveGeneratedAnswerInlineLinkProps, };
+/**
+ * Creates an `InteractiveGeneratedAnswerInlineLink` controller instance.
+ *
+ * @param engine - The headless engine.
+ * @param props - The configurable `InteractiveGeneratedAnswerInlineLink`
+ * properties.
+ * @returns An `InteractiveGeneratedAnswerInlineLink` controller instance.
+ *
+ * @group Controllers
+ * @category InteractiveGeneratedAnswerInlineLink
+ */
+export declare function buildInteractiveGeneratedAnswerInlineLink(engine: SearchEngine, props: InteractiveGeneratedAnswerInlineLinkProps): InteractiveGeneratedAnswerInlineLink;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/smart-snippet/headless-smart-snippet-interactive-inline-links.d.ts

@@ -1,14 +1,6 @@
 import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-export interface InlineLink {
-    /**
-     * The text of the inline link.
-     */
-    linkText: string;
-    /**
-     * The URL of the inline link.
-     */
-    linkURL: string;
-}
+import type { InlineLink } from '../../utils/inline-link.js';
+export type { InlineLink } from '../../utils/inline-link.js';
 /**
  * @internal
  */
@@ -33,4 +25,3 @@ interface SmartSnippetInteractiveInlineLinks {
  * @internal
  */
 export declare function buildSmartSnippetInteractiveInlineLinks(engine: SearchEngine, props?: SmartSnippetInteractiveInlineLinksProps): SmartSnippetInteractiveInlineLinks;
-export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-analytics-actions.d.ts

@@ -1,5 +1,6 @@
 import { type CustomAction, type LegacySearchAction } from '../analytics/analytics-utils.js';
 import type { SearchAction } from '../search/search-actions.js';
+import type { InlineLink } from '../../utils/inline-link.js';
 export type GeneratedAnswerFeedbackOption = 'yes' | 'unknown' | 'no';
 export type GeneratedAnswerFeedback = {
     helpful: boolean;
@@ -16,12 +17,13 @@ export declare function logOpenGeneratedAnswerSource(citationId: string): Custom
 export declare function logOpenGeneratedAnswerSource(citationId: string, answerId: string): CustomAction;
 export declare function logHoverCitation(citationId: string, citationHoverTimeInMs: number): CustomAction;
 export declare function logHoverCitation(citationId: string, citationHoverTimeInMs: number, answerId: string): CustomAction;
+export declare function logGeneratedAnswerOpenInlineLink(inlineLink: InlineLink, answerId: string): CustomAction;
 export declare function logLikeGeneratedAnswer(): CustomAction;
 export declare function logLikeGeneratedAnswer(answerId: string): CustomAction;
 export declare function logDislikeGeneratedAnswer(): CustomAction;
 export declare function logDislikeGeneratedAnswer(answerId: string): CustomAction;
 export declare const logGeneratedAnswerFeedback: (feedback: GeneratedAnswerFeedback) => CustomAction;
-export declare const logGeneratedAnswerStreamEnd: (answerGenerated: boolean, answerId?: string, answerTextIsEmpty?: boolean, conversationId?: string) => CustomAction;
+export declare const logGeneratedAnswerStreamEnd: (answerGenerated: boolean, answerId?: string, answerTextIsEmpty?: boolean) => CustomAction;
 export declare const logGeneratedAnswerResponseLinked: (answerId?: string) => CustomAction;
 export declare const logGeneratedAnswerShowAnswers: () => CustomAction;
 export declare const logGeneratedAnswerHideAnswers: () => CustomAction;
@@ -34,10 +36,11 @@ export declare const generatedAnswerAnalyticsClient: {
     logCopyGeneratedAnswer: typeof logCopyGeneratedAnswer;
     logGeneratedAnswerHideAnswers: () => CustomAction;
     logGeneratedAnswerShowAnswers: () => CustomAction;
-    logGeneratedAnswerStreamEnd: (answerGenerated: boolean, answerId?: string, answerTextIsEmpty?: boolean, conversationId?: string) => CustomAction;
+    logGeneratedAnswerStreamEnd: (answerGenerated: boolean, answerId?: string, answerTextIsEmpty?: boolean) => CustomAction;
     logGeneratedAnswerFeedback: (feedback: GeneratedAnswerFeedback) => CustomAction;
     logDislikeGeneratedAnswer: typeof logDislikeGeneratedAnswer;
     logLikeGeneratedAnswer: typeof logLikeGeneratedAnswer;
+    logGeneratedAnswerOpenInlineLink: typeof logGeneratedAnswerOpenInlineLink;
     logHoverCitation: typeof logHoverCitation;
     logOpenGeneratedAnswerSource: typeof logOpenGeneratedAnswerSource;
     logRetryGeneratedAnswer: () => LegacySearchAction;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-request.d.ts

@@ -1,6 +1,6 @@
 import type { GeneratedAnswerStreamRequest } from '../../api/generated-answer/generated-answer-request.js';
 import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
-import type { BaseParam } from '../../api/platform-service-params.js';
+import type { BaseParam, ContextParam } from '../../api/platform-service-params.js';
 import type { SearchRequest } from '../../api/search/search/search-request.js';
 import type { AnalyticsParam, AuthenticationParam, AutomaticFacetsParams } from '../../api/search/search-api-params.js';
 import type { CaseContextParam } from '../../api/service/insight/query/query-request.js';
@@ -24,6 +24,6 @@ type HeadAnswerParams = {
     pipeline?: string;
     citationsFieldToInclude?: string[];
     locale: string;
-} & AnalyticsParam;
+} & ContextParam & AnalyticsParam;
 export declare const constructGenerateHeadAnswerParams: (state: StateNeededForHeadAnswerParams, navigatorContext: NavigatorContext) => HeadAnswerParams;
 export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-selectors.d.ts

@@ -4,6 +4,7 @@ import type { FollowUpAnswersSection, GeneratedAnswerSection } from '../../state
 export declare const generativeQuestionAnsweringIdSelector: (state: Partial<SearchAppState>) => string | undefined;
 export declare const isGeneratedAnswerFeatureEnabledWithAgentAPI: (state: Partial<SearchAppState>) => state is StreamAnswerAPIState;
 export declare const selectFieldsToIncludeInCitation: (state: Partial<GeneratedAnswerSection>) => string[] | undefined;
+export declare const selectFollowUpAnswersConversationId: (state: Partial<FollowUpAnswersSection>) => string | undefined;
 export declare const citationSourceSelector: ((state: Partial<GeneratedAnswerSection & FollowUpAnswersSection>, citationId: string) => import("../../index.js").GeneratedAnswerCitation | undefined) & {
     clearCache: () => void;
     resultsCount: () => number;

package/force-app/main/default/staticresources/coveoheadless/definitions/index.d.ts

@@ -67,6 +67,8 @@ export type { GeneratedAnswer, GeneratedAnswerBase, GeneratedAnswerCitation, Gen
 export { buildGeneratedAnswer } from './controllers/generated-answer/headless-generated-answer.js';
 export type { InteractiveCitation, InteractiveCitationOptions, InteractiveCitationProps, } from './controllers/generated-answer/headless-interactive-citation.js';
 export { buildInteractiveCitation } from './controllers/generated-answer/headless-interactive-citation.js';
+export type { InteractiveGeneratedAnswerInlineLink, InteractiveGeneratedAnswerInlineLinkOptions, InteractiveGeneratedAnswerInlineLinkProps, } from './controllers/generated-answer/headless-interactive-generated-answer-inline-link.js';
+export { buildInteractiveGeneratedAnswerInlineLink } from './controllers/generated-answer/headless-interactive-generated-answer-inline-link.js';
 export type { HistoryManager, HistoryManagerState, } from './controllers/history-manager/headless-history-manager.js';
 export { buildHistoryManager } from './controllers/history-manager/headless-history-manager.js';
 export type { InteractiveInstantResult, InteractiveInstantResultOptions, InteractiveInstantResultProps, } from './controllers/instant-results/headless-interactive-instant-result.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/utils/inline-link.d.ts

@@ -0,0 +1,10 @@
+export interface InlineLink {
+    /**
+     * The text of the inline link.
+     */
+    linkText: string;
+    /**
+     * The URL of the inline link.
+     */
+    linkURL: string;
+}