@coveo/quantic 3.35.1 → 3.36.0

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/answer-generation-api-state.d.ts

@@ -0,0 +1,29 @@
+import type { BaseQueryFn, CombinedState, FetchArgs, FetchBaseQueryError, QueryDefinition, RetryOptions } from '@reduxjs/toolkit/query';
+import type { GeneratedAnswerCitation, GeneratedContentFormat } from '../../../index.js';
+import type { SearchAppState } from '../../../state/search-app-state.js';
+import type { ConfigurationSection, GeneratedAnswerSection, TabSection } from '../../../state/state-sections.js';
+import type { AnswerEndpointArgs } from './endpoints/answer/answer-endpoint.js';
+export interface GeneratedAnswerServerState {
+    answerId?: string;
+    contentFormat?: GeneratedContentFormat;
+    answer?: string;
+    citations?: GeneratedAnswerCitation[];
+    generated?: boolean;
+    isStreaming: boolean;
+    isLoading: boolean;
+    error?: {
+        message?: string;
+        code?: number;
+    };
+}
+export declare const initialAnswerGenerationServerState: () => GeneratedAnswerServerState;
+interface AnswerGenerationApiSection {
+    answerGenerationApi: CombinedState<{
+        generateAnswer: QueryDefinition<AnswerEndpointArgs, BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {} & RetryOptions, {}>, never, GeneratedAnswerServerState, 'answerGenerationApi'>;
+    }, never, 'answerGenerationApi'>;
+}
+export type AnswerGenerationApiState = {
+    searchHub: string;
+    pipeline: string;
+} & AnswerGenerationApiSection & ConfigurationSection & Partial<SearchAppState> & GeneratedAnswerSection & Partial<TabSection>;
+export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/answer-generation-api.d.ts

@@ -0,0 +1,4 @@
+/**
+ * RTK Query API for answer generation operations.
+ */
+export declare const answerGenerationApi: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {}, "answerGenerationApi", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/answer/answer-endpoint.d.ts

@@ -0,0 +1,31 @@
+import type { AnyFacetRequest } from '../../../../../features/facets/generic/interfaces/generic-facet-request.js';
+import type { AnalyticsParam, PipelineRuleParameters } from '../../../../search/search-api-params.js';
+import { type GeneratedAnswerServerState } from '../../answer-generation-api-state.js';
+/**
+ * Parameters for answer generation requests.
+ */
+type AnswerParams = {
+    q: string;
+    facets?: AnyFacetRequest[];
+    searchHub?: string;
+    pipeline?: string;
+    pipelineRuleParameters: PipelineRuleParameters;
+    locale: string;
+} & AnalyticsParam;
+/**
+ * Arguments for the answer endpoint including streaming strategy and request parameters.
+ */
+export type AnswerEndpointArgs = {
+    strategyKey: 'head-answer';
+} & AnswerParams;
+/**
+ * RTK Query endpoint for streaming answer generation.
+ */
+export declare const answerEndpoint: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {
+    generateAnswer: import("@reduxjs/toolkit/query").QueryDefinition<AnswerEndpointArgs, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerServerState, "answerGenerationApi">;
+}, "answerGenerationApi", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;
+/**
+ * Initiates an answer generation query with the specified strategy and parameters.
+ */
+export declare const initiateAnswerEndpoint: (args: AnswerEndpointArgs) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<AnswerEndpointArgs, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerServerState, "answerGenerationApi">>, any, any, import("@reduxjs/toolkit").UnknownAction>;
+export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/answer/url-builders/endpoint-url-builder.d.ts

@@ -0,0 +1,5 @@
+import type { AnswerGenerationApiState } from '../../../answer-generation-api-state.js';
+/**
+ * Builds the complete URL for the answer generation endpoint.
+ */
+export declare const buildAnswerEndpointUrl: (state: AnswerGenerationApiState) => string;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/answer-draft-reducer/answer-draft-reducer.d.ts

