@coveo/quantic 3.36.5 → 3.36.6

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

@@ -0,0 +1,14 @@
+import type { Dispatch } from '@reduxjs/toolkit';
+import type { NavigatorContext } from '../../../../../app/navigator-context-provider.js';
+import { type StateNeededForHeadAnswerParams } from '../../../../../features/generated-answer/generated-answer-request.js';
+/**
+ * Creates an AnswerRunner responsible for executing and managing
+ * the lifecycle of an AnswerAgent.
+ *
+ * The runner ensures that only one agent runs at a time.
+ * If a new run is triggered, any currently running agent is aborted.
+ */
+export declare const createAnswerRunner: () => {
+    run: (state: StateNeededForHeadAnswerParams, dispatch: Dispatch, getNavigatorContext: () => NavigatorContext) => Promise<void>;
+    abortRun: () => void;
+};

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

@@ -0,0 +1,9 @@
+import { HttpAgent, type RunAgentInput } from '@ag-ui/client';
+import type { PlatformEnvironment } from '../../../../../utils/url-utils.js';
+/**
+ * Custom HTTP Agent for answer requests
+ */
+export declare class AnswerAgent extends HttpAgent {
+    protected requestInit(input: RunAgentInput): RequestInit;
+}
+export declare const createAnswerAgent: (agentId: string, organizationId: string, env: PlatformEnvironment) => AnswerAgent;

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

@@ -0,0 +1,6 @@
+import type { AgentSubscriber } from '@ag-ui/client';
+import type { Dispatch } from '@reduxjs/toolkit';
+/**
+ * Creates an AgentSubscriber that handles answer streaming events
+ */
+export declare const createHeadAnswerStrategy: (dispatch: Dispatch) => AgentSubscriber;

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

@@ -0,0 +1,5 @@
+import type { PlatformEnvironment } from '../../../../utils/url-utils.js';
+/**
+ * Builds the base URL for answer generation requests based on the agent ID, organization ID, and environment.
+ */
+export declare const buildBaseAnswerGenerationUrl: (agentId: string, organizationId: string, environment: PlatformEnvironment) => string;

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

@@ -0,0 +1,9 @@
+import { HttpAgent, type RunAgentInput } from '@ag-ui/client';
+import type { PlatformEnvironment } from '../../../../../utils/url-utils.js';
+/**
+ * Custom HTTP Agent for follow-up answer requests
+ */
+export declare class FollowUpAgent extends HttpAgent {
+    protected requestInit(input: RunAgentInput): RequestInit;
+}
+export declare const createFollowUpAgent: (agentId: string, organizationId: string, env: PlatformEnvironment) => FollowUpAgent;

package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/agents/follow-up-agent/follow-up-answer-strategy.d.ts

@@ -0,0 +1,6 @@
+import type { AgentSubscriber } from '@ag-ui/client';
+import type { Dispatch } from '@reduxjs/toolkit';
+/**
+ * Creates an AgentSubscriber that handles follow-up answer streaming events
+ */
+export declare const createFollowUpStrategy: (dispatch: Dispatch) => AgentSubscriber;

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

@@ -1,6 +1,6 @@
 import type { AnyFacetRequest } from '../../../../../features/facets/generic/interfaces/generic-facet-request.js';
 import type { AnalyticsParam, PipelineRuleParameters } from '../../../../search/search-api-params.js';
-import { type AnswerGenerationApiState, type GeneratedAnswerServerState } from '../../answer-generation-api-state.js';
+import { type GeneratedAnswerServerState } from '../../answer-generation-api-state.js';
 /**
  * Parameters for answer generation requests.
  */
@@ -28,71 +28,3 @@ export declare const answerEndpoint: import("@reduxjs/toolkit/query").Api<import
  * 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>;
