@gooddata/api-client-tiger 10.11.0-alpha.2 → 10.11.0-alpha.21

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 (41) hide show
  1. package/esm/__version.d.ts +1 -1
  2. package/esm/__version.d.ts.map +1 -1
  3. package/esm/__version.js +1 -1
  4. package/esm/__version.js.map +1 -1
  5. package/esm/api-client-tiger.d.ts +3310 -794
  6. package/esm/client.d.ts +2 -1
  7. package/esm/client.d.ts.map +1 -1
  8. package/esm/client.js.map +1 -1
  9. package/esm/entitiesObjects.d.ts +2 -1
  10. package/esm/entitiesObjects.d.ts.map +1 -1
  11. package/esm/entitiesObjects.js +1 -1
  12. package/esm/entitiesObjects.js.map +1 -1
  13. package/esm/export.d.ts +2 -1
  14. package/esm/export.d.ts.map +1 -1
  15. package/esm/export.js +1 -1
  16. package/esm/export.js.map +1 -1
  17. package/esm/generated/afm-rest-api/api.d.ts +482 -186
  18. package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
  19. package/esm/generated/afm-rest-api/api.js +170 -138
  20. package/esm/generated/afm-rest-api/api.js.map +1 -1
  21. package/esm/generated/afm-rest-api/openapi-spec.json +367 -187
  22. package/esm/generated/metadata-json-api/api.d.ts +2862 -646
  23. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  24. package/esm/generated/metadata-json-api/api.js +2361 -358
  25. package/esm/generated/metadata-json-api/api.js.map +1 -1
  26. package/esm/generated/metadata-json-api/openapi-spec.json +9337 -8391
  27. package/esm/index.d.ts +15 -8
  28. package/esm/index.d.ts.map +1 -1
  29. package/esm/index.js +4 -4
  30. package/esm/index.js.map +1 -1
  31. package/esm/labelElements.d.ts +2 -1
  32. package/esm/labelElements.d.ts.map +1 -1
  33. package/esm/labelElements.js +1 -1
  34. package/esm/labelElements.js.map +1 -1
  35. package/esm/result.d.ts +1 -1
  36. package/esm/result.d.ts.map +1 -1
  37. package/esm/scanModel.d.ts +2 -1
  38. package/esm/scanModel.d.ts.map +1 -1
  39. package/esm/scanModel.js +2 -2
  40. package/esm/scanModel.js.map +1 -1
  41. package/package.json +3 -3
@@ -92,6 +92,31 @@ export interface AbsoluteDateFilterAbsoluteDateFilter {
92
92
  * @export
93
93
  */
94
94
  export type AbstractMeasureValueFilter = ComparisonMeasureValueFilter | RangeMeasureValueFilter | RankingFilter;
95
+ /**
96
+ * Object, with which the user is actively working.
97
+ * @export
98
+ * @interface ActiveObjectIdentification
99
+ */
100
+ export interface ActiveObjectIdentification {
101
+ /**
102
+ * Object ID.
103
+ * @type {string}
104
+ * @memberof ActiveObjectIdentification
105
+ */
106
+ id: string;
107
+ /**
108
+ * Object type, e.g. dashboard.
109
+ * @type {string}
110
+ * @memberof ActiveObjectIdentification
111
+ */
112
+ type: string;
113
+ /**
114
+ * Workspace ID.
115
+ * @type {string}
116
+ * @memberof ActiveObjectIdentification
117
+ */
118
+ workspaceId: string;
119
+ }
95
120
  /**
96
121
  *
97
122
  * @export
@@ -680,6 +705,98 @@ export interface AttributeResultHeader {
680
705
  */
681
706
  primaryLabelValue: string;
682
707
  }
