@coveo/quantic 3.30.0 → 3.30.1-pre.cc2819b982

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +10 -8
  2. package/force-app/main/default/staticresources/coveoheadless/definitions/api/api-client-utils.d.ts +1 -1
  3. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +2 -2
  4. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts +2 -2
  5. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts +2 -2
  6. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-actions.d.ts +15 -0
  7. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +9 -97
  8. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-case-classifications/get-case-classifications-request.d.ts +2 -2
  9. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts +2 -2
  10. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-request.d.ts +2 -2
  11. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/query/query-request.d.ts +4 -4
  12. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/user-actions/user-actions-request.d.ts +2 -2
  13. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-answerapi-generated-answer-mocks.d.ts +2003 -0
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/utils/testingUtils.d.ts +8 -0
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/answer-api-selectors.d.ts +72 -0
  16. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions-loader.d.ts +0 -9
  17. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions.d.ts +2 -25
  18. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-request.d.ts +2005 -0
  19. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-state.d.ts +5 -0
  20. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +2 -0
  21. package/force-app/main/default/staticresources/coveoheadless/definitions/insight.index.d.ts +0 -1
  22. package/force-app/main/default/staticresources/coveoheadless/headless.js +12 -10
  23. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +11 -9
  24. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +9 -7
  25. package/package.json +2 -2
  26. package/docs/out/quantic-docs.json +0 -6440
  27. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/tests/stream-answer-api-state-mock.d.ts +0 -1051
@@ -0,0 +1,8 @@
1
+ type DateRangeCurrentValues = {
2
+ start: string;
3
+ end: string;
4
+ endInclusive: boolean;
5
+ state: string;
6
+ };
7
+ export declare function addSecondsToFacetsTimestamps(facetsCurrentValues: DateRangeCurrentValues[], seconds: number): DateRangeCurrentValues[];
8
+ export {};
@@ -0,0 +1,72 @@
1
+ export declare const selectAnswerTriggerParams: ((state: any, ...params: any[]) => {
2
+ q: any;
3
+ requestId: any;
4
+ cannotAnswer: any;
5
+ analyticsMode: any;
6
+ actionCause: any;
7
+ }) & {
8
+ clearCache: () => void;
9
+ resultsCount: () => number;
10
+ resetResultsCount: () => void;
11
+ } & {
12
+ resultFunc: (...resultFuncArgs: readonly any[]) => {
13
+ q: any;
14
+ requestId: any;
15
+ cannotAnswer: any;
16
+ analyticsMode: any;
17
+ actionCause: any;
18
+ };
19
+ memoizedResultFunc: ((...resultFuncArgs: readonly any[]) => {
20
+ q: any;
21
+ requestId: any;
22
+ cannotAnswer: any;
23
+ analyticsMode: any;
24
+ actionCause: any;
25
+ }) & {
26
+ clearCache: () => void;
27
+ resultsCount: () => number;
28
+ resetResultsCount: () => void;
29
+ };
30
+ lastResult: () => {
31
+ q: any;
32
+ requestId: any;
33
+ cannotAnswer: any;
34
+ analyticsMode: any;
35
+ actionCause: any;
36
+ };
37
+ dependencies: import("reselect").SelectorArray<any>;
38
+ recomputations: () => number;
39
+ resetRecomputations: () => void;
40
+ dependencyRecomputations: () => number;
41
+ resetDependencyRecomputations: () => void;
42
+ } & {
43
+ argsMemoize: typeof import("reselect").weakMapMemoize;
44
+ memoize: typeof import("reselect").weakMapMemoize;
45
+ };
46
+ /**
47
+ * If answer params are not available, returns `skipToken`, a special value from RTK Query
48
+ * that tells RTK Query to "skip" running a query or selector until the params are ready.
49
+ *
50
+ * @see https://redux-toolkit.js.org/rtk-query/usage-with-typescript#skipping-queries-with-typescript-using-skiptoken
51
+ */
52
+ export declare const selectAnswerApiQueryParams: ((state: any, ...params: any[]) => any) & {
53
+ clearCache: () => void;
54
+ resultsCount: () => number;
55
+ resetResultsCount: () => void;
56
+ } & {
57
+ resultFunc: (...resultFuncArgs: readonly any[]) => any;
58
+ memoizedResultFunc: ((...resultFuncArgs: readonly any[]) => any) & {
59
+ clearCache: () => void;
60
+ resultsCount: () => number;
61
+ resetResultsCount: () => void;
62
+ };
63
+ lastResult: () => any;
64
+ dependencies: import("reselect").SelectorArray<any>;
65
+ recomputations: () => number;
66
+ resetRecomputations: () => void;
67
+ dependencyRecomputations: () => number;
68
+ resetDependencyRecomputations: () => void;
69
+ } & {
70
+ argsMemoize: typeof import("reselect").weakMapMemoize;
71
+ memoize: typeof import("reselect").weakMapMemoize;
72
+ };
@@ -7,15 +7,6 @@ import type { CoreEngine } from '../../app/engine.js';
7
7
  * @category GeneratedAnswer