-/**
- * Selects the cached answer generation data for the specified query parameters from the state.
- *
- * @param args - The answer endpoint arguments including strategy and parameters.
- * @param state - The current answer generation API state.
- * @returns The cached answer generation query result.
- */
-export declare const selectAnswer: (args: AnswerEndpointArgs, state: AnswerGenerationApiState) => ({
-    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
-    originalArgs?: undefined | undefined;
-    data?: undefined | undefined;
-    error?: undefined | undefined;
-    requestId?: undefined | undefined;
-    endpointName?: string | undefined;
-    startedTimeStamp?: undefined | undefined;
-    fulfilledTimeStamp?: undefined | undefined;
-} & {
-    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
-    isUninitialized: true;
-    isLoading: false;
-    isSuccess: false;
-    isError: false;
-}) | ({
-    status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
-    error: undefined;
-    requestId: string;
-    originalArgs: AnswerEndpointArgs;
-    endpointName: string;
-    startedTimeStamp: number;
-    data: GeneratedAnswerServerState;
-    fulfilledTimeStamp: number;
-} & {
-    status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
-    isUninitialized: false;
-    isLoading: false;
-    isSuccess: true;
-    isError: false;
-}) | ({
-    status: import("@reduxjs/toolkit/query").QueryStatus.pending;
-    originalArgs: AnswerEndpointArgs;
-    requestId: string;
-    data?: GeneratedAnswerServerState | undefined;
-    error?: import("@reduxjs/toolkit/query").FetchBaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
-    endpointName: string;
-    startedTimeStamp: number;
-    fulfilledTimeStamp?: number | undefined;
-} & {
-    status: import("@reduxjs/toolkit/query").QueryStatus.pending;
-    isUninitialized: false;
-    isLoading: true;
-    isSuccess: false;
-    isError: false;
-}) | ({
-    status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
-    data?: GeneratedAnswerServerState | undefined;
-    requestId: string;
-    fulfilledTimeStamp?: number | undefined;
-    originalArgs: AnswerEndpointArgs;
-    endpointName: string;
-    startedTimeStamp: number;
-    error: import("@reduxjs/toolkit/query").FetchBaseQueryError | import("@reduxjs/toolkit").SerializedError;
-} & {
-    status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
-    isUninitialized: false;
-    isLoading: false;
-    isSuccess: false;
-    isError: true;
-});

package/force-app/main/default/staticresources/coveoheadless/definitions/app/listener-middleware/generate-answer-listener-middleware.d.ts

@@ -1,4 +1,8 @@
-import { type ThunkDispatch, type UnknownAction } from '@reduxjs/toolkit';
-import type { AnswerGenerationApiState } from '../../api/knowledge/answer-generation/answer-generation-api-state.js';
-import type { SearchThunkExtraArguments } from '../search-thunk-extra-arguments.js';
-export declare const generateAnswerListener: import("@reduxjs/toolkit").ListenerMiddlewareInstance<AnswerGenerationApiState, ThunkDispatch<AnswerGenerationApiState, SearchThunkExtraArguments, UnknownAction>, unknown>;
+import { type Dispatch } from '@reduxjs/toolkit';
+import type { StateNeededForHeadAnswerParams } from '../../features/generated-answer/generated-answer-request.js';
+import type { NavigatorContext } from '../navigator-context-provider.js';
+export declare const createGenerateAnswerListener: (extra: {
+    getNavigatorContext: () => NavigatorContext;
+}) => import("@reduxjs/toolkit").ListenerMiddlewareInstance<StateNeededForHeadAnswerParams, Dispatch<import("@reduxjs/toolkit").UnknownAction>, {
+    getNavigatorContext: () => NavigatorContext;
+}>;

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

@@ -1,10 +1,10 @@
 import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
 import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { GeneratedAnswerBase, GeneratedAnswerState } from '../../features/generated-answer/generated-answer-state.js';
+import type { GeneratedAnswerBase, GeneratedAnswerState, GenerationStep } from '../../features/generated-answer/generated-answer-state.js';
 import type { GeneratedResponseFormat } from '../../features/generated-answer/generated-response-format.js';
 import type { GeneratedAnswer, GeneratedAnswerProps, GeneratedAnswerPropsInitialState } from '../core/generated-answer/headless-core-generated-answer.js';