708
+ /**
709
+ *
710
+ * @export
711
+ * @interface ChatRequest
712
+ */
713
+ export interface ChatRequest {
714
+ /**
715
+ * User question
716
+ * @type {string}
717
+ * @memberof ChatRequest
718
+ */
719
+ question: string;
720
+ /**
721
+ * Maximum number of search results.
722
+ * @type {number}
723
+ * @memberof ChatRequest
724
+ */
725
+ limitSearch?: number;
726
+ /**
727
+ * Maximum number of created results.
728
+ * @type {number}
729
+ * @memberof ChatRequest
730
+ */
731
+ limitCreate?: number;
732
+ /**
733
+ * List of conversation interactions
734
+ * @type {Array<ConversationInteraction>}
735
+ * @memberof ChatRequest
736
+ */
737
+ conversationHistory?: Array<ConversationInteraction>;
738
+ /**
739
+ *
740
+ * @type {UserContext}
741
+ * @memberof ChatRequest
742
+ */
743
+ userContext?: UserContext;
744
+ /**
745
+ * Temporary for experiments. Ratio of title score to descriptor score.
746
+ * @type {number}
747
+ * @memberof ChatRequest
748
+ */
749
+ titleToDescriptorRatio?: number;
750
+ /**
751
+ * Score, below which we set invalidQuestion to true. The question does not match to any use case
752
+ * @type {number}
753
+ * @memberof ChatRequest
754
+ */
755
+ routeScoreThreshold?: number;
756
+ /**
757
+ * Score, above which we return found object(s) and don\'t call LLM to create new objects.
758
+ * @type {number}
759
+ * @memberof ChatRequest
760
+ */
761
+ searchScoreThreshold?: number;
762
+ /**
763
+ * Score, above which we return found objects. Below this score objects are not relevant.
764
+ * @type {number}
765
+ * @memberof ChatRequest
766
+ */
767
+ relevantScoreThreshold?: number;
768
+ }
769
+ /**
770
+ *
771
+ * @export
772
+ * @interface ChatResult
773
+ */
774
+ export interface ChatResult {
775
+ /**
776
+ * Use cases with scores. The question was routed to the use case with highest score.
777
+ * @type {Array<RouteResultObject>}
778
+ * @memberof ChatResult
779
+ */
780
+ useCases: Array<RouteResultObject>;
781
+ /**
782
+ * Flag detecting invalid/irrelevant user question. No user case was found.
783
+ * @type {boolean}
784
+ * @memberof ChatResult
785
+ */
786
+ invalidQuestion: boolean;
787
+ /**
788
+ * List of objects found by similarity search.
789
+ * @type {Array<SearchResultObject>}
790
+ * @memberof ChatResult
791
+ */
792
+ foundObjects?: Array<SearchResultObject>;
793
+ /**
794
+ *
795
+ * @type {CreatedVisualizations}
796
+ * @memberof ChatResult
797
+ */
798
+ createdVisualizations?: CreatedVisualizations;
799
+ }
683
800
  /**
684
801
  *
685
802
  * @export
@@ -802,7 +919,31 @@ export declare const ComparisonMeasureValueFilterComparisonMeasureValueFilterOpe
802
919
  };
803
920
  export type ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = typeof ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum[keyof typeof ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum];
804
921
  /**
805
- * List of created visualizations
922
+ * List of conversation interactions
923
+ * @export
924
+ * @interface ConversationInteraction
925
+ */
926
+ export interface ConversationInteraction {
927
+ /**
928
+ *
929
+ * @type {CreatedVisualizationInteractionWithContext | FoundObjectInteractionWithContext | TextInteractionWithContext}
930
+ * @memberof ConversationInteraction
931
+ */
932
+ content: CreatedVisualizationInteractionWithContext | FoundObjectInteractionWithContext | TextInteractionWithContext;
933
+ /**
934
+ * Role of actor.
935
+ * @type {string}
936
+ * @memberof ConversationInteraction
937
+ */
938
+ role: ConversationInteractionRoleEnum;
939
+ }
940
+ export declare const ConversationInteractionRoleEnum: {
941
+ readonly USER: "USER";
942
+ readonly AI: "AI";
943
+ };
944
+ export type ConversationInteractionRoleEnum = typeof ConversationInteractionRoleEnum[keyof typeof ConversationInteractionRoleEnum];
945
+ /**
946
+ * Visualization created by AI.
806
947
  * @export
807
948
  * @interface CreatedVisualization
808
949
  */
@@ -846,6 +987,69 @@ export declare const CreatedVisualizationVisualizationTypeEnum: {
846
987
  readonly PIE: "PIE";
847
988
  };
848
989
  export type CreatedVisualizationVisualizationTypeEnum = typeof CreatedVisualizationVisualizationTypeEnum[keyof typeof CreatedVisualizationVisualizationTypeEnum];
990
+ /**
991
+ *
992
+ * @export
993
+ * @interface CreatedVisualizationInteractionWithContext
994
+ */
995
+ export interface CreatedVisualizationInteractionWithContext {
996
+ /**
997
+ * Include all in the chat context. Used for further questions. Use if it\'s not clear which objects relate to the question.
998
+ * @type {boolean}
999
+ * @memberof CreatedVisualizationInteractionWithContext
1000
+ */
1001
+ includeToChatContext: boolean;
1002
+ /**
1003
+ * User feedback
1004
+ * @type {string}
1005
+ * @memberof CreatedVisualizationInteractionWithContext
1006
+ */
1007
+ userFeedback: CreatedVisualizationInteractionWithContextUserFeedbackEnum;
1008
+ /**
1009
+ *
1010
+ * @type {CreatedVisualization}
1011
+ * @memberof CreatedVisualizationInteractionWithContext
1012
+ */
1013
+ createdVisualization: CreatedVisualization;
1014
+ }
1015
+ export declare const CreatedVisualizationInteractionWithContextUserFeedbackEnum: {
1016
+ readonly POSITIVE: "POSITIVE";
1017
+ readonly NEGATIVE: "NEGATIVE";
1018
+ readonly NONE: "NONE";
1019
+ };
1020
+ export type CreatedVisualizationInteractionWithContextUserFeedbackEnum = typeof CreatedVisualizationInteractionWithContextUserFeedbackEnum[keyof typeof CreatedVisualizationInteractionWithContextUserFeedbackEnum];
1021
+ /**
1022
+ *
1023
+ * @export
1024
+ * @interface CreatedVisualizationInteractionWithContextAllOf
1025
+ */
1026
+ export interface CreatedVisualizationInteractionWithContextAllOf {
1027
+ /**
1028
+ *
1029
+ * @type {CreatedVisualization}
1030
+ * @memberof CreatedVisualizationInteractionWithContextAllOf
1031
+ */
1032
+ createdVisualization?: CreatedVisualization;
1033
+ }
1034
+ /**
1035
+ * Visualization definitions created by AI.
1036
+ * @export
1037
+ * @interface CreatedVisualizations
1038
+ */
1039
+ export interface CreatedVisualizations {
1040
+ /**
1041
+ * List of created visualization objects
1042
+ * @type {Array<CreatedVisualization>}
1043
+ * @memberof CreatedVisualizations
1044
+ */
1045
+ objects: Array<CreatedVisualization>;
1046
+ /**
1047
+ * Reasoning from LLM. Description of how the answer was generated.
1048
+ * @type {string}
1049
+ * @memberof CreatedVisualizations
1050
+ */
1051
+ reasoning: string;
1052
+ }
849
1053
  /**
850
1054
  * Mapping from dimension items (either \'localIdentifier\' from \'AttributeItem\', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.
851
1055
  * @export
@@ -975,8 +1179,12 @@ export interface DimAttribute {
975
1179
  * @type {string}
976
1180
  * @memberof DimAttribute
977
1181
  */