@@ -0,0 +1,26 @@
+import type { GeneratedAnswerServerState } from '../../answer-generation-api-state.js';
+import type { Message, StreamPayload } from '../types.js';
+/**
+ * Sets the answer ID in the draft state if provided.
+ */
+export declare const setAnswerId: (draft: GeneratedAnswerServerState, answerId: string) => void;
+/**
+ * Initializes streaming by setting content format and updating streaming flags.
+ */
+export declare const initializeStreamingAnswer: (draft: GeneratedAnswerServerState, payload: Pick<GeneratedAnswerServerState, "contentFormat">) => void;
+/**
+ * Appends or sets answer text from streaming deltas.
+ */
+export declare const setAnswer: (draft: GeneratedAnswerServerState, payload: Pick<StreamPayload, "textDelta">) => void;
+/**
+ * Updates the citations list in the draft state.
+ */
+export declare const setCitations: (draft: GeneratedAnswerServerState, payload: Pick<StreamPayload, "citations">) => void;
+/**
+ * Finalizes streaming by marking it complete and stopping the stream.
+ */
+export declare const endStreaming: (draft: GeneratedAnswerServerState, payload: Pick<StreamPayload, "answerGenerated">) => void;
+/**
+ * Sets error state and stops streaming when an error occurs.
+ */
+export declare const setAnswerError: (draft: GeneratedAnswerServerState, message: Message) => void;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/answer-streaming-runner.d.ts

