@coveo/quantic 3.36.0 → 3.36.2

package/force-app/main/default/staticresources/coveoheadless/definitions/features/follow-up-answers/follow-up-answers-actions.d.ts

@@ -0,0 +1,70 @@
+import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
+import type { GeneratedContentFormat } from '../generated-answer/generated-response-format.js';
+export declare const setIsEnabled: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "followUpAnswers/setIsEnabled", never, never>;
+export declare const setFollowUpAnswersConversationId: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string], string, "followUpAnswers/setFollowUpAnswersConversationId", never, never>;
+export declare const createFollowUpAnswer: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    question: string;
+}], {
+    question: string;
+}, "followUpAnswers/createFollowUpAnswer", never, never>;
+export declare const setActiveFollowUpAnswerId: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string], string, "followUpAnswers/setActiveFollowUpAnswerId", never, never>;
+export declare const setFollowUpAnswerContentFormat: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    contentFormat: GeneratedContentFormat;
+}], {
+    answerId: string;
+    contentFormat: GeneratedContentFormat;
+}, "followUpAnswers/setFollowUpAnswerContentFormat", never, never>;
+export declare const setFollowUpIsLoading: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    isLoading: boolean;
+}], {
+    answerId: string;
+    isLoading: boolean;
+}, "followUpAnswers/setFollowUpIsLoading", never, never>;
+export declare const followUpMessageChunkReceived: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    textDelta: string;
+}], {
+    answerId: string;
+    textDelta: string;
+}, "followUpAnswers/followUpMessageChunkReceived", never, never>;
+export declare const followUpCitationsReceived: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    citations: GeneratedAnswerCitation[];
+}], {
+    answerId: string;
+    citations: GeneratedAnswerCitation[];
+}, "followUpAnswers/followUpCitationsReceived", never, never>;
+export declare const followUpCompleted: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    cannotAnswer?: boolean;
+}], {
+    answerId: string;
+    cannotAnswer?: boolean;
+}, "followUpAnswers/followUpCompleted", never, never>;
+export declare const followUpFailed: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    message?: string;
+    code?: number;
+}], {
+    answerId: string;
+    message?: string;
+    code?: number;
+}, "followUpAnswers/followUpFailed", never, never>;
+export declare const likeFollowUp: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+}], {
+    answerId: string;
+}, "followUpAnswers/likeFollowUp", never, never>;
+export declare const dislikeFollowUp: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+}], {
+    answerId: string;
+}, "followUpAnswers/dislikeFollowUp", never, never>;
+export declare const submitFollowUpFeedback: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+}], {
+    answerId: string;
+}, "followUpAnswers/submitFollowUpFeedback", never, never>;
+export declare const resetFollowUpAnswers: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"followUpAnswers/resetFollowUpAnswers">;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/follow-up-answers/follow-up-answers-slice.d.ts

@@ -0,0 +1,4 @@
+import { type FollowUpAnswersState } from './follow-up-answers-state.js';
+export declare const followUpAnswersReducer: import("@reduxjs/toolkit").Reducer<FollowUpAnswersState> & {
+    getInitialState: () => FollowUpAnswersState;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/follow-up-answers/follow-up-answers-state.d.ts

@@ -4,17 +4,19 @@ import type { GeneratedAnswerBase } from '../generated-answer/generated-answer-s
  * Represents a follow-up answer generated in response to a user's question.
  * Extends the base generated answer structure with the originating question.
  */
-interface FollowUpAnswer extends GeneratedAnswerBase {
+export interface FollowUpAnswer extends GeneratedAnswerBase {
     /** The question prompted to generate this follow-up answer. */
     question: string;
+    /** Indicates if this follow-up answer is currently active. */
+    isActive: boolean;
 }
 /**
  * @internal
  * The follow-up answers state.
  */
 export interface FollowUpAnswersState {
-    /** The unique identifier of the follow-up answer session. */
-    id: string;
+    /** The unique identifier of the follow-up answers conversation. */
+    conversationId: string;
     /**
      * Determines if the follow-up answer feature is enabled.
      */
@@ -25,4 +27,4 @@ export interface FollowUpAnswersState {
     followUpAnswers: FollowUpAnswer[];
 }
 export declare function getFollowUpAnswersInitialState(): FollowUpAnswersState;
-export {};
+export declare const createInitialFollowUpAnswer: (question: string) => FollowUpAnswer;

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

@@ -1,10 +1,19 @@
+import { StringValue } from '@coveo/bueno';
 import type { GeneratedAnswerCitationsPayload, GeneratedAnswerMessagePayload } from '../../api/generated-answer/generated-answer-event-payload.js';
 import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
 import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
-import type { AnswerApiQueryParams } from '../../features/generated-answer/generated-answer-request.js';
+import type { AnswerApiQueryParams, StateNeededForHeadAnswerParams } from '../../features/generated-answer/generated-answer-request.js';
 import type { ConfigurationSection, DebugSection, GeneratedAnswerSection, SearchSection } from '../../state/state-sections.js';
 import { type GeneratedResponseFormat } from './generated-response-format.js';
 type StateNeededByGeneratedAnswerStream = ConfigurationSection & SearchSection & GeneratedAnswerSection & DebugSection;
+export declare const citationSchema: {
+    id: StringValue<string>;
+    title: StringValue<string>;
+    uri: StringValue<string>;
+    permanentid: StringValue<string>;
+    clickUri: StringValue<string>;
+};
+export declare const answerContentFormatSchema: StringValue<"text/plain" | "text/markdown">;
 export interface GeneratedAnswerErrorPayload {
     message?: string;
     code?: number;
@@ -37,7 +46,7 @@ export declare const updateAnswerConfigurationId: import("@reduxjs/toolkit").Act
 export declare const registerFieldsToIncludeInCitations: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string[]], string[], "generatedAnswer/registerFieldsToIncludeInCitations", never, never>;
 export declare const setIsAnswerGenerated: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "generatedAnswer/setIsAnswerGenerated", never, never>;
 export declare const setCannotAnswer: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "generatedAnswer/setCannotAnswer", never, never>;
-export declare const setAnswerApiQueryParams: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: AnswerApiQueryParams], unknown, "generatedAnswer/setAnswerApiQueryParams", never, never>;
+export declare const setAnswerApiQueryParams: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: Partial<AnswerApiQueryParams>], unknown, "generatedAnswer/setAnswerApiQueryParams", never, never>;
 interface StreamAnswerArgs {
     setAbortControllerRef: (ref: AbortController) => void;
 }
@@ -74,4 +83,22 @@ export declare const generateAnswer: import("@reduxjs/toolkit").AsyncThunk<void,
     fulfilledMeta?: unknown;
     rejectedMeta?: unknown;
 }>;