8
8
  */
9
9
  export interface GeneratedAnswerActionCreators {
10
- /**
11
- * Generates a new answer using the Answer API.
12
- *
13
- * This action requires an answer configuration ID to be set in the engine configuration.
14
- * When present, it will use the Answer API service for enhanced answer generation.
15
- *
16
- * @returns A dispatchable action.
17
- */
18
- generateAnswer(): void;
19
10
  /**
20
11
  * Resets the generated answer state to a clean slate.
21
12
  *
@@ -1,6 +1,5 @@
1
1
  import type { GeneratedAnswerCitationsPayload, GeneratedAnswerMessagePayload } from '../../api/generated-answer/generated-answer-event-payload.js';
2
- import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
3
- import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
2
+ import type { SearchRequest } from '../../api/search/search/search-request.js';
4
3
  import type { ConfigurationSection, DebugSection, GeneratedAnswerSection, SearchSection } from '../../state/state-sections.js';
5
4
  import { type GeneratedResponseFormat } from './generated-response-format.js';
6
5
  type StateNeededByGeneratedAnswerStream = ConfigurationSection & SearchSection & GeneratedAnswerSection & DebugSection;
@@ -34,6 +33,7 @@ export declare const updateAnswerConfigurationId: import("@reduxjs/toolkit").Act
34
33
  export declare const registerFieldsToIncludeInCitations: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string[]], string[], "generatedAnswer/registerFieldsToIncludeInCitations", never, never>;
35
34
  export declare const setIsAnswerGenerated: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "generatedAnswer/setIsAnswerGenerated", never, never>;
36
35
  export declare const setCannotAnswer: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "generatedAnswer/setCannotAnswer", never, never>;
36
+ export declare const setAnswerApiQueryParams: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: Partial<SearchRequest>], unknown, "generatedAnswer/setAnswerApiQueryParams", never, never>;
37
37
  interface StreamAnswerArgs {
38
38
  setAbortControllerRef: (ref: AbortController) => void;
39
39
  }
@@ -47,27 +47,4 @@ export declare const streamAnswer: import("@reduxjs/toolkit").AsyncThunk<void, S
47
47
  fulfilledMeta?: unknown;
48
48
  rejectedMeta?: unknown;
49
49
  }>;
50
- /**
51
- * Thunk to handle the sequence of actions required to generate a new answer
52
- * after a search request.
53
- *
54
- * ⚠️ This action only works when an **answer configuration ID** is present
55
- * in the engine configuration. In that case, the **Answer API** will be used
56
- * instead of the regular search pipeline.
57
- *
58
- * Flow:
59
- * 1. Reset any existing answer state.
60
- * 2. Fetch a new answer from the Answer API using the provided configuration.
61
- * 3. Update the search action metadata.
62
- */
63
- export declare const generateAnswer: import("@reduxjs/toolkit").AsyncThunk<void, void, {
64
- state: StreamAnswerAPIState;
65
- extra: SearchThunkExtraArguments;
66
- dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction> | undefined;
67
- rejectValue?: unknown;
68
- serializedErrorType?: unknown;
69
- pendingMeta?: unknown;
70
- fulfilledMeta?: unknown;
71
- rejectedMeta?: unknown;
72
- }>;
73
50
  export {};