@coveo/quantic 3.30.0 → 3.30.1-pre.6b0dd27fd8

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 (20) 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 +5 -5
  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/features/generated-answer/generated-answer-actions-loader.d.ts +0 -9
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-actions.d.ts +0 -25
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/insight.index.d.ts +0 -1
  16. package/force-app/main/default/staticresources/coveoheadless/headless.js +12 -10
  17. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +11 -9
  18. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +9 -7
  19. package/package.json +2 -2
  20. package/docs/out/quantic-docs.json +0 -6440
@@ -3,5 +3,5 @@ import type { BaseParam } from './platform-service-params.js';
3
3
  import type { AllSearchAPIResponse } from './search/search-api-client.js';
4
4
  import type { SearchAPIErrorWithStatusCode } from './search/search-api-error-response.js';
5
5
  import type { AuthenticationParam } from './search/search-api-params.js';
6
- export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "accessToken" | "organizationId" | "url" | "authentication">;
6
+ export declare function pickNonBaseParams<Params extends BaseParam & AuthenticationParam>(req: Params): Omit<Params, "accessToken" | "url" | "organizationId" | "authentication">;
7
7
  export declare const unwrapError: (payload: PlatformResponse<AllSearchAPIResponse>) => SearchAPIErrorWithStatusCode;
@@ -29,10 +29,10 @@ export declare const getRequestOptions: (req: FilterableCommerceAPIRequest, path
29
29
  sort: import("./sort.js").SortOption | undefined;
30
30
  };
31
31
  accessToken: string;
32
- url: string;
33
32
  method: import("../../platform-client.js").HttpMethods;
34
- origin: import("../../preprocess-request.js").PlatformClientOrigin;
35
33
  contentType: import("../../platform-client.js").HTTPContentType;
34
+ url: string;
35
+ origin: import("../../preprocess-request.js").PlatformClientOrigin;
36
36
  requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
37
37
  };
38
38
  export declare const baseRequest: (req: BaseParam, path: CommerceApiMethod) => Pick<PlatformClientCallOptions, "accessToken" | "method" | "contentType" | "url" | "origin" | "requestMetadata">;
@@ -25,9 +25,9 @@ export declare const buildRecommendationsRequest: (req: CommerceRecommendationsR
25
25
  perPage: number | undefined;
26
26
  };
27
27
  accessToken: string;
28
- url: string;
29
28
  method: import("../../platform-client.js").HttpMethods;
30
- origin: import("../../preprocess-request.js").PlatformClientOrigin;
31
29
  contentType: import("../../platform-client.js").HTTPContentType;
30
+ url: string;
31
+ origin: import("../../preprocess-request.js").PlatformClientOrigin;
32
32
  requestMetadata?: import("../../preprocess-request.js").RequestMetadata | undefined;
33
33
  };
@@ -22,9 +22,9 @@ export declare const getQuerySuggestRequestOptions: (req: QuerySuggestRequest) =
22
22
  currency: string;
23
23
  };
24
24
  accessToken: string;
25
- url: string;
26
25
  method: import("../../../platform-client.js").HttpMethods;
27
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
28
26
  contentType: import("../../../platform-client.js").HTTPContentType;
27
+ url: string;
28
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
29
29
  requestMetadata?: import("../../../preprocess-request.js").RequestMetadata | undefined;
30
30
  };
@@ -0,0 +1,15 @@
1
+ import type { NavigatorContext } from '../../app/navigator-context-provider.js';
2
+ import type { StreamAnswerAPIState } from './stream-answer-api-state.js';
3
+ export declare const triggerSearchRequest: import("@reduxjs/toolkit").AsyncThunk<void, {
4
+ state: StreamAnswerAPIState;
5
+ navigatorContext: NavigatorContext;
6
+ }, {
7
+ state?: unknown;
8
+ dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("redux").UnknownAction>;
9
+ extra?: unknown;
10
+ rejectValue?: unknown;
11
+ serializedErrorType?: unknown;
12
+ pendingMeta?: unknown;
13
+ fulfilledMeta?: unknown;
14
+ rejectedMeta?: unknown;
15
+ }>;
@@ -75,7 +75,7 @@ export declare const constructAnswerQueryParams: (state: StreamAnswerAPIState, u
75
75
  queryCorrection?: {
76
76
  enabled: boolean;
77
77
  options: {
78
- automaticallyCorrect: "whenNoResults" | "never";
78
+ automaticallyCorrect: "never" | "whenNoResults";
79
79
  };
80
80
  } | undefined;
81
81
  enableDidYouMean?: boolean | undefined;
@@ -116,9 +116,9 @@ export declare const selectAnswer: (state: StreamAnswerAPIState, navigatorContex
116
116
  }) | ({
117
117
  status: import("@reduxjs/toolkit/query").QueryStatus.fulfilled;
118
118
  error: undefined;
119
- endpointName: string;
120
- originalArgs: Partial<SearchRequest>;
121
119
  requestId: string;
120
+ originalArgs: Partial<SearchRequest>;
121
+ endpointName: string;
122
122
  startedTimeStamp: number;
123
123
  data: GeneratedAnswerStream;
124
124
  fulfilledTimeStamp: number;
@@ -145,11 +145,11 @@ export declare const selectAnswer: (state: StreamAnswerAPIState, navigatorContex
145
145
  isError: false;
146
146
  }) | ({
147
147
  status: import("@reduxjs/toolkit/query").QueryStatus.rejected;
148
+ requestId: string;
148
149
  data?: GeneratedAnswerStream | undefined;
149
- endpointName: string;
150
150
  fulfilledTimeStamp?: number | undefined;
151
151
  originalArgs: Partial<SearchRequest>;
152
- requestId: string;
152
+ endpointName: string;
153
153
  startedTimeStamp: number;
154
154
  error: import("@reduxjs/toolkit").SerializedError | import("@reduxjs/toolkit/query").FetchBaseQueryError;
155
155
  } & {
@@ -12,8 +12,8 @@ export declare const buildGetCaseClassificationsRequest: (req: GetCaseClassifica
12
12
  };
13
13
  };
14
14
  accessToken: string;
15
- url: string;
16
15
  method: import("../../../platform-client.js").HttpMethods;
17
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
18
16
  contentType: import("../../../platform-client.js").HTTPContentType;
17
+ url: string;
18
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
19
19
  };
@@ -29,8 +29,8 @@ export declare const buildGetDocumentSuggestionsRequest: (req: GetDocumentSugges
29
29
  } | undefined;
30
30
  };