@@ -0,0 +1,26 @@
+import type { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
+import type { GeneratedAnswerServerState } from '../answer-generation-api-state.js';
+import type { StreamingStrategy } from './types.js';
+type StateWithConfiguration = {
+    configuration: {
+        accessToken: string;
+    };
+};
+/**
+ * Streams answer generation from an endpoint using a specified strategy.
+ *
+ * Establishes a server-sent events connection to stream answer generation responses.
+ * Coordinates between server state updates (via serverStateEventHandler) and
+ * application-specific logic (via strategy handlers).
+ *
+ * @param endpointUrl - The streaming endpoint URL
+ * @param args - Request arguments to send in the POST body
+ * @param api - Redux toolkit query API with state getter, dispatch, and cache updater
+ * @param strategy - Strategy defining application-specific event handlers
+ */
+export declare const streamAnswerWithStrategy: <TArgs, TState extends StateWithConfiguration>(endpointUrl: string, args: TArgs, api: {
+    getState: () => TState;
+    dispatch: ThunkDispatch<TState, unknown, UnknownAction>;
+    updateCachedData: (updater: (draft: GeneratedAnswerServerState) => void) => void;
+}, strategy: StreamingStrategy<TState>) => Promise<void>;
+export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/server-state-event-handler/server-state-event-handler.d.ts

@@ -0,0 +1,21 @@
+import type { GeneratedAnswerServerState } from '../../answer-generation-api-state.js';
+import type { EventType, Message } from '../types.js';
+/**
+ * Event handler interface for managing answer server state updates during answer streaming.
+ */
+interface ServerStateEventHandler<TDraft = GeneratedAnswerServerState> {
+    /**
+     * Extracts and stores the answer ID from response headers.
+     */
+    handleOpen: (response: Response, updateCachedData: (updater: (draft: TDraft) => void) => void) => void;
+    /**
+     * Handlers for different streaming message types that update cached server state.
+     */
+    handleMessage: Partial<Record<EventType, (message: Message, updateCachedData: (updater: (draft: TDraft) => void) => void) => void>>;
+    handleError?: (error: unknown) => void;
+}
+/**
+ * Manages answer server state updates during answer generation streaming.
+ */
+export declare const serverStateEventHandler: ServerStateEventHandler;
+export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/strategies/streaming-strategies.d.ts

@@ -0,0 +1,3 @@
+export declare const streamingStrategies: {
+    'head-answer': import("../types.js").StreamingStrategy<import("../../answer-generation-api-state.js").AnswerGenerationApiState>;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/types.d.ts

@@ -0,0 +1,42 @@
+import type { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
+import type { GeneratedContentFormat } from '../../../../features/generated-answer/generated-response-format.js';
+import type { GeneratedAnswerCitation } from '../../../generated-answer/generated-answer-event-payload.js';
+/**
+ * Message types received during answer generation streaming.
+ */
+type PayloadType = 'genqa.headerMessageType' | 'genqa.messageType' | 'genqa.citationsType' | 'genqa.endOfStreamType';
+/**
+ * Represents a streaming message from the answer generation endpoint.
+ */
+export interface Message {
+    payloadType: PayloadType;
+    payload: string;
+    finishReason?: string;
+    errorMessage?: string;
+    code?: number;
+}
+/**
+ * Event types including standard payload types and error events.
+ */
+export type EventType = PayloadType | 'error';
+/**
+ * Parsed payload data from streaming messages.
+ */
+export interface StreamPayload {
+    textDelta?: string;
+    padding?: string;
+    answerGenerated?: boolean;
+    contentFormat?: GeneratedContentFormat;
+    citations?: GeneratedAnswerCitation[];
+}
+/**
+ * Strategy interface for handling application-specific streaming events.
+ * Defines handlers for connection lifecycle and message processing.
+ */
+export interface StreamingStrategy<TState> {
+    handleOpen: (response: Response, dispatch: ThunkDispatch<TState, unknown, UnknownAction>) => void;
+    handleError: (error: unknown) => void;
+    handleMessage: Partial<Record<EventType, (message: Message, dispatch: ThunkDispatch<TState, unknown, UnknownAction>) => void>>;
+    handleClose?: (dispatch: ThunkDispatch<TState, unknown, UnknownAction>) => void;
+}
+export {};

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-slice.d.ts

@@ -1,2 +1,7 @@
 import { type BaseQueryFn, type FetchArgs, type FetchBaseQueryError } from '@reduxjs/toolkit/query';
+/**
+ * `dynamicBaseQuery` is passed to the baseQuery of the createApi,
+ * but note that the baseQuery will not be used if a queryFn is provided in the createApi endpoint
+ */
+export declare const dynamicBaseQuery: BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>;
 export declare const answerSlice: import("@reduxjs/toolkit/query").Api<BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, {}, "answer", never, typeof import("@reduxjs/toolkit/query").coreModuleName>;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/search/search-api-params.d.ts

@@ -103,7 +103,7 @@ export interface AutomaticFacetsParams {
 export interface PipelineRuleParams {
     pipelineRuleParameters?: PipelineRuleParameters;
 }
-type PipelineRuleParameters = {
+export type PipelineRuleParameters = {
     mlGenerativeQuestionAnswering?: GenQAParameters;
 };
 type GenQAParameters = {

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

@@ -63,11 +63,12 @@ export type { PlatformEnvironment } from './utils/url-utils.js';
 export { Selectors };
 export type { CartItemParam } from './api/commerce/commerce-api-params.js';
 export type { Badge, BadgePlacement, BadgesProduct, } from './api/commerce/product-enrichment/product-enrichment-response.js';
+export { deserializeRelativeDate, validateRelativeDate, } from './api/search/date/relative-date.js';
 export type { CategoryFacetSearchResult } from './api/search/facet-search/category-facet-search/category-facet-search-response.js';
 export type { SpecificFacetSearchResult as RegularFacetSearchResult } from './api/search/facet-search/specific-facet-search/specific-facet-search-response.js';
 export type { Cart, CartInitialState, CartItem, CartProps, CartState, } from './controllers/commerce/context/cart/headless-cart.js';
 export { buildCart } from './controllers/commerce/context/cart/headless-cart.js';
-export type { Context, ContextOptions, ContextProps, ContextState, UserLocation, View, } from './controllers/commerce/context/headless-context.js';
+export type { Context, ContextOptions, ContextProps, ContextState, CustomContext, UserLocation, View, } from './controllers/commerce/context/headless-context.js';
 export { buildContext } from './controllers/commerce/context/headless-context.js';
 export type { Breadcrumb, BreadcrumbManager, BreadcrumbManagerState, BreadcrumbValue, DeselectableValue, } from './controllers/commerce/core/breadcrumb-manager/headless-core-breadcrumb-manager.js';
 export type { CategoryFacet, CategoryFacetState, } from './controllers/commerce/core/facets/category/headless-commerce-category-facet.js';
@@ -142,6 +143,5 @@ export type { CommerceSearchParameters } from './features/commerce/search-parame
 export type { SearchParameters } from './features/search-parameters/search-parameter-actions.js';
 export type { Template } from './features/templates/templates-manager.ts';
 export { HighlightUtils };
-export { deserializeRelativeDate, validateRelativeDate, } from './api/search/date/relative-date.js';
 export { productListingSerializer, searchSerializer, } from './features/commerce/parameters/parameters-serializer.js';
 export { VERSION } from './utils/version.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/commerce/context/headless-context.d.ts

@@ -7,6 +7,7 @@ export interface ContextOptions {
     currency: CurrencyCodeISO4217;
     view: View;
     location?: UserLocation;
+    custom?: CustomContext;
 }
 export interface View {
     url: string;
@@ -15,6 +16,14 @@ export interface UserLocation {
     latitude: number;
     longitude: number;
 }
+/**
+ * Custom context that accepts JSON-serializable values.
+ * Values should be primitives (string, number, boolean, null) or nested objects/arrays of primitives.
+ * Detailed validation is performed by the backend.
+ */
+export interface CustomContext {
+    [key: string]: unknown;
+}
 export interface ContextProps {
     /**
      * The initial options that should be applied to this `Context` controller.
@@ -53,6 +62,11 @@ export interface Context extends Controller {
      * @param location - The new location.
      */
     setLocation(location: UserLocation): void;
+    /**
+     * Sets custom context values.
+     * @param custom - An object containing custom key-value pairs.
+     */
+    setCustom(custom: CustomContext): void;
     /**
      * A scoped and simplified part of the headless state that is relevant to the `Context` controller.
      */
@@ -70,6 +84,7 @@ export interface ContextState {
     currency: CurrencyCodeISO4217;
     view: View;
     location?: UserLocation;
+    custom?: CustomContext;
 }
 /**
  * Creates a `Context` controller instance.

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/context/context-actions-loader.d.ts

@@ -1,7 +1,7 @@
 import type { PayloadAction } from '@reduxjs/toolkit';
 import type { CommerceEngine } from '../../../app/commerce-engine/commerce-engine.js';
-import { type SetContextPayload, type SetLocationPayload, type SetViewPayload } from './context-actions.js';
-export type { SetContextPayload, SetViewPayload, SetLocationPayload };
+import { type SetContextPayload, type SetCustomPayload, type SetLocationPayload, type SetViewPayload } from './context-actions.js';
+export type { SetContextPayload, SetCustomPayload, SetLocationPayload, SetViewPayload, };
 /**
  * The context action creators.
  *
@@ -30,6 +30,13 @@ export interface ContextActionCreators {
      * @returns A dispatchable action.
      */
     setLocation(payload: SetLocationPayload): PayloadAction<SetLocationPayload>;
+    /**
+     * Sets the custom context property without modifying any other context properties.
+     *
+     * @param payload - The action creator payload.
+     * @returns A dispatchable action.
+     */
+    setCustom(payload: SetCustomPayload): PayloadAction<SetCustomPayload>;
 }
 /**
  * Loads the commerce context reducer and returns the available context action creators.

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/context/context-actions.d.ts

@@ -1,15 +1,20 @@
 import type { CurrencyCodeISO4217 } from '@coveo/relay-event-types';
 import type { ViewParams } from '../../../api/commerce/commerce-api-params.js';
-import type { LocationState } from './context-state.js';
+import type { CustomContextState, LocationState } from './context-state.js';
 export interface SetContextPayload {
     language: string;
     country: string;
     currency: CurrencyCodeISO4217;
     view: SetViewPayload;
     location?: SetLocationPayload;
+    custom?: CustomContextState;
 }
 export declare const setContext: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetContextPayload], SetContextPayload, "commerce/context/set", never, never>;
 export type SetViewPayload = Pick<ViewParams, 'url'>;
 export declare const setView: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetViewPayload], SetViewPayload, "commerce/context/setView", never, never>;
 export type SetLocationPayload = LocationState;
 export declare const setLocation: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: Required<Pick<import("../../../api/commerce/commerce-api-params.js").UserParams, "latitude" | "longitude">>], Required<Pick<import("../../../api/commerce/commerce-api-params.js").UserParams, "latitude" | "longitude">>, "commerce/context/setLocation", never, never>;
+export type SetCustomPayload = CustomContextState | undefined;
+export declare const setCustom: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetCustomPayload], {
+    custom: SetCustomPayload;
+}, "commerce/context/setCustom", never, never>;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/context/context-state.d.ts

@@ -1,11 +1,20 @@
 import type { CurrencyCodeISO4217 } from '@coveo/relay-event-types';
 import type { UserParams, ViewParams } from '../../../api/commerce/commerce-api-params.js';
 export type LocationState = Required<Pick<UserParams, 'latitude' | 'longitude'>>;
+/**
+ * Custom context state that accepts JSON-serializable values.
+ * Values should be primitives (string, number, boolean, null) or nested objects/arrays of primitives.
+ * Detailed validation is performed by the backend.
+ */
+export interface CustomContextState {
+    [key: string]: unknown;
+}
 export interface CommerceContextState {
     language: string;
     country: string;
     currency: CurrencyCodeISO4217;
     view: ViewParams;
     location?: LocationState;
+    custom?: CustomContextState;
 }
 export declare const getContextInitialState: () => CommerceContextState;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/context/context-validation.d.ts

@@ -7,12 +7,22 @@ export declare const locationDefinition: {
     latitude: NumberValue;
     longitude: NumberValue;
 };
+/**
+ * Custom context for passing additional JSON-serializable data.
+ * Values should be primitives (string, number, boolean, null) or nested objects/arrays.
+ * Pass undefined to clear custom context.
+ * Detailed validation is performed by the backend.
+ */
+export declare const customDefinition: {
+    custom: RecordValue;
+};
 export declare const contextDefinition: {
     language: StringValue<string>;
     country: StringValue<string>;
     currency: StringValue<CurrencyCodeISO4217>;
     view: RecordValue;
     location: RecordValue;
+    custom: RecordValue;
 };
 export declare const contextSchema: Schema<{
     language: string;
@@ -20,4 +30,5 @@ export declare const contextSchema: Schema<{
     currency: CurrencyCodeISO4217;
     view: unknown;
     location: unknown;
+    custom: unknown;
 }>;

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

@@ -0,0 +1,28 @@
+import type { GeneratedAnswerBase } from '../generated-answer/generated-answer-state.js';
+/**
+ * @internal
+ * 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 {
+    /** The question prompted to generate this follow-up answer. */
+    question: string;
+}
+/**
+ * @internal
+ * The follow-up answers state.
+ */
+export interface FollowUpAnswersState {
+    /** The unique identifier of the follow-up answer session. */
+    id: string;
+    /**
+     * Determines if the follow-up answer feature is enabled.
+     */
+    isEnabled: boolean;
+    /**
+     * The follow-up answers.
+     */
+    followUpAnswers: FollowUpAnswer[];
+}
+export declare function getFollowUpAnswersInitialState(): FollowUpAnswersState;
+export {};

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

@@ -63,6 +63,7 @@ export declare const streamAnswerAPIStateMockWithStaticFiltersAndTabExpressionWi
     recentQueries?: import("../recent-queries/recent-queries-state.js").RecentQueriesState | undefined;
     excerptLength?: import("../excerpt-length/excerpt-length-state.js").ExcerptLengthState | undefined;
     generatedAnswer: import("./generated-answer-state.js").GeneratedAnswerState;
+    followUpAnswers?: import("../follow-up-answers/follow-up-answers-state.js").FollowUpAnswersState | undefined;
     instantResults?: import("../instant-results/instant-results-state.js").InstantResultsState | undefined;
     insightConfiguration?: import("../insight-configuration/insight-configuration-state.js").InsightConfigurationState | undefined;
     insightCaseContext?: import("../case-context/case-context-state.js").CaseContextState | undefined;

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

@@ -2,17 +2,12 @@ import type { GeneratedAnswerCitation } from '../../api/generated-answer/generat
 import type { AnswerApiQueryParams } from '../../features/generated-answer/generated-answer-request.js';
 import type { GeneratedContentFormat, GeneratedResponseFormat } from './generated-response-format.js';
 /**
- * A scoped and simplified part of the headless state that is relevant to the `GeneratedAnswer` component.
- *
- * @group Controllers
- * @category GeneratedAnswer
+ * Base interface for generated answer structures.
+ * Contains core properties shared across different generated answer implementations.
  */
-export interface GeneratedAnswerState {
-    id: string;
-    /**
-     * Determines if the generated answer is visible.
-     */
-    isVisible: boolean;
+export interface GeneratedAnswerBase {
+    /** The unique identifier of the answer returned by the backend. */
+    answerId?: string;
     /**
      * Determines if the generated answer is loading.
      */
@@ -21,10 +16,6 @@ export interface GeneratedAnswerState {
      * Determines if the generated answer is streaming.
      */
     isStreaming: boolean;
-    /**
-     * Determines if the generated answer is enabled.
-     */
-    isEnabled: boolean;
     /**
      * The generated answer.
      */
@@ -39,6 +30,22 @@ export interface GeneratedAnswerState {
      * The document snippets retrieved to generate the answer.
      */
     citations: GeneratedAnswerCitation[];
+    /**
+     * The generated answer error.
+     */
+    error?: {
+        message?: string;
+        code?: number;
+        isRetryable?: boolean;
+    };
+    /**
+     * Determines if the answer is generated.
+     */
+    isAnswerGenerated: boolean;
+    /**
+     * Whether an answer cannot be generated after a query is executed.
+     */
+    cannotAnswer: boolean;
     /**
      * Determines if the generated answer is liked, or upvoted by the end user.
      */
@@ -48,41 +55,42 @@ export interface GeneratedAnswerState {
      */
     disliked: boolean;
     /**
-     * The desired format options for the generated answer.
+     * Determines if the generated answer feedback was submitted.
      */
-    responseFormat: GeneratedResponseFormat;
+    feedbackSubmitted: boolean;
+}
+/**
+ * A scoped and simplified part of the headless state that is relevant to the `GeneratedAnswer` component.
+ *
+ * @group Controllers
+ * @category GeneratedAnswer
+ */
+export interface GeneratedAnswerState extends GeneratedAnswerBase {
+    id: string;
     /**
-     * Determines if the feedback modal is currently opened.
+     * Determines if the generated answer is visible.
      */
-    feedbackModalOpen: boolean;
+    isVisible: boolean;
     /**
-     * The generated answer error.
+     * Determines if the generated answer is enabled.
      */
-    error?: {
-        message?: string;
-        code?: number;
-        isRetryable?: boolean;
-    };
+    isEnabled: boolean;
     /**
-     * Determines if the generated answer feedback was submitted.
+     * The desired format options for the generated answer.
      */
-    feedbackSubmitted: boolean;
+    responseFormat: GeneratedResponseFormat;
     /**
-     * A list of indexed fields to include in the citations returned with the generated answer.
+     * Determines if the feedback modal is currently opened.
      */
-    fieldsToIncludeInCitations: string[];
+    feedbackModalOpen: boolean;
     /**
-     * Determines if the answer is generated.
+     * A list of indexed fields to include in the citations returned with the generated answer.
      */
-    isAnswerGenerated: boolean;
+    fieldsToIncludeInCitations: string[];
     /**
      * Whether the answer is expanded.
      */
     expanded: boolean;
-    /**
-     * Whether an answer cannot be generated after a query is executed.
-     */
-    cannotAnswer: boolean;
     /**
      * The answer configuration unique identifier.
      */
@@ -91,8 +99,6 @@ export interface GeneratedAnswerState {
      * The query parameters used for the answer API request cache key
      */
     answerApiQueryParams?: AnswerApiQueryParams;
-    /** The unique identifier of the answer returned by the Answer API. */
-    answerId?: string;
     /** The current mode of answer generation. */
     answerGenerationMode: 'automatic' | 'manual';
 }

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

@@ -0,0 +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>;

package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts

@@ -4,14 +4,7 @@ import type { ConfigurationSection } from '../../../state/state-sections.js';
 import type { AutomaticFacetRequest } from '../../facets/automatic-facet-set/interfaces/request.js';
 type StateNeededBySearchRequest = ConfigurationSection & Partial<SearchAppState>;
 export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eventDescription?: EventDescription) => Promise<import("../search-mappings.js").MappedSearchRequest<{
-    pipelineRuleParameters?: {
-        mlGenerativeQuestionAnswering?: {
-            responseFormat: {
-                contentFormat?: import("../../generated-answer/generated-response-format.js").GeneratedContentFormat[];
-            };
-            citationsFieldToInclude: string[];
-        };
-    };
+    pipelineRuleParameters?: import("../../../api/search/search-api-params.js").PipelineRuleParameters;
     generateAutomaticFacets?: {
         desiredCount: number;
         numberOfValues?: number;

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

@@ -5,14 +5,7 @@ import type { ConfigurationSection } from '../../state/state-sections.js';
 import type { AutomaticFacetRequest } from '../facets/automatic-facet-set/interfaces/request.js';
 type StateNeededBySearchRequest = ConfigurationSection & Partial<SearchAppState>;
 export declare const buildSearchRequest: (state: StateNeededBySearchRequest, navigatorContext: NavigatorContext, eventDescription?: EventDescription) => Promise<import("./search-mappings.js").MappedSearchRequest<{
-    pipelineRuleParameters?: {
-        mlGenerativeQuestionAnswering?: {
-            responseFormat: {
-                contentFormat?: import("../generated-answer/generated-response-format.js").GeneratedContentFormat[];
-            };
-            citationsFieldToInclude: string[];
-        };
-    };
+    pipelineRuleParameters?: import("../../api/search/search-api-params.js").PipelineRuleParameters;
     generateAutomaticFacets?: {
         desiredCount: number;
         numberOfValues?: number;

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr/commerce/controllers/context/headless-context.ssr.d.ts

@@ -1,6 +1,6 @@
-import { type Context, type ContextOptions, type ContextProps, type ContextState, type UserLocation, type View } from '../../../../controllers/commerce/context/headless-context.js';
+import { type Context, type ContextOptions, type ContextProps, type ContextState, type CustomContext, type UserLocation, type View } from '../../../../controllers/commerce/context/headless-context.js';
 import type { UniversalControllerDefinitionWithProps } from '../../types/controller-definitions.js';
-export type { Context, ContextProps, ContextState, View, UserLocation, ContextOptions, };
+export type { Context, ContextOptions, ContextProps, ContextState, CustomContext, UserLocation, View, };
 export interface ContextDefinition extends UniversalControllerDefinitionWithProps<Context, ContextOptions> {
 }
 /**

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

@@ -85,7 +85,7 @@ export type { BreadcrumbManager, BreadcrumbManagerDefinition, BreadcrumbManagerS
 export { defineBreadcrumbManager } from './ssr-next/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js';
 export type { Cart, CartBuildProps, CartDefinition, CartInitialState, CartItem, CartProps, CartState, } from './ssr-next/commerce/controllers/cart/headless-cart.ssr.js';
 export { defineCart } from './ssr-next/commerce/controllers/cart/headless-cart.ssr.js';
-export type { Context, ContextDefinition, ContextOptions, ContextProps, ContextState, UserLocation, View, } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
+export type { Context, ContextDefinition, ContextOptions, ContextProps, ContextState, CustomContext, UserLocation, View, } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
 export { defineContext } from './ssr-next/commerce/controllers/context/headless-context.ssr.js';
 export type { DidYouMean, DidYouMeanDefinition, DidYouMeanState, } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
 export { defineDidYouMean } from './ssr-next/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';

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

@@ -80,7 +80,7 @@ export type { BreadcrumbManager, BreadcrumbManagerState, } from './ssr/commerce/
 export { defineBreadcrumbManager } from './ssr/commerce/controllers/breadcrumb-manager/headless-core-breadcrumb-manager.ssr.js';
 export type { Cart, CartBuildProps, CartDefinition, CartInitialState, CartItem, CartProps, CartState, } from './ssr/commerce/controllers/cart/headless-cart.ssr.js';
 export { defineCart } from './ssr/commerce/controllers/cart/headless-cart.ssr.js';
-export type { Context, ContextDefinition, ContextOptions, ContextProps, ContextState, UserLocation, View, } from './ssr/commerce/controllers/context/headless-context.ssr.js';
+export type { Context, ContextDefinition, ContextOptions, ContextProps, ContextState, CustomContext, UserLocation, View, } from './ssr/commerce/controllers/context/headless-context.ssr.js';
 export { defineContext } from './ssr/commerce/controllers/context/headless-context.ssr.js';
 export type { DidYouMean, DidYouMeanState, } from './ssr/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';
 export { defineDidYouMean } from './ssr/commerce/controllers/did-you-mean/headless-did-you-mean.ssr.js';

package/force-app/main/default/staticresources/coveoheadless/definitions/ssr-next/commerce/controllers/context/headless-context.ssr.d.ts

@@ -1,6 +1,6 @@
-import { type Context, type ContextOptions, type ContextProps, type ContextState, type UserLocation, type View } from '../../../../controllers/commerce/context/headless-context.js';
+import { type Context, type ContextOptions, type ContextProps, type ContextState, type CustomContext, type UserLocation, type View } from '../../../../controllers/commerce/context/headless-context.js';
 import type { UniversalControllerDefinitionWithProps } from '../../types/controller-definitions.js';
-export type { Context, ContextProps, ContextState, View, UserLocation, ContextOptions, };
+export type { Context, ContextOptions, ContextProps, ContextState, CustomContext, UserLocation, View, };
 export type ContextDefinition = UniversalControllerDefinitionWithProps<Context, {
     initialState: ContextOptions;
 }>;