@coveo/quantic 3.36.2 → 3.36.4

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 (40) hide show
  1. package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js +8 -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/commerce-api-client.d.ts +3 -2
  4. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/commerce-metadata.d.ts +1 -1
  5. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/common/request.d.ts +3 -3
  6. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/product-enrichment/product-enrichment-request.d.ts +3 -3
  7. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/recommendations/recommendations-request.d.ts +3 -3
  8. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/plan/plan-request.d.ts +31 -0
  9. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/plan/plan-response.d.ts +8 -0
  10. package/force-app/main/default/staticresources/coveoheadless/definitions/api/commerce/search/query-suggest/query-suggest-request.d.ts +3 -3
  11. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/answer/answer-endpoint.d.ts +69 -1
  12. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/endpoints/follow-up/follow-up-endpoint.d.ts +1 -2
  13. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/answer-generation/streaming/types.d.ts +10 -11
  14. package/force-app/main/default/staticresources/coveoheadless/definitions/api/knowledge/stream-answer-api.d.ts +3 -3
  15. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-case-classifications/get-case-classifications-request.d.ts +3 -3
  16. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/case-assist/get-document-suggestions/get-document-suggestions-request.d.ts +3 -3
  17. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/get-interface/get-interface-config-request.d.ts +3 -3
  18. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/query/query-request.d.ts +6 -6
  19. package/force-app/main/default/staticresources/coveoheadless/definitions/api/service/insight/user-actions/user-actions-request.d.ts +3 -3
  20. package/force-app/main/default/staticresources/coveoheadless/definitions/app/listener-middleware/generate-answer-listener-middleware.d.ts +4 -0
  21. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-core-generated-answer.d.ts +4 -0
  22. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/generated-answer/headless-generated-answer.d.ts +4 -3
  23. package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-generated-answer-with-follow-ups.d.ts +47 -0
  24. package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/analytics-utils.d.ts +1 -0
  25. package/force-app/main/default/staticresources/coveoheadless/definitions/features/analytics/search-action-cause.d.ts +4 -0
  26. package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-analytics-actions.d.ts +107 -2
  27. package/force-app/main/default/staticresources/coveoheadless/definitions/features/attached-results/attached-results-state.d.ts +4 -0
  28. package/force-app/main/default/staticresources/coveoheadless/definitions/features/commerce/standalone-search-box-set/plan-request-builder.d.ts +1 -4
  29. package/force-app/main/default/staticresources/coveoheadless/definitions/features/follow-up-answers/follow-up-answer-request.d.ts +4 -0
  30. package/force-app/main/default/staticresources/coveoheadless/definitions/features/follow-up-answers/follow-up-answers-actions.d.ts +12 -0
  31. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/answer-api-selectors.d.ts +1 -4
  32. package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-selectors.d.ts +2 -0
  33. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/legacy/search-request.d.ts +1 -1
  34. package/force-app/main/default/staticresources/coveoheadless/definitions/features/search/search-request.d.ts +1 -1
  35. package/force-app/main/default/staticresources/coveoheadless/definitions/index.d.ts +1 -1
  36. package/force-app/main/default/staticresources/coveoheadless/definitions/utils/facet-utils.d.ts +1 -1
  37. package/force-app/main/default/staticresources/coveoheadless/headless.js +10 -10
  38. package/force-app/main/default/staticresources/coveoheadless/insight/headless.js +9 -9
  39. package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js +7 -7
  40. package/package.json +2 -2
@@ -1,9 +1,6 @@
1
- import type { PageParam, PerPageParam, QueryParam } from '../../../api/commerce/commerce-api-params.js';
2
- import type { BaseCommerceAPIRequest } from '../../../api/commerce/common/request.js';
1
+ import type { CommercePlanRequest } from '../../../api/commerce/search/plan/plan-request.js';
3
2
  import type { NavigatorContext } from '../../../app/navigator-context-provider.js';
4
3
  import type { CommerceQuerySection } from '../../../state/state-sections.js';
5
4
  import { type StateNeededForBaseCommerceAPIRequest } from '../common/base-commerce-api-request-builder.js';
6
5
  export type StateNeededForPlanCommerceAPIRequest = StateNeededForBaseCommerceAPIRequest & CommerceQuerySection;
7
- type CommercePlanRequest = BaseCommerceAPIRequest & QueryParam & PageParam & PerPageParam;
8
6
  export declare const buildPlanRequest: (state: StateNeededForPlanCommerceAPIRequest, navigatorContext: NavigatorContext) => CommercePlanRequest;
9
- export {};
@@ -0,0 +1,4 @@
1
+ import type { FollowUpAnswerParams } from '../../api/knowledge/answer-generation/endpoints/follow-up/follow-up-endpoint.js';
2
+ import type { ConfigurationSection, FollowUpAnswersSection } from '../../state/state-sections.js';
3
+ export type StateNeededForFollowUpAnswerParams = FollowUpAnswersSection & ConfigurationSection;
4
+ export declare const constructGenerateFollowUpAnswerParams: (followUpQuestion: string, state: StateNeededForFollowUpAnswerParams) => FollowUpAnswerParams;
@@ -1,5 +1,7 @@
1
1
  import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
2
+ import type { SearchThunkExtraArguments } from '../../app/search-thunk-extra-arguments.js';
2
3
  import type { GeneratedContentFormat } from '../generated-answer/generated-response-format.js';
4
+ import { type StateNeededForFollowUpAnswerParams } from './follow-up-answer-request.js';
3
5
  export declare const setIsEnabled: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: boolean], boolean, "followUpAnswers/setIsEnabled", never, never>;
4
6
  export declare const setFollowUpAnswersConversationId: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: string], string, "followUpAnswers/setFollowUpAnswersConversationId", never, never>;