978
- type: string;
1182
+ type: DimAttributeTypeEnum;
979
1183
  }
1184
+ export declare const DimAttributeTypeEnum: {
1185
+ readonly ATTRIBUTE: "attribute";
1186
+ };
1187
+ export type DimAttributeTypeEnum = typeof DimAttributeTypeEnum[keyof typeof DimAttributeTypeEnum];
980
1188
  /**
981
1189
  * Single dimension description.
982
1190
  * @export
@@ -1398,6 +1606,50 @@ export interface ForecastResult {
1398
1606
  */
1399
1607
  upperBound: Array<number>;
1400
1608
  }
1609
+ /**
1610
+ *
1611
+ * @export
1612
+ * @interface FoundObjectInteractionWithContext
1613
+ */
1614
+ export interface FoundObjectInteractionWithContext {
1615
+ /**
1616
+ * Include all in the chat context. Used for further questions. Use if it\'s not clear which objects relate to the question.
1617
+ * @type {boolean}
1618
+ * @memberof FoundObjectInteractionWithContext
1619
+ */
1620
+ includeToChatContext: boolean;
1621
+ /**
1622
+ * User feedback
1623
+ * @type {string}
1624
+ * @memberof FoundObjectInteractionWithContext
1625
+ */
1626
+ userFeedback: FoundObjectInteractionWithContextUserFeedbackEnum;
1627
+ /**
1628
+ *
1629
+ * @type {SearchResultObject}
1630
+ * @memberof FoundObjectInteractionWithContext
1631
+ */
1632
+ foundObject: SearchResultObject;
1633
+ }
1634
+ export declare const FoundObjectInteractionWithContextUserFeedbackEnum: {
1635
+ readonly POSITIVE: "POSITIVE";
1636
+ readonly NEGATIVE: "NEGATIVE";
1637
+ readonly NONE: "NONE";
1638
+ };
1639
+ export type FoundObjectInteractionWithContextUserFeedbackEnum = typeof FoundObjectInteractionWithContextUserFeedbackEnum[keyof typeof FoundObjectInteractionWithContextUserFeedbackEnum];
1640
+ /**
1641
+ *
1642
+ * @export
1643
+ * @interface FoundObjectInteractionWithContextAllOf
1644
+ */
1645
+ export interface FoundObjectInteractionWithContextAllOf {
1646
+ /**
1647
+ *
1648
+ * @type {SearchResultObject}
1649
+ * @memberof FoundObjectInteractionWithContextAllOf
1650
+ */
1651
+ foundObject?: SearchResultObject;
1652
+ }
1401
1653
  /**
1402
1654
  * Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.
1403
1655
  * @export
@@ -1469,6 +1721,31 @@ export interface InlineMeasureDefinitionInline {
1469
1721
  */
1470
1722
  maql: string;
1471
1723
  }
1724
+ /**
1725
+ * Interaction content.
1726
+ * @export
1727
+ * @interface InteractionWithContext
1728
+ */
1729
+ export interface InteractionWithContext {
1730
+ /**
1731
+ * Include all in the chat context. Used for further questions. Use if it\'s not clear which objects relate to the question.
1732
+ * @type {boolean}
1733
+ * @memberof InteractionWithContext
1734
+ */
1735
+ includeToChatContext: boolean;
1736
+ /**
1737
+ * User feedback
1738
+ * @type {string}
1739
+ * @memberof InteractionWithContext
1740
+ */
1741
+ userFeedback: InteractionWithContextUserFeedbackEnum;
1742
+ }
1743
+ export declare const InteractionWithContextUserFeedbackEnum: {
1744
+ readonly POSITIVE: "POSITIVE";
1745
+ readonly NEGATIVE: "NEGATIVE";
1746
+ readonly NONE: "NONE";
1747
+ };
1748
+ export type InteractionWithContextUserFeedbackEnum = typeof InteractionWithContextUserFeedbackEnum[keyof typeof InteractionWithContextUserFeedbackEnum];
1472
1749
  /**
1473
1750
  *
1474
1751
  * @export
@@ -1731,7 +2008,7 @@ export interface Metric {
1731
2008
  * @type {string}
1732
2009
  * @memberof Metric
1733
2010
  */
1734
- type: string;
2011
+ type: MetricTypeEnum;
1735
2012
  /**
1736
2013
  * Agg function. Empty if a stored metric is used.
1737
2014
  * @type {string}
@@ -1739,6 +2016,12 @@ export interface Metric {
1739
2016
  */
1740
2017
  aggFunction?: MetricAggFunctionEnum;
1741
2018
  }