-import { type GeneratedAnswerWithFollowUps } from '../knowledge/generated-answer/headless-generated-answer-with-follow-ups.js';
-export type { GeneratedAnswerCitation, GeneratedResponseFormat, GeneratedAnswerState, GeneratedAnswer, GeneratedAnswerWithFollowUps, GeneratedAnswerBase, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, };
+import { type GeneratedAnswerWithFollowUps, type GeneratedAnswerWithFollowUpsState } from '../knowledge/generated-answer/headless-generated-answer-with-follow-ups.js';
+export type { GeneratedAnswerCitation, GeneratedResponseFormat, GeneratedAnswerState, GeneratedAnswer, GeneratedAnswerWithFollowUps, GeneratedAnswerWithFollowUpsState, GeneratedAnswerBase, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GenerationStep, };
 /**
  * Creates a `GeneratedAnswer` controller instance.
 

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-generated-answer-with-follow-ups.d.ts

@@ -3,7 +3,7 @@ import type { SearchEngine } from '../../../app/search-engine/search-engine.js';
 import type { FollowUpAnswersState } from '../../../features/follow-up-answers/follow-up-answers-state.js';
 import type { GeneratedAnswerState } from '../../../index.js';
 import { type GeneratedAnswer, type GeneratedAnswerAnalyticsClient, type GeneratedAnswerProps } from '../../core/generated-answer/headless-core-generated-answer.js';
-interface GeneratedAnswerWithFollowUpsState extends GeneratedAnswerState {
+export interface GeneratedAnswerWithFollowUpsState extends GeneratedAnswerState {
     followUpAnswers: FollowUpAnswersState;
 }
 export interface GeneratedAnswerWithFollowUps extends GeneratedAnswer {
@@ -44,4 +44,3 @@ export type GeneratedAnswerWithFollowUpsProps = GeneratedAnswerProps & Required<
  * @returns A `GeneratedAnswerWithFollowUps` controller instance.
  */
 export declare function buildGeneratedAnswerWithFollowUps(engine: SearchEngine | InsightEngine, analyticsClient: GeneratedAnswerAnalyticsClient, props: GeneratedAnswerWithFollowUpsProps): GeneratedAnswerWithFollowUps;
-export {};

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

@@ -5,6 +5,15 @@ export declare const selectLocale: (state: {
 export declare const selectTimezone: (state: {
     configuration: ConfigurationState;
 }) => string;
+export declare const selectAccessToken: (state: {
+    configuration: ConfigurationState;
+}) => string;
+export declare const selectOrganizationId: (state: {
+    configuration: ConfigurationState;
+}) => string;
+export declare const selectEnvironment: (state: {
+    configuration: ConfigurationState;
+}) => "dev" | "stg" | "hipaa" | "prod";
 /**
  * Selects the agent ID from the knowledge configuration.
  * Used for agent-based answer generation via the Agent API.

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

@@ -1,5 +1,6 @@
 import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
 import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
+import { type GenerationStepName } from '../generated-answer/generated-answer-state.js';
 import type { GeneratedContentFormat } from '../generated-answer/generated-response-format.js';
 import { type StateNeededForFollowUpAnswerParams } from './follow-up-answer-request.js';
 export declare const setIsEnabled: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "followUpAnswers/setIsEnabled", never, never>;
@@ -24,6 +25,13 @@ export declare const setFollowUpIsLoading: import("@reduxjs/toolkit").ActionCrea
     answerId: string;
     isLoading: boolean;
 }, "followUpAnswers/setFollowUpIsLoading", never, never>;
+export declare const setFollowUpIsStreaming: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    isStreaming: boolean;
+}], {
+    answerId: string;
+    isStreaming: boolean;
+}, "followUpAnswers/setFollowUpIsStreaming", never, never>;
 export declare const followUpMessageChunkReceived: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
     answerId: string;
     textDelta: string;
@@ -54,6 +62,11 @@ export declare const followUpFailed: import("@reduxjs/toolkit").ActionCreatorWit
     message?: string;
     code?: number;
 }, "followUpAnswers/followUpFailed", never, never>;
+export declare const activeFollowUpStartFailed: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    message?: string;
+}], {
+    message?: string;
+}, "followUpAnswers/activeFollowUpStartFailed", never, never>;
 export declare const likeFollowUp: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
     answerId: string;
 }], {
@@ -70,6 +83,24 @@ export declare const submitFollowUpFeedback: import("@reduxjs/toolkit").ActionCr
     answerId: string;
 }, "followUpAnswers/submitFollowUpFeedback", never, never>;
 export declare const resetFollowUpAnswers: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"followUpAnswers/resetFollowUpAnswers">;
+export declare const followUpStepStarted: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    name: GenerationStepName;
+    startedAt: number;
+}], {
+    answerId: string;
+    name: GenerationStepName;
+    startedAt: number;
+}, "followUpAnswers/stepStarted", never, never>;
+export declare const followUpStepFinished: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    answerId: string;
+    name: GenerationStepName;
+    finishedAt: number;
+}], {
+    answerId: string;
+    name: GenerationStepName;
+    finishedAt: number;
+}, "followUpAnswers/stepFinished", never, never>;
 export declare const generateFollowUpAnswer: import("@reduxjs/toolkit").AsyncThunk<void, string, {
     state: StateNeededForFollowUpAnswerParams;
     extra: SearchThunkExtraArguments;

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

@@ -4,6 +4,7 @@ import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api
 import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.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 GenerationStepName } from './generated-answer-state.js';
 import { type GeneratedResponseFormat } from './generated-response-format.js';
 type StateNeededByGeneratedAnswerStream = ConfigurationSection & SearchSection & GeneratedAnswerSection & DebugSection;
 export declare const citationSchema: {
@@ -47,6 +48,20 @@ export declare const registerFieldsToIncludeInCitations: import("@reduxjs/toolki
 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: Partial<AnswerApiQueryParams>], unknown, "generatedAnswer/setAnswerApiQueryParams", never, never>;
+export declare const startStep: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    name: GenerationStepName;
+    startedAt: number;
+}], {
+    name: GenerationStepName;
+    startedAt: number;
+}, "generatedAnswer/startStep", never, never>;
+export declare const finishStep: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
+    name: GenerationStepName;
+    finishedAt: number;
+}], {
+    name: GenerationStepName;
+    finishedAt: number;
+}, "generatedAnswer/finishStep", never, never>;
 interface StreamAnswerArgs {
     setAbortControllerRef: (ref: AbortController) => void;
 }

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

@@ -1,6 +1,15 @@
 import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
 import type { AnswerApiQueryParams } from '../../features/generated-answer/generated-answer-request.js';
 import type { GeneratedContentFormat, GeneratedResponseFormat } from './generated-response-format.js';
+type GenerationStepStatus = 'active' | 'completed';
+export type GenerationStepName = (typeof GENERATION_STEP_NAMES)[number];
+export declare const GENERATION_STEP_NAMES: readonly ["searching", "thinking", "answering"];
+export interface GenerationStep {
+    name: GenerationStepName;
+    status: GenerationStepStatus;
+    startedAt: number;
+    finishedAt?: number;
+}
 /**
  * Base interface for generated answer structures.
  * Contains core properties shared across different generated answer implementations.
@@ -54,6 +63,10 @@ export interface GeneratedAnswerBase {
      * Determines if the generated answer feedback was submitted.
      */
     feedbackSubmitted: boolean;
+    /**
+     * The list of steps involved in generating the answer, along with their status and timestamps.
+     */
+    generationSteps: GenerationStep[];
 }
 /**
  * A scoped and simplified part of the headless state that is relevant to the `GeneratedAnswer` component.
@@ -103,3 +116,4 @@ export interface GeneratedAnswerState extends GeneratedAnswerBase {
     isAnswerGenerated: boolean;
 }
 export declare function getGeneratedAnswerInitialState(): GeneratedAnswerState;
+export {};

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

@@ -0,0 +1,14 @@
+/**
+ * Enumeration of error codes for Server-Sent Events (SSE) related to generated answers.
+ */
+export declare enum GeneratedAnswerSseErrorCode {
+    SseMaxDurationExceeded = 1000,
+    SseFollowUpNotSupported = 1001,
+    ConversationNotFound = 1002,
+    SseModelsNotAvailable = 1003,
+    SseInternalError = 1004
+}
+/**
+ * Maps backend error codes to frontend error codes for generated answer SSE errors.
+ */
+export declare function mapRunErrorCode(code?: string): GeneratedAnswerSseErrorCode;

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

@@ -63,7 +63,7 @@ export type { FieldSuggestions, FieldSuggestionsOptions, FieldSuggestionsProps,
 export { buildFieldSuggestions } from './controllers/field-suggestions/facet/headless-field-suggestions.js';
 export type { FoldedCollection, FoldedResult, FoldedResultList, FoldedResultListOptions, FoldedResultListProps, FoldedResultListState, FoldingOptions, } from './controllers/folded-result-list/headless-folded-result-list.js';
 export { buildFoldedResultList } from './controllers/folded-result-list/headless-folded-result-list.js';
-export type { GeneratedAnswer, GeneratedAnswerBase, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedAnswerWithFollowUps, GeneratedResponseFormat, } from './controllers/generated-answer/headless-generated-answer.js';
+export type { GeneratedAnswer, GeneratedAnswerBase, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedAnswerWithFollowUps, GeneratedAnswerWithFollowUpsState, GeneratedResponseFormat, GenerationStep, } from './controllers/generated-answer/headless-generated-answer.js';
 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';