+/**
+ * Thunk to generate the head answer as part of the generated answer with follow-ups feature.
+ *
+ * This action initiates the generation of the main answer when using the Answer Generation API
+ * with an agent configuration. It requires an **agent ID** to be present in the engine configuration.
+ *
+ * @internal
+ */
+export declare const generateHeadAnswer: import("@reduxjs/toolkit").AsyncThunk<void, void, {
+    state: StateNeededForHeadAnswerParams;
+    extra: SearchThunkExtraArguments;
+    dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("@reduxjs/toolkit").UnknownAction> | undefined;
+    rejectValue?: unknown;
+    serializedErrorType?: unknown;
+    pendingMeta?: unknown;
+    fulfilledMeta?: unknown;
+    rejectedMeta?: unknown;
+}>;
 export {};

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

@@ -1,14 +1,18 @@
 import type { GeneratedAnswerStreamRequest } from '../../api/generated-answer/generated-answer-request.js';
+import type { AnswerParams } from '../../api/knowledge/answer-generation/endpoints/answer/answer-endpoint.js';
 import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
 import type { BaseParam } from '../../api/platform-service-params.js';
 import type { SearchRequest } from '../../api/search/search/search-request.js';
 import type { AuthenticationParam, AutomaticFacetsParams } from '../../api/search/search-api-params.js';
 import type { CaseContextParam } from '../../api/service/insight/query/query-request.js';
 import type { NavigatorContext } from '../../app/navigator-context-provider.js';
-import type { ConfigurationSection, GeneratedAnswerSection, SearchSection } from '../../state/state-sections.js';
+import type { SearchAppState } from '../../state/search-app-state.js';
+import type { ConfigurationSection, GeneratedAnswerSection, SearchSection, TabSection } from '../../state/state-sections.js';
 type StateNeededByGeneratedAnswerStream = ConfigurationSection & SearchSection & GeneratedAnswerSection;
 export interface AnswerApiQueryParams extends Omit<SearchRequest, keyof (BaseParam & AuthenticationParam & AutomaticFacetsParams)>, CaseContextParam {
 }
 export declare const buildStreamingRequest: (state: StateNeededByGeneratedAnswerStream) => Promise<GeneratedAnswerStreamRequest>;
 export declare const constructAnswerAPIQueryParams: (state: StreamAnswerAPIState, navigatorContext: NavigatorContext) => AnswerApiQueryParams;
+export type StateNeededForHeadAnswerParams = ConfigurationSection & Partial<SearchAppState> & GeneratedAnswerSection & Partial<TabSection>;
+export declare const constructGenerateHeadAnswerParams: (state: StateNeededForHeadAnswerParams, navigatorContext: NavigatorContext) => AnswerParams;
 export {};

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

@@ -38,10 +38,6 @@ export interface GeneratedAnswerBase {
         code?: number;
         isRetryable?: boolean;
     };
-    /**
-     * Determines if the answer is generated.
-     */
-    isAnswerGenerated: boolean;
     /**
      * Whether an answer cannot be generated after a query is executed.
      */
@@ -101,5 +97,9 @@ export interface GeneratedAnswerState extends GeneratedAnswerBase {
     answerApiQueryParams?: AnswerApiQueryParams;
     /** The current mode of answer generation. */
     answerGenerationMode: 'automatic' | 'manual';
+    /**
+     * Determines if the answer is generated.
+     */
+    isAnswerGenerated: boolean;
 }
 export declare function getGeneratedAnswerInitialState(): GeneratedAnswerState;

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

@@ -1,3 +1,3 @@
 import type { AnswerGenerationApiState } from '../../api/knowledge/answer-generation/answer-generation-api-state.js';
 import type { StreamingStrategy } from '../../api/knowledge/answer-generation/streaming/types.js';
-export declare const headAnswerStrategy: StreamingStrategy<AnswerGenerationApiState>;
+export declare const createHeadAnswerStrategy: () => StreamingStrategy<AnswerGenerationApiState>;

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

@@ -1,6 +1,5 @@
 import type { SearchAppState } from '../state/search-app-state.js';
-import type { ConfigurationSection } from '../state/state-sections.js';
-type StateNeededBySearchRequest = ConfigurationSection & Partial<SearchAppState>;
+type StateNeededBySearchRequest = Partial<SearchAppState>;
 type SortCriteria = {
     type: string;
     order: string;