2019
+ export declare const MetricTypeEnum: {
2020
+ readonly METRIC: "metric";
2021
+ readonly FACT: "fact";
2022
+ readonly ATTRIBUTE: "attribute";
2023
+ };
2024
+ export type MetricTypeEnum = typeof MetricTypeEnum[keyof typeof MetricTypeEnum];
1742
2025
  export declare const MetricAggFunctionEnum: {
1743
2026
  readonly COUNT: "COUNT";
1744
2027
  readonly SUM: "SUM";
@@ -2272,67 +2555,17 @@ export interface RouteResultObject {
2272
2555
  */
2273
2556
  useCase: string;
2274
2557
  /**
2275
- * Similarity score between input query and use case.
2276
- * @type {number}
2277
- * @memberof RouteResultObject
2278
- */
2279
- score: number;
2280
- }
2281
- /**
2282
- *
2283
- * @export
2284
- * @interface SearchCreateRequest
2285
- */
2286
- export interface SearchCreateRequest {
2287
- /**
2288
- * User question
2558
+ * Use case description, which was hit by the similarity search.
2289
2559
  * @type {string}
2290
- * @memberof SearchCreateRequest
2291
- */
2292
- question: string;
2293
- /**
2294
- * Maximum number of search results.
2295
- * @type {number}
2296
- * @memberof SearchCreateRequest
2297
- */
2298
- limitSearch?: number;
2299
- /**
2300
- * Maximum number of created results.
2301
- * @type {number}
2302
- * @memberof SearchCreateRequest
2560
+ * @memberof RouteResultObject
2303
2561
  */
2304
- limitCreate?: number;
2562
+ exampleDescription: string;
2305
2563
  /**
2306
- * Ratio of title to descriptor.
2564
+ * Similarity score between input query and the use case description.
2307
2565
  * @type {number}
2308
- * @memberof SearchCreateRequest
2309
- */
2310
- titleToDescriptorRatio?: number;
2311
- }
2312
- /**
2313
- *
2314
- * @export
2315
- * @interface SearchCreateResult
2316
- */
2317
- export interface SearchCreateResult {
2318
- /**
2319
- * List of search result objects
2320
- * @type {Array<SearchResultObject>}
2321
- * @memberof SearchCreateResult
2322
- */
2323
- objects: Array<SearchResultObject>;
2324
- /**
2325
- * List of created visualizations
2326
- * @type {Array<CreatedVisualization>}
2327
- * @memberof SearchCreateResult
2328
- */
2329
- createdVisualizations: Array<CreatedVisualization>;
2330
- /**
2331
- * Text answer. Contains reasoning from AI. Can contain an equivalent of \"I don\'t know\".
2332
- * @type {string}
2333
- * @memberof SearchCreateResult
2566
+ * @memberof RouteResultObject
2334
2567
  */
2335
- textResponse: string;
2568
+ score: number;
2336
2569
  }
2337
2570
  /**
2338
2571
  *
@@ -2425,6 +2658,12 @@ export interface SearchRequest {
2425
2658
  * @memberof SearchRequest
2426
2659
  */
2427
2660
  titleToDescriptorRatio?: number;
2661
+ /**
2662
+ * Score, above which we return found objects. Below this score objects are not relevant.
2663
+ * @type {number}
2664
+ * @memberof SearchRequest
2665
+ */
2666
+ relevantScoreThreshold?: number;
2428
2667
  }
2429
2668
  export declare const SearchRequestObjectTypesEnum: {
2430
2669
  readonly ATTRIBUTE: "attribute";
@@ -2457,7 +2696,7 @@ export interface SearchResult {
2457
2696
  relationships: Array<SearchRelationshipObject>;
2458
2697
  }
2459
2698
  /**
2460
- * List of search result objects
2699
+ *
2461
2700
  * @export
2462
2701
  * @interface SearchResultObject
2463
2702
  */
@@ -2744,6 +2983,50 @@ export declare const SortKeyValueValueDirectionEnum: {
2744
2983
  readonly DESC: "DESC";
2745
2984
  };
2746
2985
  export type SortKeyValueValueDirectionEnum = typeof SortKeyValueValueDirectionEnum[keyof typeof SortKeyValueValueDirectionEnum];
2986
+ /**
2987
+ *
2988
+ * @export
2989
+ * @interface TextInteractionWithContext
2990
+ */
2991
+ export interface TextInteractionWithContext {
2992
+ /**
2993
+ * Include all in the chat context. Used for further questions. Use if it\'s not clear which objects relate to the question.
2994
+ * @type {boolean}
2995
+ * @memberof TextInteractionWithContext
2996
+ */
2997
+ includeToChatContext: boolean;
2998
+ /**
2999
+ * User feedback
3000
+ * @type {string}
3001
+ * @memberof TextInteractionWithContext
3002
+ */
3003
+ userFeedback: TextInteractionWithContextUserFeedbackEnum;
3004
+ /**
3005
+ * Object found by similarity search.
3006
+ * @type {string}
3007
+ * @memberof TextInteractionWithContext
3008
+ */
3009
+ text: string;
3010
+ }
3011
+ export declare const TextInteractionWithContextUserFeedbackEnum: {
3012
+ readonly POSITIVE: "POSITIVE";
3013
+ readonly NEGATIVE: "NEGATIVE";
3014
+ readonly NONE: "NONE";
3015
+ };
3016
+ export type TextInteractionWithContextUserFeedbackEnum = typeof TextInteractionWithContextUserFeedbackEnum[keyof typeof TextInteractionWithContextUserFeedbackEnum];
3017
+ /**
3018
+ *
3019
+ * @export
3020
+ * @interface TextInteractionWithContextAllOf
3021
+ */
3022
+ export interface TextInteractionWithContextAllOf {
3023
+ /**
3024
+ * Object found by similarity search.
3025
+ * @type {string}
3026
+ * @memberof TextInteractionWithContextAllOf
3027
+ */
3028
+ text?: string;
3029
+ }
2747
3030
  /**
2748
3031
  * Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it\'s described in `TotalDimension`
2749
3032
  * @export
@@ -2829,6 +3112,19 @@ export interface TotalResultHeader {
2829
3112
  */
2830
3113
  function: string;
2831
3114
  }