5
7
  export declare const createFollowUpAnswer: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: {
@@ -68,3 +70,13 @@ export declare const submitFollowUpFeedback: import("@reduxjs/toolkit").ActionCr
68
70
  answerId: string;
69
71
  }, "followUpAnswers/submitFollowUpFeedback", never, never>;
70
72
  export declare const resetFollowUpAnswers: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"followUpAnswers/resetFollowUpAnswers">;
73
+ export declare const generateFollowUpAnswer: import("@reduxjs/toolkit").AsyncThunk<void, string, {
74
+ state: StateNeededForFollowUpAnswerParams;
75
+ extra: SearchThunkExtraArguments;
76
+ dispatch?: import("redux-thunk").ThunkDispatch<unknown, unknown, import("@reduxjs/toolkit").UnknownAction> | undefined;
77
+ rejectValue?: unknown;
78
+ serializedErrorType?: unknown;
79
+ pendingMeta?: unknown;
80
+ fulfilledMeta?: unknown;
81
+ rejectedMeta?: unknown;
82
+ }>;
@@ -44,10 +44,7 @@ export declare const selectAnswerTriggerParams: ((state: any, ...params: any[])
44
44
  memoize: typeof import("reselect").weakMapMemoize;
45
45
  };
46
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
47
+ * Selects the parameters to be used in the Answer API request.
51
48
  */
52
49
  export declare const selectAnswerApiQueryParams: ((state: any, ...params: any[]) => any) & {
53
50
  clearCache: () => void;
@@ -1,7 +1,9 @@
1
+ import type { StreamAnswerAPIState } from '../../api/knowledge/stream-answer-api-state.js';
1
2
  import type { GeneratedAnswerCitation } from '../../controllers/generated-answer/headless-generated-answer.js';
2
3
  import type { SearchAppState } from '../../state/search-app-state.js';
3
4
  import type { GeneratedAnswerSection } from '../../state/state-sections.js';
4
5
  export declare const generativeQuestionAnsweringIdSelector: (state: Partial<SearchAppState>) => string | undefined;
6
+ export declare const isGeneratedAnswerFeatureEnabledWithAnswerGenerationAPI: (state: Partial<SearchAppState>) => state is StreamAnswerAPIState;
5
7
  export declare const selectFieldsToIncludeInCitation: (state: Partial<GeneratedAnswerSection>) => string[] | undefined;
6
8
  export declare const citationSourceSelector: ((state: Partial<GeneratedAnswerSection>, citationId: string) => GeneratedAnswerCitation | undefined) & {
7
9
  clearCache: () => void;
@@ -17,7 +17,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, eve
17
17
  facetOptions?: import("../../facet-options/facet-options.js").FacetOptions;
18
18
  numberOfResults?: number;
19
19
  firstResult?: number;
20
- facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
20
+ facets?: (import("../../facets/facet-set/interfaces/request.js").FacetRequest | import("../../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
21
21
  cq?: string;
22
22
  queryCorrection?: {
23
23
  enabled?: boolean;
@@ -18,7 +18,7 @@ export declare const buildSearchRequest: (state: StateNeededBySearchRequest, nav
18
18
  facetOptions?: import("../facet-options/facet-options.js").FacetOptions;
19
19
  numberOfResults?: number;
20
20
  firstResult?: number;
21
- facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[] | undefined;
21
+ facets?: (import("../facets/facet-set/interfaces/request.js").FacetRequest | import("../facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest | import("../facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest)[] | undefined;
22
22
  cq?: string;
23
23
  queryCorrection?: {
24
24
  enabled?: boolean;
@@ -63,7 +63,7 @@ export type { FieldSuggestions, FieldSuggestionsOptions, FieldSuggestionsProps,
63
63
  export { buildFieldSuggestions } from './controllers/field-suggestions/facet/headless-field-suggestions.js';
64
64
  export type { FoldedCollection, FoldedResult, FoldedResultList, FoldedResultListOptions, FoldedResultListProps, FoldedResultListState, FoldingOptions, } from './controllers/folded-result-list/headless-folded-result-list.js';
65
65
  export { buildFoldedResultList } from './controllers/folded-result-list/headless-folded-result-list.js';
66
- export type { GeneratedAnswer, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedResponseFormat, } from './controllers/generated-answer/headless-generated-answer.js';
66
+ export type { GeneratedAnswer, GeneratedAnswerBase, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedAnswerWithFollowUps, GeneratedResponseFormat, } from './controllers/generated-answer/headless-generated-answer.js';
67
67
  export { buildGeneratedAnswer } from './controllers/generated-answer/headless-generated-answer.js';
68
68
  export type { InteractiveCitation, InteractiveCitationOptions, InteractiveCitationProps, } from './controllers/generated-answer/headless-interactive-citation.js';
69
69
  export { buildInteractiveCitation } from './controllers/generated-answer/headless-interactive-citation.js';
@@ -8,5 +8,5 @@ export declare function sortFacets<T extends {
8
8
  facetId: string;
9
9
  }>(facets: T[], sortOrder: string[]): T[];
10
10
  export declare const sortCriteriaMap: Record<string, SortCriteria>;
11
- export declare function getFacets(state: StateNeededBySearchRequest): (import("../features/facets/facet-set/interfaces/request.js").FacetRequest | import("../features/facets/category-facet-set/interfaces/request.js").CategoryFacetRequest | import("../features/facets/range-facets/numeric-facet-set/interfaces/request.js").NumericFacetRequest | import("../features/facets/range-facets/date-facet-set/interfaces/request.js").DateFacetRequest)[];
11
+ export declare function getFacets(state: StateNeededBySearchRequest): (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)[];
12
12
  export {};