31
31
  accessToken: string;
32
- url: string;
33
32
  method: import("../../../platform-client.js").HttpMethods;
34
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
35
33
  contentType: import("../../../platform-client.js").HTTPContentType;
34
+ url: string;
35
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
36
36
  };
@@ -4,8 +4,8 @@ export type GetInsightInterfaceConfigRequest = BaseParam & InsightIdParam;
4
4
  export declare const buildGetInsightInterfaceConfigRequest: (req: GetInsightInterfaceConfigRequest) => {
5
5
  requestParams: {};
6
6
  accessToken: string;
7
- url: string;
8
7
  method: import("../../../platform-client.js").HttpMethods;
9
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
10
8
  contentType: import("../../../platform-client.js").HTTPContentType;
9
+ url: string;
10
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
11
11
  };
@@ -9,17 +9,17 @@ interface CaseContextParam {
9
9
  export declare const buildInsightQueryRequest: (req: InsightQueryRequest) => {
10
10
  requestParams: {};
11
11
  accessToken: string;
12
- url: string;
13
12
  method: import("../../../platform-client.js").HttpMethods;
14
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
15
13
  contentType: import("../../../platform-client.js").HTTPContentType;
14
+ url: string;
15
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
16
16
  };
17
17
  export declare const buildInsightQuerySuggestRequest: (req: InsightQuerySuggestRequest) => {
18
18
  requestParams: {};
19
19
  accessToken: string;
20
- url: string;
21
20
  method: import("../../../platform-client.js").HttpMethods;
22
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
23
21
  contentType: import("../../../platform-client.js").HTTPContentType;
22
+ url: string;
23
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
24
24
  };
25
25
  export {};
@@ -11,9 +11,9 @@ export declare const buildInsightUserActionsRequest: (req: InsightUserActionsReq
11
11
  objectId: string;
12
12
  };
13
13
  accessToken: string;
14
- url: string;
15
14
  method: import("../../../platform-client.js").HttpMethods;
16
- origin: import("../../../preprocess-request.js").PlatformClientOrigin;
17
15
  contentType: import("../../../platform-client.js").HTTPContentType;
16
+ url: string;
17
+ origin: import("../../../preprocess-request.js").PlatformClientOrigin;
18
18
  };
19
19
  export {};
@@ -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,4 @@
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';
4
2
  import type { ConfigurationSection, DebugSection, GeneratedAnswerSection, SearchSection } from '../../state/state-sections.js';
5
3
  import { type GeneratedResponseFormat } from './generated-response-format.js';
6
4
  type StateNeededByGeneratedAnswerStream = ConfigurationSection & SearchSection & GeneratedAnswerSection & DebugSection;
@@ -47,27 +45,4 @@ export declare const streamAnswer: import("@reduxjs/toolkit").AsyncThunk<void, S
47
45
  fulfilledMeta?: unknown;
48
46
  rejectedMeta?: unknown;
49
47
  }>;
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
48
  export {};
@@ -104,7 +104,6 @@ export type { NumericFacetValue } from './features/facets/range-facets/numeric-f
104
104
  export * from './features/facets/range-facets/numeric-facet-set/numeric-facet-actions-loader.js';
105
105
  export * from './features/fields/fields-actions-loader.js';
106
106
  export * from './features/folding/insight-folding-actions-loader.js';
107
- export * from './features/generated-answer/generated-answer-actions-loader.js';
108
107
  export * from './features/insight-interface/insight-interface-actions-loader.js';
109
108
  export type { InsightInterfaceState } from './features/insight-interface/insight-interface-state.js';
110
109
  export * from './features/insight-search/insight-query-set-actions-loader.js';