3115
+ /**
3116
+ * User context, which can affect the behavior of the underlying AI features.
3117
+ * @export
3118
+ * @interface UserContext
3119
+ */
3120
+ export interface UserContext {
3121
+ /**
3122
+ *
3123
+ * @type {ActiveObjectIdentification}
3124
+ * @memberof UserContext
3125
+ */
3126
+ activeObject: ActiveObjectIdentification;
3127
+ }
2832
3128
  /**
2833
3129
  *
2834
3130
  * @export
@@ -2853,6 +3149,15 @@ export interface ValidateByItem {
2853
3149
  * @export
2854
3150
  */
2855
3151
  export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration) => {
3152
+ /**
3153
+ * (BETA) Combines multiple use cases such as search, create visualizations, ...
3154
+ * @summary (BETA) Chat with AI
3155
+ * @param {string} workspaceId Workspace identifier
3156
+ * @param {ChatRequest} chatRequest
3157
+ * @param {*} [options] Override http request option.
3158
+ * @throws {RequiredError}
3159
+ */
3160
+ aiChat: (workspaceId: string, chatRequest: ChatRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2856
3161
  /**
2857
3162
  * (BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.
2858
3163
  * @summary (BETA) Route to supported use cases based on this input query.
@@ -2871,15 +3176,6 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
2871
3176
  * @throws {RequiredError}
2872
3177
  */
2873
3178
  aiSearch: (workspaceId: string, searchRequest: SearchRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2874
- /**
2875
- * (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.
2876
- * @summary (BETA) Semantic Search in Metadata + creates new visualizations
2877
- * @param {string} workspaceId Workspace identifier
2878
- * @param {SearchCreateRequest} searchCreateRequest
2879
- * @param {*} [options] Override http request option.
2880
- * @throws {RequiredError}
2881
- */
2882
- aiSearchCreate: (workspaceId: string, searchCreateRequest: SearchCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
2883
3179
  /**
2884
3180
  * (EXPERIMENTAL) Computes anomaly detection.
2885
3181
  * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
@@ -3045,6 +3341,15 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
3045
3341
  * @export
3046
3342
  */
3047
3343
  export declare const ActionsApiFp: (configuration?: Configuration) => {
3344
+ /**
3345
+ * (BETA) Combines multiple use cases such as search, create visualizations, ...
3346
+ * @summary (BETA) Chat with AI
3347
+ * @param {string} workspaceId Workspace identifier
3348
+ * @param {ChatRequest} chatRequest
3349
+ * @param {*} [options] Override http request option.
3350
+ * @throws {RequiredError}
3351
+ */
3352
+ aiChat(workspaceId: string, chatRequest: ChatRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatResult>>;
3048
3353
  /**
3049
3354
  * (BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.
3050
3355
  * @summary (BETA) Route to supported use cases based on this input query.
@@ -3063,15 +3368,6 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
3063
3368
  * @throws {RequiredError}
3064
3369
  */
3065
3370
  aiSearch(workspaceId: string, searchRequest: SearchRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResult>>;
3066
- /**
3067
- * (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.
3068
- * @summary (BETA) Semantic Search in Metadata + creates new visualizations
3069
- * @param {string} workspaceId Workspace identifier
3070
- * @param {SearchCreateRequest} searchCreateRequest
3071
- * @param {*} [options] Override http request option.
3072
- * @throws {RequiredError}
3073
- */
3074
- aiSearchCreate(workspaceId: string, searchCreateRequest: SearchCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchCreateResult>>;
3075
3371
  /**
3076
3372
  * (EXPERIMENTAL) Computes anomaly detection.
3077
3373
  * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
@@ -3237,6 +3533,14 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
3237
3533
  * @export
3238
3534
  */
3239
3535
  export declare const ActionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3536
+ /**
3537
+ * (BETA) Combines multiple use cases such as search, create visualizations, ...
3538
+ * @summary (BETA) Chat with AI
3539
+ * @param {ActionsApiAiChatRequest} requestParameters Request parameters.
3540
+ * @param {*} [options] Override http request option.
3541
+ * @throws {RequiredError}
3542
+ */
3543
+ aiChat(requestParameters: ActionsApiAiChatRequest, options?: AxiosRequestConfig): AxiosPromise<ChatResult>;
3240
3544
  /**
3241
3545
  * (BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.
3242
3546
  * @summary (BETA) Route to supported use cases based on this input query.
@@ -3253,14 +3557,6 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
3253
3557
  * @throws {RequiredError}
3254
3558
  */
3255
3559
  aiSearch(requestParameters: ActionsApiAiSearchRequest, options?: AxiosRequestConfig): AxiosPromise<SearchResult>;
3256
- /**
3257
- * (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.
3258
- * @summary (BETA) Semantic Search in Metadata + creates new visualizations
3259
- * @param {ActionsApiAiSearchCreateRequest} requestParameters Request parameters.
3260
- * @param {*} [options] Override http request option.
3261
- * @throws {RequiredError}
3262
- */
3263
- aiSearchCreate(requestParameters: ActionsApiAiSearchCreateRequest, options?: AxiosRequestConfig): AxiosPromise<SearchCreateResult>;
3264
3560
  /**
3265
3561
  * (EXPERIMENTAL) Computes anomaly detection.
3266
3562
  * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
@@ -3388,6 +3684,15 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
3388
3684
  * @interface ActionsApi
3389
3685
  */
3390
3686
  export interface ActionsApiInterface {
3687
+ /**
3688
+ * (BETA) Combines multiple use cases such as search, create visualizations, ...
3689
+ * @summary (BETA) Chat with AI
3690
+ * @param {ActionsApiAiChatRequest} requestParameters Request parameters.
3691
+ * @param {*} [options] Override http request option.
3692
+ * @throws {RequiredError}
3693
+ * @memberof ActionsApiInterface
3694
+ */
3695
+ aiChat(requestParameters: ActionsApiAiChatRequest, options?: AxiosRequestConfig): AxiosPromise<ChatResult>;
3391
3696
  /**
3392
3697
  * (BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.
3393
3698
  * @summary (BETA) Route to supported use cases based on this input query.
@@ -3406,15 +3711,6 @@ export interface ActionsApiInterface {
3406
3711
  * @memberof ActionsApiInterface
3407
3712
  */
3408
3713
  aiSearch(requestParameters: ActionsApiAiSearchRequest, options?: AxiosRequestConfig): AxiosPromise<SearchResult>;
3409
- /**
3410
- * (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.
3411
- * @summary (BETA) Semantic Search in Metadata + creates new visualizations
3412
- * @param {ActionsApiAiSearchCreateRequest} requestParameters Request parameters.
3413
- * @param {*} [options] Override http request option.
3414
- * @throws {RequiredError}
3415
- * @memberof ActionsApiInterface
3416
- */
3417
- aiSearchCreate(requestParameters: ActionsApiAiSearchCreateRequest, options?: AxiosRequestConfig): AxiosPromise<SearchCreateResult>;
3418
3714
  /**
3419
3715
  * (EXPERIMENTAL) Computes anomaly detection.
3420
3716
  * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
@@ -3551,6 +3847,25 @@ export interface ActionsApiInterface {
3551
3847
  */
3552
3848
  retrieveResult(requestParameters: ActionsApiRetrieveResultRequest, options?: AxiosRequestConfig): AxiosPromise<ExecutionResult>;
3553
3849
  }
3850
+ /**
3851
+ * Request parameters for aiChat operation in ActionsApi.
3852
+ * @export
3853
+ * @interface ActionsApiAiChatRequest
3854
+ */
3855
+ export interface ActionsApiAiChatRequest {
3856
+ /**
3857
+ * Workspace identifier
3858
+ * @type {string}
3859
+ * @memberof ActionsApiAiChat
3860
+ */
3861
+ readonly workspaceId: string;
3862
+ /**
3863
+ *
3864
+ * @type {ChatRequest}
3865
+ * @memberof ActionsApiAiChat
3866
+ */
3867
+ readonly chatRequest: ChatRequest;
3868
+ }
3554
3869
  /**
3555
3870
  * Request parameters for aiRoute operation in ActionsApi.
3556
3871
  * @export
@@ -3589,25 +3904,6 @@ export interface ActionsApiAiSearchRequest {
3589
3904
  */
3590
3905
  readonly searchRequest: SearchRequest;
3591
3906
  }
3592
- /**
3593
- * Request parameters for aiSearchCreate operation in ActionsApi.
3594
- * @export
3595
- * @interface ActionsApiAiSearchCreateRequest
3596
- */
3597
- export interface ActionsApiAiSearchCreateRequest {
3598
- /**
3599
- * Workspace identifier
3600
- * @type {string}
3601
- * @memberof ActionsApiAiSearchCreate
3602
- */
3603
- readonly workspaceId: string;
3604
- /**
3605
- *
3606
- * @type {SearchCreateRequest}
3607
- * @memberof ActionsApiAiSearchCreate
3608
- */
3609
- readonly searchCreateRequest: SearchCreateRequest;
3610
- }
3611
3907
  /**
3612
3908
  * Request parameters for anomalyDetection operation in ActionsApi.
3613
3909
  * @export
@@ -4044,6 +4340,15 @@ export interface ActionsApiRetrieveResultRequest {
4044
4340
  * @extends {BaseAPI}
4045
4341
  */
4046
4342
  export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
4343
+ /**
4344
+ * (BETA) Combines multiple use cases such as search, create visualizations, ...
4345
+ * @summary (BETA) Chat with AI
4346
+ * @param {ActionsApiAiChatRequest} requestParameters Request parameters.
4347
+ * @param {*} [options] Override http request option.
4348
+ * @throws {RequiredError}
4349
+ * @memberof ActionsApi
4350
+ */
4351
+ aiChat(requestParameters: ActionsApiAiChatRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatResult, any>>;
4047
4352
  /**
4048
4353
  * (BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.
4049
4354
  * @summary (BETA) Route to supported use cases based on this input query.
@@ -4062,15 +4367,6 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
4062
4367
  * @memberof ActionsApi
4063
4368
  */
4064
4369
  aiSearch(requestParameters: ActionsApiAiSearchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchResult, any>>;
4065
- /**
4066
- * (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.
4067
- * @summary (BETA) Semantic Search in Metadata + creates new visualizations
4068
- * @param {ActionsApiAiSearchCreateRequest} requestParameters Request parameters.
4069
- * @param {*} [options] Override http request option.
4070
- * @throws {RequiredError}
4071
- * @memberof ActionsApi
4072
- */
4073
- aiSearchCreate(requestParameters: ActionsApiAiSearchCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchCreateResult, any>>;
4074
4370
  /**
4075
4371
  * (EXPERIMENTAL) Computes anomaly detection.
4076
4372
  * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
@@ -4908,6 +5204,15 @@ export declare class ComputationApi extends BaseAPI implements ComputationApiInt
4908
5204
  * @export
4909
5205
  */
4910
5206
  export declare const SmartFunctionsApiAxiosParamCreator: (configuration?: Configuration) => {
5207
+ /**
5208
+ * (BETA) Combines multiple use cases such as search, create visualizations, ...
5209
+ * @summary (BETA) Chat with AI
5210
+ * @param {string} workspaceId Workspace identifier
5211
+ * @param {ChatRequest} chatRequest
5212
+ * @param {*} [options] Override http request option.
5213
+ * @throws {RequiredError}
5214
+ */
5215
+ aiChat: (workspaceId: string, chatRequest: ChatRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4911
5216
  /**
4912
5217
  * (BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.
4913
5218
  * @summary (BETA) Route to supported use cases based on this input query.
@@ -4926,15 +5231,6 @@ export declare const SmartFunctionsApiAxiosParamCreator: (configuration?: Config
4926
5231
  * @throws {RequiredError}
4927
5232
  */
4928
5233
  aiSearch: (workspaceId: string, searchRequest: SearchRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4929
- /**
4930
- * (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.
4931
- * @summary (BETA) Semantic Search in Metadata + creates new visualizations
4932
- * @param {string} workspaceId Workspace identifier
4933
- * @param {SearchCreateRequest} searchCreateRequest
4934
- * @param {*} [options] Override http request option.
4935
- * @throws {RequiredError}
4936
- */
4937
- aiSearchCreate: (workspaceId: string, searchCreateRequest: SearchCreateRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4938
5234
  /**
4939
5235
  * (EXPERIMENTAL) Computes anomaly detection.
4940
5236
  * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
@@ -5007,6 +5303,15 @@ export declare const SmartFunctionsApiAxiosParamCreator: (configuration?: Config
5007
5303
  * @export
5008
5304
  */
5009
5305
  export declare const SmartFunctionsApiFp: (configuration?: Configuration) => {
5306
+ /**
5307
+ * (BETA) Combines multiple use cases such as search, create visualizations, ...
5308
+ * @summary (BETA) Chat with AI
5309
+ * @param {string} workspaceId Workspace identifier
5310
+ * @param {ChatRequest} chatRequest
5311
+ * @param {*} [options] Override http request option.
5312
+ * @throws {RequiredError}
5313
+ */
5314
+ aiChat(workspaceId: string, chatRequest: ChatRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatResult>>;
5010
5315
  /**
5011
5316
  * (BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.
5012
5317
  * @summary (BETA) Route to supported use cases based on this input query.
@@ -5025,15 +5330,6 @@ export declare const SmartFunctionsApiFp: (configuration?: Configuration) => {
5025
5330
  * @throws {RequiredError}
5026
5331
  */
5027
5332
  aiSearch(workspaceId: string, searchRequest: SearchRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResult>>;
5028
- /**
5029
- * (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.
5030
- * @summary (BETA) Semantic Search in Metadata + creates new visualizations
5031
- * @param {string} workspaceId Workspace identifier
5032
- * @param {SearchCreateRequest} searchCreateRequest
5033
- * @param {*} [options] Override http request option.
5034
- * @throws {RequiredError}
5035
- */
5036
- aiSearchCreate(workspaceId: string, searchCreateRequest: SearchCreateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchCreateResult>>;
5037
5333
  /**
5038
5334
  * (EXPERIMENTAL) Computes anomaly detection.
5039
5335
  * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
@@ -5106,6 +5402,14 @@ export declare const SmartFunctionsApiFp: (configuration?: Configuration) => {
5106
5402
  * @export
5107
5403
  */
5108
5404
  export declare const SmartFunctionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5405
+ /**
5406
+ * (BETA) Combines multiple use cases such as search, create visualizations, ...
5407
+ * @summary (BETA) Chat with AI
5408
+ * @param {SmartFunctionsApiAiChatRequest} requestParameters Request parameters.
5409
+ * @param {*} [options] Override http request option.
5410
+ * @throws {RequiredError}
5411
+ */
5412
+ aiChat(requestParameters: SmartFunctionsApiAiChatRequest, options?: AxiosRequestConfig): AxiosPromise<ChatResult>;
5109
5413
  /**
5110
5414
  * (BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.
5111
5415
  * @summary (BETA) Route to supported use cases based on this input query.
@@ -5122,14 +5426,6 @@ export declare const SmartFunctionsApiFactory: (configuration?: Configuration, b
5122
5426
  * @throws {RequiredError}
5123
5427
  */
5124
5428
  aiSearch(requestParameters: SmartFunctionsApiAiSearchRequest, options?: AxiosRequestConfig): AxiosPromise<SearchResult>;
5125
- /**
5126
- * (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.
5127
- * @summary (BETA) Semantic Search in Metadata + creates new visualizations
5128
- * @param {SmartFunctionsApiAiSearchCreateRequest} requestParameters Request parameters.
5129
- * @param {*} [options] Override http request option.
5130
- * @throws {RequiredError}
5131
- */
5132
- aiSearchCreate(requestParameters: SmartFunctionsApiAiSearchCreateRequest, options?: AxiosRequestConfig): AxiosPromise<SearchCreateResult>;
5133
5429
  /**
5134
5430
  * (EXPERIMENTAL) Computes anomaly detection.
5135
5431
  * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
@@ -5185,6 +5481,15 @@ export declare const SmartFunctionsApiFactory: (configuration?: Configuration, b
5185
5481
  * @interface SmartFunctionsApi
5186
5482
  */
5187
5483
  export interface SmartFunctionsApiInterface {
5484
+ /**
5485
+ * (BETA) Combines multiple use cases such as search, create visualizations, ...
5486
+ * @summary (BETA) Chat with AI
5487
+ * @param {SmartFunctionsApiAiChatRequest} requestParameters Request parameters.
5488
+ * @param {*} [options] Override http request option.
5489
+ * @throws {RequiredError}
5490
+ * @memberof SmartFunctionsApiInterface
5491
+ */
5492
+ aiChat(requestParameters: SmartFunctionsApiAiChatRequest, options?: AxiosRequestConfig): AxiosPromise<ChatResult>;
5188
5493
  /**
5189
5494
  * (BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.
5190
5495
  * @summary (BETA) Route to supported use cases based on this input query.
@@ -5203,15 +5508,6 @@ export interface SmartFunctionsApiInterface {
5203
5508
  * @memberof SmartFunctionsApiInterface
5204
5509
  */
5205
5510
  aiSearch(requestParameters: SmartFunctionsApiAiSearchRequest, options?: AxiosRequestConfig): AxiosPromise<SearchResult>;
5206
- /**
5207
- * (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.
5208
- * @summary (BETA) Semantic Search in Metadata + creates new visualizations
5209
- * @param {SmartFunctionsApiAiSearchCreateRequest} requestParameters Request parameters.
5210
- * @param {*} [options] Override http request option.
5211
- * @throws {RequiredError}
5212
- * @memberof SmartFunctionsApiInterface
5213
- */
5214
- aiSearchCreate(requestParameters: SmartFunctionsApiAiSearchCreateRequest, options?: AxiosRequestConfig): AxiosPromise<SearchCreateResult>;
5215
5511
  /**
5216
5512
  * (EXPERIMENTAL) Computes anomaly detection.
5217
5513
  * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
@@ -5267,6 +5563,25 @@ export interface SmartFunctionsApiInterface {
5267
5563
  */
5268
5564
  forecastResult(requestParameters: SmartFunctionsApiForecastResultRequest, options?: AxiosRequestConfig): AxiosPromise<ForecastResult>;
5269
5565
  }
5566
+ /**
5567
+ * Request parameters for aiChat operation in SmartFunctionsApi.
5568
+ * @export
5569
+ * @interface SmartFunctionsApiAiChatRequest
5570
+ */
5571
+ export interface SmartFunctionsApiAiChatRequest {
5572
+ /**
5573
+ * Workspace identifier
5574
+ * @type {string}
5575
+ * @memberof SmartFunctionsApiAiChat
5576
+ */
5577
+ readonly workspaceId: string;
5578
+ /**
5579
+ *
5580
+ * @type {ChatRequest}
5581
+ * @memberof SmartFunctionsApiAiChat
5582
+ */
5583
+ readonly chatRequest: ChatRequest;
5584
+ }
5270
5585
  /**
5271
5586
  * Request parameters for aiRoute operation in SmartFunctionsApi.
5272
5587
  * @export
@@ -5305,25 +5620,6 @@ export interface SmartFunctionsApiAiSearchRequest {
5305
5620
  */
5306
5621
  readonly searchRequest: SearchRequest;
5307
5622
  }
5308
- /**
5309
- * Request parameters for aiSearchCreate operation in SmartFunctionsApi.
5310
- * @export
5311
- * @interface SmartFunctionsApiAiSearchCreateRequest
5312
- */
5313
- export interface SmartFunctionsApiAiSearchCreateRequest {
5314
- /**
5315
- * Workspace identifier
5316
- * @type {string}
5317
- * @memberof SmartFunctionsApiAiSearchCreate
5318
- */
5319
- readonly workspaceId: string;
5320
- /**
5321
- *
5322
- * @type {SearchCreateRequest}
5323
- * @memberof SmartFunctionsApiAiSearchCreate
5324
- */
5325
- readonly searchCreateRequest: SearchCreateRequest;
5326
- }
5327
5623
  /**
5328
5624
  * Request parameters for anomalyDetection operation in SmartFunctionsApi.
5329
5625
  * @export
@@ -5517,6 +5813,15 @@ export interface SmartFunctionsApiForecastResultRequest {
5517
5813
  * @extends {BaseAPI}
5518
5814
  */
5519
5815
  export declare class SmartFunctionsApi extends BaseAPI implements SmartFunctionsApiInterface {
5816
+ /**
5817
+ * (BETA) Combines multiple use cases such as search, create visualizations, ...
5818
+ * @summary (BETA) Chat with AI
5819
+ * @param {SmartFunctionsApiAiChatRequest} requestParameters Request parameters.
5820
+ * @param {*} [options] Override http request option.
5821
+ * @throws {RequiredError}
5822
+ * @memberof SmartFunctionsApi
5823
+ */
5824
+ aiChat(requestParameters: SmartFunctionsApiAiChatRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatResult, any>>;
5520
5825
  /**
5521
5826
  * (BETA) Uses similarity (e.g. cosine distance) to find most similar use cases.
5522
5827
  * @summary (BETA) Route to supported use cases based on this input query.
@@ -5535,15 +5840,6 @@ export declare class SmartFunctionsApi extends BaseAPI implements SmartFunctions
5535
5840
  * @memberof SmartFunctionsApi
5536
5841
  */
5537
5842
  aiSearch(requestParameters: SmartFunctionsApiAiSearchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchResult, any>>;
5538
- /**
5539
- * (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.
5540
- * @summary (BETA) Semantic Search in Metadata + creates new visualizations
5541
- * @param {SmartFunctionsApiAiSearchCreateRequest} requestParameters Request parameters.
5542
- * @param {*} [options] Override http request option.
5543
- * @throws {RequiredError}
5544
- * @memberof SmartFunctionsApi
5545
- */
5546
- aiSearchCreate(requestParameters: SmartFunctionsApiAiSearchCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchCreateResult, any>>;
5547
5843
  /**
5548
5844
  * (EXPERIMENTAL) Computes anomaly detection.
5549
5845
  * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection