@gooddata/api-client-tiger 11.28.0-alpha.0 → 11.28.0-alpha.2
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.js +1 -1
- package/esm/api-client-tiger.d.ts +678 -555
- package/esm/endpoints/actions/index.d.ts +1 -1
- package/esm/endpoints/actions/index.d.ts.map +1 -1
- package/esm/endpoints/actions/index.js +2 -6
- package/esm/endpoints/actions/index.js.map +1 -1
- package/esm/endpoints/genAI/index.d.ts +2 -2
- package/esm/endpoints/genAI/index.d.ts.map +1 -1
- package/esm/endpoints/genAI/index.js +4 -2
- package/esm/endpoints/genAI/index.js.map +1 -1
- package/esm/gd-tiger-model/TigerTypes.d.ts +1 -1
- package/esm/gd-tiger-model/TigerTypes.d.ts.map +1 -1
- package/esm/gd-tiger-model/typeGuards.d.ts.map +1 -1
- package/esm/gd-tiger-model/typeGuards.js +9 -1
- package/esm/gd-tiger-model/typeGuards.js.map +1 -1
- package/esm/gd-tiger-model/typeGuards.test.js +22 -1
- package/esm/gd-tiger-model/typeGuards.test.js.map +1 -1
- package/esm/generated/afm-rest-api/api.d.ts +0 -512
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +0 -505
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/index.js +1 -1
- package/esm/generated/afm-rest-api/index.js.map +1 -1
- package/esm/generated/ai-json-api/api.d.ts +613 -164
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +438 -48
- package/esm/generated/ai-json-api/api.js.map +1 -1
- package/esm/generated/auth-json-api/index.js +1 -1
- package/esm/generated/auth-json-api/index.js.map +1 -1
- package/esm/generated/automation-json-api/index.js +1 -1
- package/esm/generated/automation-json-api/index.js.map +1 -1
- package/esm/generated/export-json-api/index.js +1 -1
- package/esm/generated/export-json-api/index.js.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +8 -0
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/index.js +1 -1
- package/esm/generated/metadata-json-api/index.js.map +1 -1
- package/esm/generated/result-json-api/index.js +1 -1
- package/esm/generated/result-json-api/index.js.map +1 -1
- package/esm/generated/scan-json-api/index.js +1 -1
- package/esm/generated/scan-json-api/index.js.map +1 -1
- package/package.json +5 -5
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
import { Configuration } from './configuration.js';
|
|
13
13
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
14
|
import { RequestArgs, BaseAPI } from './base.js';
|
|
15
|
-
export interface
|
|
15
|
+
export interface AiAllowedRelationshipType {
|
|
16
16
|
'sourceType': string;
|
|
17
17
|
'targetType': string;
|
|
18
18
|
'allowOrphans'?: boolean;
|
|
@@ -38,28 +38,28 @@ export interface AiClusteringAmount {
|
|
|
38
38
|
*/
|
|
39
39
|
export type AiContent = ({
|
|
40
40
|
type: 'multipart';
|
|
41
|
-
} &
|
|
41
|
+
} & AiMultipartContent) | ({
|
|
42
42
|
type: 'reasoning';
|
|
43
|
-
} &
|
|
43
|
+
} & AiReasoningContent) | ({
|
|
44
44
|
type: 'text';
|
|
45
|
-
} &
|
|
45
|
+
} & AiTextMessageContent) | ({
|
|
46
46
|
type: 'toolCall';
|
|
47
|
-
} &
|
|
47
|
+
} & AiFunctionCallContent) | ({
|
|
48
48
|
type: 'toolResult';
|
|
49
|
-
} &
|
|
49
|
+
} & AiFunctionResultContent);
|
|
50
50
|
/**
|
|
51
51
|
* Conversation item list response.
|
|
52
52
|
*/
|
|
53
|
-
export interface
|
|
53
|
+
export interface AiConversationItemListResponse {
|
|
54
54
|
/**
|
|
55
55
|
* Ordered list of conversation items.
|
|
56
56
|
*/
|
|
57
|
-
'items': Array<
|
|
57
|
+
'items': Array<AiConversationItemResponse>;
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
60
|
* Conversation item returned by the agentic HTTP API.
|
|
61
61
|
*/
|
|
62
|
-
export interface
|
|
62
|
+
export interface AiConversationItemResponse {
|
|
63
63
|
/**
|
|
64
64
|
* Conversation item identifier.
|
|
65
65
|
*/
|
|
@@ -79,17 +79,17 @@ export interface AiConversationItemResponseDto {
|
|
|
79
79
|
/**
|
|
80
80
|
* Author role of the item.
|
|
81
81
|
*/
|
|
82
|
-
'role':
|
|
82
|
+
'role': AiConversationItemResponseRoleEnum;
|
|
83
83
|
'content': AiContent;
|
|
84
84
|
'responseId'?: string | null;
|
|
85
85
|
'replyTo'?: string | null;
|
|
86
86
|
'taskId'?: string | null;
|
|
87
87
|
}
|
|
88
|
-
export type
|
|
88
|
+
export type AiConversationItemResponseRoleEnum = 'user' | 'assistant' | 'tool';
|
|
89
89
|
/**
|
|
90
90
|
* Conversation returned by the agentic HTTP API.
|
|
91
91
|
*/
|
|
92
|
-
export interface
|
|
92
|
+
export interface AiConversationResponse {
|
|
93
93
|
/**
|
|
94
94
|
* Conversation identifier.
|
|
95
95
|
*/
|
|
@@ -115,18 +115,18 @@ export interface AiConversationResponseDto {
|
|
|
115
115
|
*/
|
|
116
116
|
'lastActivityAt': string;
|
|
117
117
|
}
|
|
118
|
-
export interface
|
|
118
|
+
export interface AiConversationResponseList {
|
|
119
119
|
/**
|
|
120
120
|
* Conversation responses.
|
|
121
121
|
*/
|
|
122
|
-
'responses': Array<
|
|
122
|
+
'responses': Array<AiConversationTurnResponse>;
|
|
123
123
|
}
|
|
124
|
-
export interface
|
|
124
|
+
export interface AiConversationTurnResponse {
|
|
125
125
|
/**
|
|
126
126
|
* Response identifier.
|
|
127
127
|
*/
|
|
128
128
|
'responseId': string;
|
|
129
|
-
'feedback'?:
|
|
129
|
+
'feedback'?: AiFeedback | null;
|
|
130
130
|
/**
|
|
131
131
|
* Response creation timestamp (ISO-8601 UTC).
|
|
132
132
|
*/
|
|
@@ -162,14 +162,37 @@ export declare const AiDateGranularity: {
|
|
|
162
162
|
readonly YEAR: "YEAR";
|
|
163
163
|
};
|
|
164
164
|
export type AiDateGranularity = typeof AiDateGranularity[keyof typeof AiDateGranularity];
|
|
165
|
-
|
|
165
|
+
/**
|
|
166
|
+
* Response for DELETE /documents/{documentId}.
|
|
167
|
+
*/
|
|
168
|
+
export interface AiDeleteDocumentResponse {
|
|
169
|
+
'success': boolean;
|
|
170
|
+
'message': string;
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* Document metadata returned by GET /documents/{document_id} and list.
|
|
174
|
+
*/
|
|
175
|
+
export interface AiDocumentMetadataResponse {
|
|
176
|
+
'id': string;
|
|
177
|
+
'filename': string;
|
|
178
|
+
'numChunks': number;
|
|
179
|
+
'createdAt': string;
|
|
180
|
+
'updatedAt': string;
|
|
181
|
+
'createdBy': string;
|
|
182
|
+
'updatedBy': string;
|
|
183
|
+
'scopes': Array<string>;
|
|
184
|
+
'workspaceId'?: string | null;
|
|
185
|
+
'title'?: string | null;
|
|
186
|
+
'isDisabled'?: boolean | null;
|
|
187
|
+
}
|
|
188
|
+
export interface AiFeedback {
|
|
166
189
|
/**
|
|
167
190
|
* Feedback type.
|
|
168
191
|
*/
|
|
169
|
-
'type':
|
|
192
|
+
'type': AiFeedbackTypeEnum;
|
|
170
193
|
'text'?: string | null;
|
|
171
194
|
}
|
|
172
|
-
export type
|
|
195
|
+
export type AiFeedbackTypeEnum = 'POSITIVE' | 'NEGATIVE';
|
|
173
196
|
export interface AiFieldsValue {
|
|
174
197
|
'using': string;
|
|
175
198
|
'aggregation'?: AiFieldsValueAggregationEnum;
|
|
@@ -192,7 +215,7 @@ export interface AiFilterByValue {
|
|
|
192
215
|
export type AiFilterByValueTypeEnum = 'attribute_filter' | 'date_filter' | 'ranking_filter';
|
|
193
216
|
export interface AiForecastPeriod {
|
|
194
217
|
}
|
|
195
|
-
export interface
|
|
218
|
+
export interface AiFunctionCallContent {
|
|
196
219
|
[key: string]: any;
|
|
197
220
|
/**
|
|
198
221
|
* Type of item content.
|
|
@@ -215,11 +238,11 @@ export interface AiFunctionCallContentDto {
|
|
|
215
238
|
*/
|
|
216
239
|
'arguments': object;
|
|
217
240
|
}
|
|
218
|
-
export interface
|
|
241
|
+
export interface AiFunctionResultContent {
|
|
219
242
|
/**
|
|
220
243
|
* Type of item content.
|
|
221
244
|
*/
|
|
222
|
-
'type'?:
|
|
245
|
+
'type'?: AiFunctionResultContentTypeEnum;
|
|
223
246
|
/**
|
|
224
247
|
* Function call correlation identifier.
|
|
225
248
|
*/
|
|
@@ -229,16 +252,16 @@ export interface AiFunctionResultContentDto {
|
|
|
229
252
|
*/
|
|
230
253
|
'result': string;
|
|
231
254
|
}
|
|
232
|
-
export type
|
|
255
|
+
export type AiFunctionResultContentTypeEnum = 'toolResult';
|
|
233
256
|
export interface AiHTTPValidationError {
|
|
234
257
|
'detail'?: Array<AiValidationError>;
|
|
235
258
|
}
|
|
236
|
-
export interface
|
|
259
|
+
export interface AiKeyDriverAnalysis {
|
|
237
260
|
[key: string]: any;
|
|
238
261
|
/**
|
|
239
262
|
* Measure definition for key driver analysis.
|
|
240
263
|
*/
|
|
241
|
-
'measure':
|
|
264
|
+
'measure': AiKeyDriverAnalysisMeasure;
|
|
242
265
|
/**
|
|
243
266
|
* Date attribute identifier used for period comparison.
|
|
244
267
|
*/
|
|
@@ -256,7 +279,7 @@ export interface AiKeyDriverAnalysisDto {
|
|
|
256
279
|
*/
|
|
257
280
|
'filters': Array<object>;
|
|
258
281
|
}
|
|
259
|
-
export interface
|
|
282
|
+
export interface AiKeyDriverAnalysisMeasure {
|
|
260
283
|
/**
|
|
261
284
|
* Measure object identifier.
|
|
262
285
|
*/
|
|
@@ -264,44 +287,52 @@ export interface AiKeyDriverAnalysisMeasureDto {
|
|
|
264
287
|
/**
|
|
265
288
|
* Measure object type.
|
|
266
289
|
*/
|
|
267
|
-
'type':
|
|
268
|
-
'aggregation'?:
|
|
290
|
+
'type': AiKeyDriverAnalysisMeasureTypeEnum;
|
|
291
|
+
'aggregation'?: AiKeyDriverAnalysisMeasureAggregationEnum | null;
|
|
269
292
|
}
|
|
270
|
-
export type
|
|
271
|
-
export type
|
|
272
|
-
export interface
|
|
293
|
+
export type AiKeyDriverAnalysisMeasureTypeEnum = 'metric' | 'fact' | 'attribute';
|
|
294
|
+
export type AiKeyDriverAnalysisMeasureAggregationEnum = 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'COUNT';
|
|
295
|
+
export interface AiKeyDriverAnalysisPart {
|
|
273
296
|
/**
|
|
274
297
|
* Type of multipart part.
|
|
275
298
|
*/
|
|
276
|
-
'type'?:
|
|
277
|
-
'kda'?:
|
|
299
|
+
'type'?: AiKeyDriverAnalysisPartTypeEnum;
|
|
300
|
+
'kda'?: AiKeyDriverAnalysis | null;
|
|
278
301
|
}
|
|
279
|
-
export type
|
|
280
|
-
|
|
302
|
+
export type AiKeyDriverAnalysisPartTypeEnum = 'kda';
|
|
303
|
+
/**
|
|
304
|
+
* Response for GET /documents.
|
|
305
|
+
*/
|
|
306
|
+
export interface AiListDocumentsResponse {
|
|
307
|
+
'documents': Array<AiDocumentMetadataResponse>;
|
|
308
|
+
'totalCount'?: number | null;
|
|
309
|
+
'nextPageToken'?: string | null;
|
|
310
|
+
}
|
|
311
|
+
export interface AiMultipartContent {
|
|
281
312
|
/**
|
|
282
313
|
* Type of item content.
|
|
283
314
|
*/
|
|
284
|
-
'type'?:
|
|
315
|
+
'type'?: AiMultipartContentTypeEnum;
|
|
285
316
|
/**
|
|
286
317
|
* Ordered multipart content fragments.
|
|
287
318
|
*/
|
|
288
|
-
'parts': Array<
|
|
319
|
+
'parts': Array<AiMultipartContentPartsInner>;
|
|
289
320
|
}
|
|
290
|
-
export type
|
|
321
|
+
export type AiMultipartContentTypeEnum = 'multipart';
|
|
291
322
|
/**
|
|
292
|
-
* @type
|
|
323
|
+
* @type AiMultipartContentPartsInner
|
|
293
324
|
*/
|
|
294
|
-
export type
|
|
325
|
+
export type AiMultipartContentPartsInner = ({
|
|
295
326
|
type: 'kda';
|
|
296
|
-
} &
|
|
327
|
+
} & AiKeyDriverAnalysisPart) | ({
|
|
297
328
|
type: 'searchResults';
|
|
298
|
-
} &
|
|
329
|
+
} & AiSearchResults) | ({
|
|
299
330
|
type: 'text';
|
|
300
|
-
} &
|
|
331
|
+
} & AiTextPart) | ({
|
|
301
332
|
type: 'visualization';
|
|
302
|
-
} &
|
|
333
|
+
} & AiVisualizationPart) | ({
|
|
303
334
|
type: 'whatIf';
|
|
304
|
-
} &
|
|
335
|
+
} & AiWhatIfAnalysisPart);
|
|
305
336
|
export declare const AiObjectType: {
|
|
306
337
|
readonly UNIDENTIFIED: "unidentified";
|
|
307
338
|
readonly WORKSPACE: "workspace";
|
|
@@ -317,6 +348,14 @@ export declare const AiObjectType: {
|
|
|
317
348
|
readonly FILTER_CONTEXT: "filter_context";
|
|
318
349
|
};
|
|
319
350
|
export type AiObjectType = typeof AiObjectType[keyof typeof AiObjectType];
|
|
351
|
+
/**
|
|
352
|
+
* Request body for PATCH /documents/{documentId}.
|
|
353
|
+
*/
|
|
354
|
+
export interface AiPatchDocumentRequest {
|
|
355
|
+
'isDisabled'?: boolean | null;
|
|
356
|
+
'title'?: string | null;
|
|
357
|
+
'scopes'?: Array<string> | null;
|
|
358
|
+
}
|
|
320
359
|
export interface AiQuery {
|
|
321
360
|
'fields': {
|
|
322
361
|
[key: string]: AiFieldsValue;
|
|
@@ -348,26 +387,33 @@ export interface AiRankingFilter {
|
|
|
348
387
|
'bottom'?: number;
|
|
349
388
|
}
|
|
350
389
|
export type AiRankingFilterTypeEnum = 'ranking_filter';
|
|
351
|
-
export interface
|
|
390
|
+
export interface AiReasoningContent {
|
|
352
391
|
/**
|
|
353
392
|
* Type of item content.
|
|
354
393
|
*/
|
|
355
|
-
'type'?:
|
|
394
|
+
'type'?: AiReasoningContentTypeEnum;
|
|
356
395
|
/**
|
|
357
396
|
* Reasoning summary intended for UI display.
|
|
358
397
|
*/
|
|
359
398
|
'summary': string;
|
|
360
399
|
}
|
|
361
|
-
export type
|
|
362
|
-
export interface
|
|
363
|
-
'type':
|
|
400
|
+
export type AiReasoningContentTypeEnum = 'reasoning';
|
|
401
|
+
export interface AiResponseFeedback {
|
|
402
|
+
'type': AiResponseFeedbackTypeEnum;
|
|
364
403
|
'text'?: string | null;
|
|
365
404
|
}
|
|
366
|
-
export type
|
|
405
|
+
export type AiResponseFeedbackTypeEnum = 'POSITIVE' | 'NEGATIVE';
|
|
367
406
|
export interface AiResponseFeedbackRequest {
|
|
368
|
-
'feedback':
|
|
407
|
+
'feedback': AiResponseFeedback | null;
|
|
408
|
+
}
|
|
409
|
+
/**
|
|
410
|
+
* Response for GET /search.
|
|
411
|
+
*/
|
|
412
|
+
export interface AiSearchDocumentsResponse {
|
|
413
|
+
'results': Array<AiSearchResultItem>;
|
|
414
|
+
'statistics': AiSearchStatistics;
|
|
369
415
|
}
|
|
370
|
-
export interface
|
|
416
|
+
export interface AiSearchObject {
|
|
371
417
|
/**
|
|
372
418
|
* Object identifier.
|
|
373
419
|
*/
|
|
@@ -398,7 +444,7 @@ export interface AiSearchObjectDto {
|
|
|
398
444
|
*/
|
|
399
445
|
'score': number;
|
|
400
446
|
}
|
|
401
|
-
export interface
|
|
447
|
+
export interface AiSearchRelationship {
|
|
402
448
|
/**
|
|
403
449
|
* Workspace ID of the source object.
|
|
404
450
|
*/
|
|
@@ -432,70 +478,102 @@ export interface AiSearchRelationshipDto {
|
|
|
432
478
|
*/
|
|
433
479
|
'targetTitle': string;
|
|
434
480
|
}
|
|
435
|
-
|
|
481
|
+
/**
|
|
482
|
+
* A single search result entry.
|
|
483
|
+
*/
|
|
484
|
+
export interface AiSearchResultItem {
|
|
485
|
+
'id': string;
|
|
486
|
+
'filename': string;
|
|
487
|
+
'content': string;
|
|
488
|
+
'score': number;
|
|
489
|
+
'chunkIndex': number;
|
|
490
|
+
'totalChunks': number;
|
|
491
|
+
'pageNumbers': Array<number>;
|
|
492
|
+
'workspaceId'?: string | null;
|
|
493
|
+
'title'?: string | null;
|
|
494
|
+
'scopes': Array<string>;
|
|
495
|
+
}
|
|
496
|
+
export interface AiSearchResults {
|
|
436
497
|
/**
|
|
437
498
|
* Type of multipart part.
|
|
438
499
|
*/
|
|
439
|
-
'type'?:
|
|
500
|
+
'type'?: AiSearchResultsTypeEnum;
|
|
440
501
|
/**
|
|
441
502
|
* Search result objects for widget rendering.
|
|
442
503
|
*/
|
|
443
|
-
'objects': Array<
|
|
504
|
+
'objects': Array<AiSearchObject>;
|
|
444
505
|
/**
|
|
445
506
|
* Keywords used in search query.
|
|
446
507
|
*/
|
|
447
508
|
'keywords': Array<string>;
|
|
448
509
|
'requestedObjectType'?: string | null;
|
|
449
|
-
'relationships'?: Array<
|
|
510
|
+
'relationships'?: Array<AiSearchRelationship> | null;
|
|
450
511
|
}
|
|
451
|
-
export type
|
|
452
|
-
|
|
453
|
-
|
|
512
|
+
export type AiSearchResultsTypeEnum = 'searchResults';
|
|
513
|
+
/**
|
|
514
|
+
* Statistics about the search results.
|
|
515
|
+
*/
|
|
516
|
+
export interface AiSearchStatistics {
|
|
517
|
+
'totalResults': number;
|
|
518
|
+
'averageSimilarityScore': number;
|
|
519
|
+
}
|
|
520
|
+
export interface AiSendMessageContent {
|
|
521
|
+
'type': AiSendMessageContentTypeEnum;
|
|
454
522
|
'text': string;
|
|
455
523
|
}
|
|
456
|
-
export type
|
|
457
|
-
export interface
|
|
458
|
-
'role':
|
|
459
|
-
'content':
|
|
524
|
+
export type AiSendMessageContentTypeEnum = 'text';
|
|
525
|
+
export interface AiSendMessageItem {
|
|
526
|
+
'role': AiSendMessageItemRoleEnum;
|
|
527
|
+
'content': AiSendMessageContent;
|
|
460
528
|
}
|
|
461
|
-
export type
|
|
462
|
-
export interface
|
|
463
|
-
'search'?:
|
|
529
|
+
export type AiSendMessageItemRoleEnum = 'user';
|
|
530
|
+
export interface AiSendMessageOptions {
|
|
531
|
+
'search'?: AiSendMessageSearchOptions | null;
|
|
464
532
|
}
|
|
465
533
|
/**
|
|
466
534
|
* POST /conversations/{conversationId}/messages body.
|
|
467
535
|
*/
|
|
468
536
|
export interface AiSendMessageRequest {
|
|
469
|
-
'item':
|
|
470
|
-
'options'?:
|
|
537
|
+
'item': AiSendMessageItem;
|
|
538
|
+
'options'?: AiSendMessageOptions | null;
|
|
471
539
|
}
|
|
472
|
-
export interface
|
|
540
|
+
export interface AiSendMessageSearchOptions {
|
|
473
541
|
'objectTypes'?: Array<AiObjectType> | null;
|
|
474
542
|
'searchLimit'?: number | null;
|
|
475
|
-
'allowedRelationshipTypes'?: Array<
|
|
543
|
+
'allowedRelationshipTypes'?: Array<AiAllowedRelationshipType> | null;
|
|
476
544
|
}
|
|
477
|
-
export interface
|
|
545
|
+
export interface AiTextMessageContent {
|
|
478
546
|
/**
|
|
479
547
|
* Type of item content.
|
|
480
548
|
*/
|
|
481
|
-
'type'?:
|
|
549
|
+
'type'?: AiTextMessageContentTypeEnum;
|
|
482
550
|
/**
|
|
483
551
|
* Plain text message content.
|
|
484
552
|
*/
|
|
485
553
|
'text': string;
|
|
486
554
|
}
|
|
487
|
-
export type
|
|
488
|
-
export interface
|
|
555
|
+
export type AiTextMessageContentTypeEnum = 'text';
|
|
556
|
+
export interface AiTextPart {
|
|
489
557
|
/**
|
|
490
558
|
* Type of multipart part.
|
|
491
559
|
*/
|
|
492
|
-
'type'?:
|
|
560
|
+
'type'?: AiTextPartTypeEnum;
|
|
493
561
|
/**
|
|
494
562
|
* Text fragment.
|
|
495
563
|
*/
|
|
496
564
|
'text': string;
|
|
497
565
|
}
|
|
498
|
-
export type
|
|
566
|
+
export type AiTextPartTypeEnum = 'text';
|
|
567
|
+
/**
|
|
568
|
+
* Response for POST/PUT /documents.
|
|
569
|
+
*/
|
|
570
|
+
export interface AiUploadDocumentResponse {
|
|
571
|
+
'id': string;
|
|
572
|
+
'filename': string;
|
|
573
|
+
'success': boolean;
|
|
574
|
+
'message': string;
|
|
575
|
+
'numChunks': number;
|
|
576
|
+
}
|
|
499
577
|
export interface AiValidationError {
|
|
500
578
|
'loc': Array<AiValidationErrorLocInner>;
|
|
501
579
|
'msg': string;
|
|
@@ -538,33 +616,23 @@ export interface AiVisualizationIdUpdateRequest {
|
|
|
538
616
|
export interface AiVisualizationMetricsInner {
|
|
539
617
|
'field': string;
|
|
540
618
|
}
|
|
541
|
-
export interface
|
|
619
|
+
export interface AiVisualizationPart {
|
|
542
620
|
/**
|
|
543
621
|
* Type of multipart part.
|
|
544
622
|
*/
|
|
545
|
-
'type'?:
|
|
623
|
+
'type'?: AiVisualizationPartTypeEnum;
|
|
546
624
|
'visualization'?: AiVisualization | null;
|
|
547
|
-
/**
|
|
548
|
-
* Visualization state metadata.
|
|
549
|
-
*/
|
|
550
|
-
'metadata': AiVisualizationPartMetadataDto;
|
|
551
|
-
}
|
|
552
|
-
export type AiVisualizationPartDtoTypeEnum = 'visualization';
|
|
553
|
-
export interface AiVisualizationPartMetadataDto {
|
|
554
|
-
/**
|
|
555
|
-
* Whether the visualization was explicitly saved by user action.
|
|
556
|
-
*/
|
|
557
|
-
'isSaved': boolean;
|
|
558
625
|
}
|
|
559
|
-
export
|
|
626
|
+
export type AiVisualizationPartTypeEnum = 'visualization';
|
|
627
|
+
export interface AiWhatIfAnalysisPart {
|
|
560
628
|
/**
|
|
561
629
|
* Type of multipart part.
|
|
562
630
|
*/
|
|
563
|
-
'type'?:
|
|
564
|
-
'whatIf'?:
|
|
631
|
+
'type'?: AiWhatIfAnalysisPartTypeEnum;
|
|
632
|
+
'whatIf'?: AiWhatIfScenario | null;
|
|
565
633
|
}
|
|
566
|
-
export type
|
|
567
|
-
export interface
|
|
634
|
+
export type AiWhatIfAnalysisPartTypeEnum = 'whatIf';
|
|
635
|
+
export interface AiWhatIfMeasureAdjustment {
|
|
568
636
|
/**
|
|
569
637
|
* Adjusted metric identifier.
|
|
570
638
|
*/
|
|
@@ -578,7 +646,7 @@ export interface AiWhatIfMeasureAdjustmentDto {
|
|
|
578
646
|
*/
|
|
579
647
|
'scenarioMaql': string;
|
|
580
648
|
}
|
|
581
|
-
export interface
|
|
649
|
+
export interface AiWhatIfScenario {
|
|
582
650
|
/**
|
|
583
651
|
* Base visualization reference used by scenario.
|
|
584
652
|
*/
|
|
@@ -586,13 +654,13 @@ export interface AiWhatIfScenarioDto {
|
|
|
586
654
|
/**
|
|
587
655
|
* Defined what-if variants.
|
|
588
656
|
*/
|
|
589
|
-
'scenarios': Array<
|
|
657
|
+
'scenarios': Array<AiWhatIfScenarioVariant>;
|
|
590
658
|
/**
|
|
591
659
|
* Whether baseline values are included.
|
|
592
660
|
*/
|
|
593
661
|
'includeBaseline': boolean;
|
|
594
662
|
}
|
|
595
|
-
export interface
|
|
663
|
+
export interface AiWhatIfScenarioVariant {
|
|
596
664
|
/**
|
|
597
665
|
* Scenario name.
|
|
598
666
|
*/
|
|
@@ -600,7 +668,7 @@ export interface AiWhatIfScenarioVariantDto {
|
|
|
600
668
|
/**
|
|
601
669
|
* Scenario adjustments.
|
|
602
670
|
*/
|
|
603
|
-
'adjustments': Array<
|
|
671
|
+
'adjustments': Array<AiWhatIfMeasureAdjustment>;
|
|
604
672
|
}
|
|
605
673
|
/**
|
|
606
674
|
*
|
|
@@ -661,7 +729,7 @@ export declare function ConversationsAi_DeleteConversationApiV1AiWorkspacesWorks
|
|
|
661
729
|
* @param {Configuration} [configuration] Optional configuration.
|
|
662
730
|
* @throws {RequiredError}
|
|
663
731
|
*/
|
|
664
|
-
export declare function ConversationsAi_GetConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGet(axios: AxiosInstance, basePath: string, requestParameters: ConversationsAiGetConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGetRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<
|
|
732
|
+
export declare function ConversationsAi_GetConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGet(axios: AxiosInstance, basePath: string, requestParameters: ConversationsAiGetConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGetRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiConversationResponse>;
|
|
665
733
|
/**
|
|
666
734
|
*
|
|
667
735
|
* @summary Get Conversations
|
|
@@ -672,7 +740,7 @@ export declare function ConversationsAi_GetConversationApiV1AiWorkspacesWorkspac
|
|
|
672
740
|
* @param {Configuration} [configuration] Optional configuration.
|
|
673
741
|
* @throws {RequiredError}
|
|
674
742
|
*/
|
|
675
|
-
export declare function ConversationsAi_GetConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGet(axios: AxiosInstance, basePath: string, requestParameters: ConversationsAiGetConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGetRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<Array<
|
|
743
|
+
export declare function ConversationsAi_GetConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGet(axios: AxiosInstance, basePath: string, requestParameters: ConversationsAiGetConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGetRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<Array<AiConversationResponse>>;
|
|
676
744
|
/**
|
|
677
745
|
*
|
|
678
746
|
* @summary Post Conversations
|
|
@@ -683,7 +751,7 @@ export declare function ConversationsAi_GetConversationsApiV1AiWorkspacesWorkspa
|
|
|
683
751
|
* @param {Configuration} [configuration] Optional configuration.
|
|
684
752
|
* @throws {RequiredError}
|
|
685
753
|
*/
|
|
686
|
-
export declare function ConversationsAi_PostConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPost(axios: AxiosInstance, basePath: string, requestParameters: ConversationsAiPostConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPostRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<
|
|
754
|
+
export declare function ConversationsAi_PostConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPost(axios: AxiosInstance, basePath: string, requestParameters: ConversationsAiPostConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPostRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiConversationResponse>;
|
|
687
755
|
/**
|
|
688
756
|
* ConversationsAi - interface
|
|
689
757
|
* @export
|
|
@@ -707,7 +775,7 @@ export interface ConversationsAiInterface {
|
|
|
707
775
|
* @throws {RequiredError}
|
|
708
776
|
* @memberof ConversationsAiInterface
|
|
709
777
|
*/
|
|
710
|
-
getConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGet(requestParameters: ConversationsAiGetConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGetRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
778
|
+
getConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGet(requestParameters: ConversationsAiGetConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGetRequest, options?: AxiosRequestConfig): AxiosPromise<AiConversationResponse>;
|
|
711
779
|
/**
|
|
712
780
|
*
|
|
713
781
|
* @summary Get Conversations
|
|
@@ -716,7 +784,7 @@ export interface ConversationsAiInterface {
|
|
|
716
784
|
* @throws {RequiredError}
|
|
717
785
|
* @memberof ConversationsAiInterface
|
|
718
786
|
*/
|
|
719
|
-
getConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGet(requestParameters: ConversationsAiGetConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGetRequest, options?: AxiosRequestConfig): AxiosPromise<Array<
|
|
787
|
+
getConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGet(requestParameters: ConversationsAiGetConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGetRequest, options?: AxiosRequestConfig): AxiosPromise<Array<AiConversationResponse>>;
|
|
720
788
|
/**
|
|
721
789
|
*
|
|
722
790
|
* @summary Post Conversations
|
|
@@ -725,7 +793,7 @@ export interface ConversationsAiInterface {
|
|
|
725
793
|
* @throws {RequiredError}
|
|
726
794
|
* @memberof ConversationsAiInterface
|
|
727
795
|
*/
|
|
728
|
-
postConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPost(requestParameters: ConversationsAiPostConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPostRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
796
|
+
postConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPost(requestParameters: ConversationsAiPostConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPostRequest, options?: AxiosRequestConfig): AxiosPromise<AiConversationResponse>;
|
|
729
797
|
}
|
|
730
798
|
/**
|
|
731
799
|
* Request parameters for deleteConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdDelete operation in ConversationsAi.
|
|
@@ -815,7 +883,7 @@ export declare class ConversationsAi extends BaseAPI implements ConversationsAiI
|
|
|
815
883
|
* @throws {RequiredError}
|
|
816
884
|
* @memberof ConversationsAi
|
|
817
885
|
*/
|
|
818
|
-
getConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGet(requestParameters: ConversationsAiGetConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGetRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
886
|
+
getConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGet(requestParameters: ConversationsAiGetConversationApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdGetRequest, options?: AxiosRequestConfig): AxiosPromise<AiConversationResponse>;
|
|
819
887
|
/**
|
|
820
888
|
*
|
|
821
889
|
* @summary Get Conversations
|
|
@@ -824,7 +892,7 @@ export declare class ConversationsAi extends BaseAPI implements ConversationsAiI
|
|
|
824
892
|
* @throws {RequiredError}
|
|
825
893
|
* @memberof ConversationsAi
|
|
826
894
|
*/
|
|
827
|
-
getConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGet(requestParameters: ConversationsAiGetConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGetRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
895
|
+
getConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGet(requestParameters: ConversationsAiGetConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsGetRequest, options?: AxiosRequestConfig): AxiosPromise<AiConversationResponse[]>;
|
|
828
896
|
/**
|
|
829
897
|
*
|
|
830
898
|
* @summary Post Conversations
|
|
@@ -833,7 +901,7 @@ export declare class ConversationsAi extends BaseAPI implements ConversationsAiI
|
|
|
833
901
|
* @throws {RequiredError}
|
|
834
902
|
* @memberof ConversationsAi
|
|
835
903
|
*/
|
|
836
|
-
postConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPost(requestParameters: ConversationsAiPostConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPostRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
904
|
+
postConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPost(requestParameters: ConversationsAiPostConversationsApiV1AiWorkspacesWorkspaceIdChatConversationsPostRequest, options?: AxiosRequestConfig): AxiosPromise<AiConversationResponse>;
|
|
837
905
|
}
|
|
838
906
|
/**
|
|
839
907
|
*
|
|
@@ -855,7 +923,7 @@ export declare function ItemsAiAxiosParamCreator_GetConversationItemsApiV1AiWork
|
|
|
855
923
|
* @param {Configuration} [configuration] Optional configuration.
|
|
856
924
|
* @throws {RequiredError}
|
|
857
925
|
*/
|
|
858
|
-
export declare function ItemsAi_GetConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGet(axios: AxiosInstance, basePath: string, requestParameters: ItemsAiGetConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGetRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<
|
|
926
|
+
export declare function ItemsAi_GetConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGet(axios: AxiosInstance, basePath: string, requestParameters: ItemsAiGetConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGetRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiConversationItemListResponse>;
|
|
859
927
|
/**
|
|
860
928
|
* ItemsAi - interface
|
|
861
929
|
* @export
|
|
@@ -870,7 +938,7 @@ export interface ItemsAiInterface {
|
|
|
870
938
|
* @throws {RequiredError}
|
|
871
939
|
* @memberof ItemsAiInterface
|
|
872
940
|
*/
|
|
873
|
-
getConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGet(requestParameters: ItemsAiGetConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGetRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
941
|
+
getConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGet(requestParameters: ItemsAiGetConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGetRequest, options?: AxiosRequestConfig): AxiosPromise<AiConversationItemListResponse>;
|
|
874
942
|
}
|
|
875
943
|
/**
|
|
876
944
|
* Request parameters for getConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGet operation in ItemsAi.
|
|
@@ -906,161 +974,497 @@ export declare class ItemsAi extends BaseAPI implements ItemsAiInterface {
|
|
|
906
974
|
* @throws {RequiredError}
|
|
907
975
|
* @memberof ItemsAi
|
|
908
976
|
*/
|
|
909
|
-
getConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGet(requestParameters: ItemsAiGetConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGetRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
977
|
+
getConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGet(requestParameters: ItemsAiGetConversationItemsApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdItemsGetRequest, options?: AxiosRequestConfig): AxiosPromise<AiConversationItemListResponse>;
|
|
910
978
|
}
|
|
979
|
+
/**
|
|
980
|
+
* Upload a new knowledge document. Returns 409 if filename already exists.
|
|
981
|
+
* @summary Upload Document
|
|
982
|
+
* @param {string} workspaceId
|
|
983
|
+
* @param {File} file
|
|
984
|
+
* @param {string} [title]
|
|
985
|
+
* @param {Array<string>} [scopes]
|
|
986
|
+
* @param {*} [options] Override http request option.
|
|
987
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
988
|
+
* @throws {RequiredError}
|
|
989
|
+
*/
|
|
990
|
+
export declare function KnowledgeAiAxiosParamCreator_CreateDocument(workspaceId: string, file: File, title?: string, scopes?: Array<string>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
991
|
+
/**
|
|
992
|
+
* Delete a knowledge document and all its chunks.
|
|
993
|
+
* @summary Delete Document
|
|
994
|
+
* @param {string} workspaceId
|
|
995
|
+
* @param {string} documentId
|
|
996
|
+
* @param {*} [options] Override http request option.
|
|
997
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
998
|
+
* @throws {RequiredError}
|
|
999
|
+
*/
|
|
1000
|
+
export declare function KnowledgeAiAxiosParamCreator_DeleteDocument(workspaceId: string, documentId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
911
1001
|
/**
|
|
912
1002
|
* Download a knowledge document\'s raw file.
|
|
913
1003
|
* @summary Download Document
|
|
914
1004
|
* @param {string} workspaceId
|
|
915
|
-
* @param {string}
|
|
1005
|
+
* @param {string} documentId
|
|
916
1006
|
* @param {*} [options] Override http request option.
|
|
917
1007
|
* @param {Configuration} [configuration] Optional configuration.
|
|
918
1008
|
* @throws {RequiredError}
|
|
919
1009
|
*/
|
|
920
|
-
export declare function
|
|
1010
|
+
export declare function KnowledgeAiAxiosParamCreator_DownloadDocument(workspaceId: string, documentId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
921
1011
|
/**
|
|
922
|
-
*
|
|
923
|
-
* @summary
|
|
1012
|
+
* Get a single knowledge document\'s metadata.
|
|
1013
|
+
* @summary Get Document
|
|
924
1014
|
* @param {string} workspaceId
|
|
925
|
-
* @param {
|
|
1015
|
+
* @param {string} documentId
|
|
1016
|
+
* @param {*} [options] Override http request option.
|
|
1017
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1018
|
+
* @throws {RequiredError}
|
|
1019
|
+
*/
|
|
1020
|
+
export declare function KnowledgeAiAxiosParamCreator_GetDocument(workspaceId: string, documentId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1021
|
+
/**
|
|
1022
|
+
* List knowledge documents accessible from the workspace.
|
|
1023
|
+
* @summary List Documents
|
|
1024
|
+
* @param {string} workspaceId
|
|
1025
|
+
* @param {Array<string>} [scopes]
|
|
1026
|
+
* @param {number} [size]
|
|
1027
|
+
* @param {string} [pageToken]
|
|
1028
|
+
* @param {string} [metaInclude]
|
|
1029
|
+
* @param {'enabled' | 'disabled'} [state]
|
|
1030
|
+
* @param {string} [query]
|
|
1031
|
+
* @param {*} [options] Override http request option.
|
|
1032
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1033
|
+
* @throws {RequiredError}
|
|
1034
|
+
*/
|
|
1035
|
+
export declare function KnowledgeAiAxiosParamCreator_ListDocuments(workspaceId: string, scopes?: Array<string>, size?: number, pageToken?: string, metaInclude?: string, state?: 'enabled' | 'disabled', query?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1036
|
+
/**
|
|
1037
|
+
* Patch a knowledge document\'s metadata without re-uploading content.
|
|
1038
|
+
* @summary Patch Document
|
|
1039
|
+
* @param {string} workspaceId
|
|
1040
|
+
* @param {string} documentId
|
|
1041
|
+
* @param {AiPatchDocumentRequest} aiPatchDocumentRequest
|
|
1042
|
+
* @param {*} [options] Override http request option.
|
|
1043
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1044
|
+
* @throws {RequiredError}
|
|
1045
|
+
*/
|
|
1046
|
+
export declare function KnowledgeAiAxiosParamCreator_PatchDocument(workspaceId: string, documentId: string, aiPatchDocumentRequest: AiPatchDocumentRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1047
|
+
/**
|
|
1048
|
+
* Search the knowledge base using semantic similarity.
|
|
1049
|
+
* @summary Search Documents
|
|
1050
|
+
* @param {string} workspaceId
|
|
1051
|
+
* @param {string} query
|
|
1052
|
+
* @param {number} [limit]
|
|
1053
|
+
* @param {number} [minScore]
|
|
1054
|
+
* @param {Array<string>} [scopes]
|
|
926
1055
|
* @param {*} [options] Override http request option.
|
|
927
1056
|
* @param {Configuration} [configuration] Optional configuration.
|
|
928
1057
|
* @throws {RequiredError}
|
|
929
1058
|
*/
|
|
930
|
-
export declare function
|
|
1059
|
+
export declare function KnowledgeAiAxiosParamCreator_SearchKnowledge(workspaceId: string, query: string, limit?: number, minScore?: number, scopes?: Array<string>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
931
1060
|
/**
|
|
932
1061
|
* Upload or replace a knowledge document.
|
|
933
1062
|
* @summary Upsert Document
|
|
934
1063
|
* @param {string} workspaceId
|
|
935
1064
|
* @param {File} file
|
|
1065
|
+
* @param {string} [title]
|
|
1066
|
+
* @param {Array<string>} [scopes]
|
|
1067
|
+
* @param {*} [options] Override http request option.
|
|
1068
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1069
|
+
* @throws {RequiredError}
|
|
1070
|
+
*/
|
|
1071
|
+
export declare function KnowledgeAiAxiosParamCreator_UpsertDocument(workspaceId: string, file: File, title?: string, scopes?: Array<string>, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1072
|
+
/**
|
|
1073
|
+
* Upload a new knowledge document. Returns 409 if filename already exists.
|
|
1074
|
+
* @summary Upload Document
|
|
1075
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1076
|
+
* @param {string} basePath Base path.
|
|
1077
|
+
* @param {KnowledgeAiCreateDocumentRequest} requestParameters Request parameters.
|
|
936
1078
|
* @param {*} [options] Override http request option.
|
|
937
1079
|
* @param {Configuration} [configuration] Optional configuration.
|
|
938
1080
|
* @throws {RequiredError}
|
|
939
1081
|
*/
|
|
940
|
-
export declare function
|
|
1082
|
+
export declare function KnowledgeAi_CreateDocument(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiCreateDocumentRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiUploadDocumentResponse>;
|
|
1083
|
+
/**
|
|
1084
|
+
* Delete a knowledge document and all its chunks.
|
|
1085
|
+
* @summary Delete Document
|
|
1086
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1087
|
+
* @param {string} basePath Base path.
|
|
1088
|
+
* @param {KnowledgeAiDeleteDocumentRequest} requestParameters Request parameters.
|
|
1089
|
+
* @param {*} [options] Override http request option.
|
|
1090
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1091
|
+
* @throws {RequiredError}
|
|
1092
|
+
*/
|
|
1093
|
+
export declare function KnowledgeAi_DeleteDocument(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiDeleteDocumentRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiDeleteDocumentResponse>;
|
|
941
1094
|
/**
|
|
942
1095
|
* Download a knowledge document\'s raw file.
|
|
943
1096
|
* @summary Download Document
|
|
944
1097
|
* @param {AxiosInstance} axios Axios instance.
|
|
945
1098
|
* @param {string} basePath Base path.
|
|
946
|
-
* @param {
|
|
1099
|
+
* @param {KnowledgeAiDownloadDocumentRequest} requestParameters Request parameters.
|
|
947
1100
|
* @param {*} [options] Override http request option.
|
|
948
1101
|
* @param {Configuration} [configuration] Optional configuration.
|
|
949
1102
|
* @throws {RequiredError}
|
|
950
1103
|
*/
|
|
951
|
-
export declare function
|
|
1104
|
+
export declare function KnowledgeAi_DownloadDocument(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiDownloadDocumentRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<any>;
|
|
952
1105
|
/**
|
|
953
|
-
*
|
|
954
|
-
* @summary
|
|
1106
|
+
* Get a single knowledge document\'s metadata.
|
|
1107
|
+
* @summary Get Document
|
|
1108
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1109
|
+
* @param {string} basePath Base path.
|
|
1110
|
+
* @param {KnowledgeAiGetDocumentRequest} requestParameters Request parameters.
|
|
1111
|
+
* @param {*} [options] Override http request option.
|
|
1112
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1113
|
+
* @throws {RequiredError}
|
|
1114
|
+
*/
|
|
1115
|
+
export declare function KnowledgeAi_GetDocument(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiGetDocumentRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiDocumentMetadataResponse>;
|
|
1116
|
+
/**
|
|
1117
|
+
* List knowledge documents accessible from the workspace.
|
|
1118
|
+
* @summary List Documents
|
|
1119
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1120
|
+
* @param {string} basePath Base path.
|
|
1121
|
+
* @param {KnowledgeAiListDocumentsRequest} requestParameters Request parameters.
|
|
1122
|
+
* @param {*} [options] Override http request option.
|
|
1123
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1124
|
+
* @throws {RequiredError}
|
|
1125
|
+
*/
|
|
1126
|
+
export declare function KnowledgeAi_ListDocuments(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiListDocumentsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiListDocumentsResponse>;
|
|
1127
|
+
/**
|
|
1128
|
+
* Patch a knowledge document\'s metadata without re-uploading content.
|
|
1129
|
+
* @summary Patch Document
|
|
1130
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1131
|
+
* @param {string} basePath Base path.
|
|
1132
|
+
* @param {KnowledgeAiPatchDocumentRequest} requestParameters Request parameters.
|
|
1133
|
+
* @param {*} [options] Override http request option.
|
|
1134
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1135
|
+
* @throws {RequiredError}
|
|
1136
|
+
*/
|
|
1137
|
+
export declare function KnowledgeAi_PatchDocument(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiPatchDocumentRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiDocumentMetadataResponse>;
|
|
1138
|
+
/**
|
|
1139
|
+
* Search the knowledge base using semantic similarity.
|
|
1140
|
+
* @summary Search Documents
|
|
955
1141
|
* @param {AxiosInstance} axios Axios instance.
|
|
956
1142
|
* @param {string} basePath Base path.
|
|
957
|
-
* @param {
|
|
1143
|
+
* @param {KnowledgeAiSearchKnowledgeRequest} requestParameters Request parameters.
|
|
958
1144
|
* @param {*} [options] Override http request option.
|
|
959
1145
|
* @param {Configuration} [configuration] Optional configuration.
|
|
960
1146
|
* @throws {RequiredError}
|
|
961
1147
|
*/
|
|
962
|
-
export declare function
|
|
1148
|
+
export declare function KnowledgeAi_SearchKnowledge(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiSearchKnowledgeRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiSearchDocumentsResponse>;
|
|
963
1149
|
/**
|
|
964
1150
|
* Upload or replace a knowledge document.
|
|
965
1151
|
* @summary Upsert Document
|
|
966
1152
|
* @param {AxiosInstance} axios Axios instance.
|
|
967
1153
|
* @param {string} basePath Base path.
|
|
968
|
-
* @param {
|
|
1154
|
+
* @param {KnowledgeAiUpsertDocumentRequest} requestParameters Request parameters.
|
|
969
1155
|
* @param {*} [options] Override http request option.
|
|
970
1156
|
* @param {Configuration} [configuration] Optional configuration.
|
|
971
1157
|
* @throws {RequiredError}
|
|
972
1158
|
*/
|
|
973
|
-
export declare function
|
|
1159
|
+
export declare function KnowledgeAi_UpsertDocument(axios: AxiosInstance, basePath: string, requestParameters: KnowledgeAiUpsertDocumentRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiUploadDocumentResponse>;
|
|
974
1160
|
/**
|
|
975
1161
|
* KnowledgeAi - interface
|
|
976
1162
|
* @export
|
|
977
1163
|
* @interface KnowledgeAi
|
|
978
1164
|
*/
|
|
979
1165
|
export interface KnowledgeAiInterface {
|
|
1166
|
+
/**
|
|
1167
|
+
* Upload a new knowledge document. Returns 409 if filename already exists.
|
|
1168
|
+
* @summary Upload Document
|
|
1169
|
+
* @param {KnowledgeAiCreateDocumentRequest} requestParameters Request parameters.
|
|
1170
|
+
* @param {*} [options] Override http request option.
|
|
1171
|
+
* @throws {RequiredError}
|
|
1172
|
+
* @memberof KnowledgeAiInterface
|
|
1173
|
+
*/
|
|
1174
|
+
createDocument(requestParameters: KnowledgeAiCreateDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<AiUploadDocumentResponse>;
|
|
1175
|
+
/**
|
|
1176
|
+
* Delete a knowledge document and all its chunks.
|
|
1177
|
+
* @summary Delete Document
|
|
1178
|
+
* @param {KnowledgeAiDeleteDocumentRequest} requestParameters Request parameters.
|
|
1179
|
+
* @param {*} [options] Override http request option.
|
|
1180
|
+
* @throws {RequiredError}
|
|
1181
|
+
* @memberof KnowledgeAiInterface
|
|
1182
|
+
*/
|
|
1183
|
+
deleteDocument(requestParameters: KnowledgeAiDeleteDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<AiDeleteDocumentResponse>;
|
|
980
1184
|
/**
|
|
981
1185
|
* Download a knowledge document\'s raw file.
|
|
982
1186
|
* @summary Download Document
|
|
983
|
-
* @param {
|
|
1187
|
+
* @param {KnowledgeAiDownloadDocumentRequest} requestParameters Request parameters.
|
|
984
1188
|
* @param {*} [options] Override http request option.
|
|
985
1189
|
* @throws {RequiredError}
|
|
986
1190
|
* @memberof KnowledgeAiInterface
|
|
987
1191
|
*/
|
|
988
|
-
|
|
1192
|
+
downloadDocument(requestParameters: KnowledgeAiDownloadDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
|
|
989
1193
|
/**
|
|
990
|
-
*
|
|
991
|
-
* @summary
|
|
992
|
-
* @param {
|
|
1194
|
+
* Get a single knowledge document\'s metadata.
|
|
1195
|
+
* @summary Get Document
|
|
1196
|
+
* @param {KnowledgeAiGetDocumentRequest} requestParameters Request parameters.
|
|
993
1197
|
* @param {*} [options] Override http request option.
|
|
994
1198
|
* @throws {RequiredError}
|
|
995
1199
|
* @memberof KnowledgeAiInterface
|
|
996
1200
|
*/
|
|
997
|
-
|
|
1201
|
+
getDocument(requestParameters: KnowledgeAiGetDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<AiDocumentMetadataResponse>;
|
|
1202
|
+
/**
|
|
1203
|
+
* List knowledge documents accessible from the workspace.
|
|
1204
|
+
* @summary List Documents
|
|
1205
|
+
* @param {KnowledgeAiListDocumentsRequest} requestParameters Request parameters.
|
|
1206
|
+
* @param {*} [options] Override http request option.
|
|
1207
|
+
* @throws {RequiredError}
|
|
1208
|
+
* @memberof KnowledgeAiInterface
|
|
1209
|
+
*/
|
|
1210
|
+
listDocuments(requestParameters: KnowledgeAiListDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<AiListDocumentsResponse>;
|
|
1211
|
+
/**
|
|
1212
|
+
* Patch a knowledge document\'s metadata without re-uploading content.
|
|
1213
|
+
* @summary Patch Document
|
|
1214
|
+
* @param {KnowledgeAiPatchDocumentRequest} requestParameters Request parameters.
|
|
1215
|
+
* @param {*} [options] Override http request option.
|
|
1216
|
+
* @throws {RequiredError}
|
|
1217
|
+
* @memberof KnowledgeAiInterface
|
|
1218
|
+
*/
|
|
1219
|
+
patchDocument(requestParameters: KnowledgeAiPatchDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<AiDocumentMetadataResponse>;
|
|
1220
|
+
/**
|
|
1221
|
+
* Search the knowledge base using semantic similarity.
|
|
1222
|
+
* @summary Search Documents
|
|
1223
|
+
* @param {KnowledgeAiSearchKnowledgeRequest} requestParameters Request parameters.
|
|
1224
|
+
* @param {*} [options] Override http request option.
|
|
1225
|
+
* @throws {RequiredError}
|
|
1226
|
+
* @memberof KnowledgeAiInterface
|
|
1227
|
+
*/
|
|
1228
|
+
searchKnowledge(requestParameters: KnowledgeAiSearchKnowledgeRequest, options?: AxiosRequestConfig): AxiosPromise<AiSearchDocumentsResponse>;
|
|
998
1229
|
/**
|
|
999
1230
|
* Upload or replace a knowledge document.
|
|
1000
1231
|
* @summary Upsert Document
|
|
1001
|
-
* @param {
|
|
1232
|
+
* @param {KnowledgeAiUpsertDocumentRequest} requestParameters Request parameters.
|
|
1002
1233
|
* @param {*} [options] Override http request option.
|
|
1003
1234
|
* @throws {RequiredError}
|
|
1004
1235
|
* @memberof KnowledgeAiInterface
|
|
1005
1236
|
*/
|
|
1006
|
-
|
|
1237
|
+
upsertDocument(requestParameters: KnowledgeAiUpsertDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<AiUploadDocumentResponse>;
|
|
1238
|
+
}
|
|
1239
|
+
/**
|
|
1240
|
+
* Request parameters for createDocument operation in KnowledgeAi.
|
|
1241
|
+
* @export
|
|
1242
|
+
* @interface KnowledgeAiCreateDocumentRequest
|
|
1243
|
+
*/
|
|
1244
|
+
export interface KnowledgeAiCreateDocumentRequest {
|
|
1245
|
+
/**
|
|
1246
|
+
*
|
|
1247
|
+
* @type {string}
|
|
1248
|
+
* @memberof KnowledgeAiCreateDocument
|
|
1249
|
+
*/
|
|
1250
|
+
readonly workspaceId: string;
|
|
1251
|
+
/**
|
|
1252
|
+
*
|
|
1253
|
+
* @type {File}
|
|
1254
|
+
* @memberof KnowledgeAiCreateDocument
|
|
1255
|
+
*/
|
|
1256
|
+
readonly file: File;
|
|
1257
|
+
/**
|
|
1258
|
+
*
|
|
1259
|
+
* @type {string}
|
|
1260
|
+
* @memberof KnowledgeAiCreateDocument
|
|
1261
|
+
*/
|
|
1262
|
+
readonly title?: string;
|
|
1263
|
+
/**
|
|
1264
|
+
*
|
|
1265
|
+
* @type {Array<string>}
|
|
1266
|
+
* @memberof KnowledgeAiCreateDocument
|
|
1267
|
+
*/
|
|
1268
|
+
readonly scopes?: Array<string>;
|
|
1007
1269
|
}
|
|
1008
1270
|
/**
|
|
1009
|
-
* Request parameters for
|
|
1271
|
+
* Request parameters for deleteDocument operation in KnowledgeAi.
|
|
1010
1272
|
* @export
|
|
1011
|
-
* @interface
|
|
1273
|
+
* @interface KnowledgeAiDeleteDocumentRequest
|
|
1012
1274
|
*/
|
|
1013
|
-
export interface
|
|
1275
|
+
export interface KnowledgeAiDeleteDocumentRequest {
|
|
1014
1276
|
/**
|
|
1015
1277
|
*
|
|
1016
1278
|
* @type {string}
|
|
1017
|
-
* @memberof
|
|
1279
|
+
* @memberof KnowledgeAiDeleteDocument
|
|
1018
1280
|
*/
|
|
1019
1281
|
readonly workspaceId: string;
|
|
1020
1282
|
/**
|
|
1021
1283
|
*
|
|
1022
1284
|
* @type {string}
|
|
1023
|
-
* @memberof
|
|
1285
|
+
* @memberof KnowledgeAiDeleteDocument
|
|
1024
1286
|
*/
|
|
1025
|
-
readonly
|
|
1287
|
+
readonly documentId: string;
|
|
1026
1288
|
}
|
|
1027
1289
|
/**
|
|
1028
|
-
* Request parameters for
|
|
1290
|
+
* Request parameters for downloadDocument operation in KnowledgeAi.
|
|
1029
1291
|
* @export
|
|
1030
|
-
* @interface
|
|
1292
|
+
* @interface KnowledgeAiDownloadDocumentRequest
|
|
1031
1293
|
*/
|
|
1032
|
-
export interface
|
|
1294
|
+
export interface KnowledgeAiDownloadDocumentRequest {
|
|
1033
1295
|
/**
|
|
1034
1296
|
*
|
|
1035
1297
|
* @type {string}
|
|
1036
|
-
* @memberof
|
|
1298
|
+
* @memberof KnowledgeAiDownloadDocument
|
|
1037
1299
|
*/
|
|
1038
1300
|
readonly workspaceId: string;
|
|
1039
1301
|
/**
|
|
1040
1302
|
*
|
|
1041
|
-
* @type {
|
|
1042
|
-
* @memberof
|
|
1303
|
+
* @type {string}
|
|
1304
|
+
* @memberof KnowledgeAiDownloadDocument
|
|
1043
1305
|
*/
|
|
1044
|
-
readonly
|
|
1306
|
+
readonly documentId: string;
|
|
1307
|
+
}
|
|
1308
|
+
/**
|
|
1309
|
+
* Request parameters for getDocument operation in KnowledgeAi.
|
|
1310
|
+
* @export
|
|
1311
|
+
* @interface KnowledgeAiGetDocumentRequest
|
|
1312
|
+
*/
|
|
1313
|
+
export interface KnowledgeAiGetDocumentRequest {
|
|
1314
|
+
/**
|
|
1315
|
+
*
|
|
1316
|
+
* @type {string}
|
|
1317
|
+
* @memberof KnowledgeAiGetDocument
|
|
1318
|
+
*/
|
|
1319
|
+
readonly workspaceId: string;
|
|
1320
|
+
/**
|
|
1321
|
+
*
|
|
1322
|
+
* @type {string}
|
|
1323
|
+
* @memberof KnowledgeAiGetDocument
|
|
1324
|
+
*/
|
|
1325
|
+
readonly documentId: string;
|
|
1326
|
+
}
|
|
1327
|
+
/**
|
|
1328
|
+
* Request parameters for listDocuments operation in KnowledgeAi.
|
|
1329
|
+
* @export
|
|
1330
|
+
* @interface KnowledgeAiListDocumentsRequest
|
|
1331
|
+
*/
|
|
1332
|
+
export interface KnowledgeAiListDocumentsRequest {
|
|
1333
|
+
/**
|
|
1334
|
+
*
|
|
1335
|
+
* @type {string}
|
|
1336
|
+
* @memberof KnowledgeAiListDocuments
|
|
1337
|
+
*/
|
|
1338
|
+
readonly workspaceId: string;
|
|
1339
|
+
/**
|
|
1340
|
+
*
|
|
1341
|
+
* @type {Array<string>}
|
|
1342
|
+
* @memberof KnowledgeAiListDocuments
|
|
1343
|
+
*/
|
|
1344
|
+
readonly scopes?: Array<string>;
|
|
1345
|
+
/**
|
|
1346
|
+
*
|
|
1347
|
+
* @type {number}
|
|
1348
|
+
* @memberof KnowledgeAiListDocuments
|
|
1349
|
+
*/
|
|
1350
|
+
readonly size?: number;
|
|
1351
|
+
/**
|
|
1352
|
+
*
|
|
1353
|
+
* @type {string}
|
|
1354
|
+
* @memberof KnowledgeAiListDocuments
|
|
1355
|
+
*/
|
|
1356
|
+
readonly pageToken?: string;
|
|
1357
|
+
/**
|
|
1358
|
+
*
|
|
1359
|
+
* @type {string}
|
|
1360
|
+
* @memberof KnowledgeAiListDocuments
|
|
1361
|
+
*/
|
|
1362
|
+
readonly metaInclude?: string;
|
|
1363
|
+
/**
|
|
1364
|
+
*
|
|
1365
|
+
* @type {'enabled' | 'disabled'}
|
|
1366
|
+
* @memberof KnowledgeAiListDocuments
|
|
1367
|
+
*/
|
|
1368
|
+
readonly state?: 'enabled' | 'disabled';
|
|
1369
|
+
/**
|
|
1370
|
+
*
|
|
1371
|
+
* @type {string}
|
|
1372
|
+
* @memberof KnowledgeAiListDocuments
|
|
1373
|
+
*/
|
|
1374
|
+
readonly query?: string;
|
|
1375
|
+
}
|
|
1376
|
+
/**
|
|
1377
|
+
* Request parameters for patchDocument operation in KnowledgeAi.
|
|
1378
|
+
* @export
|
|
1379
|
+
* @interface KnowledgeAiPatchDocumentRequest
|
|
1380
|
+
*/
|
|
1381
|
+
export interface KnowledgeAiPatchDocumentRequest {
|
|
1382
|
+
/**
|
|
1383
|
+
*
|
|
1384
|
+
* @type {string}
|
|
1385
|
+
* @memberof KnowledgeAiPatchDocument
|
|
1386
|
+
*/
|
|
1387
|
+
readonly workspaceId: string;
|
|
1388
|
+
/**
|
|
1389
|
+
*
|
|
1390
|
+
* @type {string}
|
|
1391
|
+
* @memberof KnowledgeAiPatchDocument
|
|
1392
|
+
*/
|
|
1393
|
+
readonly documentId: string;
|
|
1394
|
+
/**
|
|
1395
|
+
*
|
|
1396
|
+
* @type {AiPatchDocumentRequest}
|
|
1397
|
+
* @memberof KnowledgeAiPatchDocument
|
|
1398
|
+
*/
|
|
1399
|
+
readonly aiPatchDocumentRequest: AiPatchDocumentRequest;
|
|
1045
1400
|
}
|
|
1046
1401
|
/**
|
|
1047
|
-
* Request parameters for
|
|
1402
|
+
* Request parameters for searchKnowledge operation in KnowledgeAi.
|
|
1048
1403
|
* @export
|
|
1049
|
-
* @interface
|
|
1404
|
+
* @interface KnowledgeAiSearchKnowledgeRequest
|
|
1050
1405
|
*/
|
|
1051
|
-
export interface
|
|
1406
|
+
export interface KnowledgeAiSearchKnowledgeRequest {
|
|
1052
1407
|
/**
|
|
1053
1408
|
*
|
|
1054
1409
|
* @type {string}
|
|
1055
|
-
* @memberof
|
|
1410
|
+
* @memberof KnowledgeAiSearchKnowledge
|
|
1411
|
+
*/
|
|
1412
|
+
readonly workspaceId: string;
|
|
1413
|
+
/**
|
|
1414
|
+
*
|
|
1415
|
+
* @type {string}
|
|
1416
|
+
* @memberof KnowledgeAiSearchKnowledge
|
|
1417
|
+
*/
|
|
1418
|
+
readonly query: string;
|
|
1419
|
+
/**
|
|
1420
|
+
*
|
|
1421
|
+
* @type {number}
|
|
1422
|
+
* @memberof KnowledgeAiSearchKnowledge
|
|
1423
|
+
*/
|
|
1424
|
+
readonly limit?: number;
|
|
1425
|
+
/**
|
|
1426
|
+
*
|
|
1427
|
+
* @type {number}
|
|
1428
|
+
* @memberof KnowledgeAiSearchKnowledge
|
|
1429
|
+
*/
|
|
1430
|
+
readonly minScore?: number;
|
|
1431
|
+
/**
|
|
1432
|
+
*
|
|
1433
|
+
* @type {Array<string>}
|
|
1434
|
+
* @memberof KnowledgeAiSearchKnowledge
|
|
1435
|
+
*/
|
|
1436
|
+
readonly scopes?: Array<string>;
|
|
1437
|
+
}
|
|
1438
|
+
/**
|
|
1439
|
+
* Request parameters for upsertDocument operation in KnowledgeAi.
|
|
1440
|
+
* @export
|
|
1441
|
+
* @interface KnowledgeAiUpsertDocumentRequest
|
|
1442
|
+
*/
|
|
1443
|
+
export interface KnowledgeAiUpsertDocumentRequest {
|
|
1444
|
+
/**
|
|
1445
|
+
*
|
|
1446
|
+
* @type {string}
|
|
1447
|
+
* @memberof KnowledgeAiUpsertDocument
|
|
1056
1448
|
*/
|
|
1057
1449
|
readonly workspaceId: string;
|
|
1058
1450
|
/**
|
|
1059
1451
|
*
|
|
1060
1452
|
* @type {File}
|
|
1061
|
-
* @memberof
|
|
1453
|
+
* @memberof KnowledgeAiUpsertDocument
|
|
1062
1454
|
*/
|
|
1063
1455
|
readonly file: File;
|
|
1456
|
+
/**
|
|
1457
|
+
*
|
|
1458
|
+
* @type {string}
|
|
1459
|
+
* @memberof KnowledgeAiUpsertDocument
|
|
1460
|
+
*/
|
|
1461
|
+
readonly title?: string;
|
|
1462
|
+
/**
|
|
1463
|
+
*
|
|
1464
|
+
* @type {Array<string>}
|
|
1465
|
+
* @memberof KnowledgeAiUpsertDocument
|
|
1466
|
+
*/
|
|
1467
|
+
readonly scopes?: Array<string>;
|
|
1064
1468
|
}
|
|
1065
1469
|
/**
|
|
1066
1470
|
* KnowledgeAi - object-oriented interface
|
|
@@ -1069,33 +1473,78 @@ export interface KnowledgeAiUpsertDocumentApiV1AiWorkspacesWorkspaceIdKnowledgeD
|
|
|
1069
1473
|
* @extends {BaseAPI}
|
|
1070
1474
|
*/
|
|
1071
1475
|
export declare class KnowledgeAi extends BaseAPI implements KnowledgeAiInterface {
|
|
1476
|
+
/**
|
|
1477
|
+
* Upload a new knowledge document. Returns 409 if filename already exists.
|
|
1478
|
+
* @summary Upload Document
|
|
1479
|
+
* @param {KnowledgeAiCreateDocumentRequest} requestParameters Request parameters.
|
|
1480
|
+
* @param {*} [options] Override http request option.
|
|
1481
|
+
* @throws {RequiredError}
|
|
1482
|
+
* @memberof KnowledgeAi
|
|
1483
|
+
*/
|
|
1484
|
+
createDocument(requestParameters: KnowledgeAiCreateDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<AiUploadDocumentResponse>;
|
|
1485
|
+
/**
|
|
1486
|
+
* Delete a knowledge document and all its chunks.
|
|
1487
|
+
* @summary Delete Document
|
|
1488
|
+
* @param {KnowledgeAiDeleteDocumentRequest} requestParameters Request parameters.
|
|
1489
|
+
* @param {*} [options] Override http request option.
|
|
1490
|
+
* @throws {RequiredError}
|
|
1491
|
+
* @memberof KnowledgeAi
|
|
1492
|
+
*/
|
|
1493
|
+
deleteDocument(requestParameters: KnowledgeAiDeleteDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<AiDeleteDocumentResponse>;
|
|
1072
1494
|
/**
|
|
1073
1495
|
* Download a knowledge document\'s raw file.
|
|
1074
1496
|
* @summary Download Document
|
|
1075
|
-
* @param {
|
|
1497
|
+
* @param {KnowledgeAiDownloadDocumentRequest} requestParameters Request parameters.
|
|
1076
1498
|
* @param {*} [options] Override http request option.
|
|
1077
1499
|
* @throws {RequiredError}
|
|
1078
1500
|
* @memberof KnowledgeAi
|
|
1079
1501
|
*/
|
|
1080
|
-
|
|
1502
|
+
downloadDocument(requestParameters: KnowledgeAiDownloadDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
|
|
1081
1503
|
/**
|
|
1082
|
-
*
|
|
1083
|
-
* @summary
|
|
1084
|
-
* @param {
|
|
1504
|
+
* Get a single knowledge document\'s metadata.
|
|
1505
|
+
* @summary Get Document
|
|
1506
|
+
* @param {KnowledgeAiGetDocumentRequest} requestParameters Request parameters.
|
|
1507
|
+
* @param {*} [options] Override http request option.
|
|
1508
|
+
* @throws {RequiredError}
|
|
1509
|
+
* @memberof KnowledgeAi
|
|
1510
|
+
*/
|
|
1511
|
+
getDocument(requestParameters: KnowledgeAiGetDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<AiDocumentMetadataResponse>;
|
|
1512
|
+
/**
|
|
1513
|
+
* List knowledge documents accessible from the workspace.
|
|
1514
|
+
* @summary List Documents
|
|
1515
|
+
* @param {KnowledgeAiListDocumentsRequest} requestParameters Request parameters.
|
|
1516
|
+
* @param {*} [options] Override http request option.
|
|
1517
|
+
* @throws {RequiredError}
|
|
1518
|
+
* @memberof KnowledgeAi
|
|
1519
|
+
*/
|
|
1520
|
+
listDocuments(requestParameters: KnowledgeAiListDocumentsRequest, options?: AxiosRequestConfig): AxiosPromise<AiListDocumentsResponse>;
|
|
1521
|
+
/**
|
|
1522
|
+
* Patch a knowledge document\'s metadata without re-uploading content.
|
|
1523
|
+
* @summary Patch Document
|
|
1524
|
+
* @param {KnowledgeAiPatchDocumentRequest} requestParameters Request parameters.
|
|
1525
|
+
* @param {*} [options] Override http request option.
|
|
1526
|
+
* @throws {RequiredError}
|
|
1527
|
+
* @memberof KnowledgeAi
|
|
1528
|
+
*/
|
|
1529
|
+
patchDocument(requestParameters: KnowledgeAiPatchDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<AiDocumentMetadataResponse>;
|
|
1530
|
+
/**
|
|
1531
|
+
* Search the knowledge base using semantic similarity.
|
|
1532
|
+
* @summary Search Documents
|
|
1533
|
+
* @param {KnowledgeAiSearchKnowledgeRequest} requestParameters Request parameters.
|
|
1085
1534
|
* @param {*} [options] Override http request option.
|
|
1086
1535
|
* @throws {RequiredError}
|
|
1087
1536
|
* @memberof KnowledgeAi
|
|
1088
1537
|
*/
|
|
1089
|
-
|
|
1538
|
+
searchKnowledge(requestParameters: KnowledgeAiSearchKnowledgeRequest, options?: AxiosRequestConfig): AxiosPromise<AiSearchDocumentsResponse>;
|
|
1090
1539
|
/**
|
|
1091
1540
|
* Upload or replace a knowledge document.
|
|
1092
1541
|
* @summary Upsert Document
|
|
1093
|
-
* @param {
|
|
1542
|
+
* @param {KnowledgeAiUpsertDocumentRequest} requestParameters Request parameters.
|
|
1094
1543
|
* @param {*} [options] Override http request option.
|
|
1095
1544
|
* @throws {RequiredError}
|
|
1096
1545
|
* @memberof KnowledgeAi
|
|
1097
1546
|
*/
|
|
1098
|
-
|
|
1547
|
+
upsertDocument(requestParameters: KnowledgeAiUpsertDocumentRequest, options?: AxiosRequestConfig): AxiosPromise<AiUploadDocumentResponse>;
|
|
1099
1548
|
}
|
|
1100
1549
|
/**
|
|
1101
1550
|
*
|
|
@@ -1209,7 +1658,7 @@ export declare function ResponsesAiAxiosParamCreator_PatchResponseApiV1AiWorkspa
|
|
|
1209
1658
|
* @param {Configuration} [configuration] Optional configuration.
|
|
1210
1659
|
* @throws {RequiredError}
|
|
1211
1660
|
*/
|
|
1212
|
-
export declare function ResponsesAi_GetConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGet(axios: AxiosInstance, basePath: string, requestParameters: ResponsesAiGetConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGetRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<
|
|
1661
|
+
export declare function ResponsesAi_GetConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGet(axios: AxiosInstance, basePath: string, requestParameters: ResponsesAiGetConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGetRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<AiConversationResponseList>;
|
|
1213
1662
|
/**
|
|
1214
1663
|
*
|
|
1215
1664
|
* @summary Patch Response
|
|
@@ -1235,7 +1684,7 @@ export interface ResponsesAiInterface {
|
|
|
1235
1684
|
* @throws {RequiredError}
|
|
1236
1685
|
* @memberof ResponsesAiInterface
|
|
1237
1686
|
*/
|
|
1238
|
-
getConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGet(requestParameters: ResponsesAiGetConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGetRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
1687
|
+
getConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGet(requestParameters: ResponsesAiGetConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGetRequest, options?: AxiosRequestConfig): AxiosPromise<AiConversationResponseList>;
|
|
1239
1688
|
/**
|
|
1240
1689
|
*
|
|
1241
1690
|
* @summary Patch Response
|
|
@@ -1311,7 +1760,7 @@ export declare class ResponsesAi extends BaseAPI implements ResponsesAiInterface
|
|
|
1311
1760
|
* @throws {RequiredError}
|
|
1312
1761
|
* @memberof ResponsesAi
|
|
1313
1762
|
*/
|
|
1314
|
-
getConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGet(requestParameters: ResponsesAiGetConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGetRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
1763
|
+
getConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGet(requestParameters: ResponsesAiGetConversationResponsesApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesGetRequest, options?: AxiosRequestConfig): AxiosPromise<AiConversationResponseList>;
|
|
1315
1764
|
/**
|
|
1316
1765
|
*
|
|
1317
1766
|
* @summary Patch Response
|