@gooddata/api-client-tiger 11.50.0-alpha.3 → 11.50.0
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.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +8005 -4512
- package/esm/generated/afm-rest-api/api.d.ts +731 -673
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.d.ts +432 -380
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +29 -24
- package/esm/generated/auth-json-api/api.d.ts +22 -22
- package/esm/generated/auth-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.d.ts +339 -300
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.d.ts +266 -207
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +6107 -2913
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +570 -68
- package/esm/generated/result-json-api/api.d.ts +87 -87
- package/esm/generated/result-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.d.ts +109 -109
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/index.d.ts +4 -4
- package/esm/index.d.ts.map +1 -1
- package/package.json +4 -4
|
@@ -16,12 +16,12 @@ export interface AiAbsoluteDateFilter {
|
|
|
16
16
|
'absoluteDateFilter': AiAbsoluteDateFilterBody;
|
|
17
17
|
}
|
|
18
18
|
export interface AiAbsoluteDateFilterBody {
|
|
19
|
-
'dataset': AiAfmObjectIdentifier;
|
|
20
|
-
'from': string;
|
|
21
|
-
'to': string;
|
|
22
19
|
'applyOnResult'?: boolean | null;
|
|
20
|
+
'dataset': AiAfmObjectIdentifier;
|
|
23
21
|
'emptyValueHandling'?: AiEmptyValueHandling | null;
|
|
22
|
+
'from': string;
|
|
24
23
|
'localIdentifier'?: string | null;
|
|
24
|
+
'to': string;
|
|
25
25
|
}
|
|
26
26
|
export interface AiActiveObjectIdentification {
|
|
27
27
|
'id': string;
|
|
@@ -48,12 +48,12 @@ export interface AiAfmObjectIdentifierBody {
|
|
|
48
48
|
* A single agent visible to the calling user in the workspace.
|
|
49
49
|
*/
|
|
50
50
|
export interface AiAgentListItemResponse {
|
|
51
|
-
'id': string;
|
|
52
|
-
'name': string;
|
|
53
51
|
'description'?: string | null;
|
|
52
|
+
'id': string;
|
|
54
53
|
'isAvailableToAll': boolean;
|
|
55
|
-
'modifiedAt'?: string | null;
|
|
56
54
|
'lastUsedAt'?: string | null;
|
|
55
|
+
'modifiedAt'?: string | null;
|
|
56
|
+
'name': string;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
59
|
* List of agents accessible to the calling user.
|
|
@@ -83,26 +83,22 @@ export interface AiAlertDatasetRef {
|
|
|
83
83
|
* The alert itself (mirrors canonical AutomationAlert).
|
|
84
84
|
*/
|
|
85
85
|
export interface AiAlertDefinition {
|
|
86
|
+
'condition': AiCondition;
|
|
86
87
|
/**
|
|
87
88
|
* Execution (AFM) definition of the alert.
|
|
88
89
|
*/
|
|
89
90
|
'execution': AiAlertExecution;
|
|
90
|
-
'
|
|
91
|
+
'interval'?: AiIntervalGranularity | null;
|
|
91
92
|
/**
|
|
92
93
|
* Trigger behavior.
|
|
93
94
|
*/
|
|
94
95
|
'trigger'?: AiAlertTrigger;
|
|
95
|
-
'interval'?: AiIntervalGranularity | null;
|
|
96
96
|
}
|
|
97
97
|
/**
|
|
98
98
|
* Execution definition (AFM) of the alert. ``measures`` / ``attributes`` / ``filters`` are opaque AFM wire objects (same treatment as ``KeyDriverAnalysis.filters``); the semantic typing the FE renders lives on the typed ``condition`` union.
|
|
99
99
|
*/
|
|
100
100
|
export interface AiAlertExecution {
|
|
101
101
|
[key: string]: any;
|
|
102
|
-
/**
|
|
103
|
-
* Metrics computed by the alert (1-2).
|
|
104
|
-
*/
|
|
105
|
-
'measures'?: Array<object>;
|
|
106
102
|
/**
|
|
107
103
|
* Attribute slicing configuration.
|
|
108
104
|
*/
|
|
@@ -111,53 +107,57 @@ export interface AiAlertExecution {
|
|
|
111
107
|
* Alert execution filters.
|
|
112
108
|
*/
|
|
113
109
|
'filters'?: Array<object>;
|
|
110
|
+
/**
|
|
111
|
+
* Metrics computed by the alert (1-2).
|
|
112
|
+
*/
|
|
113
|
+
'measures'?: Array<object>;
|
|
114
114
|
}
|
|
115
115
|
/**
|
|
116
116
|
* Structured pre-creation alert proposal — the single model used as the HTTP DTO, the persisted shape, and the in-memory conversation-state object.
|
|
117
117
|
*/
|
|
118
118
|
export interface AiAlertProposal {
|
|
119
|
-
/**
|
|
120
|
-
* Alert title.
|
|
121
|
-
*/
|
|
122
|
-
'title': string;
|
|
123
119
|
/**
|
|
124
120
|
* The alert definition (condition, execution, trigger).
|
|
125
121
|
*/
|
|
126
122
|
'alert': AiAlertDefinition;
|
|
123
|
+
'automationId'?: string | null;
|
|
124
|
+
/**
|
|
125
|
+
* Confirmation call to action.
|
|
126
|
+
*/
|
|
127
|
+
'cta'?: string;
|
|
128
|
+
'dashboard'?: AiDashboardRef | null;
|
|
129
|
+
'description'?: string | null;
|
|
130
|
+
'forLabel'?: string | null;
|
|
131
|
+
'forMode'?: string | null;
|
|
127
132
|
/**
|
|
128
133
|
* Notification channel for delivery.
|
|
129
134
|
*/
|
|
130
135
|
'notificationChannel': AiNotificationChannelRef;
|
|
131
|
-
'description'?: string | null;
|
|
132
|
-
'automationId'?: string | null;
|
|
133
136
|
/**
|
|
134
137
|
* Recipients shown in the proposal.
|
|
135
138
|
*/
|
|
136
139
|
'recipients'?: Array<AiAlertRecipient>;
|
|
137
140
|
'schedule'?: AiAlertSchedule | null;
|
|
138
|
-
'dashboard'?: AiDashboardRef | null;
|
|
139
|
-
'forMode'?: string | null;
|
|
140
|
-
'forLabel'?: string | null;
|
|
141
141
|
/**
|
|
142
|
-
*
|
|
142
|
+
* Alert title.
|
|
143
143
|
*/
|
|
144
|
-
'
|
|
144
|
+
'title': string;
|
|
145
145
|
}
|
|
146
146
|
export interface AiAlertProposalPart {
|
|
147
|
+
'alertProposal'?: AiAlertProposal | null;
|
|
147
148
|
/**
|
|
148
149
|
* Type of multipart part.
|
|
149
150
|
*/
|
|
150
151
|
'type'?: AiAlertProposalPartTypeEnum;
|
|
151
|
-
'alertProposal'?: AiAlertProposal | null;
|
|
152
152
|
}
|
|
153
153
|
export type AiAlertProposalPartTypeEnum = 'alertProposal';
|
|
154
154
|
export interface AiAlertRecipient {
|
|
155
|
+
'email'?: string | null;
|
|
156
|
+
'id'?: string | null;
|
|
155
157
|
/**
|
|
156
158
|
* Recipient display label.
|
|
157
159
|
*/
|
|
158
160
|
'label': string;
|
|
159
|
-
'id'?: string | null;
|
|
160
|
-
'email'?: string | null;
|
|
161
161
|
}
|
|
162
162
|
export interface AiAlertSchedule {
|
|
163
163
|
'cron'?: string | null;
|
|
@@ -173,17 +173,17 @@ export declare const AiAlertTrigger: {
|
|
|
173
173
|
};
|
|
174
174
|
export type AiAlertTrigger = typeof AiAlertTrigger[keyof typeof AiAlertTrigger];
|
|
175
175
|
export interface AiAllTimeDateFilterBodyInput {
|
|
176
|
-
'dataset': AiAfmObjectIdentifier;
|
|
177
|
-
'granularity'?: AiDateGranularityInput | null;
|
|
178
176
|
'applyOnResult'?: boolean | null;
|
|
177
|
+
'dataset': AiAfmObjectIdentifier;
|
|
179
178
|
'emptyValueHandling'?: AiEmptyValueHandling | null;
|
|
179
|
+
'granularity'?: AiDateGranularityInput | null;
|
|
180
180
|
'localIdentifier'?: string | null;
|
|
181
181
|
}
|
|
182
182
|
export interface AiAllTimeDateFilterBodyOutput {
|
|
183
|
-
'dataset': AiAfmObjectIdentifier;
|
|
184
|
-
'granularity'?: AiAppApplicationDtosAfmFilterDefinitionDateGranularity | null;
|
|
185
183
|
'applyOnResult'?: boolean | null;
|
|
184
|
+
'dataset': AiAfmObjectIdentifier;
|
|
186
185
|
'emptyValueHandling'?: AiEmptyValueHandling | null;
|
|
186
|
+
'granularity'?: AiAppApplicationDtosAfmFilterDefinitionDateGranularity | null;
|
|
187
187
|
'localIdentifier'?: string | null;
|
|
188
188
|
}
|
|
189
189
|
export interface AiAllTimeDateFilterInput {
|
|
@@ -193,9 +193,9 @@ export interface AiAllTimeDateFilterOutput {
|
|
|
193
193
|
'allTimeDateFilter': AiAllTimeDateFilterBodyOutput;
|
|
194
194
|
}
|
|
195
195
|
export interface AiAllowedRelationshipType {
|
|
196
|
+
'allowOrphans'?: boolean;
|
|
196
197
|
'sourceType': string;
|
|
197
198
|
'targetType': string;
|
|
198
|
-
'allowOrphans'?: boolean;
|
|
199
199
|
}
|
|
200
200
|
export interface AiAnomalyCondition {
|
|
201
201
|
/**
|
|
@@ -205,18 +205,18 @@ export interface AiAnomalyCondition {
|
|
|
205
205
|
}
|
|
206
206
|
export interface AiAnomalyDetection {
|
|
207
207
|
/**
|
|
208
|
-
*
|
|
208
|
+
* Date dataset used for anomaly detection.
|
|
209
209
|
*/
|
|
210
|
-
'
|
|
211
|
-
'sensitivity': AiSensitivity;
|
|
210
|
+
'dataset': AiAlertDatasetRef;
|
|
212
211
|
/**
|
|
213
212
|
* Time-based granularity of the analysis.
|
|
214
213
|
*/
|
|
215
214
|
'granularity': AiAnomalyDetectionGranularity;
|
|
216
215
|
/**
|
|
217
|
-
*
|
|
216
|
+
* Metric analyzed for anomalies.
|
|
218
217
|
*/
|
|
219
|
-
'
|
|
218
|
+
'measure': AiMetricOperand;
|
|
219
|
+
'sensitivity': AiSensitivity;
|
|
220
220
|
}
|
|
221
221
|
/**
|
|
222
222
|
* Time-based granularity supported by anomaly detection.
|
|
@@ -267,22 +267,22 @@ export declare const AiAppDomainConversationsVisualizationDateGranularity: {
|
|
|
267
267
|
};
|
|
268
268
|
export type AiAppDomainConversationsVisualizationDateGranularity = typeof AiAppDomainConversationsVisualizationDateGranularity[keyof typeof AiAppDomainConversationsVisualizationDateGranularity];
|
|
269
269
|
export interface AiAppDomainConversationsVisualizationRankingFilter {
|
|
270
|
-
'type': AiAppDomainConversationsVisualizationRankingFilterTypeEnum;
|
|
271
|
-
'using': string;
|
|
272
270
|
'attribute'?: string;
|
|
273
|
-
'top'?: number;
|
|
274
271
|
'bottom'?: number;
|
|
272
|
+
'top'?: number;
|
|
273
|
+
'type': AiAppDomainConversationsVisualizationRankingFilterTypeEnum;
|
|
274
|
+
'using': string;
|
|
275
275
|
}
|
|
276
276
|
export type AiAppDomainConversationsVisualizationRankingFilterTypeEnum = 'ranking_filter';
|
|
277
277
|
export interface AiArithmeticMeasure {
|
|
278
|
-
/**
|
|
279
|
-
* Arithmetic operator between the two metrics.
|
|
280
|
-
*/
|
|
281
|
-
'operator': AiArithmeticOperator;
|
|
282
278
|
/**
|
|
283
279
|
* First metric.
|
|
284
280
|
*/
|
|
285
281
|
'left': AiMetricOperand;
|
|
282
|
+
/**
|
|
283
|
+
* Arithmetic operator between the two metrics.
|
|
284
|
+
*/
|
|
285
|
+
'operator': AiArithmeticOperator;
|
|
286
286
|
/**
|
|
287
287
|
* Second metric.
|
|
288
288
|
*/
|
|
@@ -297,35 +297,35 @@ export declare const AiArithmeticOperator: {
|
|
|
297
297
|
};
|
|
298
298
|
export type AiArithmeticOperator = typeof AiArithmeticOperator[keyof typeof AiArithmeticOperator];
|
|
299
299
|
export interface AiAttributeFilter {
|
|
300
|
+
'state': AiAttributeFilterState;
|
|
300
301
|
'type': AiAttributeFilterTypeEnum;
|
|
301
302
|
'using': string;
|
|
302
|
-
'state': AiAttributeFilterState;
|
|
303
303
|
}
|
|
304
304
|
export type AiAttributeFilterTypeEnum = 'attribute_filter';
|
|
305
305
|
export interface AiAttributeFilterElements {
|
|
306
306
|
'values': Array<string | null>;
|
|
307
307
|
}
|
|
308
308
|
export interface AiAttributeFilterState {
|
|
309
|
-
'include'?: Array<string>;
|
|
310
309
|
'exclude'?: Array<string>;
|
|
310
|
+
'include'?: Array<string>;
|
|
311
311
|
}
|
|
312
312
|
export interface AiAttributeSortItem {
|
|
313
|
-
'
|
|
313
|
+
'aggregation'?: AiAttributeSortItemAggregationEnum;
|
|
314
314
|
'by': string;
|
|
315
315
|
'direction': AiAttributeSortItemDirectionEnum;
|
|
316
|
-
'
|
|
316
|
+
'type': AiAttributeSortItemTypeEnum;
|
|
317
317
|
}
|
|
318
|
-
export type AiAttributeSortItemTypeEnum = 'attribute_sort';
|
|
319
|
-
export type AiAttributeSortItemDirectionEnum = 'ASC' | 'DESC';
|
|
320
318
|
export type AiAttributeSortItemAggregationEnum = 'SUM';
|
|
319
|
+
export type AiAttributeSortItemDirectionEnum = 'ASC' | 'DESC';
|
|
320
|
+
export type AiAttributeSortItemTypeEnum = 'attribute_sort';
|
|
321
321
|
export interface AiBoundedFilterInput {
|
|
322
|
-
'granularity': AiDateGranularityInput;
|
|
323
322
|
'from'?: number | null;
|
|
323
|
+
'granularity': AiDateGranularityInput;
|
|
324
324
|
'to'?: number | null;
|
|
325
325
|
}
|
|
326
326
|
export interface AiBoundedFilterOutput {
|
|
327
|
-
'granularity': AiAppApplicationDtosAfmFilterDefinitionDateGranularity;
|
|
328
327
|
'from'?: number | null;
|
|
328
|
+
'granularity': AiAppApplicationDtosAfmFilterDefinitionDateGranularity;
|
|
329
329
|
'to'?: number | null;
|
|
330
330
|
}
|
|
331
331
|
export interface AiBucketRefObject {
|
|
@@ -334,14 +334,14 @@ export interface AiBucketRefObject {
|
|
|
334
334
|
export interface AiClusteringAmount {
|
|
335
335
|
}
|
|
336
336
|
export interface AiComparison {
|
|
337
|
-
/**
|
|
338
|
-
* Comparison operator.
|
|
339
|
-
*/
|
|
340
|
-
'operator': AiComparisonConditionOperator;
|
|
341
337
|
/**
|
|
342
338
|
* Metric being compared.
|
|
343
339
|
*/
|
|
344
340
|
'left': AiMetricOperand;
|
|
341
|
+
/**
|
|
342
|
+
* Comparison operator.
|
|
343
|
+
*/
|
|
344
|
+
'operator': AiComparisonConditionOperator;
|
|
345
345
|
'right': AiRight;
|
|
346
346
|
}
|
|
347
347
|
export interface AiComparisonCondition {
|
|
@@ -366,13 +366,13 @@ export interface AiComparisonMeasureValueFilter {
|
|
|
366
366
|
'comparisonMeasureValueFilter': AiComparisonMeasureValueFilterBody;
|
|
367
367
|
}
|
|
368
368
|
export interface AiComparisonMeasureValueFilterBody {
|
|
369
|
+
'applyOnResult'?: boolean | null;
|
|
370
|
+
'dimensionality'?: Array<AiComparisonMeasureValueFilterBodyDimensionalityInner> | null;
|
|
371
|
+
'localIdentifier'?: string | null;
|
|
369
372
|
'measure': AiMeasure;
|
|
370
373
|
'operator': AiComparisonMeasureValueOperator;
|
|
371
|
-
'value': number;
|
|
372
374
|
'treatNullValuesAs'?: number | null;
|
|
373
|
-
'
|
|
374
|
-
'applyOnResult'?: boolean | null;
|
|
375
|
-
'localIdentifier'?: string | null;
|
|
375
|
+
'value': number;
|
|
376
376
|
}
|
|
377
377
|
export interface AiComparisonMeasureValueFilterBodyDimensionalityInner {
|
|
378
378
|
'identifier': AiAfmObjectIdentifierBody;
|
|
@@ -391,17 +391,21 @@ export interface AiCompoundMeasureValueFilter {
|
|
|
391
391
|
'compoundMeasureValueFilter': AiCompoundMeasureValueFilterBody;
|
|
392
392
|
}
|
|
393
393
|
export interface AiCompoundMeasureValueFilterBody {
|
|
394
|
-
'measure': AiMeasure;
|
|
395
|
-
'conditions': Array<AiCompoundMeasureValueFilterBodyConditionsInner>;
|
|
396
|
-
'treatNullValuesAs'?: number | null;
|
|
397
|
-
'dimensionality'?: Array<AiComparisonMeasureValueFilterBodyDimensionalityInner> | null;
|
|
398
394
|
'applyOnResult'?: boolean | null;
|
|
395
|
+
'conditions': Array<AiCompoundMeasureValueFilterBodyConditionsInner>;
|
|
396
|
+
'dimensionality'?: Array<AiCompoundMeasureValueFilterBodyDimensionalityInner> | null;
|
|
399
397
|
'localIdentifier'?: string | null;
|
|
398
|
+
'measure': AiMeasure1;
|
|
399
|
+
'treatNullValuesAs'?: number | null;
|
|
400
400
|
}
|
|
401
401
|
export interface AiCompoundMeasureValueFilterBodyConditionsInner {
|
|
402
402
|
'comparison': AiMeasureValueComparisonInner;
|
|
403
403
|
'range': AiMeasureValueRangeInner;
|
|
404
404
|
}
|
|
405
|
+
export interface AiCompoundMeasureValueFilterBodyDimensionalityInner {
|
|
406
|
+
'identifier': AiAfmObjectIdentifierBody;
|
|
407
|
+
'localIdentifier': string;
|
|
408
|
+
}
|
|
405
409
|
/**
|
|
406
410
|
* @type AiCondition
|
|
407
411
|
* Alert trigger condition.
|
|
@@ -423,8 +427,8 @@ export type AiContent = ({
|
|
|
423
427
|
type: 'toolResult';
|
|
424
428
|
} & AiFunctionResultContent);
|
|
425
429
|
export interface AiConversationFeedbackRequest {
|
|
426
|
-
'responseId': string;
|
|
427
430
|
'feedback': AiResponseFeedback | null;
|
|
431
|
+
'responseId': string;
|
|
428
432
|
}
|
|
429
433
|
/**
|
|
430
434
|
* Conversation item list response.
|
|
@@ -439,34 +443,34 @@ export interface AiConversationItemListResponse {
|
|
|
439
443
|
* Conversation item returned by the agentic HTTP API.
|
|
440
444
|
*/
|
|
441
445
|
export interface AiConversationItemResponse {
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
'itemId': string;
|
|
446
|
+
'actorUserId'?: string | null;
|
|
447
|
+
'agentId'?: string | null;
|
|
448
|
+
'content': AiContent;
|
|
446
449
|
/**
|
|
447
450
|
* Parent conversation identifier.
|
|
448
451
|
*/
|
|
449
452
|
'conversationId': string;
|
|
450
|
-
/**
|
|
451
|
-
* Zero-based item order within the response turn.
|
|
452
|
-
*/
|
|
453
|
-
'itemIndex': number;
|
|
454
453
|
/**
|
|
455
454
|
* Item creation timestamp (ISO-8601 UTC).
|
|
456
455
|
*/
|
|
457
456
|
'createdAt': string;
|
|
457
|
+
/**
|
|
458
|
+
* Conversation item identifier.
|
|
459
|
+
*/
|
|
460
|
+
'itemId': string;
|
|
461
|
+
/**
|
|
462
|
+
* Zero-based item order within the response turn.
|
|
463
|
+
*/
|
|
464
|
+
'itemIndex': number;
|
|
465
|
+
'newAgentId'?: string | null;
|
|
466
|
+
'oldAgentId'?: string | null;
|
|
467
|
+
'replyTo'?: string | null;
|
|
468
|
+
'responseId'?: string | null;
|
|
458
469
|
/**
|
|
459
470
|
* Author role of the item.
|
|
460
471
|
*/
|
|
461
472
|
'role': AiConversationItemResponseRoleEnum;
|
|
462
|
-
'content': AiContent;
|
|
463
|
-
'responseId'?: string | null;
|
|
464
|
-
'replyTo'?: string | null;
|
|
465
473
|
'taskId'?: string | null;
|
|
466
|
-
'agentId'?: string | null;
|
|
467
|
-
'oldAgentId'?: string | null;
|
|
468
|
-
'newAgentId'?: string | null;
|
|
469
|
-
'actorUserId'?: string | null;
|
|
470
474
|
'trigger'?: AiConversationItemResponseTriggerEnum | null;
|
|
471
475
|
}
|
|
472
476
|
export type AiConversationItemResponseRoleEnum = 'user' | 'assistant' | 'tool' | 'system';
|
|
@@ -496,40 +500,40 @@ export interface AiConversationListResponse {
|
|
|
496
500
|
* Conversation returned by the agentic HTTP API.
|
|
497
501
|
*/
|
|
498
502
|
export interface AiConversationResponse {
|
|
503
|
+
'agentId'?: string | null;
|
|
499
504
|
/**
|
|
500
505
|
* Conversation identifier.
|
|
501
506
|
*/
|
|
502
507
|
'conversationId': string;
|
|
503
508
|
/**
|
|
504
|
-
*
|
|
509
|
+
* Conversation creation timestamp (ISO-8601 UTC).
|
|
505
510
|
*/
|
|
506
|
-
'
|
|
511
|
+
'createdAt': string;
|
|
507
512
|
/**
|
|
508
|
-
*
|
|
513
|
+
* Whether this is a preview conversation.
|
|
509
514
|
*/
|
|
510
|
-
'
|
|
515
|
+
'isPreview'?: boolean;
|
|
511
516
|
/**
|
|
512
|
-
*
|
|
517
|
+
* Last activity timestamp (ISO-8601 UTC).
|
|
513
518
|
*/
|
|
514
|
-
'
|
|
515
|
-
'title'?: string | null;
|
|
519
|
+
'lastActivityAt': string;
|
|
516
520
|
/**
|
|
517
|
-
*
|
|
521
|
+
* Organization identifier.
|
|
518
522
|
*/
|
|
519
|
-
'
|
|
523
|
+
'organizationId': string;
|
|
520
524
|
/**
|
|
521
525
|
* Whether this conversation is pinned by the user.
|
|
522
526
|
*/
|
|
523
527
|
'pinned'?: boolean;
|
|
528
|
+
'title'?: string | null;
|
|
524
529
|
/**
|
|
525
|
-
*
|
|
530
|
+
* Owner user identifier.
|
|
526
531
|
*/
|
|
527
|
-
'
|
|
532
|
+
'userId': string;
|
|
528
533
|
/**
|
|
529
|
-
*
|
|
534
|
+
* Workspace identifier.
|
|
530
535
|
*/
|
|
531
|
-
'
|
|
532
|
-
'agentId'?: string | null;
|
|
536
|
+
'workspaceId': string;
|
|
533
537
|
}
|
|
534
538
|
export interface AiConversationResponseList {
|
|
535
539
|
/**
|
|
@@ -539,14 +543,14 @@ export interface AiConversationResponseList {
|
|
|
539
543
|
}
|
|
540
544
|
export interface AiConversationTurnResponse {
|
|
541
545
|
/**
|
|
542
|
-
* Response
|
|
546
|
+
* Response creation timestamp (ISO-8601 UTC).
|
|
543
547
|
*/
|
|
544
|
-
'
|
|
548
|
+
'createdAt': string;
|
|
545
549
|
'feedback'?: AiFeedback | null;
|
|
546
550
|
/**
|
|
547
|
-
* Response
|
|
551
|
+
* Response identifier.
|
|
548
552
|
*/
|
|
549
|
-
'
|
|
553
|
+
'responseId': string;
|
|
550
554
|
/**
|
|
551
555
|
* Response update timestamp (ISO-8601 UTC).
|
|
552
556
|
*/
|
|
@@ -556,8 +560,8 @@ export interface AiConversationTurnResponse {
|
|
|
556
560
|
* PATCH /conversations/{conversationId} body.
|
|
557
561
|
*/
|
|
558
562
|
export interface AiConversationUpdateRequest {
|
|
559
|
-
'title'?: string | null;
|
|
560
563
|
'pinned'?: boolean | null;
|
|
564
|
+
'title'?: string | null;
|
|
561
565
|
}
|
|
562
566
|
/**
|
|
563
567
|
* POST /conversations body.
|
|
@@ -569,22 +573,22 @@ export interface AiCreateConversationRequest {
|
|
|
569
573
|
* AAC ref: dashboard.json (PoC subset). The dashboard builder always emits the tabbed layout (``tabs``); ``sections`` is kept for compatibility with the AAC schema\'s flat (single-layout) form.
|
|
570
574
|
*/
|
|
571
575
|
export interface AiDashboard {
|
|
572
|
-
'type': AiDashboardTypeEnum;
|
|
573
|
-
'id': string;
|
|
574
|
-
'title': string;
|
|
575
576
|
'description'?: string;
|
|
576
|
-
'tabs'?: Array<AiDashboardTab>;
|
|
577
|
-
'sections'?: Array<AiDashboardSection>;
|
|
578
577
|
'filters'?: {
|
|
579
578
|
[key: string]: AiDashboardDateFilter;
|
|
580
579
|
};
|
|
580
|
+
'id': string;
|
|
581
|
+
'sections'?: Array<AiDashboardSection>;
|
|
582
|
+
'tabs'?: Array<AiDashboardTab>;
|
|
583
|
+
'title': string;
|
|
584
|
+
'type': AiDashboardTypeEnum;
|
|
581
585
|
}
|
|
582
586
|
export type AiDashboardTypeEnum = 'dashboard';
|
|
583
587
|
export interface AiDashboardDateFilter {
|
|
584
|
-
'type': AiDashboardDateFilterTypeEnum;
|
|
585
|
-
'granularity'?: AiAppDomainConversationsVisualizationDateGranularity;
|
|
586
588
|
'from'?: number;
|
|
589
|
+
'granularity'?: AiAppDomainConversationsVisualizationDateGranularity;
|
|
587
590
|
'to'?: number;
|
|
591
|
+
'type': AiDashboardDateFilterTypeEnum;
|
|
588
592
|
}
|
|
589
593
|
export type AiDashboardDateFilterTypeEnum = 'date_filter';
|
|
590
594
|
/**
|
|
@@ -594,12 +598,12 @@ export interface AiDashboardIdUpdateRequest {
|
|
|
594
598
|
'id': string;
|
|
595
599
|
}
|
|
596
600
|
export interface AiDashboardPart {
|
|
601
|
+
'dashboard'?: AiDashboard | null;
|
|
602
|
+
'savedDashboardId'?: string | null;
|
|
597
603
|
/**
|
|
598
604
|
* Type of multipart part.
|
|
599
605
|
*/
|
|
600
606
|
'type'?: AiDashboardPartTypeEnum;
|
|
601
|
-
'dashboard'?: AiDashboard | null;
|
|
602
|
-
'savedDashboardId'?: string | null;
|
|
603
607
|
}
|
|
604
608
|
export type AiDashboardPartTypeEnum = 'dashboard';
|
|
605
609
|
export interface AiDashboardRef {
|
|
@@ -613,35 +617,35 @@ export interface AiDashboardRef {
|
|
|
613
617
|
* AAC ref: dashboard.json section.
|
|
614
618
|
*/
|
|
615
619
|
export interface AiDashboardSection {
|
|
616
|
-
'title'?: string;
|
|
617
620
|
'description'?: string;
|
|
621
|
+
'title'?: string;
|
|
618
622
|
'widgets': Array<AiDashboardWidget>;
|
|
619
623
|
}
|
|
620
624
|
/**
|
|
621
625
|
* AAC ref: dashboard.json tab (the latest, tabbed dashboard layout). In the tabbed layout filters live on the tab, not on the dashboard root (the convertor treats tab-level and root-level filters as mutually exclusive).
|
|
622
626
|
*/
|
|
623
627
|
export interface AiDashboardTab {
|
|
624
|
-
'id': string;
|
|
625
|
-
'title': string;
|
|
626
|
-
'sections': Array<AiDashboardSection>;
|
|
627
628
|
'filters'?: {
|
|
628
629
|
[key: string]: AiDashboardDateFilter;
|
|
629
630
|
};
|
|
631
|
+
'id': string;
|
|
632
|
+
'sections': Array<AiDashboardSection>;
|
|
633
|
+
'title': string;
|
|
630
634
|
}
|
|
631
635
|
/**
|
|
632
636
|
* AAC ref: dashboard.json visualization widget (size hints in 12-column grid units).
|
|
633
637
|
*/
|
|
634
638
|
export interface AiDashboardWidget {
|
|
635
|
-
'visualization': string;
|
|
636
|
-
'title'?: string;
|
|
637
639
|
'columns'?: number;
|
|
638
640
|
'rows'?: number;
|
|
641
|
+
'title'?: string;
|
|
642
|
+
'visualization': string;
|
|
639
643
|
}
|
|
640
644
|
export interface AiDateFilterAbsolute {
|
|
641
|
-
'type': AiDateFilterAbsoluteTypeEnum;
|
|
642
|
-
'using': string;
|
|
643
645
|
'from': string;
|
|
644
646
|
'to': string;
|
|
647
|
+
'type': AiDateFilterAbsoluteTypeEnum;
|
|
648
|
+
'using': string;
|
|
645
649
|
}
|
|
646
650
|
export type AiDateFilterAbsoluteTypeEnum = 'date_filter';
|
|
647
651
|
export declare const AiDateFilterGranularity: {
|
|
@@ -663,11 +667,11 @@ export declare const AiDateFilterGranularity: {
|
|
|
663
667
|
};
|
|
664
668
|
export type AiDateFilterGranularity = typeof AiDateFilterGranularity[keyof typeof AiDateFilterGranularity];
|
|
665
669
|
export interface AiDateFilterRelative {
|
|
666
|
-
'type': AiDateFilterRelativeTypeEnum;
|
|
667
|
-
'using': string;
|
|
668
|
-
'granularity': AiAppDomainConversationsVisualizationDateGranularity;
|
|
669
670
|
'from': number;
|
|
671
|
+
'granularity': AiAppDomainConversationsVisualizationDateGranularity;
|
|
670
672
|
'to': number;
|
|
673
|
+
'type': AiDateFilterRelativeTypeEnum;
|
|
674
|
+
'using': string;
|
|
671
675
|
}
|
|
672
676
|
export type AiDateFilterRelativeTypeEnum = 'date_filter';
|
|
673
677
|
export declare const AiDateGranularityInput: {
|
|
@@ -696,24 +700,24 @@ export type AiDateGranularityInput = typeof AiDateGranularityInput[keyof typeof
|
|
|
696
700
|
* Response for DELETE /documents/{documentId}.
|
|
697
701
|
*/
|
|
698
702
|
export interface AiDeleteDocumentResponse {
|
|
699
|
-
'success': boolean;
|
|
700
703
|
'message': string;
|
|
704
|
+
'success': boolean;
|
|
701
705
|
}
|
|
702
706
|
/**
|
|
703
707
|
* Document metadata returned by GET /documents/{document_id} and list.
|
|
704
708
|
*/
|
|
705
709
|
export interface AiDocumentMetadataResponse {
|
|
706
|
-
'
|
|
710
|
+
'createdAt': string;
|
|
711
|
+
'createdBy': string;
|
|
707
712
|
'filename': string;
|
|
713
|
+
'id': string;
|
|
714
|
+
'isDisabled'?: boolean | null;
|
|
708
715
|
'numChunks': number;
|
|
709
|
-
'
|
|
716
|
+
'scopes': Array<string>;
|
|
717
|
+
'title'?: string | null;
|
|
710
718
|
'updatedAt': string;
|
|
711
|
-
'createdBy': string;
|
|
712
719
|
'updatedBy': string;
|
|
713
|
-
'scopes': Array<string>;
|
|
714
720
|
'workspaceId'?: string | null;
|
|
715
|
-
'title'?: string | null;
|
|
716
|
-
'isDisabled'?: boolean | null;
|
|
717
721
|
}
|
|
718
722
|
export declare const AiEmptyValueHandling: {
|
|
719
723
|
readonly INCLUDE: "INCLUDE";
|
|
@@ -722,36 +726,36 @@ export declare const AiEmptyValueHandling: {
|
|
|
722
726
|
};
|
|
723
727
|
export type AiEmptyValueHandling = typeof AiEmptyValueHandling[keyof typeof AiEmptyValueHandling];
|
|
724
728
|
export interface AiFeedback {
|
|
729
|
+
'text'?: string | null;
|
|
725
730
|
/**
|
|
726
731
|
* Feedback type.
|
|
727
732
|
*/
|
|
728
733
|
'type': AiFeedbackTypeEnum;
|
|
729
|
-
'text'?: string | null;
|
|
730
734
|
}
|
|
731
735
|
export type AiFeedbackTypeEnum = 'POSITIVE' | 'NEGATIVE';
|
|
732
736
|
export interface AiFieldsValue {
|
|
733
|
-
'using': string;
|
|
734
737
|
'aggregation'?: AiFieldsValueAggregationEnum;
|
|
735
738
|
'title'?: string;
|
|
739
|
+
'using': string;
|
|
736
740
|
'show_all_values'?: boolean;
|
|
737
741
|
}
|
|
738
742
|
export type AiFieldsValueAggregationEnum = 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'COUNT';
|
|
739
743
|
export interface AiFilterByValue {
|
|
744
|
+
'state': AiAttributeFilterState;
|
|
740
745
|
'type': AiFilterByValueTypeEnum;
|
|
741
746
|
'using': string;
|
|
742
|
-
'state': AiAttributeFilterState;
|
|
743
747
|
'from': AiFrom;
|
|
744
748
|
'to': AiTo;
|
|
745
749
|
'granularity': AiAppDomainConversationsVisualizationDateGranularity;
|
|
746
750
|
'attribute'?: string;
|
|
747
|
-
'top'?: number;
|
|
748
751
|
'bottom'?: number;
|
|
752
|
+
'top'?: number;
|
|
749
753
|
'condition': AiFilterByValueConditionEnum;
|
|
750
|
-
'value': string;
|
|
751
754
|
'null_values_as_zero'?: boolean;
|
|
752
|
-
'
|
|
755
|
+
'value': string;
|
|
753
756
|
'case_sensitive'?: boolean;
|
|
754
757
|
'display_as'?: string;
|
|
758
|
+
'values': Array<string>;
|
|
755
759
|
}
|
|
756
760
|
export type AiFilterByValueTypeEnum = 'attribute_filter' | 'date_filter' | 'ranking_filter' | 'metric_value_filter' | 'text_filter';
|
|
757
761
|
export type AiFilterByValueConditionEnum = 'contains' | 'doesNotContain' | 'startsWith' | 'doesNotStartWith' | 'endsWith' | 'doesNotEndWith';
|
|
@@ -759,34 +763,32 @@ export interface AiForecastPeriod {
|
|
|
759
763
|
}
|
|
760
764
|
export interface AiFrom {
|
|
761
765
|
}
|
|
766
|
+
export interface AiFrom1 {
|
|
767
|
+
}
|
|
762
768
|
export interface AiFunctionCallContent {
|
|
763
769
|
[key: string]: any;
|
|
764
770
|
/**
|
|
765
|
-
*
|
|
766
|
-
*/
|
|
767
|
-
'type'?: string;
|
|
768
|
-
/**
|
|
769
|
-
* Function call item identifier from LLM.
|
|
771
|
+
* Function/tool arguments payload.
|
|
770
772
|
*/
|
|
771
|
-
'
|
|
773
|
+
'arguments': object;
|
|
772
774
|
/**
|
|
773
775
|
* Function call correlation identifier.
|
|
774
776
|
*/
|
|
775
777
|
'callId': string;
|
|
778
|
+
/**
|
|
779
|
+
* Function call item identifier from LLM.
|
|
780
|
+
*/
|
|
781
|
+
'id': string;
|
|
776
782
|
/**
|
|
777
783
|
* Function/tool name.
|
|
778
784
|
*/
|
|
779
785
|
'name': string;
|
|
780
786
|
/**
|
|
781
|
-
*
|
|
787
|
+
* Type of item content.
|
|
782
788
|
*/
|
|
783
|
-
'
|
|
789
|
+
'type'?: string;
|
|
784
790
|
}
|
|
785
791
|
export interface AiFunctionResultContent {
|
|
786
|
-
/**
|
|
787
|
-
* Type of item content.
|
|
788
|
-
*/
|
|
789
|
-
'type'?: AiFunctionResultContentTypeEnum;
|
|
790
792
|
/**
|
|
791
793
|
* Function call correlation identifier.
|
|
792
794
|
*/
|
|
@@ -795,6 +797,10 @@ export interface AiFunctionResultContent {
|
|
|
795
797
|
* Serialized function/tool execution result.
|
|
796
798
|
*/
|
|
797
799
|
'result': string;
|
|
800
|
+
/**
|
|
801
|
+
* Type of item content.
|
|
802
|
+
*/
|
|
803
|
+
'type'?: AiFunctionResultContentTypeEnum;
|
|
798
804
|
}
|
|
799
805
|
export type AiFunctionResultContentTypeEnum = 'toolResult';
|
|
800
806
|
export interface AiHTTPValidationError {
|
|
@@ -804,8 +810,8 @@ export interface AiInlineFilterDefinition {
|
|
|
804
810
|
'inline': AiInlineFilterDefinitionBody;
|
|
805
811
|
}
|
|
806
812
|
export interface AiInlineFilterDefinitionBody {
|
|
807
|
-
'filter': string;
|
|
808
813
|
'applyOnResult'?: boolean | null;
|
|
814
|
+
'filter': string;
|
|
809
815
|
'localIdentifier'?: string | null;
|
|
810
816
|
}
|
|
811
817
|
/**
|
|
@@ -822,27 +828,28 @@ export type AiIntervalGranularity = typeof AiIntervalGranularity[keyof typeof Ai
|
|
|
822
828
|
export interface AiKeyDriverAnalysis {
|
|
823
829
|
[key: string]: any;
|
|
824
830
|
/**
|
|
825
|
-
*
|
|
831
|
+
* Analyzed period identifier.
|
|
826
832
|
*/
|
|
827
|
-
'
|
|
833
|
+
'analyzedPeriod': string;
|
|
828
834
|
/**
|
|
829
835
|
* Date attribute identifier used for period comparison.
|
|
830
836
|
*/
|
|
831
837
|
'dateAttributeId': string;
|
|
832
838
|
/**
|
|
833
|
-
*
|
|
839
|
+
* Filters applied to analysis.
|
|
834
840
|
*/
|
|
835
|
-
'
|
|
841
|
+
'filters': Array<object>;
|
|
836
842
|
/**
|
|
837
|
-
*
|
|
843
|
+
* Measure definition for key driver analysis.
|
|
838
844
|
*/
|
|
839
|
-
'
|
|
845
|
+
'measure': AiKeyDriverAnalysisMeasure;
|
|
840
846
|
/**
|
|
841
|
-
*
|
|
847
|
+
* Reference period identifier.
|
|
842
848
|
*/
|
|
843
|
-
'
|
|
849
|
+
'referencePeriod': string;
|
|
844
850
|
}
|
|
845
851
|
export interface AiKeyDriverAnalysisMeasure {
|
|
852
|
+
'aggregation'?: AiKeyDriverAnalysisMeasureAggregationEnum | null;
|
|
846
853
|
/**
|
|
847
854
|
* Measure object identifier.
|
|
848
855
|
*/
|
|
@@ -851,41 +858,48 @@ export interface AiKeyDriverAnalysisMeasure {
|
|
|
851
858
|
* Measure object type.
|
|
852
859
|
*/
|
|
853
860
|
'type': AiKeyDriverAnalysisMeasureTypeEnum;
|
|
854
|
-
'aggregation'?: AiKeyDriverAnalysisMeasureAggregationEnum | null;
|
|
855
861
|
}
|
|
856
|
-
export type AiKeyDriverAnalysisMeasureTypeEnum = 'metric' | 'fact' | 'attribute';
|
|
857
862
|
export type AiKeyDriverAnalysisMeasureAggregationEnum = 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'COUNT';
|
|
863
|
+
export type AiKeyDriverAnalysisMeasureTypeEnum = 'metric' | 'fact' | 'attribute';
|
|
858
864
|
export interface AiKeyDriverAnalysisPart {
|
|
865
|
+
'kda'?: AiKeyDriverAnalysis | null;
|
|
859
866
|
/**
|
|
860
867
|
* Type of multipart part.
|
|
861
868
|
*/
|
|
862
869
|
'type'?: AiKeyDriverAnalysisPartTypeEnum;
|
|
863
|
-
'kda'?: AiKeyDriverAnalysis | null;
|
|
864
870
|
}
|
|
865
871
|
export type AiKeyDriverAnalysisPartTypeEnum = 'kda';
|
|
866
872
|
export interface AiLabel {
|
|
867
873
|
'identifier': AiAfmObjectIdentifierBody;
|
|
868
874
|
'localIdentifier': string;
|
|
869
875
|
}
|
|
876
|
+
export interface AiLabel1 {
|
|
877
|
+
'identifier': AiAfmObjectIdentifierBody;
|
|
878
|
+
'localIdentifier': string;
|
|
879
|
+
}
|
|
880
|
+
export interface AiLabel2 {
|
|
881
|
+
'identifier': AiAfmObjectIdentifierBody;
|
|
882
|
+
'localIdentifier': string;
|
|
883
|
+
}
|
|
870
884
|
/**
|
|
871
885
|
* Response for GET /documents.
|
|
872
886
|
*/
|
|
873
887
|
export interface AiListDocumentsResponse {
|
|
874
888
|
'documents': Array<AiDocumentMetadataResponse>;
|
|
875
|
-
'totalCount'?: number | null;
|
|
876
889
|
'nextPageToken'?: string | null;
|
|
890
|
+
'totalCount'?: number | null;
|
|
877
891
|
}
|
|
878
892
|
export interface AiMatchAttributeFilter {
|
|
879
893
|
'matchAttributeFilter': AiMatchAttributeFilterBody;
|
|
880
894
|
}
|
|
881
895
|
export interface AiMatchAttributeFilterBody {
|
|
896
|
+
'applyOnResult'?: boolean | null;
|
|
897
|
+
'caseSensitive'?: boolean;
|
|
882
898
|
'label': AiLabel;
|
|
883
899
|
'literal': string;
|
|
900
|
+
'localIdentifier'?: string | null;
|
|
884
901
|
'matchType': AiMatchType;
|
|
885
|
-
'caseSensitive'?: boolean;
|
|
886
902
|
'negate'?: boolean;
|
|
887
|
-
'applyOnResult'?: boolean | null;
|
|
888
|
-
'localIdentifier'?: string | null;
|
|
889
903
|
}
|
|
890
904
|
export declare const AiMatchType: {
|
|
891
905
|
readonly STARTS_WITH: "STARTS_WITH";
|
|
@@ -897,6 +911,14 @@ export interface AiMeasure {
|
|
|
897
911
|
'identifier': AiAfmObjectIdentifierBody;
|
|
898
912
|
'localIdentifier': string;
|
|
899
913
|
}
|
|
914
|
+
export interface AiMeasure1 {
|
|
915
|
+
'identifier': AiAfmObjectIdentifierBody;
|
|
916
|
+
'localIdentifier': string;
|
|
917
|
+
}
|
|
918
|
+
export interface AiMeasure2 {
|
|
919
|
+
'identifier': AiAfmObjectIdentifierBody;
|
|
920
|
+
'localIdentifier': string;
|
|
921
|
+
}
|
|
900
922
|
/**
|
|
901
923
|
* Comparison branch of a compound measure value condition: ``{\"comparison\": {...}}``.
|
|
902
924
|
*/
|
|
@@ -914,28 +936,28 @@ export interface AiMeasureValueRangeCondition {
|
|
|
914
936
|
'range': AiMeasureValueRangeInner;
|
|
915
937
|
}
|
|
916
938
|
export interface AiMeasureValueRangeInner {
|
|
917
|
-
'operator': AiRangeMeasureValueOperator;
|
|
918
939
|
'from': number;
|
|
940
|
+
'operator': AiRangeMeasureValueOperator;
|
|
919
941
|
'to': number;
|
|
920
942
|
}
|
|
921
943
|
/**
|
|
922
944
|
* Reference to a metric by AFM local identifier.
|
|
923
945
|
*/
|
|
924
946
|
export interface AiMetricOperand {
|
|
947
|
+
'format'?: string | null;
|
|
925
948
|
/**
|
|
926
949
|
* Local identifier of the metric to be compared.
|
|
927
950
|
*/
|
|
928
951
|
'localIdentifier': string;
|
|
929
|
-
'format'?: string | null;
|
|
930
952
|
'title'?: string | null;
|
|
931
953
|
}
|
|
932
954
|
export interface AiMetricSortItem {
|
|
933
|
-
'type': AiMetricSortItemTypeEnum;
|
|
934
955
|
'direction': AiMetricSortItemDirectionEnum;
|
|
935
956
|
'metrics': Array<AiMetricSortItemMetricsInner>;
|
|
957
|
+
'type': AiMetricSortItemTypeEnum;
|
|
936
958
|
}
|
|
937
|
-
export type AiMetricSortItemTypeEnum = 'metric_sort';
|
|
938
959
|
export type AiMetricSortItemDirectionEnum = 'ASC' | 'DESC';
|
|
960
|
+
export type AiMetricSortItemTypeEnum = 'metric_sort';
|
|
939
961
|
export interface AiMetricSortItemMetricsInner {
|
|
940
962
|
'by': string;
|
|
941
963
|
'element'?: string;
|
|
@@ -947,20 +969,20 @@ export interface AiMetricSortLocatorItem {
|
|
|
947
969
|
'function'?: string;
|
|
948
970
|
}
|
|
949
971
|
export interface AiMetricUsageResponse {
|
|
950
|
-
'type': AiObservabilityMetricType;
|
|
951
972
|
'currentValue': number;
|
|
952
973
|
'previousValue': number;
|
|
953
974
|
'total'?: number | null;
|
|
975
|
+
'type': AiObservabilityMetricType;
|
|
954
976
|
}
|
|
955
977
|
export interface AiMetricValueComparisonFilter {
|
|
978
|
+
'condition': AiMetricValueComparisonFilterConditionEnum;
|
|
979
|
+
'null_values_as_zero'?: boolean;
|
|
956
980
|
'type': AiMetricValueComparisonFilterTypeEnum;
|
|
957
981
|
'using': string;
|
|
958
|
-
'condition': AiMetricValueComparisonFilterConditionEnum;
|
|
959
982
|
'value': AiValue;
|
|
960
|
-
'null_values_as_zero'?: boolean;
|
|
961
983
|
}
|
|
962
|
-
export type AiMetricValueComparisonFilterTypeEnum = 'metric_value_filter';
|
|
963
984
|
export type AiMetricValueComparisonFilterConditionEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
985
|
+
export type AiMetricValueComparisonFilterTypeEnum = 'metric_value_filter';
|
|
964
986
|
export declare const AiMetricValueFilterConditionComparison: {
|
|
965
987
|
readonly GREATER_THAN: "GREATER_THAN";
|
|
966
988
|
readonly GREATER_THAN_OR_EQUAL_TO: "GREATER_THAN_OR_EQUAL_TO";
|
|
@@ -976,25 +998,25 @@ export declare const AiMetricValueFilterConditionRange: {
|
|
|
976
998
|
};
|
|
977
999
|
export type AiMetricValueFilterConditionRange = typeof AiMetricValueFilterConditionRange[keyof typeof AiMetricValueFilterConditionRange];
|
|
978
1000
|
export interface AiMetricValueRangeFilter {
|
|
979
|
-
'type': AiMetricValueRangeFilterTypeEnum;
|
|
980
|
-
'using': string;
|
|
981
1001
|
'condition': AiMetricValueRangeFilterConditionEnum;
|
|
982
1002
|
'from': AiFrom;
|
|
983
|
-
'to': AiTo;
|
|
984
1003
|
'null_values_as_zero'?: boolean;
|
|
1004
|
+
'to': AiTo;
|
|
1005
|
+
'type': AiMetricValueRangeFilterTypeEnum;
|
|
1006
|
+
'using': string;
|
|
985
1007
|
}
|
|
986
|
-
export type AiMetricValueRangeFilterTypeEnum = 'metric_value_filter';
|
|
987
1008
|
export type AiMetricValueRangeFilterConditionEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
1009
|
+
export type AiMetricValueRangeFilterTypeEnum = 'metric_value_filter';
|
|
988
1010
|
export interface AiMultipartContent {
|
|
989
|
-
/**
|
|
990
|
-
* Type of item content.
|
|
991
|
-
*/
|
|
992
|
-
'type'?: AiMultipartContentTypeEnum;
|
|
993
1011
|
/**
|
|
994
1012
|
* Ordered multipart content fragments.
|
|
995
1013
|
*/
|
|
996
1014
|
'parts': Array<AiMultipartContentPartsInner>;
|
|
997
1015
|
'suggestions'?: AiSuggestions | null;
|
|
1016
|
+
/**
|
|
1017
|
+
* Type of item content.
|
|
1018
|
+
*/
|
|
1019
|
+
'type'?: AiMultipartContentTypeEnum;
|
|
998
1020
|
}
|
|
999
1021
|
export type AiMultipartContentTypeEnum = 'multipart';
|
|
1000
1022
|
/**
|
|
@@ -1019,10 +1041,10 @@ export interface AiNegativeAttributeFilter {
|
|
|
1019
1041
|
'negativeAttributeFilter': AiNegativeAttributeFilterBody;
|
|
1020
1042
|
}
|
|
1021
1043
|
export interface AiNegativeAttributeFilterBody {
|
|
1022
|
-
'label': AiLabel;
|
|
1023
|
-
'notIn': AiAttributeFilterElements;
|
|
1024
1044
|
'applyOnResult'?: boolean | null;
|
|
1045
|
+
'label': AiLabel1;
|
|
1025
1046
|
'localIdentifier'?: string | null;
|
|
1047
|
+
'notIn': AiAttributeFilterElements;
|
|
1026
1048
|
'usesArbitraryValues'?: boolean | null;
|
|
1027
1049
|
}
|
|
1028
1050
|
export interface AiNotificationChannelRef {
|
|
@@ -1065,16 +1087,16 @@ export interface AiObservabilityOverviewResponse {
|
|
|
1065
1087
|
*/
|
|
1066
1088
|
export interface AiPatchDocumentRequest {
|
|
1067
1089
|
'isDisabled'?: boolean | null;
|
|
1068
|
-
'title'?: string | null;
|
|
1069
1090
|
'scopes'?: Array<string> | null;
|
|
1091
|
+
'title'?: string | null;
|
|
1070
1092
|
}
|
|
1071
1093
|
export interface AiPositiveAttributeFilter {
|
|
1072
1094
|
'positiveAttributeFilter': AiPositiveAttributeFilterBody;
|
|
1073
1095
|
}
|
|
1074
1096
|
export interface AiPositiveAttributeFilterBody {
|
|
1075
|
-
'label': AiLabel;
|
|
1076
|
-
'in': AiAttributeFilterElements;
|
|
1077
1097
|
'applyOnResult'?: boolean | null;
|
|
1098
|
+
'in': AiAttributeFilterElements;
|
|
1099
|
+
'label': AiLabel2;
|
|
1078
1100
|
'localIdentifier'?: string | null;
|
|
1079
1101
|
'usesArbitraryValues'?: boolean | null;
|
|
1080
1102
|
}
|
|
@@ -1088,42 +1110,42 @@ export interface AiQuery {
|
|
|
1088
1110
|
'sort_by'?: Array<AiQuerySortByInner>;
|
|
1089
1111
|
}
|
|
1090
1112
|
export interface AiQueryFieldAttribute {
|
|
1091
|
-
'using': string;
|
|
1092
|
-
'title'?: string;
|
|
1093
1113
|
'show_all_values'?: boolean;
|
|
1114
|
+
'title'?: string;
|
|
1115
|
+
'using': string;
|
|
1094
1116
|
}
|
|
1095
1117
|
/**
|
|
1096
1118
|
* Metric/fact/attribute measure field (attribute requires COUNT).
|
|
1097
1119
|
*/
|
|
1098
1120
|
export interface AiQueryFieldMeasure {
|
|
1099
|
-
'using': string;
|
|
1100
1121
|
'aggregation'?: AiQueryFieldMeasureAggregationEnum;
|
|
1101
1122
|
'title'?: string;
|
|
1123
|
+
'using': string;
|
|
1102
1124
|
}
|
|
1103
1125
|
export type AiQueryFieldMeasureAggregationEnum = 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'COUNT';
|
|
1104
1126
|
export interface AiQuerySortByInner {
|
|
1105
|
-
'
|
|
1127
|
+
'aggregation'?: AiQuerySortByInnerAggregationEnum;
|
|
1106
1128
|
'by': string;
|
|
1107
1129
|
'direction': AiQuerySortByInnerDirectionEnum;
|
|
1108
|
-
'
|
|
1130
|
+
'type': AiQuerySortByInnerTypeEnum;
|
|
1109
1131
|
'metrics': Array<AiMetricSortItemMetricsInner>;
|
|
1110
1132
|
}
|
|
1111
|
-
export type AiQuerySortByInnerTypeEnum = 'attribute_sort' | 'metric_sort';
|
|
1112
|
-
export type AiQuerySortByInnerDirectionEnum = 'ASC' | 'DESC';
|
|
1113
1133
|
export type AiQuerySortByInnerAggregationEnum = 'SUM';
|
|
1134
|
+
export type AiQuerySortByInnerDirectionEnum = 'ASC' | 'DESC';
|
|
1135
|
+
export type AiQuerySortByInnerTypeEnum = 'attribute_sort' | 'metric_sort';
|
|
1114
1136
|
export interface AiRange {
|
|
1115
1137
|
/**
|
|
1116
|
-
* Range
|
|
1138
|
+
* Range lower bound.
|
|
1117
1139
|
*/
|
|
1118
|
-
'
|
|
1140
|
+
'from': AiValueOperand;
|
|
1119
1141
|
/**
|
|
1120
1142
|
* Metric being compared.
|
|
1121
1143
|
*/
|
|
1122
1144
|
'measure': AiMetricOperand;
|
|
1123
1145
|
/**
|
|
1124
|
-
* Range
|
|
1146
|
+
* Range operator.
|
|
1125
1147
|
*/
|
|
1126
|
-
'
|
|
1148
|
+
'operator': AiRangeConditionOperator;
|
|
1127
1149
|
/**
|
|
1128
1150
|
* Range upper bound.
|
|
1129
1151
|
*/
|
|
@@ -1147,14 +1169,18 @@ export interface AiRangeMeasureValueFilter {
|
|
|
1147
1169
|
'rangeMeasureValueFilter': AiRangeMeasureValueFilterBody;
|
|
1148
1170
|
}
|
|
1149
1171
|
export interface AiRangeMeasureValueFilterBody {
|
|
1150
|
-
'
|
|
1151
|
-
'
|
|
1172
|
+
'applyOnResult'?: boolean | null;
|
|
1173
|
+
'dimensionality'?: Array<AiRangeMeasureValueFilterBodyDimensionalityInner> | null;
|
|
1152
1174
|
'from': number;
|
|
1175
|
+
'localIdentifier'?: string | null;
|
|
1176
|
+
'measure': AiMeasure2;
|
|
1177
|
+
'operator': AiRangeMeasureValueOperator;
|
|
1153
1178
|
'to': number;
|
|
1154
1179
|
'treatNullValuesAs'?: number | null;
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
'
|
|
1180
|
+
}
|
|
1181
|
+
export interface AiRangeMeasureValueFilterBodyDimensionalityInner {
|
|
1182
|
+
'identifier': AiAfmObjectIdentifierBody;
|
|
1183
|
+
'localIdentifier': string;
|
|
1158
1184
|
}
|
|
1159
1185
|
export declare const AiRangeMeasureValueOperator: {
|
|
1160
1186
|
readonly BETWEEN: "BETWEEN";
|
|
@@ -1162,12 +1188,20 @@ export declare const AiRangeMeasureValueOperator: {
|
|
|
1162
1188
|
};
|
|
1163
1189
|
export type AiRangeMeasureValueOperator = typeof AiRangeMeasureValueOperator[keyof typeof AiRangeMeasureValueOperator];
|
|
1164
1190
|
export interface AiRankingFilterBody {
|
|
1165
|
-
'measures': Array<AiComparisonMeasureValueFilterBodyDimensionalityInner>;
|
|
1166
|
-
'operator': AiRankingOperator;
|
|
1167
|
-
'value': number;
|
|
1168
|
-
'dimensionality'?: Array<AiComparisonMeasureValueFilterBodyDimensionalityInner> | null;
|
|
1169
1191
|
'applyOnResult'?: boolean | null;
|
|
1192
|
+
'dimensionality'?: Array<AiRankingFilterBodyDimensionalityInner> | null;
|
|
1170
1193
|
'localIdentifier'?: string | null;
|
|
1194
|
+
'measures': Array<AiRankingFilterBodyMeasuresInner>;
|
|
1195
|
+
'operator': AiRankingOperator;
|
|
1196
|
+
'value': number;
|
|
1197
|
+
}
|
|
1198
|
+
export interface AiRankingFilterBodyDimensionalityInner {
|
|
1199
|
+
'identifier': AiAfmObjectIdentifierBody;
|
|
1200
|
+
'localIdentifier': string;
|
|
1201
|
+
}
|
|
1202
|
+
export interface AiRankingFilterBodyMeasuresInner {
|
|
1203
|
+
'identifier': AiAfmObjectIdentifierBody;
|
|
1204
|
+
'localIdentifier': string;
|
|
1171
1205
|
}
|
|
1172
1206
|
export interface AiRankingFilterInput {
|
|
1173
1207
|
'rankingFilter': AiRankingFilterBody;
|
|
@@ -1178,25 +1212,25 @@ export declare const AiRankingOperator: {
|
|
|
1178
1212
|
};
|
|
1179
1213
|
export type AiRankingOperator = typeof AiRankingOperator[keyof typeof AiRankingOperator];
|
|
1180
1214
|
export interface AiReasoningContent {
|
|
1181
|
-
/**
|
|
1182
|
-
* Type of item content.
|
|
1183
|
-
*/
|
|
1184
|
-
'type'?: AiReasoningContentTypeEnum;
|
|
1185
1215
|
/**
|
|
1186
1216
|
* Reasoning summary intended for UI display.
|
|
1187
1217
|
*/
|
|
1188
1218
|
'summary': string;
|
|
1219
|
+
/**
|
|
1220
|
+
* Type of item content.
|
|
1221
|
+
*/
|
|
1222
|
+
'type'?: AiReasoningContentTypeEnum;
|
|
1189
1223
|
}
|
|
1190
1224
|
export type AiReasoningContentTypeEnum = 'reasoning';
|
|
1191
1225
|
export interface AiRelative {
|
|
1192
|
-
/**
|
|
1193
|
-
* Relative condition operator.
|
|
1194
|
-
*/
|
|
1195
|
-
'operator': AiRelativeConditionOperator;
|
|
1196
1226
|
/**
|
|
1197
1227
|
* Arithmetic combination of the two metrics.
|
|
1198
1228
|
*/
|
|
1199
1229
|
'measure': AiArithmeticMeasure;
|
|
1230
|
+
/**
|
|
1231
|
+
* Relative condition operator.
|
|
1232
|
+
*/
|
|
1233
|
+
'operator': AiRelativeConditionOperator;
|
|
1200
1234
|
/**
|
|
1201
1235
|
* Threshold the relative change is compared to.
|
|
1202
1236
|
*/
|
|
@@ -1218,24 +1252,24 @@ export declare const AiRelativeConditionOperator: {
|
|
|
1218
1252
|
};
|
|
1219
1253
|
export type AiRelativeConditionOperator = typeof AiRelativeConditionOperator[keyof typeof AiRelativeConditionOperator];
|
|
1220
1254
|
export interface AiRelativeDateFilterBodyInput {
|
|
1221
|
-
'dataset': AiAfmObjectIdentifier;
|
|
1222
|
-
'granularity': AiDateGranularityInput;
|
|
1223
|
-
'from': number;
|
|
1224
|
-
'to': number;
|
|
1225
1255
|
'applyOnResult'?: boolean | null;
|
|
1226
1256
|
'boundedFilter'?: AiBoundedFilterInput | null;
|
|
1257
|
+
'dataset': AiAfmObjectIdentifier;
|
|
1227
1258
|
'emptyValueHandling'?: AiEmptyValueHandling | null;
|
|
1259
|
+
'from': number;
|
|
1260
|
+
'granularity': AiDateGranularityInput;
|
|
1228
1261
|
'localIdentifier'?: string | null;
|
|
1262
|
+
'to': number;
|
|
1229
1263
|
}
|
|
1230
1264
|
export interface AiRelativeDateFilterBodyOutput {
|
|
1231
|
-
'dataset': AiAfmObjectIdentifier;
|
|
1232
|
-
'granularity': AiAppApplicationDtosAfmFilterDefinitionDateGranularity;
|
|
1233
|
-
'from': number;
|
|
1234
|
-
'to': number;
|
|
1235
1265
|
'applyOnResult'?: boolean | null;
|
|
1236
1266
|
'boundedFilter'?: AiBoundedFilterOutput | null;
|
|
1267
|
+
'dataset': AiAfmObjectIdentifier;
|
|
1237
1268
|
'emptyValueHandling'?: AiEmptyValueHandling | null;
|
|
1269
|
+
'from': number;
|
|
1270
|
+
'granularity': AiAppApplicationDtosAfmFilterDefinitionDateGranularity;
|
|
1238
1271
|
'localIdentifier'?: string | null;
|
|
1272
|
+
'to': number;
|
|
1239
1273
|
}
|
|
1240
1274
|
export interface AiRelativeDateFilterInput {
|
|
1241
1275
|
'relativeDateFilter': AiRelativeDateFilterBodyInput;
|
|
@@ -1243,9 +1277,15 @@ export interface AiRelativeDateFilterInput {
|
|
|
1243
1277
|
export interface AiRelativeDateFilterOutput {
|
|
1244
1278
|
'relativeDateFilter': AiRelativeDateFilterBodyOutput;
|
|
1245
1279
|
}
|
|
1280
|
+
export declare const AiRequestedReasoningEffort: {
|
|
1281
|
+
readonly LOW: "LOW";
|
|
1282
|
+
readonly MEDIUM: "MEDIUM";
|
|
1283
|
+
readonly HIGH: "HIGH";
|
|
1284
|
+
};
|
|
1285
|
+
export type AiRequestedReasoningEffort = typeof AiRequestedReasoningEffort[keyof typeof AiRequestedReasoningEffort];
|
|
1246
1286
|
export interface AiResponseFeedback {
|
|
1247
|
-
'type': AiResponseFeedbackTypeEnum;
|
|
1248
1287
|
'text'?: string | null;
|
|
1288
|
+
'type': AiResponseFeedbackTypeEnum;
|
|
1249
1289
|
}
|
|
1250
1290
|
export type AiResponseFeedbackTypeEnum = 'POSITIVE' | 'NEGATIVE';
|
|
1251
1291
|
export interface AiResponseFeedbackRequest {
|
|
@@ -1264,122 +1304,123 @@ export interface AiSearchDocumentsResponse {
|
|
|
1264
1304
|
'statistics': AiSearchStatistics;
|
|
1265
1305
|
}
|
|
1266
1306
|
export interface AiSearchObject {
|
|
1307
|
+
'certification'?: string | null;
|
|
1308
|
+
'certificationMessage'?: string | null;
|
|
1309
|
+
'createdAt'?: string | null;
|
|
1310
|
+
'datasetId'?: string | null;
|
|
1311
|
+
'datasetTitle'?: string | null;
|
|
1312
|
+
'datasetType'?: string | null;
|
|
1313
|
+
'description'?: string | null;
|
|
1267
1314
|
/**
|
|
1268
1315
|
* Object identifier.
|
|
1269
1316
|
*/
|
|
1270
1317
|
'id': string;
|
|
1318
|
+
'isHidden'?: boolean | null;
|
|
1319
|
+
'modifiedAt'?: string | null;
|
|
1271
1320
|
/**
|
|
1272
|
-
*
|
|
1273
|
-
*/
|
|
1274
|
-
'type': string;
|
|
1275
|
-
/**
|
|
1276
|
-
* Workspace identifier.
|
|
1321
|
+
* Search relevance score.
|
|
1277
1322
|
*/
|
|
1278
|
-
'
|
|
1323
|
+
'score': number;
|
|
1324
|
+
'tags'?: Array<string> | null;
|
|
1279
1325
|
/**
|
|
1280
1326
|
* Object title.
|
|
1281
1327
|
*/
|
|
1282
1328
|
'title': string;
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
'
|
|
1287
|
-
'datasetTitle'?: string | null;
|
|
1329
|
+
/**
|
|
1330
|
+
* Object type name.
|
|
1331
|
+
*/
|
|
1332
|
+
'type': string;
|
|
1288
1333
|
'visualizationUrl'?: string | null;
|
|
1289
|
-
'createdAt'?: string | null;
|
|
1290
|
-
'modifiedAt'?: string | null;
|
|
1291
|
-
'isHidden'?: boolean | null;
|
|
1292
1334
|
/**
|
|
1293
|
-
*
|
|
1335
|
+
* Workspace identifier.
|
|
1294
1336
|
*/
|
|
1295
|
-
'
|
|
1296
|
-
'certification'?: string | null;
|
|
1297
|
-
'certificationMessage'?: string | null;
|
|
1337
|
+
'workspaceId': string;
|
|
1298
1338
|
}
|
|
1299
1339
|
export interface AiSearchRelationship {
|
|
1300
|
-
/**
|
|
1301
|
-
* Workspace ID of the source object.
|
|
1302
|
-
*/
|
|
1303
|
-
'sourceWorkspaceId': string;
|
|
1304
1340
|
/**
|
|
1305
1341
|
* Source object identifier.
|
|
1306
1342
|
*/
|
|
1307
1343
|
'sourceId': string;
|
|
1308
|
-
/**
|
|
1309
|
-
* Source object type.
|
|
1310
|
-
*/
|
|
1311
|
-
'sourceType': string;
|
|
1312
1344
|
/**
|
|
1313
1345
|
* Source object title.
|
|
1314
1346
|
*/
|
|
1315
1347
|
'sourceTitle': string;
|
|
1316
1348
|
/**
|
|
1317
|
-
*
|
|
1349
|
+
* Source object type.
|
|
1318
1350
|
*/
|
|
1319
|
-
'
|
|
1351
|
+
'sourceType': string;
|
|
1352
|
+
/**
|
|
1353
|
+
* Workspace ID of the source object.
|
|
1354
|
+
*/
|
|
1355
|
+
'sourceWorkspaceId': string;
|
|
1320
1356
|
/**
|
|
1321
1357
|
* Target object identifier.
|
|
1322
1358
|
*/
|
|
1323
1359
|
'targetId': string;
|
|
1360
|
+
/**
|
|
1361
|
+
* Target object title.
|
|
1362
|
+
*/
|
|
1363
|
+
'targetTitle': string;
|
|
1324
1364
|
/**
|
|
1325
1365
|
* Target object type.
|
|
1326
1366
|
*/
|
|
1327
1367
|
'targetType': string;
|
|
1328
1368
|
/**
|
|
1329
|
-
*
|
|
1369
|
+
* Workspace ID of the target object.
|
|
1330
1370
|
*/
|
|
1331
|
-
'
|
|
1371
|
+
'targetWorkspaceId': string;
|
|
1332
1372
|
}
|
|
1333
1373
|
/**
|
|
1334
1374
|
* A single search result entry.
|
|
1335
1375
|
*/
|
|
1336
1376
|
export interface AiSearchResultItem {
|
|
1337
|
-
'
|
|
1338
|
-
'filename': string;
|
|
1377
|
+
'chunkIndex': number;
|
|
1339
1378
|
'content': string;
|
|
1379
|
+
'filename': string;
|
|
1380
|
+
'id': string;
|
|
1381
|
+
'pageNumbers': Array<number>;
|
|
1382
|
+
'scopes': Array<string>;
|
|
1340
1383
|
'score': number;
|
|
1341
|
-
'
|
|
1384
|
+
'title'?: string | null;
|
|
1342
1385
|
'totalChunks': number;
|
|
1343
|
-
'pageNumbers': Array<number>;
|
|
1344
1386
|
'workspaceId'?: string | null;
|
|
1345
|
-
'title'?: string | null;
|
|
1346
|
-
'scopes': Array<string>;
|
|
1347
1387
|
}
|
|
1348
1388
|
export interface AiSearchResults {
|
|
1349
1389
|
/**
|
|
1350
|
-
*
|
|
1390
|
+
* Keywords used in search query.
|
|
1351
1391
|
*/
|
|
1352
|
-
'
|
|
1392
|
+
'keywords': Array<string>;
|
|
1353
1393
|
/**
|
|
1354
1394
|
* Search result objects for widget rendering.
|
|
1355
1395
|
*/
|
|
1356
1396
|
'objects': Array<AiSearchObject>;
|
|
1397
|
+
'relationships'?: Array<AiSearchRelationship> | null;
|
|
1398
|
+
'requestedObjectType'?: string | null;
|
|
1357
1399
|
/**
|
|
1358
|
-
*
|
|
1400
|
+
* Type of multipart part.
|
|
1359
1401
|
*/
|
|
1360
|
-
'
|
|
1361
|
-
'requestedObjectType'?: string | null;
|
|
1362
|
-
'relationships'?: Array<AiSearchRelationship> | null;
|
|
1402
|
+
'type'?: AiSearchResultsTypeEnum;
|
|
1363
1403
|
}
|
|
1364
1404
|
export type AiSearchResultsTypeEnum = 'searchResults';
|
|
1365
1405
|
/**
|
|
1366
1406
|
* Statistics about the search results.
|
|
1367
1407
|
*/
|
|
1368
1408
|
export interface AiSearchStatistics {
|
|
1369
|
-
'totalResults': number;
|
|
1370
1409
|
'averageSimilarityScore': number;
|
|
1410
|
+
'totalResults': number;
|
|
1371
1411
|
}
|
|
1372
1412
|
export interface AiSendMessageContent {
|
|
1373
|
-
'type': AiSendMessageContentTypeEnum;
|
|
1374
1413
|
'text': string;
|
|
1414
|
+
'type': AiSendMessageContentTypeEnum;
|
|
1375
1415
|
}
|
|
1376
1416
|
export type AiSendMessageContentTypeEnum = 'text';
|
|
1377
1417
|
export interface AiSendMessageItem {
|
|
1378
|
-
'role': AiSendMessageItemRoleEnum;
|
|
1379
1418
|
'content': AiSendMessageContent;
|
|
1419
|
+
'role': AiSendMessageItemRoleEnum;
|
|
1380
1420
|
}
|
|
1381
1421
|
export type AiSendMessageItemRoleEnum = 'user';
|
|
1382
1422
|
export interface AiSendMessageOptions {
|
|
1423
|
+
'reasoningEffort'?: AiRequestedReasoningEffort | null;
|
|
1383
1424
|
'search'?: AiSendMessageSearchOptions | null;
|
|
1384
1425
|
}
|
|
1385
1426
|
/**
|
|
@@ -1391,11 +1432,11 @@ export interface AiSendMessageRequest {
|
|
|
1391
1432
|
'userContext'?: AiUserContext | null;
|
|
1392
1433
|
}
|
|
1393
1434
|
export interface AiSendMessageSearchOptions {
|
|
1435
|
+
'allowedRelationshipTypes'?: Array<AiAllowedRelationshipType> | null;
|
|
1436
|
+
'excludeTags'?: Array<string> | null;
|
|
1437
|
+
'includeTags'?: Array<string> | null;
|
|
1394
1438
|
'objectTypes'?: Array<AiObjectType> | null;
|
|
1395
1439
|
'searchLimit'?: number | null;
|
|
1396
|
-
'includeTags'?: Array<string> | null;
|
|
1397
|
-
'excludeTags'?: Array<string> | null;
|
|
1398
|
-
'allowedRelationshipTypes'?: Array<AiAllowedRelationshipType> | null;
|
|
1399
1440
|
}
|
|
1400
1441
|
/**
|
|
1401
1442
|
* Sensitivity level for anomaly detection.
|
|
@@ -1410,11 +1451,11 @@ export type AiSensitivity = typeof AiSensitivity[keyof typeof AiSensitivity];
|
|
|
1410
1451
|
* A single skill available to the organization.
|
|
1411
1452
|
*/
|
|
1412
1453
|
export interface AiSkillResponse {
|
|
1413
|
-
'name': string;
|
|
1414
|
-
'title': string;
|
|
1415
1454
|
'description': string;
|
|
1416
|
-
'tags': Array<string>;
|
|
1417
1455
|
'examples': Array<string>;
|
|
1456
|
+
'name': string;
|
|
1457
|
+
'tags': Array<string>;
|
|
1458
|
+
'title': string;
|
|
1418
1459
|
}
|
|
1419
1460
|
/**
|
|
1420
1461
|
* A quick-reply action button rendered alongside the follow-up question.
|
|
@@ -1433,33 +1474,33 @@ export interface AiSuggestedAction {
|
|
|
1433
1474
|
* Follow-up suggestions emitted by the assistant alongside its terminal multipart message. Carried on the assistant ``MultipartContent`` so suggestions are persisted in conversation history and stream on the same SSE event as the response that produced them.
|
|
1434
1475
|
*/
|
|
1435
1476
|
export interface AiSuggestions {
|
|
1436
|
-
/**
|
|
1437
|
-
* Yes-answerable follow-up question recommending the next step.
|
|
1438
|
-
*/
|
|
1439
|
-
'followUpQuestion': string;
|
|
1440
1477
|
/**
|
|
1441
1478
|
* Quick-reply action buttons. The first action matches the follow-up question.
|
|
1442
1479
|
*/
|
|
1443
1480
|
'actions': Array<AiSuggestedAction>;
|
|
1481
|
+
/**
|
|
1482
|
+
* Yes-answerable follow-up question recommending the next step.
|
|
1483
|
+
*/
|
|
1484
|
+
'followUpQuestion': string;
|
|
1444
1485
|
}
|
|
1445
1486
|
export interface AiSummarizeRequest {
|
|
1446
|
-
'visualizations'?: Array<string> | null;
|
|
1447
|
-
'filterContext'?: Array<AiSummarizeRequestFilterContextInner> | null;
|
|
1448
1487
|
'dashboardId': string;
|
|
1449
|
-
'
|
|
1488
|
+
'filterContext'?: Array<AiSummarizeRequestFilterContextInner> | null;
|
|
1450
1489
|
'formatHint'?: string | null;
|
|
1490
|
+
'tabId'?: string | null;
|
|
1491
|
+
'visualizations'?: Array<string> | null;
|
|
1451
1492
|
}
|
|
1452
1493
|
/**
|
|
1453
1494
|
* @type AiSummarizeRequestFilterContextInner
|
|
1454
1495
|
*/
|
|
1455
1496
|
export type AiSummarizeRequestFilterContextInner = AiAbsoluteDateFilter | AiAllTimeDateFilterInput | AiComparisonMeasureValueFilter | AiCompoundMeasureValueFilter | AiInlineFilterDefinition | AiMatchAttributeFilter | AiNegativeAttributeFilter | AiPositiveAttributeFilter | AiRangeMeasureValueFilter | AiRankingFilterInput | AiRelativeDateFilterInput;
|
|
1456
1497
|
export interface AiSummarizeResponse {
|
|
1457
|
-
'summary': string;
|
|
1458
1498
|
'filterContext': Array<AiSummarizeResponseFilterContextInner>;
|
|
1459
|
-
'visualizationsIncluded': Array<AiVisualizationIncludedResponse>;
|
|
1460
|
-
'visualizationsExcluded': Array<AiVisualizationExcludedResponse>;
|
|
1461
1499
|
'generatedAt': string;
|
|
1500
|
+
'summary': string;
|
|
1462
1501
|
'tabId'?: string | null;
|
|
1502
|
+
'visualizationsExcluded': Array<AiVisualizationExcludedResponse>;
|
|
1503
|
+
'visualizationsIncluded': Array<AiVisualizationIncludedResponse>;
|
|
1463
1504
|
}
|
|
1464
1505
|
/**
|
|
1465
1506
|
* @type AiSummarizeResponseFilterContextInner
|
|
@@ -1472,82 +1513,85 @@ export interface AiSwitchAgentRequest {
|
|
|
1472
1513
|
'agentId': string;
|
|
1473
1514
|
}
|
|
1474
1515
|
export interface AiTextFilterValue {
|
|
1516
|
+
'case_sensitive'?: boolean;
|
|
1517
|
+
'condition': AiTextFilterValueConditionEnum;
|
|
1518
|
+
'display_as'?: string;
|
|
1475
1519
|
'type': AiTextFilterValueTypeEnum;
|
|
1476
1520
|
'using': string;
|
|
1477
|
-
'condition': AiTextFilterValueConditionEnum;
|
|
1478
1521
|
'value': string;
|
|
1479
|
-
'case_sensitive'?: boolean;
|
|
1480
|
-
'display_as'?: string;
|
|
1481
1522
|
}
|
|
1482
|
-
export type AiTextFilterValueTypeEnum = 'text_filter';
|
|
1483
1523
|
export type AiTextFilterValueConditionEnum = 'contains' | 'doesNotContain' | 'startsWith' | 'doesNotStartWith' | 'endsWith' | 'doesNotEndWith';
|
|
1524
|
+
export type AiTextFilterValueTypeEnum = 'text_filter';
|
|
1484
1525
|
export interface AiTextFilterValues {
|
|
1526
|
+
'case_sensitive'?: boolean;
|
|
1527
|
+
'condition': AiTextFilterValuesConditionEnum;
|
|
1528
|
+
'display_as'?: string;
|
|
1485
1529
|
'type': AiTextFilterValuesTypeEnum;
|
|
1486
1530
|
'using': string;
|
|
1487
|
-
'condition': AiTextFilterValuesConditionEnum;
|
|
1488
1531
|
'values': Array<string | null>;
|
|
1489
|
-
'case_sensitive'?: boolean;
|
|
1490
|
-
'display_as'?: string;
|
|
1491
1532
|
}
|
|
1492
|
-
export type AiTextFilterValuesTypeEnum = 'text_filter';
|
|
1493
1533
|
export type AiTextFilterValuesConditionEnum = 'is' | 'isNot';
|
|
1534
|
+
export type AiTextFilterValuesTypeEnum = 'text_filter';
|
|
1494
1535
|
export interface AiTextMessageContent {
|
|
1495
|
-
/**
|
|
1496
|
-
* Type of item content.
|
|
1497
|
-
*/
|
|
1498
|
-
'type'?: AiTextMessageContentTypeEnum;
|
|
1499
1536
|
/**
|
|
1500
1537
|
* Plain text message content.
|
|
1501
1538
|
*/
|
|
1502
1539
|
'text': string;
|
|
1540
|
+
/**
|
|
1541
|
+
* Type of item content.
|
|
1542
|
+
*/
|
|
1543
|
+
'type'?: AiTextMessageContentTypeEnum;
|
|
1503
1544
|
}
|
|
1504
1545
|
export type AiTextMessageContentTypeEnum = 'text';
|
|
1505
1546
|
export interface AiTextPart {
|
|
1506
|
-
/**
|
|
1507
|
-
* Type of multipart part.
|
|
1508
|
-
*/
|
|
1509
|
-
'type'?: AiTextPartTypeEnum;
|
|
1510
1547
|
/**
|
|
1511
1548
|
* Text fragment.
|
|
1512
1549
|
*/
|
|
1513
1550
|
'text': string;
|
|
1551
|
+
/**
|
|
1552
|
+
* Type of multipart part.
|
|
1553
|
+
*/
|
|
1554
|
+
'type'?: AiTextPartTypeEnum;
|
|
1514
1555
|
}
|
|
1515
1556
|
export type AiTextPartTypeEnum = 'text';
|
|
1516
1557
|
export interface AiTo {
|
|
1517
1558
|
}
|
|
1559
|
+
export interface AiTo1 {
|
|
1560
|
+
}
|
|
1518
1561
|
/**
|
|
1519
1562
|
* Response for POST/PUT /documents.
|
|
1520
1563
|
*/
|
|
1521
1564
|
export interface AiUploadDocumentResponse {
|
|
1522
|
-
'id': string;
|
|
1523
1565
|
'filename': string;
|
|
1524
|
-
'
|
|
1566
|
+
'id': string;
|
|
1525
1567
|
'message': string;
|
|
1526
1568
|
'numChunks': number;
|
|
1569
|
+
'success': boolean;
|
|
1527
1570
|
}
|
|
1528
1571
|
export interface AiUserContext {
|
|
1529
|
-
'view'?: AiUserContextView | null;
|
|
1530
|
-
'referencedObjects'?: Array<AiUserContextObjectReferenceGroup> | null;
|
|
1531
1572
|
'activeObject'?: AiActiveObjectIdentification | null;
|
|
1573
|
+
'referencedObjects'?: Array<AiUserContextObjectReferenceGroup> | null;
|
|
1574
|
+
'view'?: AiUserContextView | null;
|
|
1532
1575
|
}
|
|
1533
1576
|
export interface AiUserContextDashboard {
|
|
1577
|
+
'filters'?: Array<AiVisualizationFilter> | null;
|
|
1534
1578
|
'id': string;
|
|
1535
1579
|
'title'?: string | null;
|
|
1536
1580
|
'widgets'?: Array<AiUserContextWidgetDescriptor>;
|
|
1537
|
-
'filters'?: Array<AiVisualizationFilter> | null;
|
|
1538
1581
|
}
|
|
1539
1582
|
export interface AiUserContextInsightWidgetDescriptor {
|
|
1540
|
-
'widgetId': string;
|
|
1541
|
-
'title': string;
|
|
1542
1583
|
'filters'?: Array<AiVisualizationFilter> | null;
|
|
1543
|
-
'widgetType': AiUserContextInsightWidgetDescriptorWidgetTypeEnum;
|
|
1544
1584
|
'resultId'?: string | null;
|
|
1585
|
+
'title': string;
|
|
1545
1586
|
'visualizationId': string;
|
|
1587
|
+
'widgetId': string;
|
|
1588
|
+
'widgetType': AiUserContextInsightWidgetDescriptorWidgetTypeEnum;
|
|
1546
1589
|
}
|
|
1547
1590
|
export type AiUserContextInsightWidgetDescriptorWidgetTypeEnum = 'insight';
|
|
1548
1591
|
export interface AiUserContextObjectReference {
|
|
1549
|
-
'type': AiUserContextObjectReferenceTypeEnum;
|
|
1550
1592
|
'id': string;
|
|
1593
|
+
'title'?: string | null;
|
|
1594
|
+
'type': AiUserContextObjectReferenceTypeEnum;
|
|
1551
1595
|
}
|
|
1552
1596
|
export type AiUserContextObjectReferenceTypeEnum = 'WIDGET' | 'METRIC' | 'ATTRIBUTE' | 'DASHBOARD' | 'FACT';
|
|
1553
1597
|
export interface AiUserContextObjectReferenceGroup {
|
|
@@ -1555,44 +1599,44 @@ export interface AiUserContextObjectReferenceGroup {
|
|
|
1555
1599
|
'objects': Array<AiUserContextObjectReference>;
|
|
1556
1600
|
}
|
|
1557
1601
|
export interface AiUserContextRichTextWidgetDescriptor {
|
|
1558
|
-
'
|
|
1559
|
-
'title': string;
|
|
1602
|
+
'content'?: string | null;
|
|
1560
1603
|
'filters'?: Array<AiVisualizationFilter> | null;
|
|
1604
|
+
'title': string;
|
|
1605
|
+
'widgetId': string;
|
|
1561
1606
|
'widgetType': AiUserContextRichTextWidgetDescriptorWidgetTypeEnum;
|
|
1562
|
-
'content'?: string | null;
|
|
1563
1607
|
}
|
|
1564
1608
|
export type AiUserContextRichTextWidgetDescriptorWidgetTypeEnum = 'richText';
|
|
1565
1609
|
export interface AiUserContextView {
|
|
1566
1610
|
'dashboard'?: AiUserContextDashboard | null;
|
|
1567
1611
|
}
|
|
1568
1612
|
export interface AiUserContextVisualizationSwitcherWidgetDescriptor {
|
|
1569
|
-
'
|
|
1570
|
-
'title': string;
|
|
1613
|
+
'activeVisualizationId': string;
|
|
1571
1614
|
'filters'?: Array<AiVisualizationFilter> | null;
|
|
1572
|
-
'widgetType': AiUserContextVisualizationSwitcherWidgetDescriptorWidgetTypeEnum;
|
|
1573
1615
|
'resultId'?: string | null;
|
|
1574
|
-
'
|
|
1616
|
+
'title': string;
|
|
1575
1617
|
'visualizationIds'?: Array<string>;
|
|
1618
|
+
'widgetId': string;
|
|
1619
|
+
'widgetType': AiUserContextVisualizationSwitcherWidgetDescriptorWidgetTypeEnum;
|
|
1576
1620
|
}
|
|
1577
1621
|
export type AiUserContextVisualizationSwitcherWidgetDescriptorWidgetTypeEnum = 'visualizationSwitcher';
|
|
1578
1622
|
export interface AiUserContextWidgetDescriptor {
|
|
1579
|
-
'widgetId': string;
|
|
1580
|
-
'title': string;
|
|
1581
1623
|
'filters'?: Array<AiVisualizationFilter>;
|
|
1582
|
-
'widgetType': AiUserContextWidgetDescriptorWidgetTypeEnum;
|
|
1583
1624
|
'resultId'?: string;
|
|
1625
|
+
'title': string;
|
|
1584
1626
|
'visualizationId': string;
|
|
1627
|
+
'widgetId': string;
|
|
1628
|
+
'widgetType': AiUserContextWidgetDescriptorWidgetTypeEnum;
|
|
1585
1629
|
'content'?: string;
|
|
1586
1630
|
'activeVisualizationId': string;
|
|
1587
1631
|
'visualizationIds'?: Array<string>;
|
|
1588
1632
|
}
|
|
1589
1633
|
export type AiUserContextWidgetDescriptorWidgetTypeEnum = 'visualizationSwitcher';
|
|
1590
1634
|
export interface AiValidationError {
|
|
1635
|
+
'ctx'?: object;
|
|
1636
|
+
'input'?: any;
|
|
1591
1637
|
'loc': Array<AiValidationErrorLocInner>;
|
|
1592
1638
|
'msg': string;
|
|
1593
1639
|
'type': string;
|
|
1594
|
-
'input'?: any;
|
|
1595
|
-
'ctx'?: object;
|
|
1596
1640
|
}
|
|
1597
1641
|
export interface AiValidationErrorLocInner {
|
|
1598
1642
|
}
|
|
@@ -1603,6 +1647,8 @@ export interface AiValue {
|
|
|
1603
1647
|
*/
|
|
1604
1648
|
export interface AiValue1 {
|
|
1605
1649
|
}
|
|
1650
|
+
export interface AiValue2 {
|
|
1651
|
+
}
|
|
1606
1652
|
/**
|
|
1607
1653
|
* Literal threshold value.
|
|
1608
1654
|
*/
|
|
@@ -1610,62 +1656,62 @@ export interface AiValueOperand {
|
|
|
1610
1656
|
'value': AiValue1 | null;
|
|
1611
1657
|
}
|
|
1612
1658
|
export interface AiVisualization {
|
|
1613
|
-
'
|
|
1659
|
+
'config'?: AiVisualizationConfig;
|
|
1614
1660
|
'id': string;
|
|
1661
|
+
'metrics'?: Array<AiVisualizationMetricsInner>;
|
|
1615
1662
|
'query': AiQuery;
|
|
1663
|
+
'segment_by'?: Array<AiVisualizationSegmentByInner>;
|
|
1616
1664
|
'title'?: string;
|
|
1617
|
-
'
|
|
1618
|
-
'view_by'?: Array<
|
|
1619
|
-
'segment_by'?: Array<AiVisualizationMetricsInner>;
|
|
1620
|
-
'config'?: AiVisualizationConfig;
|
|
1665
|
+
'type': AiVisualizationTypeEnum;
|
|
1666
|
+
'view_by'?: Array<AiVisualizationViewByInner>;
|
|
1621
1667
|
}
|
|
1622
1668
|
export type AiVisualizationTypeEnum = 'table' | 'headline_chart' | 'bar_chart' | 'column_chart' | 'line_chart' | 'pie_chart' | 'scatter_chart';
|
|
1623
1669
|
export interface AiVisualizationAbsoluteDateFilter {
|
|
1624
|
-
'type': AiVisualizationAbsoluteDateFilterTypeEnum;
|
|
1625
|
-
'using'?: string | null;
|
|
1626
1670
|
'from': string;
|
|
1627
1671
|
'to': string;
|
|
1672
|
+
'type': AiVisualizationAbsoluteDateFilterTypeEnum;
|
|
1673
|
+
'using'?: string | null;
|
|
1628
1674
|
}
|
|
1629
1675
|
export type AiVisualizationAbsoluteDateFilterTypeEnum = 'date_filter';
|
|
1630
1676
|
export interface AiVisualizationAttributeFilter {
|
|
1677
|
+
'state': AiVisualizationAttributeFilterState;
|
|
1631
1678
|
'type': AiVisualizationAttributeFilterTypeEnum;
|
|
1632
1679
|
'using': string;
|
|
1633
|
-
'state': AiVisualizationAttributeFilterState;
|
|
1634
1680
|
}
|
|
1635
1681
|
export type AiVisualizationAttributeFilterTypeEnum = 'attribute_filter';
|
|
1636
1682
|
export interface AiVisualizationAttributeFilterState {
|
|
1637
|
-
'include'?: Array<string> | null;
|
|
1638
1683
|
'exclude'?: Array<string> | null;
|
|
1684
|
+
'include'?: Array<string> | null;
|
|
1639
1685
|
}
|
|
1640
1686
|
export interface AiVisualizationBottomRankingFilter {
|
|
1641
|
-
'type': AiVisualizationBottomRankingFilterTypeEnum;
|
|
1642
|
-
'using': string;
|
|
1643
1687
|
'attribute'?: string | null;
|
|
1644
1688
|
'bottom': number;
|
|
1689
|
+
'type': AiVisualizationBottomRankingFilterTypeEnum;
|
|
1690
|
+
'using': string;
|
|
1645
1691
|
}
|
|
1646
1692
|
export type AiVisualizationBottomRankingFilterTypeEnum = 'ranking_filter';
|
|
1647
1693
|
export interface AiVisualizationConfig {
|
|
1648
|
-
'
|
|
1649
|
-
'forecast_confidence'?: number;
|
|
1650
|
-
'forecast_period'?: AiForecastPeriod;
|
|
1651
|
-
'forecast_seasonal'?: boolean;
|
|
1652
|
-
'clustering_enabled'?: boolean;
|
|
1653
|
-
'clustering_amount'?: AiClusteringAmount;
|
|
1654
|
-
'clustering_threshold'?: number;
|
|
1694
|
+
'anomaly_detection_color'?: string;
|
|
1655
1695
|
'anomaly_detection_enabled'?: boolean;
|
|
1656
1696
|
'anomaly_detection_sensitivity'?: AiVisualizationConfigAnomalyDetectionSensitivityEnum;
|
|
1657
1697
|
'anomaly_detection_size'?: AiVisualizationConfigAnomalyDetectionSizeEnum;
|
|
1658
|
-
'
|
|
1698
|
+
'clustering_amount'?: AiClusteringAmount;
|
|
1699
|
+
'clustering_enabled'?: boolean;
|
|
1700
|
+
'clustering_threshold'?: number;
|
|
1659
1701
|
'disable_key_drive_analysis'?: {
|
|
1660
1702
|
[key: string]: boolean;
|
|
1661
1703
|
};
|
|
1704
|
+
'forecast_confidence'?: number;
|
|
1705
|
+
'forecast_enabled'?: boolean;
|
|
1706
|
+
'forecast_period'?: AiForecastPeriod;
|
|
1707
|
+
'forecast_seasonal'?: boolean;
|
|
1662
1708
|
}
|
|
1663
1709
|
export type AiVisualizationConfigAnomalyDetectionSensitivityEnum = 'low' | 'medium' | 'high';
|
|
1664
1710
|
export type AiVisualizationConfigAnomalyDetectionSizeEnum = 'small' | 'medium' | 'large';
|
|
1665
1711
|
export interface AiVisualizationExcludedResponse {
|
|
1666
|
-
'visualizationId': string;
|
|
1667
1712
|
'reason': string;
|
|
1668
1713
|
'title'?: string | null;
|
|
1714
|
+
'visualizationId': string;
|
|
1669
1715
|
}
|
|
1670
1716
|
/**
|
|
1671
1717
|
* @type AiVisualizationFilter
|
|
@@ -1678,24 +1724,24 @@ export interface AiVisualizationIdUpdateRequest {
|
|
|
1678
1724
|
'id': string;
|
|
1679
1725
|
}
|
|
1680
1726
|
export interface AiVisualizationIncludedResponse {
|
|
1681
|
-
'visualizationId': string;
|
|
1682
1727
|
'title'?: string | null;
|
|
1728
|
+
'visualizationId': string;
|
|
1683
1729
|
}
|
|
1684
1730
|
export interface AiVisualizationMetricValueComparisonFilter {
|
|
1685
|
-
'type': AiVisualizationMetricValueComparisonFilterTypeEnum;
|
|
1686
|
-
'using': string;
|
|
1687
1731
|
'condition': AiMetricValueFilterConditionComparison;
|
|
1688
|
-
'value': AiValue;
|
|
1689
1732
|
'nullValuesAsZero': boolean;
|
|
1733
|
+
'type': AiVisualizationMetricValueComparisonFilterTypeEnum;
|
|
1734
|
+
'using': string;
|
|
1735
|
+
'value': AiValue2;
|
|
1690
1736
|
}
|
|
1691
1737
|
export type AiVisualizationMetricValueComparisonFilterTypeEnum = 'metric_value_filter';
|
|
1692
1738
|
export interface AiVisualizationMetricValueRangeFilter {
|
|
1693
|
-
'type': AiVisualizationMetricValueRangeFilterTypeEnum;
|
|
1694
|
-
'using': string;
|
|
1695
1739
|
'condition': AiMetricValueFilterConditionRange;
|
|
1696
|
-
'from':
|
|
1697
|
-
'to': AiTo;
|
|
1740
|
+
'from': AiFrom1;
|
|
1698
1741
|
'nullValuesAsZero': boolean;
|
|
1742
|
+
'to': AiTo1;
|
|
1743
|
+
'type': AiVisualizationMetricValueRangeFilterTypeEnum;
|
|
1744
|
+
'using': string;
|
|
1699
1745
|
}
|
|
1700
1746
|
export type AiVisualizationMetricValueRangeFilterTypeEnum = 'metric_value_filter';
|
|
1701
1747
|
export interface AiVisualizationMetricsInner {
|
|
@@ -1710,20 +1756,26 @@ export interface AiVisualizationPart {
|
|
|
1710
1756
|
}
|
|
1711
1757
|
export type AiVisualizationPartTypeEnum = 'visualization';
|
|
1712
1758
|
export interface AiVisualizationRelativeDateFilter {
|
|
1713
|
-
'type': AiVisualizationRelativeDateFilterTypeEnum;
|
|
1714
|
-
'using'?: string | null;
|
|
1715
|
-
'granularity': AiDateFilterGranularity;
|
|
1716
1759
|
'from': number;
|
|
1760
|
+
'granularity': AiDateFilterGranularity;
|
|
1717
1761
|
'to': number;
|
|
1762
|
+
'type': AiVisualizationRelativeDateFilterTypeEnum;
|
|
1763
|
+
'using'?: string | null;
|
|
1718
1764
|
}
|
|
1719
1765
|
export type AiVisualizationRelativeDateFilterTypeEnum = 'date_filter';
|
|
1766
|
+
export interface AiVisualizationSegmentByInner {
|
|
1767
|
+
'field': string;
|
|
1768
|
+
}
|
|
1720
1769
|
export interface AiVisualizationTopRankingFilter {
|
|
1721
|
-
'type': AiVisualizationTopRankingFilterTypeEnum;
|
|
1722
|
-
'using': string;
|
|
1723
1770
|
'attribute'?: string | null;
|
|
1724
1771
|
'top': number;
|
|
1772
|
+
'type': AiVisualizationTopRankingFilterTypeEnum;
|
|
1773
|
+
'using': string;
|
|
1725
1774
|
}
|
|
1726
1775
|
export type AiVisualizationTopRankingFilterTypeEnum = 'ranking_filter';
|
|
1776
|
+
export interface AiVisualizationViewByInner {
|
|
1777
|
+
'field': string;
|
|
1778
|
+
}
|
|
1727
1779
|
export interface AiWhatIfAnalysisPart {
|
|
1728
1780
|
/**
|
|
1729
1781
|
* Type of multipart part.
|
|
@@ -1748,27 +1800,27 @@ export interface AiWhatIfMeasureAdjustment {
|
|
|
1748
1800
|
}
|
|
1749
1801
|
export interface AiWhatIfScenario {
|
|
1750
1802
|
/**
|
|
1751
|
-
*
|
|
1803
|
+
* Whether baseline values are included.
|
|
1752
1804
|
*/
|
|
1753
|
-
'
|
|
1805
|
+
'includeBaseline': boolean;
|
|
1754
1806
|
/**
|
|
1755
1807
|
* Defined what-if variants.
|
|
1756
1808
|
*/
|
|
1757
1809
|
'scenarios': Array<AiWhatIfScenarioVariant>;
|
|
1758
1810
|
/**
|
|
1759
|
-
*
|
|
1811
|
+
* Base visualization reference used by scenario.
|
|
1760
1812
|
*/
|
|
1761
|
-
'
|
|
1813
|
+
'visualizationRef': string;
|
|
1762
1814
|
}
|
|
1763
1815
|
export interface AiWhatIfScenarioVariant {
|
|
1764
|
-
/**
|
|
1765
|
-
* Scenario name.
|
|
1766
|
-
*/
|
|
1767
|
-
'label': string;
|
|
1768
1816
|
/**
|
|
1769
1817
|
* Scenario adjustments.
|
|
1770
1818
|
*/
|
|
1771
1819
|
'adjustments': Array<AiWhatIfMeasureAdjustment>;
|
|
1820
|
+
/**
|
|
1821
|
+
* Scenario name.
|
|
1822
|
+
*/
|
|
1823
|
+
'label': string;
|
|
1772
1824
|
}
|
|
1773
1825
|
/**
|
|
1774
1826
|
* Returns AI usage stats for the caller\'s organization for the current calendar month, alongside the previous month\'s value. Backed by the ai_usage_counters table populated by the metering pipeline.
|
|
@@ -2555,24 +2607,24 @@ export declare class ItemsAi extends BaseAPI implements ItemsAiInterface {
|
|
|
2555
2607
|
* @summary Upload Document
|
|
2556
2608
|
* @param {string} workspaceId
|
|
2557
2609
|
* @param {File} file
|
|
2558
|
-
* @param {string} [title]
|
|
2559
2610
|
* @param {Array<string>} [scopes]
|
|
2611
|
+
* @param {string} [title]
|
|
2560
2612
|
* @param {*} [options] Override http request option.
|
|
2561
2613
|
* @param {Configuration} [configuration] Optional configuration.
|
|
2562
2614
|
* @throws {RequiredError}
|
|
2563
2615
|
*/
|
|
2564
|
-
export declare function KnowledgeAiAxiosParamCreator_CreateDocument(workspaceId: string, file: File,
|
|
2616
|
+
export declare function KnowledgeAiAxiosParamCreator_CreateDocument(workspaceId: string, file: File, scopes?: Array<string>, title?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
2565
2617
|
/**
|
|
2566
2618
|
* Upload a new org-scoped knowledge document.
|
|
2567
2619
|
* @summary Upload Document Org
|
|
2568
2620
|
* @param {File} file
|
|
2569
|
-
* @param {string} [title]
|
|
2570
2621
|
* @param {Array<string>} [scopes]
|
|
2622
|
+
* @param {string} [title]
|
|
2571
2623
|
* @param {*} [options] Override http request option.
|
|
2572
2624
|
* @param {Configuration} [configuration] Optional configuration.
|
|
2573
2625
|
* @throws {RequiredError}
|
|
2574
2626
|
*/
|
|
2575
|
-
export declare function KnowledgeAiAxiosParamCreator_CreateOrgDocument(file: File,
|
|
2627
|
+
export declare function KnowledgeAiAxiosParamCreator_CreateOrgDocument(file: File, scopes?: Array<string>, title?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
2576
2628
|
/**
|
|
2577
2629
|
* Delete a knowledge document and all its chunks (local docs only).
|
|
2578
2630
|
* @summary Delete Document
|
|
@@ -2710,24 +2762,24 @@ export declare function KnowledgeAiAxiosParamCreator_SearchOrgKnowledge(query: s
|
|
|
2710
2762
|
* @summary Upsert Document
|
|
2711
2763
|
* @param {string} workspaceId
|
|
2712
2764
|
* @param {File} file
|
|
2713
|
-
* @param {string} [title]
|
|
2714
2765
|
* @param {Array<string>} [scopes]
|
|
2766
|
+
* @param {string} [title]
|
|
2715
2767
|
* @param {*} [options] Override http request option.
|
|
2716
2768
|
* @param {Configuration} [configuration] Optional configuration.
|
|
2717
2769
|
* @throws {RequiredError}
|
|
2718
2770
|
*/
|
|
2719
|
-
export declare function KnowledgeAiAxiosParamCreator_UpsertDocument(workspaceId: string, file: File,
|
|
2771
|
+
export declare function KnowledgeAiAxiosParamCreator_UpsertDocument(workspaceId: string, file: File, scopes?: Array<string>, title?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
2720
2772
|
/**
|
|
2721
2773
|
* Upload or replace an org-scoped knowledge document.
|
|
2722
2774
|
* @summary Upsert Document Org
|
|
2723
2775
|
* @param {File} file
|
|
2724
|
-
* @param {string} [title]
|
|
2725
2776
|
* @param {Array<string>} [scopes]
|
|
2777
|
+
* @param {string} [title]
|
|
2726
2778
|
* @param {*} [options] Override http request option.
|
|
2727
2779
|
* @param {Configuration} [configuration] Optional configuration.
|
|
2728
2780
|
* @throws {RequiredError}
|
|
2729
2781
|
*/
|
|
2730
|
-
export declare function KnowledgeAiAxiosParamCreator_UpsertOrgDocument(file: File,
|
|
2782
|
+
export declare function KnowledgeAiAxiosParamCreator_UpsertOrgDocument(file: File, scopes?: Array<string>, title?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
2731
2783
|
/**
|
|
2732
2784
|
* Upload a new knowledge document. Returns 409 if filename already exists.
|
|
2733
2785
|
* @summary Upload Document
|
|
@@ -3075,16 +3127,16 @@ export interface KnowledgeAiCreateDocumentRequest {
|
|
|
3075
3127
|
readonly file: File;
|
|
3076
3128
|
/**
|
|
3077
3129
|
*
|
|
3078
|
-
* @type {string}
|
|
3130
|
+
* @type {Array<string>}
|
|
3079
3131
|
* @memberof KnowledgeAiCreateDocument
|
|
3080
3132
|
*/
|
|
3081
|
-
readonly
|
|
3133
|
+
readonly scopes?: Array<string>;
|
|
3082
3134
|
/**
|
|
3083
3135
|
*
|
|
3084
|
-
* @type {
|
|
3136
|
+
* @type {string}
|
|
3085
3137
|
* @memberof KnowledgeAiCreateDocument
|
|
3086
3138
|
*/
|
|
3087
|
-
readonly
|
|
3139
|
+
readonly title?: string;
|
|
3088
3140
|
}
|
|
3089
3141
|
/**
|
|
3090
3142
|
* Request parameters for createOrgDocument operation in KnowledgeAi.
|
|
@@ -3100,16 +3152,16 @@ export interface KnowledgeAiCreateOrgDocumentRequest {
|
|
|
3100
3152
|
readonly file: File;
|
|
3101
3153
|
/**
|
|
3102
3154
|
*
|
|
3103
|
-
* @type {string}
|
|
3155
|
+
* @type {Array<string>}
|
|
3104
3156
|
* @memberof KnowledgeAiCreateOrgDocument
|
|
3105
3157
|
*/
|
|
3106
|
-
readonly
|
|
3158
|
+
readonly scopes?: Array<string>;
|
|
3107
3159
|
/**
|
|
3108
3160
|
*
|
|
3109
|
-
* @type {
|
|
3161
|
+
* @type {string}
|
|
3110
3162
|
* @memberof KnowledgeAiCreateOrgDocument
|
|
3111
3163
|
*/
|
|
3112
|
-
readonly
|
|
3164
|
+
readonly title?: string;
|
|
3113
3165
|
}
|
|
3114
3166
|
/**
|
|
3115
3167
|
* Request parameters for deleteDocument operation in KnowledgeAi.
|
|
@@ -3431,16 +3483,16 @@ export interface KnowledgeAiUpsertDocumentRequest {
|
|
|
3431
3483
|
readonly file: File;
|
|
3432
3484
|
/**
|
|
3433
3485
|
*
|
|
3434
|
-
* @type {string}
|
|
3486
|
+
* @type {Array<string>}
|
|
3435
3487
|
* @memberof KnowledgeAiUpsertDocument
|
|
3436
3488
|
*/
|
|
3437
|
-
readonly
|
|
3489
|
+
readonly scopes?: Array<string>;
|
|
3438
3490
|
/**
|
|
3439
3491
|
*
|
|
3440
|
-
* @type {
|
|
3492
|
+
* @type {string}
|
|
3441
3493
|
* @memberof KnowledgeAiUpsertDocument
|
|
3442
3494
|
*/
|
|
3443
|
-
readonly
|
|
3495
|
+
readonly title?: string;
|
|
3444
3496
|
}
|
|
3445
3497
|
/**
|
|
3446
3498
|
* Request parameters for upsertOrgDocument operation in KnowledgeAi.
|
|
@@ -3456,16 +3508,16 @@ export interface KnowledgeAiUpsertOrgDocumentRequest {
|
|
|
3456
3508
|
readonly file: File;
|
|
3457
3509
|
/**
|
|
3458
3510
|
*
|
|
3459
|
-
* @type {string}
|
|
3511
|
+
* @type {Array<string>}
|
|
3460
3512
|
* @memberof KnowledgeAiUpsertOrgDocument
|
|
3461
3513
|
*/
|
|
3462
|
-
readonly
|
|
3514
|
+
readonly scopes?: Array<string>;
|
|
3463
3515
|
/**
|
|
3464
3516
|
*
|
|
3465
|
-
* @type {
|
|
3517
|
+
* @type {string}
|
|
3466
3518
|
* @memberof KnowledgeAiUpsertOrgDocument
|
|
3467
3519
|
*/
|
|
3468
|
-
readonly
|
|
3520
|
+
readonly title?: string;
|
|
3469
3521
|
}
|
|
3470
3522
|
/**
|
|
3471
3523
|
* KnowledgeAi - object-oriented interface
|