@coveo/quantic 3.20.1 → 3.20.2-pre.6a91e0c32b

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

@@ -1,7 +1,7 @@
 import { ThunkDispatch, UnknownAction } from '@reduxjs/toolkit';
 import { GeneratedContentFormat } from '../../features/generated-answer/generated-response-format.js';
 import { SearchAppState } from '../../state/search-app-state.js';
-import { ConfigurationSection, GeneratedAnswerSection, InsightConfigurationSection } from '../../state/state-sections.js';
+import { ConfigurationSection, GeneratedAnswerSection, InsightConfigurationSection, TabSection } from '../../state/state-sections.js';
 import { EventSourceMessage } from '../../utils/fetch-event-source/parse.js';
 import { GeneratedAnswerCitation } from '../generated-answer/generated-answer-event-payload.js';
 import { SearchRequest } from '../search/search/search-request.js';
@@ -9,7 +9,7 @@ export type StateNeededByAnswerAPI = {
     searchHub: string;
     pipeline: string;
     answer: ReturnType<typeof answerApi.reducer>;
-} & ConfigurationSection & Partial<SearchAppState> & Partial<InsightConfigurationSection> & GeneratedAnswerSection;
+} & ConfigurationSection & Partial<SearchAppState> & Partial<InsightConfigurationSection> & GeneratedAnswerSection & Partial<TabSection>;
 export interface GeneratedAnswerStream {
     answerId?: string;
     contentFormat?: GeneratedContentFormat;
@@ -75,13 +75,17 @@ export declare const constructAnswerQueryParams: (state: StateNeededByAnswerAPI,
     facets?: (import("../../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
     pipeline?: string | undefined;
     searchHub?: string | undefined;
-    q: string | undefined;
     pipelineRuleParameters: {
         mlGenerativeQuestionAnswering: {
             responseFormat: import("../../features/generated-answer/generated-response-format.js").GeneratedResponseFormat;
             citationsFieldToInclude: string[];
         };
     };
+    lq?: string | undefined;
+    dq?: string | undefined;
+    cq?: string | undefined;
+    aq?: string | undefined;
+    q: string | undefined;
 };
 export declare const fetchAnswer: (state: StateNeededByAnswerAPI) => import("redux-thunk").ThunkAction<import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<Partial<SearchRequest>, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("@reduxjs/toolkit/query").FetchArgs, unknown, import("@reduxjs/toolkit/query").FetchBaseQueryError, {} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GeneratedAnswerStream, "answer">>, any, any, UnknownAction>;
 export declare const selectAnswer: (state: StateNeededByAnswerAPI) => ({

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

@@ -1,7 +1,13 @@
 import { StateNeededByAnswerAPI } from '../stream-answer-api.js';
 export declare const streamAnswerAPIStateMock: StateNeededByAnswerAPI;
+export declare const streamAnswerAPIStateMockWithATabWithAnExpression: StateNeededByAnswerAPI;
+export declare const streamAnswerAPIStateMockWithoutAnyTab: StateNeededByAnswerAPI;
 export declare const expectedStreamAnswerAPIParam: {
     q: string;
+    aq: string;
+    cq: string;
+    dq: string;
+    lq: string;
     pipelineRuleParameters: {
         mlGenerativeQuestionAnswering: {
             responseFormat: {
@@ -106,3 +112,223 @@ export declare const expectedStreamAnswerAPIParam: {
     firstResult: number;
     tab: string;
 };
+export declare const expectedStreamAnswerAPIParamWithATabWithAnExpression: {
+    cq: string;
+    tab: string;
+    q: string;
+    aq: string;
+    dq: string;
+    lq: string;
+    pipelineRuleParameters: {
+        mlGenerativeQuestionAnswering: {
+            responseFormat: {
+                contentFormat: string[];
+            };
+            citationsFieldToInclude: never[];
+        };
+    };
+    searchHub: string;
+    facets: ({
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        resultsMustMatch: string;
+        type: string;
+        currentValues: never[];
+        freezeCurrentValues: boolean;
+        isFieldExpanded: boolean;
+        preventAutoSelect: boolean;
+        facetId: string;
+        field: string;
+        rangeAlgorithm?: undefined;
+        generateAutomaticRanges?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    } | {
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        rangeAlgorithm: string;
+        resultsMustMatch: string;
+        currentValues: {
+            start: string;
+            end: string;
+            endInclusive: boolean;
+            state: string;
+        }[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        generateAutomaticRanges: boolean;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    } | {
+        delimitingCharacter: string;
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        basePath: never[];
+        filterByBasePath: boolean;
+        resultsMustMatch: string;
+        currentValues: never[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        rangeAlgorithm?: undefined;
+        generateAutomaticRanges?: undefined;
+    } | {
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        rangeAlgorithm: string;
+        resultsMustMatch: string;
+        currentValues: {
+            endInclusive: boolean;
+            state: string;
+            start: number;
+            end: number;
+        }[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        generateAutomaticRanges: boolean;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    })[];
+    fieldsToInclude: string[];
+    queryCorrection: {
+        enabled: boolean;
+        options: {
+            automaticallyCorrect: string;
+        };
+    };
+    enableDidYouMean: boolean;
+    numberOfResults: number;
+    firstResult: number;
+};
+export declare const expectedStreamAnswerAPIParamWithoutAnyTab: {
+    tab: string;
+    q: string;
+    aq: string;
+    cq: string;
+    dq: string;
+    lq: string;
+    pipelineRuleParameters: {
+        mlGenerativeQuestionAnswering: {
+            responseFormat: {
+                contentFormat: string[];
+            };
+            citationsFieldToInclude: never[];
+        };
+    };
+    searchHub: string;
+    facets: ({
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        resultsMustMatch: string;
+        type: string;
+        currentValues: never[];
+        freezeCurrentValues: boolean;
+        isFieldExpanded: boolean;
+        preventAutoSelect: boolean;
+        facetId: string;
+        field: string;
+        rangeAlgorithm?: undefined;
+        generateAutomaticRanges?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    } | {
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        rangeAlgorithm: string;
+        resultsMustMatch: string;
+        currentValues: {
+            start: string;
+            end: string;
+            endInclusive: boolean;
+            state: string;
+        }[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        generateAutomaticRanges: boolean;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    } | {
+        delimitingCharacter: string;
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        basePath: never[];
+        filterByBasePath: boolean;
+        resultsMustMatch: string;
+        currentValues: never[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        rangeAlgorithm?: undefined;
+        generateAutomaticRanges?: undefined;
+    } | {
+        filterFacetCount: boolean;
+        injectionDepth: number;
+        numberOfValues: number;
+        sortCriteria: string;
+        rangeAlgorithm: string;
+        resultsMustMatch: string;
+        currentValues: {
+            endInclusive: boolean;
+            state: string;
+            start: number;
+            end: number;
+        }[];
+        preventAutoSelect: boolean;
+        type: string;
+        facetId: string;
+        field: string;
+        generateAutomaticRanges: boolean;
+        freezeCurrentValues?: undefined;
+        isFieldExpanded?: undefined;
+        delimitingCharacter?: undefined;
+        basePath?: undefined;
+        filterByBasePath?: undefined;
+    })[];
+    fieldsToInclude: string[];
+    queryCorrection: {
+        enabled: boolean;
+        options: {
+            automaticallyCorrect: string;
+        };
+    };
+    enableDidYouMean: boolean;
+    numberOfResults: number;
+    firstResult: number;
+};

package/force-app/main/default/staticresources/coveoheadless/definitions/features/advanced-search-queries/advanced-search-query-selectors.d.ts

@@ -0,0 +1,46 @@
+import { AdvancedSearchQueriesState } from './advanced-search-queries-state.js';
+export declare const selectAdvancedSearchQueries: ((state: {
+    advancedSearchQueries?: AdvancedSearchQueriesState;
+}) => {
+    lq?: string | undefined;
+    dq?: string | undefined;
+    cq?: string | undefined;
+    aq?: string | undefined;
+}) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: AdvancedSearchQueriesState | undefined) => {
+        lq?: string | undefined;
+        dq?: string | undefined;
+        cq?: string | undefined;
+        aq?: string | undefined;
+    };
+    memoizedResultFunc: ((resultFuncArgs_0: AdvancedSearchQueriesState | undefined) => {
+        lq?: string | undefined;
+        dq?: string | undefined;
+        cq?: string | undefined;
+        aq?: string | undefined;
+    }) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => {
+        lq?: string | undefined;
+        dq?: string | undefined;
+        cq?: string | undefined;
+        aq?: string | undefined;
+    };
+    dependencies: [(state: {
+        advancedSearchQueries?: AdvancedSearchQueriesState;
+    }) => AdvancedSearchQueriesState | undefined];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};

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

@@ -20,3 +20,24 @@ export declare const selectActiveTab: ((state: TabSetState | undefined) => strin
     argsMemoize: typeof import("reselect").weakMapMemoize;
     memoize: typeof import("reselect").weakMapMemoize;
 };
+export declare const selectActiveTabExpression: ((state: TabSetState | undefined) => string) & {
+    clearCache: () => void;
+    resultsCount: () => number;
+    resetResultsCount: () => void;
+} & {
+    resultFunc: (resultFuncArgs_0: TabSetState | undefined) => string;
+    memoizedResultFunc: ((resultFuncArgs_0: TabSetState | undefined) => string) & {
+        clearCache: () => void;
+        resultsCount: () => number;
+        resetResultsCount: () => void;
+    };
+    lastResult: () => string;
+    dependencies: [(state?: TabSetState) => TabSetState | undefined];
+    recomputations: () => number;
+    resetRecomputations: () => void;
+    dependencyRecomputations: () => number;
+    resetDependencyRecomputations: () => void;
+} & {
+    argsMemoize: typeof import("reselect").weakMapMemoize;
+    memoize: typeof import("reselect").weakMapMemoize;
+};