@quantcdn/quant-client 4.9.0 → 4.10.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/api.ts +3427 -1418
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1389 -137
- package/dist/api.js +2807 -1405
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +1389 -137
- package/dist/esm/api.js +2722 -1329
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +2 -2
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* QuantCDN API
|
|
3
3
|
* Unified API for QuantCDN Admin and QuantCloud Platform services
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 4.
|
|
5
|
+
* The version of the OpenAPI document: 4.10.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -611,7 +611,49 @@ export interface ChatInferenceRequest {
|
|
|
611
611
|
* @memberof ChatInferenceRequest
|
|
612
612
|
*/
|
|
613
613
|
'async'?: boolean;
|
|
614
|
+
/**
|
|
615
|
+
* Top-level convenience alias for toolConfig.allowedTools. Whitelists which tools can be auto-executed.
|
|
616
|
+
* @type {Array<string>}
|
|
617
|
+
* @memberof ChatInferenceRequest
|
|
618
|
+
*/
|
|
619
|
+
'allowedTools'?: Array<string>;
|
|
620
|
+
/**
|
|
621
|
+
*
|
|
622
|
+
* @type {ChatInferenceRequestGuardrails}
|
|
623
|
+
* @memberof ChatInferenceRequest
|
|
624
|
+
*/
|
|
625
|
+
'guardrails'?: ChatInferenceRequestGuardrails;
|
|
626
|
+
}
|
|
627
|
+
/**
|
|
628
|
+
* AWS Bedrock guardrails configuration for content filtering and safety.
|
|
629
|
+
* @export
|
|
630
|
+
* @interface ChatInferenceRequestGuardrails
|
|
631
|
+
*/
|
|
632
|
+
export interface ChatInferenceRequestGuardrails {
|
|
633
|
+
/**
|
|
634
|
+
* Guardrail identifier from AWS Bedrock
|
|
635
|
+
* @type {string}
|
|
636
|
+
* @memberof ChatInferenceRequestGuardrails
|
|
637
|
+
*/
|
|
638
|
+
'guardrailIdentifier'?: string;
|
|
639
|
+
/**
|
|
640
|
+
* Guardrail version
|
|
641
|
+
* @type {string}
|
|
642
|
+
* @memberof ChatInferenceRequestGuardrails
|
|
643
|
+
*/
|
|
644
|
+
'guardrailVersion'?: string;
|
|
645
|
+
/**
|
|
646
|
+
* Enable guardrail trace output
|
|
647
|
+
* @type {string}
|
|
648
|
+
* @memberof ChatInferenceRequestGuardrails
|
|
649
|
+
*/
|
|
650
|
+
'trace'?: ChatInferenceRequestGuardrailsTraceEnum;
|
|
614
651
|
}
|
|
652
|
+
export declare const ChatInferenceRequestGuardrailsTraceEnum: {
|
|
653
|
+
readonly Enabled: "enabled";
|
|
654
|
+
readonly Disabled: "disabled";
|
|
655
|
+
};
|
|
656
|
+
export type ChatInferenceRequestGuardrailsTraceEnum = typeof ChatInferenceRequestGuardrailsTraceEnum[keyof typeof ChatInferenceRequestGuardrailsTraceEnum];
|
|
615
657
|
/**
|
|
616
658
|
*
|
|
617
659
|
* @export
|
|
@@ -993,6 +1035,18 @@ export interface ChatInferenceStreamRequest {
|
|
|
993
1035
|
* @memberof ChatInferenceStreamRequest
|
|
994
1036
|
*/
|
|
995
1037
|
'async'?: boolean;
|
|
1038
|
+
/**
|
|
1039
|
+
* Top-level convenience alias for toolConfig.allowedTools. Whitelists which tools can be auto-executed.
|
|
1040
|
+
* @type {Array<string>}
|
|
1041
|
+
* @memberof ChatInferenceStreamRequest
|
|
1042
|
+
*/
|
|
1043
|
+
'allowedTools'?: Array<string>;
|
|
1044
|
+
/**
|
|
1045
|
+
*
|
|
1046
|
+
* @type {ChatInferenceRequestGuardrails}
|
|
1047
|
+
* @memberof ChatInferenceStreamRequest
|
|
1048
|
+
*/
|
|
1049
|
+
'guardrails'?: ChatInferenceRequestGuardrails;
|
|
996
1050
|
}
|
|
997
1051
|
/**
|
|
998
1052
|
*
|
|
@@ -2227,6 +2281,148 @@ export interface CreateEnvironmentRequestEnvironmentInner {
|
|
|
2227
2281
|
*/
|
|
2228
2282
|
'value'?: string;
|
|
2229
2283
|
}
|
|
2284
|
+
/**
|
|
2285
|
+
*
|
|
2286
|
+
* @export
|
|
2287
|
+
* @interface CreateOrchestrationRequest
|
|
2288
|
+
*/
|
|
2289
|
+
export interface CreateOrchestrationRequest {
|
|
2290
|
+
/**
|
|
2291
|
+
* Orchestration name
|
|
2292
|
+
* @type {string}
|
|
2293
|
+
* @memberof CreateOrchestrationRequest
|
|
2294
|
+
*/
|
|
2295
|
+
'name': string;
|
|
2296
|
+
/**
|
|
2297
|
+
* Optional description
|
|
2298
|
+
* @type {string}
|
|
2299
|
+
* @memberof CreateOrchestrationRequest
|
|
2300
|
+
*/
|
|
2301
|
+
'description'?: string | null;
|
|
2302
|
+
/**
|
|
2303
|
+
* Agent to process items
|
|
2304
|
+
* @type {string}
|
|
2305
|
+
* @memberof CreateOrchestrationRequest
|
|
2306
|
+
*/
|
|
2307
|
+
'agentId'?: string | null;
|
|
2308
|
+
/**
|
|
2309
|
+
* Tool to execute for items
|
|
2310
|
+
* @type {string}
|
|
2311
|
+
* @memberof CreateOrchestrationRequest
|
|
2312
|
+
*/
|
|
2313
|
+
'toolId'?: string | null;
|
|
2314
|
+
/**
|
|
2315
|
+
* Workflow to run for items
|
|
2316
|
+
* @type {string}
|
|
2317
|
+
* @memberof CreateOrchestrationRequest
|
|
2318
|
+
*/
|
|
2319
|
+
'workflowId'?: string | null;
|
|
2320
|
+
/**
|
|
2321
|
+
*
|
|
2322
|
+
* @type {CreateOrchestrationRequestInputSource}
|
|
2323
|
+
* @memberof CreateOrchestrationRequest
|
|
2324
|
+
*/
|
|
2325
|
+
'inputSource': CreateOrchestrationRequestInputSource;
|
|
2326
|
+
/**
|
|
2327
|
+
* Items per batch
|
|
2328
|
+
* @type {number}
|
|
2329
|
+
* @memberof CreateOrchestrationRequest
|
|
2330
|
+
*/
|
|
2331
|
+
'batchSize'?: number;
|
|
2332
|
+
/**
|
|
2333
|
+
* Concurrent items within a batch
|
|
2334
|
+
* @type {number}
|
|
2335
|
+
* @memberof CreateOrchestrationRequest
|
|
2336
|
+
*/
|
|
2337
|
+
'concurrency'?: number;
|
|
2338
|
+
/**
|
|
2339
|
+
*
|
|
2340
|
+
* @type {CreateOrchestrationRequestStopCondition}
|
|
2341
|
+
* @memberof CreateOrchestrationRequest
|
|
2342
|
+
*/
|
|
2343
|
+
'stopCondition'?: CreateOrchestrationRequestStopCondition;
|
|
2344
|
+
/**
|
|
2345
|
+
* Skill IDs to assign
|
|
2346
|
+
* @type {Array<string>}
|
|
2347
|
+
* @memberof CreateOrchestrationRequest
|
|
2348
|
+
*/
|
|
2349
|
+
'assignedSkills'?: Array<string>;
|
|
2350
|
+
/**
|
|
2351
|
+
* Whether to start immediately
|
|
2352
|
+
* @type {boolean}
|
|
2353
|
+
* @memberof CreateOrchestrationRequest
|
|
2354
|
+
*/
|
|
2355
|
+
'autoStart'?: boolean;
|
|
2356
|
+
}
|
|
2357
|
+
/**
|
|
2358
|
+
*
|
|
2359
|
+
* @export
|
|
2360
|
+
* @interface CreateOrchestrationRequestInputSource
|
|
2361
|
+
*/
|
|
2362
|
+
export interface CreateOrchestrationRequestInputSource {
|
|
2363
|
+
/**
|
|
2364
|
+
* Input source type (api type not yet supported)
|
|
2365
|
+
* @type {string}
|
|
2366
|
+
* @memberof CreateOrchestrationRequestInputSource
|
|
2367
|
+
*/
|
|
2368
|
+
'type': CreateOrchestrationRequestInputSourceTypeEnum;
|
|
2369
|
+
/**
|
|
2370
|
+
* Static items (for type=static)
|
|
2371
|
+
* @type {Array<object>}
|
|
2372
|
+
* @memberof CreateOrchestrationRequestInputSource
|
|
2373
|
+
*/
|
|
2374
|
+
'items'?: Array<object>;
|
|
2375
|
+
/**
|
|
2376
|
+
* Task query filters (for type=task_query)
|
|
2377
|
+
* @type {object}
|
|
2378
|
+
* @memberof CreateOrchestrationRequestInputSource
|
|
2379
|
+
*/
|
|
2380
|
+
'taskQuery'?: object;
|
|
2381
|
+
/**
|
|
2382
|
+
* AI prompt (for type=generator)
|
|
2383
|
+
* @type {string}
|
|
2384
|
+
* @memberof CreateOrchestrationRequestInputSource
|
|
2385
|
+
*/
|
|
2386
|
+
'generatorPrompt'?: string;
|
|
2387
|
+
}
|
|
2388
|
+
export declare const CreateOrchestrationRequestInputSourceTypeEnum: {
|
|
2389
|
+
readonly Static: "static";
|
|
2390
|
+
readonly TaskQuery: "task_query";
|
|
2391
|
+
readonly Generator: "generator";
|
|
2392
|
+
};
|
|
2393
|
+
export type CreateOrchestrationRequestInputSourceTypeEnum = typeof CreateOrchestrationRequestInputSourceTypeEnum[keyof typeof CreateOrchestrationRequestInputSourceTypeEnum];
|
|
2394
|
+
/**
|
|
2395
|
+
*
|
|
2396
|
+
* @export
|
|
2397
|
+
* @interface CreateOrchestrationRequestStopCondition
|
|
2398
|
+
*/
|
|
2399
|
+
export interface CreateOrchestrationRequestStopCondition {
|
|
2400
|
+
/**
|
|
2401
|
+
*
|
|
2402
|
+
* @type {string}
|
|
2403
|
+
* @memberof CreateOrchestrationRequestStopCondition
|
|
2404
|
+
*/
|
|
2405
|
+
'type'?: CreateOrchestrationRequestStopConditionTypeEnum;
|
|
2406
|
+
/**
|
|
2407
|
+
* Max iterations (for type=max_iterations)
|
|
2408
|
+
* @type {number}
|
|
2409
|
+
* @memberof CreateOrchestrationRequestStopCondition
|
|
2410
|
+
*/
|
|
2411
|
+
'maxIterations'?: number;
|
|
2412
|
+
/**
|
|
2413
|
+
* AI prompt to evaluate stop (for type=condition)
|
|
2414
|
+
* @type {string}
|
|
2415
|
+
* @memberof CreateOrchestrationRequestStopCondition
|
|
2416
|
+
*/
|
|
2417
|
+
'conditionPrompt'?: string;
|
|
2418
|
+
}
|
|
2419
|
+
export declare const CreateOrchestrationRequestStopConditionTypeEnum: {
|
|
2420
|
+
readonly AllComplete: "all_complete";
|
|
2421
|
+
readonly MaxIterations: "max_iterations";
|
|
2422
|
+
readonly Condition: "condition";
|
|
2423
|
+
readonly Manual: "manual";
|
|
2424
|
+
};
|
|
2425
|
+
export type CreateOrchestrationRequestStopConditionTypeEnum = typeof CreateOrchestrationRequestStopConditionTypeEnum[keyof typeof CreateOrchestrationRequestStopConditionTypeEnum];
|
|
2230
2426
|
/**
|
|
2231
2427
|
*
|
|
2232
2428
|
* @export
|
|
@@ -2728,6 +2924,75 @@ export interface DeleteVectorCollection200Response {
|
|
|
2728
2924
|
*/
|
|
2729
2925
|
'message'?: string;
|
|
2730
2926
|
}
|
|
2927
|
+
/**
|
|
2928
|
+
*
|
|
2929
|
+
* @export
|
|
2930
|
+
* @interface DeleteVectorDocuments200Response
|
|
2931
|
+
*/
|
|
2932
|
+
export interface DeleteVectorDocuments200Response {
|
|
2933
|
+
/**
|
|
2934
|
+
*
|
|
2935
|
+
* @type {string}
|
|
2936
|
+
* @memberof DeleteVectorDocuments200Response
|
|
2937
|
+
*/
|
|
2938
|
+
'message'?: string;
|
|
2939
|
+
/**
|
|
2940
|
+
*
|
|
2941
|
+
* @type {string}
|
|
2942
|
+
* @memberof DeleteVectorDocuments200Response
|
|
2943
|
+
*/
|
|
2944
|
+
'collectionId'?: string;
|
|
2945
|
+
/**
|
|
2946
|
+
*
|
|
2947
|
+
* @type {number}
|
|
2948
|
+
* @memberof DeleteVectorDocuments200Response
|
|
2949
|
+
*/
|
|
2950
|
+
'deletedCount'?: number;
|
|
2951
|
+
}
|
|
2952
|
+
/**
|
|
2953
|
+
*
|
|
2954
|
+
* @export
|
|
2955
|
+
* @interface DeleteVectorDocumentsRequest
|
|
2956
|
+
*/
|
|
2957
|
+
export interface DeleteVectorDocumentsRequest {
|
|
2958
|
+
/**
|
|
2959
|
+
* Delete ALL documents in collection
|
|
2960
|
+
* @type {boolean}
|
|
2961
|
+
* @memberof DeleteVectorDocumentsRequest
|
|
2962
|
+
*/
|
|
2963
|
+
'purgeAll'?: boolean;
|
|
2964
|
+
/**
|
|
2965
|
+
* Delete specific documents by UUID
|
|
2966
|
+
* @type {Array<string>}
|
|
2967
|
+
* @memberof DeleteVectorDocumentsRequest
|
|
2968
|
+
*/
|
|
2969
|
+
'documentIds'?: Array<string>;
|
|
2970
|
+
/**
|
|
2971
|
+
*
|
|
2972
|
+
* @type {DeleteVectorDocumentsRequestMetadata}
|
|
2973
|
+
* @memberof DeleteVectorDocumentsRequest
|
|
2974
|
+
*/
|
|
2975
|
+
'metadata'?: DeleteVectorDocumentsRequestMetadata;
|
|
2976
|
+
}
|
|
2977
|
+
/**
|
|
2978
|
+
*
|
|
2979
|
+
* @export
|
|
2980
|
+
* @interface DeleteVectorDocumentsRequestMetadata
|
|
2981
|
+
*/
|
|
2982
|
+
export interface DeleteVectorDocumentsRequestMetadata {
|
|
2983
|
+
/**
|
|
2984
|
+
* Metadata field name (e.g., \'drupal_entity_id\')
|
|
2985
|
+
* @type {string}
|
|
2986
|
+
* @memberof DeleteVectorDocumentsRequestMetadata
|
|
2987
|
+
*/
|
|
2988
|
+
'field'?: string;
|
|
2989
|
+
/**
|
|
2990
|
+
* Values to match (OR logic)
|
|
2991
|
+
* @type {Array<string>}
|
|
2992
|
+
* @memberof DeleteVectorDocumentsRequestMetadata
|
|
2993
|
+
*/
|
|
2994
|
+
'values'?: Array<string>;
|
|
2995
|
+
}
|
|
2731
2996
|
/**
|
|
2732
2997
|
*
|
|
2733
2998
|
* @export
|
|
@@ -4807,6 +5072,38 @@ export interface KVItemsShow200Response {
|
|
|
4807
5072
|
* @export
|
|
4808
5073
|
*/
|
|
4809
5074
|
export type KVItemsShow200ResponseValue = object | string;
|
|
5075
|
+
/**
|
|
5076
|
+
*
|
|
5077
|
+
* @export
|
|
5078
|
+
* @interface KVLinkToProject200Response
|
|
5079
|
+
*/
|
|
5080
|
+
export interface KVLinkToProject200Response {
|
|
5081
|
+
/**
|
|
5082
|
+
*
|
|
5083
|
+
* @type {boolean}
|
|
5084
|
+
* @memberof KVLinkToProject200Response
|
|
5085
|
+
*/
|
|
5086
|
+
'success'?: boolean;
|
|
5087
|
+
/**
|
|
5088
|
+
*
|
|
5089
|
+
* @type {string}
|
|
5090
|
+
* @memberof KVLinkToProject200Response
|
|
5091
|
+
*/
|
|
5092
|
+
'message'?: string;
|
|
5093
|
+
}
|
|
5094
|
+
/**
|
|
5095
|
+
*
|
|
5096
|
+
* @export
|
|
5097
|
+
* @interface KVLinkToProjectRequest
|
|
5098
|
+
*/
|
|
5099
|
+
export interface KVLinkToProjectRequest {
|
|
5100
|
+
/**
|
|
5101
|
+
* Target project ID to link to
|
|
5102
|
+
* @type {number}
|
|
5103
|
+
* @memberof KVLinkToProjectRequest
|
|
5104
|
+
*/
|
|
5105
|
+
'project_id': number;
|
|
5106
|
+
}
|
|
4810
5107
|
/**
|
|
4811
5108
|
*
|
|
4812
5109
|
* @export
|
|
@@ -5430,132 +5727,244 @@ export interface ListFiles200ResponseFilesInner {
|
|
|
5430
5727
|
/**
|
|
5431
5728
|
*
|
|
5432
5729
|
* @export
|
|
5433
|
-
* @interface
|
|
5730
|
+
* @interface ListOrchestrationBatches200Response
|
|
5434
5731
|
*/
|
|
5435
|
-
export interface
|
|
5732
|
+
export interface ListOrchestrationBatches200Response {
|
|
5436
5733
|
/**
|
|
5437
5734
|
*
|
|
5438
|
-
* @type {Array<
|
|
5439
|
-
* @memberof
|
|
5440
|
-
*/
|
|
5441
|
-
'tasks'?: Array<ListTasks200ResponseTasksInner>;
|
|
5442
|
-
/**
|
|
5443
|
-
* Task IDs (only with dependsOn filter)
|
|
5444
|
-
* @type {Array<string>}
|
|
5445
|
-
* @memberof ListTasks200Response
|
|
5735
|
+
* @type {Array<ListOrchestrationBatches200ResponseBatchesInner>}
|
|
5736
|
+
* @memberof ListOrchestrationBatches200Response
|
|
5446
5737
|
*/
|
|
5447
|
-
'
|
|
5738
|
+
'batches'?: Array<ListOrchestrationBatches200ResponseBatchesInner>;
|
|
5448
5739
|
/**
|
|
5449
5740
|
*
|
|
5450
|
-
* @type {number}
|
|
5451
|
-
* @memberof ListTasks200Response
|
|
5452
|
-
*/
|
|
5453
|
-
'count'?: number;
|
|
5454
|
-
/**
|
|
5455
|
-
* The queried task ID (only with dependsOn filter)
|
|
5456
5741
|
* @type {string}
|
|
5457
|
-
* @memberof
|
|
5742
|
+
* @memberof ListOrchestrationBatches200Response
|
|
5458
5743
|
*/
|
|
5459
|
-
'
|
|
5744
|
+
'nextCursor'?: string | null;
|
|
5460
5745
|
}
|
|
5461
5746
|
/**
|
|
5462
5747
|
*
|
|
5463
5748
|
* @export
|
|
5464
|
-
* @interface
|
|
5749
|
+
* @interface ListOrchestrationBatches200ResponseBatchesInner
|
|
5465
5750
|
*/
|
|
5466
|
-
export interface
|
|
5467
|
-
/**
|
|
5468
|
-
*
|
|
5469
|
-
* @type {string}
|
|
5470
|
-
* @memberof ListTasks200ResponseTasksInner
|
|
5471
|
-
*/
|
|
5472
|
-
'taskId'?: string;
|
|
5473
|
-
/**
|
|
5474
|
-
*
|
|
5475
|
-
* @type {string}
|
|
5476
|
-
* @memberof ListTasks200ResponseTasksInner
|
|
5477
|
-
*/
|
|
5478
|
-
'orgId'?: string;
|
|
5751
|
+
export interface ListOrchestrationBatches200ResponseBatchesInner {
|
|
5479
5752
|
/**
|
|
5480
5753
|
*
|
|
5481
5754
|
* @type {string}
|
|
5482
|
-
* @memberof
|
|
5755
|
+
* @memberof ListOrchestrationBatches200ResponseBatchesInner
|
|
5483
5756
|
*/
|
|
5484
|
-
'
|
|
5757
|
+
'batchId'?: string;
|
|
5485
5758
|
/**
|
|
5486
5759
|
*
|
|
5487
5760
|
* @type {string}
|
|
5488
|
-
* @memberof
|
|
5761
|
+
* @memberof ListOrchestrationBatches200ResponseBatchesInner
|
|
5489
5762
|
*/
|
|
5490
|
-
'
|
|
5763
|
+
'orchestrationId'?: string;
|
|
5491
5764
|
/**
|
|
5492
5765
|
*
|
|
5493
|
-
* @type {
|
|
5494
|
-
* @memberof
|
|
5766
|
+
* @type {number}
|
|
5767
|
+
* @memberof ListOrchestrationBatches200ResponseBatchesInner
|
|
5495
5768
|
*/
|
|
5496
|
-
'
|
|
5769
|
+
'iteration'?: number;
|
|
5497
5770
|
/**
|
|
5498
5771
|
*
|
|
5499
|
-
* @type {
|
|
5500
|
-
* @memberof
|
|
5772
|
+
* @type {number}
|
|
5773
|
+
* @memberof ListOrchestrationBatches200ResponseBatchesInner
|
|
5501
5774
|
*/
|
|
5502
|
-
'
|
|
5775
|
+
'itemCount'?: number;
|
|
5503
5776
|
/**
|
|
5504
5777
|
*
|
|
5505
|
-
* @type {
|
|
5506
|
-
* @memberof
|
|
5778
|
+
* @type {number}
|
|
5779
|
+
* @memberof ListOrchestrationBatches200ResponseBatchesInner
|
|
5507
5780
|
*/
|
|
5508
|
-
'
|
|
5781
|
+
'completedCount'?: number;
|
|
5509
5782
|
/**
|
|
5510
5783
|
*
|
|
5511
5784
|
* @type {number}
|
|
5512
|
-
* @memberof
|
|
5785
|
+
* @memberof ListOrchestrationBatches200ResponseBatchesInner
|
|
5513
5786
|
*/
|
|
5514
|
-
'
|
|
5787
|
+
'failedCount'?: number;
|
|
5515
5788
|
/**
|
|
5516
5789
|
*
|
|
5517
5790
|
* @type {string}
|
|
5518
|
-
* @memberof
|
|
5791
|
+
* @memberof ListOrchestrationBatches200ResponseBatchesInner
|
|
5519
5792
|
*/
|
|
5520
|
-
'
|
|
5793
|
+
'status'?: ListOrchestrationBatches200ResponseBatchesInnerStatusEnum;
|
|
5521
5794
|
/**
|
|
5522
5795
|
*
|
|
5523
|
-
* @type {
|
|
5524
|
-
* @memberof
|
|
5796
|
+
* @type {string}
|
|
5797
|
+
* @memberof ListOrchestrationBatches200ResponseBatchesInner
|
|
5525
5798
|
*/
|
|
5526
|
-
'
|
|
5799
|
+
'startedAt'?: string;
|
|
5527
5800
|
/**
|
|
5528
5801
|
*
|
|
5529
|
-
* @type {
|
|
5530
|
-
* @memberof
|
|
5802
|
+
* @type {string}
|
|
5803
|
+
* @memberof ListOrchestrationBatches200ResponseBatchesInner
|
|
5531
5804
|
*/
|
|
5532
|
-
'
|
|
5805
|
+
'completedAt'?: string;
|
|
5533
5806
|
/**
|
|
5534
5807
|
*
|
|
5535
|
-
* @type {
|
|
5536
|
-
* @memberof
|
|
5808
|
+
* @type {string}
|
|
5809
|
+
* @memberof ListOrchestrationBatches200ResponseBatchesInner
|
|
5537
5810
|
*/
|
|
5538
|
-
'
|
|
5811
|
+
'error'?: string | null;
|
|
5539
5812
|
}
|
|
5540
|
-
export declare const
|
|
5813
|
+
export declare const ListOrchestrationBatches200ResponseBatchesInnerStatusEnum: {
|
|
5541
5814
|
readonly Pending: "pending";
|
|
5542
|
-
readonly
|
|
5815
|
+
readonly Running: "running";
|
|
5543
5816
|
readonly Completed: "completed";
|
|
5544
5817
|
readonly Failed: "failed";
|
|
5545
|
-
readonly Cancelled: "cancelled";
|
|
5546
|
-
readonly Blocked: "blocked";
|
|
5547
5818
|
};
|
|
5548
|
-
export type
|
|
5819
|
+
export type ListOrchestrationBatches200ResponseBatchesInnerStatusEnum = typeof ListOrchestrationBatches200ResponseBatchesInnerStatusEnum[keyof typeof ListOrchestrationBatches200ResponseBatchesInnerStatusEnum];
|
|
5549
5820
|
/**
|
|
5550
5821
|
*
|
|
5551
5822
|
* @export
|
|
5552
|
-
* @interface
|
|
5823
|
+
* @interface ListOrchestrations200Response
|
|
5553
5824
|
*/
|
|
5554
|
-
export interface
|
|
5825
|
+
export interface ListOrchestrations200Response {
|
|
5555
5826
|
/**
|
|
5556
5827
|
*
|
|
5557
|
-
* @type {Array<
|
|
5558
|
-
* @memberof
|
|
5828
|
+
* @type {Array<object>}
|
|
5829
|
+
* @memberof ListOrchestrations200Response
|
|
5830
|
+
*/
|
|
5831
|
+
'orchestrations'?: Array<object>;
|
|
5832
|
+
/**
|
|
5833
|
+
*
|
|
5834
|
+
* @type {string}
|
|
5835
|
+
* @memberof ListOrchestrations200Response
|
|
5836
|
+
*/
|
|
5837
|
+
'nextCursor'?: string | null;
|
|
5838
|
+
}
|
|
5839
|
+
/**
|
|
5840
|
+
*
|
|
5841
|
+
* @export
|
|
5842
|
+
* @interface ListTasks200Response
|
|
5843
|
+
*/
|
|
5844
|
+
export interface ListTasks200Response {
|
|
5845
|
+
/**
|
|
5846
|
+
*
|
|
5847
|
+
* @type {Array<ListTasks200ResponseTasksInner>}
|
|
5848
|
+
* @memberof ListTasks200Response
|
|
5849
|
+
*/
|
|
5850
|
+
'tasks'?: Array<ListTasks200ResponseTasksInner>;
|
|
5851
|
+
/**
|
|
5852
|
+
* Task IDs (only with dependsOn filter)
|
|
5853
|
+
* @type {Array<string>}
|
|
5854
|
+
* @memberof ListTasks200Response
|
|
5855
|
+
*/
|
|
5856
|
+
'taskIds'?: Array<string>;
|
|
5857
|
+
/**
|
|
5858
|
+
*
|
|
5859
|
+
* @type {number}
|
|
5860
|
+
* @memberof ListTasks200Response
|
|
5861
|
+
*/
|
|
5862
|
+
'count'?: number;
|
|
5863
|
+
/**
|
|
5864
|
+
* The queried task ID (only with dependsOn filter)
|
|
5865
|
+
* @type {string}
|
|
5866
|
+
* @memberof ListTasks200Response
|
|
5867
|
+
*/
|
|
5868
|
+
'dependsOn'?: string;
|
|
5869
|
+
}
|
|
5870
|
+
/**
|
|
5871
|
+
*
|
|
5872
|
+
* @export
|
|
5873
|
+
* @interface ListTasks200ResponseTasksInner
|
|
5874
|
+
*/
|
|
5875
|
+
export interface ListTasks200ResponseTasksInner {
|
|
5876
|
+
/**
|
|
5877
|
+
*
|
|
5878
|
+
* @type {string}
|
|
5879
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5880
|
+
*/
|
|
5881
|
+
'taskId'?: string;
|
|
5882
|
+
/**
|
|
5883
|
+
*
|
|
5884
|
+
* @type {string}
|
|
5885
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5886
|
+
*/
|
|
5887
|
+
'orgId'?: string;
|
|
5888
|
+
/**
|
|
5889
|
+
*
|
|
5890
|
+
* @type {string}
|
|
5891
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5892
|
+
*/
|
|
5893
|
+
'taskListId'?: string | null;
|
|
5894
|
+
/**
|
|
5895
|
+
*
|
|
5896
|
+
* @type {string}
|
|
5897
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5898
|
+
*/
|
|
5899
|
+
'title'?: string;
|
|
5900
|
+
/**
|
|
5901
|
+
*
|
|
5902
|
+
* @type {string}
|
|
5903
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5904
|
+
*/
|
|
5905
|
+
'description'?: string;
|
|
5906
|
+
/**
|
|
5907
|
+
*
|
|
5908
|
+
* @type {string}
|
|
5909
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5910
|
+
*/
|
|
5911
|
+
'status'?: ListTasks200ResponseTasksInnerStatusEnum;
|
|
5912
|
+
/**
|
|
5913
|
+
*
|
|
5914
|
+
* @type {string}
|
|
5915
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5916
|
+
*/
|
|
5917
|
+
'assignedAgentId'?: string | null;
|
|
5918
|
+
/**
|
|
5919
|
+
*
|
|
5920
|
+
* @type {number}
|
|
5921
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5922
|
+
*/
|
|
5923
|
+
'progress'?: number;
|
|
5924
|
+
/**
|
|
5925
|
+
*
|
|
5926
|
+
* @type {string}
|
|
5927
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5928
|
+
*/
|
|
5929
|
+
'blockedReason'?: string | null;
|
|
5930
|
+
/**
|
|
5931
|
+
*
|
|
5932
|
+
* @type {Array<string>}
|
|
5933
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5934
|
+
*/
|
|
5935
|
+
'blockedByTaskIds'?: Array<string> | null;
|
|
5936
|
+
/**
|
|
5937
|
+
*
|
|
5938
|
+
* @type {number}
|
|
5939
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5940
|
+
*/
|
|
5941
|
+
'createdAt'?: number;
|
|
5942
|
+
/**
|
|
5943
|
+
*
|
|
5944
|
+
* @type {number}
|
|
5945
|
+
* @memberof ListTasks200ResponseTasksInner
|
|
5946
|
+
*/
|
|
5947
|
+
'updatedAt'?: number;
|
|
5948
|
+
}
|
|
5949
|
+
export declare const ListTasks200ResponseTasksInnerStatusEnum: {
|
|
5950
|
+
readonly Pending: "pending";
|
|
5951
|
+
readonly InProgress: "in_progress";
|
|
5952
|
+
readonly Completed: "completed";
|
|
5953
|
+
readonly Failed: "failed";
|
|
5954
|
+
readonly Cancelled: "cancelled";
|
|
5955
|
+
readonly Blocked: "blocked";
|
|
5956
|
+
};
|
|
5957
|
+
export type ListTasks200ResponseTasksInnerStatusEnum = typeof ListTasks200ResponseTasksInnerStatusEnum[keyof typeof ListTasks200ResponseTasksInnerStatusEnum];
|
|
5958
|
+
/**
|
|
5959
|
+
*
|
|
5960
|
+
* @export
|
|
5961
|
+
* @interface ListVectorCollections200Response
|
|
5962
|
+
*/
|
|
5963
|
+
export interface ListVectorCollections200Response {
|
|
5964
|
+
/**
|
|
5965
|
+
*
|
|
5966
|
+
* @type {Array<ListVectorCollections200ResponseCollectionsInner>}
|
|
5967
|
+
* @memberof ListVectorCollections200Response
|
|
5559
5968
|
*/
|
|
5560
5969
|
'collections'?: Array<ListVectorCollections200ResponseCollectionsInner>;
|
|
5561
5970
|
/**
|
|
@@ -8717,7 +9126,7 @@ export interface V2CrawlerSchedule {
|
|
|
8717
9126
|
*/
|
|
8718
9127
|
'crawler_last_run_id': number;
|
|
8719
9128
|
/**
|
|
8720
|
-
*
|
|
9129
|
+
* Standard Unix cron expression with 5 space-separated fields: minute, hour, day-of-month, month, day-of-week. Example: 0 2 * * * runs daily at 2 AM.
|
|
8721
9130
|
* @type {string}
|
|
8722
9131
|
* @memberof V2CrawlerSchedule
|
|
8723
9132
|
*/
|
|
@@ -8742,13 +9151,13 @@ export interface V2CrawlerSchedule {
|
|
|
8742
9151
|
*/
|
|
8743
9152
|
export interface V2CrawlerScheduleRequest {
|
|
8744
9153
|
/**
|
|
8745
|
-
* Schedule name
|
|
9154
|
+
* Schedule name. If not provided, defaults to \'Schedule {crawler_name}\'.
|
|
8746
9155
|
* @type {string}
|
|
8747
9156
|
* @memberof V2CrawlerScheduleRequest
|
|
8748
9157
|
*/
|
|
8749
|
-
'name'
|
|
9158
|
+
'name'?: string;
|
|
8750
9159
|
/**
|
|
8751
|
-
*
|
|
9160
|
+
* Standard Unix cron expression with 5 space-separated fields: minute, hour, day-of-month, month, day-of-week. Example: 0 2 * * * for daily at 2 AM.
|
|
8752
9161
|
* @type {string}
|
|
8753
9162
|
* @memberof V2CrawlerScheduleRequest
|
|
8754
9163
|
*/
|
|
@@ -8913,6 +9322,138 @@ export interface V2Error {
|
|
|
8913
9322
|
*/
|
|
8914
9323
|
'error': boolean;
|
|
8915
9324
|
}
|
|
9325
|
+
/**
|
|
9326
|
+
*
|
|
9327
|
+
* @export
|
|
9328
|
+
* @interface V2MetricData
|
|
9329
|
+
*/
|
|
9330
|
+
export interface V2MetricData {
|
|
9331
|
+
/**
|
|
9332
|
+
* Time series data points
|
|
9333
|
+
* @type {Array<V2MetricDataPoint>}
|
|
9334
|
+
* @memberof V2MetricData
|
|
9335
|
+
*/
|
|
9336
|
+
'series': Array<V2MetricDataPoint>;
|
|
9337
|
+
/**
|
|
9338
|
+
* Total value for the period
|
|
9339
|
+
* @type {number}
|
|
9340
|
+
* @memberof V2MetricData
|
|
9341
|
+
*/
|
|
9342
|
+
'period_total': number;
|
|
9343
|
+
/**
|
|
9344
|
+
* All-time total value
|
|
9345
|
+
* @type {number}
|
|
9346
|
+
* @memberof V2MetricData
|
|
9347
|
+
*/
|
|
9348
|
+
'all_time_total': number;
|
|
9349
|
+
/**
|
|
9350
|
+
* Average value per time unit in the period
|
|
9351
|
+
* @type {number}
|
|
9352
|
+
* @memberof V2MetricData
|
|
9353
|
+
*/
|
|
9354
|
+
'period_average': number;
|
|
9355
|
+
}
|
|
9356
|
+
/**
|
|
9357
|
+
*
|
|
9358
|
+
* @export
|
|
9359
|
+
* @interface V2MetricDataPoint
|
|
9360
|
+
*/
|
|
9361
|
+
export interface V2MetricDataPoint {
|
|
9362
|
+
/**
|
|
9363
|
+
*
|
|
9364
|
+
* @type {V2MetricDataPointTimestamp}
|
|
9365
|
+
* @memberof V2MetricDataPoint
|
|
9366
|
+
*/
|
|
9367
|
+
'timestamp': V2MetricDataPointTimestamp;
|
|
9368
|
+
/**
|
|
9369
|
+
* Metric value at this timestamp
|
|
9370
|
+
* @type {number}
|
|
9371
|
+
* @memberof V2MetricDataPoint
|
|
9372
|
+
*/
|
|
9373
|
+
'value': number;
|
|
9374
|
+
}
|
|
9375
|
+
/**
|
|
9376
|
+
* @type V2MetricDataPointTimestamp
|
|
9377
|
+
* Timestamp for this data point (format depends on timestamp_format parameter)
|
|
9378
|
+
* @export
|
|
9379
|
+
*/
|
|
9380
|
+
export type V2MetricDataPointTimestamp = number | string;
|
|
9381
|
+
/**
|
|
9382
|
+
*
|
|
9383
|
+
* @export
|
|
9384
|
+
* @interface V2MetricsMeta
|
|
9385
|
+
*/
|
|
9386
|
+
export interface V2MetricsMeta {
|
|
9387
|
+
/**
|
|
9388
|
+
* The period type for this data
|
|
9389
|
+
* @type {string}
|
|
9390
|
+
* @memberof V2MetricsMeta
|
|
9391
|
+
*/
|
|
9392
|
+
'period': V2MetricsMetaPeriodEnum;
|
|
9393
|
+
/**
|
|
9394
|
+
* The granularity of data points
|
|
9395
|
+
* @type {string}
|
|
9396
|
+
* @memberof V2MetricsMeta
|
|
9397
|
+
*/
|
|
9398
|
+
'granularity': V2MetricsMetaGranularityEnum;
|
|
9399
|
+
/**
|
|
9400
|
+
* Start time of the data range (ISO8601 or Unix timestamp based on timestamp_format parameter)
|
|
9401
|
+
* @type {string}
|
|
9402
|
+
* @memberof V2MetricsMeta
|
|
9403
|
+
*/
|
|
9404
|
+
'start_time': string;
|
|
9405
|
+
/**
|
|
9406
|
+
* End time of the data range (ISO8601 or Unix timestamp based on timestamp_format parameter)
|
|
9407
|
+
* @type {string}
|
|
9408
|
+
* @memberof V2MetricsMeta
|
|
9409
|
+
*/
|
|
9410
|
+
'end_time': string;
|
|
9411
|
+
/**
|
|
9412
|
+
* List of metrics included in the response
|
|
9413
|
+
* @type {Array<string>}
|
|
9414
|
+
* @memberof V2MetricsMeta
|
|
9415
|
+
*/
|
|
9416
|
+
'metrics': Array<string>;
|
|
9417
|
+
/**
|
|
9418
|
+
* Domain filter applied (if any)
|
|
9419
|
+
* @type {string}
|
|
9420
|
+
* @memberof V2MetricsMeta
|
|
9421
|
+
*/
|
|
9422
|
+
'domain'?: string | null;
|
|
9423
|
+
}
|
|
9424
|
+
export declare const V2MetricsMetaPeriodEnum: {
|
|
9425
|
+
readonly Hourly: "hourly";
|
|
9426
|
+
readonly Daily: "daily";
|
|
9427
|
+
readonly Monthly: "monthly";
|
|
9428
|
+
};
|
|
9429
|
+
export type V2MetricsMetaPeriodEnum = typeof V2MetricsMetaPeriodEnum[keyof typeof V2MetricsMetaPeriodEnum];
|
|
9430
|
+
export declare const V2MetricsMetaGranularityEnum: {
|
|
9431
|
+
readonly Minute: "minute";
|
|
9432
|
+
readonly Day: "day";
|
|
9433
|
+
readonly Month: "month";
|
|
9434
|
+
};
|
|
9435
|
+
export type V2MetricsMetaGranularityEnum = typeof V2MetricsMetaGranularityEnum[keyof typeof V2MetricsMetaGranularityEnum];
|
|
9436
|
+
/**
|
|
9437
|
+
*
|
|
9438
|
+
* @export
|
|
9439
|
+
* @interface V2MetricsResponse
|
|
9440
|
+
*/
|
|
9441
|
+
export interface V2MetricsResponse {
|
|
9442
|
+
/**
|
|
9443
|
+
*
|
|
9444
|
+
* @type {V2MetricsMeta}
|
|
9445
|
+
* @memberof V2MetricsResponse
|
|
9446
|
+
*/
|
|
9447
|
+
'meta': V2MetricsMeta;
|
|
9448
|
+
/**
|
|
9449
|
+
* Metrics data keyed by metric name
|
|
9450
|
+
* @type {{ [key: string]: V2MetricData; }}
|
|
9451
|
+
* @memberof V2MetricsResponse
|
|
9452
|
+
*/
|
|
9453
|
+
'data': {
|
|
9454
|
+
[key: string]: V2MetricData;
|
|
9455
|
+
};
|
|
9456
|
+
}
|
|
8916
9457
|
/**
|
|
8917
9458
|
*
|
|
8918
9459
|
* @export
|
|
@@ -13373,81 +13914,468 @@ export declare class AIMonitoringApi extends BaseAPI {
|
|
|
13373
13914
|
getAIUsageStats(organisation: string, month?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAIUsageStats200Response, any, {}>>;
|
|
13374
13915
|
}
|
|
13375
13916
|
/**
|
|
13376
|
-
*
|
|
13917
|
+
* AIOrchestrationsApi - axios parameter creator
|
|
13377
13918
|
* @export
|
|
13378
13919
|
*/
|
|
13379
|
-
export declare const
|
|
13920
|
+
export declare const AIOrchestrationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
13380
13921
|
/**
|
|
13381
|
-
*
|
|
13382
|
-
* @summary
|
|
13383
|
-
* @param {string} organisation The organisation
|
|
13384
|
-
* @param {
|
|
13922
|
+
* Cancel an orchestration permanently. Cannot be resumed. Any in-progress items will complete, but no new processing starts.
|
|
13923
|
+
* @summary Cancel Durable Orchestration
|
|
13924
|
+
* @param {string} organisation The organisation machine name
|
|
13925
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
13385
13926
|
* @param {*} [options] Override http request option.
|
|
13386
13927
|
* @throws {RequiredError}
|
|
13387
13928
|
*/
|
|
13388
|
-
|
|
13929
|
+
cancelOrchestration: (organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13389
13930
|
/**
|
|
13390
|
-
*
|
|
13391
|
-
* @summary
|
|
13392
|
-
* @param {string} organisation The organisation
|
|
13393
|
-
* @param {
|
|
13931
|
+
* Create a new durable orchestration for batch processing. * * **Input Sources:** * - `static`: Process a fixed list of items * - `task_query`: Process tasks matching a query * - `generator`: AI generates items from a prompt * * **Stop Conditions:** * - `all_complete`: Stop when all items processed * - `max_iterations`: Stop after N iterations * - `condition`: AI evaluates a prompt to decide * - `manual`: Run until manually stopped * * **Auto-start:** * By default, the orchestration starts immediately. Set `autoStart: false` to create in pending state.
|
|
13932
|
+
* @summary Create Durable Orchestration
|
|
13933
|
+
* @param {string} organisation The organisation machine name
|
|
13934
|
+
* @param {CreateOrchestrationRequest} createOrchestrationRequest
|
|
13394
13935
|
* @param {*} [options] Override http request option.
|
|
13395
13936
|
* @throws {RequiredError}
|
|
13396
13937
|
*/
|
|
13397
|
-
|
|
13938
|
+
createOrchestration: (organisation: string, createOrchestrationRequest: CreateOrchestrationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13398
13939
|
/**
|
|
13399
|
-
*
|
|
13400
|
-
* @summary
|
|
13401
|
-
* @param {string} organisation The organisation
|
|
13402
|
-
* @param {string}
|
|
13403
|
-
* @param {ExtendAISessionRequest} [extendAISessionRequest]
|
|
13940
|
+
* Delete an orchestration. Can only delete orchestrations in completed, failed, or cancelled status.
|
|
13941
|
+
* @summary Delete Durable Orchestration
|
|
13942
|
+
* @param {string} organisation The organisation machine name
|
|
13943
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
13404
13944
|
* @param {*} [options] Override http request option.
|
|
13405
13945
|
* @throws {RequiredError}
|
|
13406
13946
|
*/
|
|
13407
|
-
|
|
13947
|
+
deleteOrchestration: (organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13408
13948
|
/**
|
|
13409
|
-
*
|
|
13410
|
-
* @summary Get
|
|
13411
|
-
* @param {string} organisation The organisation
|
|
13412
|
-
* @param {string}
|
|
13949
|
+
* Get orchestration details including status and progress. * * **Progress Tracking:** * - `total`: Total items to process * - `completed`: Successfully processed * - `failed`: Failed processing * - `pending`: Awaiting processing
|
|
13950
|
+
* @summary Get Durable Orchestration
|
|
13951
|
+
* @param {string} organisation The organisation machine name
|
|
13952
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
13413
13953
|
* @param {*} [options] Override http request option.
|
|
13414
13954
|
* @throws {RequiredError}
|
|
13415
13955
|
*/
|
|
13416
|
-
|
|
13956
|
+
getOrchestration: (organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13417
13957
|
/**
|
|
13418
|
-
*
|
|
13419
|
-
* @summary List
|
|
13420
|
-
* @param {string} organisation The organisation
|
|
13421
|
-
* @param {string}
|
|
13422
|
-
* @param {
|
|
13423
|
-
* @param {
|
|
13424
|
-
* @param {number} [offset] Offset for pagination
|
|
13425
|
-
* @param {string} [model] Filter by model ID
|
|
13958
|
+
* Get history of batches processed by this orchestration. Returns paginated batch records with status and item counts.
|
|
13959
|
+
* @summary List Orchestration Batches
|
|
13960
|
+
* @param {string} organisation The organisation machine name
|
|
13961
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
13962
|
+
* @param {number} [limit] Maximum number of batches to return
|
|
13963
|
+
* @param {string} [cursor] Pagination cursor from previous response
|
|
13426
13964
|
* @param {*} [options] Override http request option.
|
|
13427
13965
|
* @throws {RequiredError}
|
|
13428
13966
|
*/
|
|
13429
|
-
|
|
13967
|
+
listOrchestrationBatches: (organisation: string, orchestrationId: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13430
13968
|
/**
|
|
13431
|
-
*
|
|
13432
|
-
* @summary
|
|
13433
|
-
* @param {string} organisation The organisation
|
|
13434
|
-
* @param {
|
|
13435
|
-
* @param {
|
|
13969
|
+
* List durable orchestrations for an organization with optional filtering. * * **Note:** This is different from `/tools/orchestrations` which handles async tool execution * polling. These durable orchestrations are for long-running batch processing loops. * * **Filter Options:** * - `status`: Filter by orchestration status * - `limit`: Max results (default 20, max 100) * - `cursor`: Pagination cursor
|
|
13970
|
+
* @summary List Durable Orchestrations
|
|
13971
|
+
* @param {string} organisation The organisation machine name
|
|
13972
|
+
* @param {ListOrchestrationsStatusEnum} [status] Filter by orchestration status
|
|
13973
|
+
* @param {number} [limit] Maximum number of results
|
|
13974
|
+
* @param {string} [cursor] Pagination cursor from previous response
|
|
13436
13975
|
* @param {*} [options] Override http request option.
|
|
13437
13976
|
* @throws {RequiredError}
|
|
13438
13977
|
*/
|
|
13439
|
-
|
|
13440
|
-
};
|
|
13441
|
-
/**
|
|
13442
|
-
* AISessionsApi - functional programming interface
|
|
13443
|
-
* @export
|
|
13444
|
-
*/
|
|
13445
|
-
export declare const AISessionsApiFp: (configuration?: Configuration) => {
|
|
13978
|
+
listOrchestrations: (organisation: string, status?: ListOrchestrationsStatusEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13446
13979
|
/**
|
|
13447
|
-
*
|
|
13448
|
-
* @summary
|
|
13449
|
-
* @param {string} organisation The organisation
|
|
13450
|
-
* @param {
|
|
13980
|
+
* Pause a running orchestration. The current batch will complete, but no new batches will start. Can be resumed later.
|
|
13981
|
+
* @summary Pause Durable Orchestration
|
|
13982
|
+
* @param {string} organisation The organisation machine name
|
|
13983
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
13984
|
+
* @param {*} [options] Override http request option.
|
|
13985
|
+
* @throws {RequiredError}
|
|
13986
|
+
*/
|
|
13987
|
+
pauseOrchestration: (organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13988
|
+
/**
|
|
13989
|
+
* Resume a paused orchestration. Processing continues from where it left off.
|
|
13990
|
+
* @summary Resume Durable Orchestration
|
|
13991
|
+
* @param {string} organisation The organisation machine name
|
|
13992
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
13993
|
+
* @param {*} [options] Override http request option.
|
|
13994
|
+
* @throws {RequiredError}
|
|
13995
|
+
*/
|
|
13996
|
+
resumeOrchestration: (organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13997
|
+
/**
|
|
13998
|
+
* Start a pending orchestration. Only works on orchestrations created with `autoStart: false`.
|
|
13999
|
+
* @summary Start Durable Orchestration
|
|
14000
|
+
* @param {string} organisation The organisation machine name
|
|
14001
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14002
|
+
* @param {*} [options] Override http request option.
|
|
14003
|
+
* @throws {RequiredError}
|
|
14004
|
+
*/
|
|
14005
|
+
startOrchestration: (organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14006
|
+
};
|
|
14007
|
+
/**
|
|
14008
|
+
* AIOrchestrationsApi - functional programming interface
|
|
14009
|
+
* @export
|
|
14010
|
+
*/
|
|
14011
|
+
export declare const AIOrchestrationsApiFp: (configuration?: Configuration) => {
|
|
14012
|
+
/**
|
|
14013
|
+
* Cancel an orchestration permanently. Cannot be resumed. Any in-progress items will complete, but no new processing starts.
|
|
14014
|
+
* @summary Cancel Durable Orchestration
|
|
14015
|
+
* @param {string} organisation The organisation machine name
|
|
14016
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14017
|
+
* @param {*} [options] Override http request option.
|
|
14018
|
+
* @throws {RequiredError}
|
|
14019
|
+
*/
|
|
14020
|
+
cancelOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14021
|
+
/**
|
|
14022
|
+
* Create a new durable orchestration for batch processing. * * **Input Sources:** * - `static`: Process a fixed list of items * - `task_query`: Process tasks matching a query * - `generator`: AI generates items from a prompt * * **Stop Conditions:** * - `all_complete`: Stop when all items processed * - `max_iterations`: Stop after N iterations * - `condition`: AI evaluates a prompt to decide * - `manual`: Run until manually stopped * * **Auto-start:** * By default, the orchestration starts immediately. Set `autoStart: false` to create in pending state.
|
|
14023
|
+
* @summary Create Durable Orchestration
|
|
14024
|
+
* @param {string} organisation The organisation machine name
|
|
14025
|
+
* @param {CreateOrchestrationRequest} createOrchestrationRequest
|
|
14026
|
+
* @param {*} [options] Override http request option.
|
|
14027
|
+
* @throws {RequiredError}
|
|
14028
|
+
*/
|
|
14029
|
+
createOrchestration(organisation: string, createOrchestrationRequest: CreateOrchestrationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14030
|
+
/**
|
|
14031
|
+
* Delete an orchestration. Can only delete orchestrations in completed, failed, or cancelled status.
|
|
14032
|
+
* @summary Delete Durable Orchestration
|
|
14033
|
+
* @param {string} organisation The organisation machine name
|
|
14034
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14035
|
+
* @param {*} [options] Override http request option.
|
|
14036
|
+
* @throws {RequiredError}
|
|
14037
|
+
*/
|
|
14038
|
+
deleteOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
14039
|
+
/**
|
|
14040
|
+
* Get orchestration details including status and progress. * * **Progress Tracking:** * - `total`: Total items to process * - `completed`: Successfully processed * - `failed`: Failed processing * - `pending`: Awaiting processing
|
|
14041
|
+
* @summary Get Durable Orchestration
|
|
14042
|
+
* @param {string} organisation The organisation machine name
|
|
14043
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14044
|
+
* @param {*} [options] Override http request option.
|
|
14045
|
+
* @throws {RequiredError}
|
|
14046
|
+
*/
|
|
14047
|
+
getOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14048
|
+
/**
|
|
14049
|
+
* Get history of batches processed by this orchestration. Returns paginated batch records with status and item counts.
|
|
14050
|
+
* @summary List Orchestration Batches
|
|
14051
|
+
* @param {string} organisation The organisation machine name
|
|
14052
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14053
|
+
* @param {number} [limit] Maximum number of batches to return
|
|
14054
|
+
* @param {string} [cursor] Pagination cursor from previous response
|
|
14055
|
+
* @param {*} [options] Override http request option.
|
|
14056
|
+
* @throws {RequiredError}
|
|
14057
|
+
*/
|
|
14058
|
+
listOrchestrationBatches(organisation: string, orchestrationId: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrchestrationBatches200Response>>;
|
|
14059
|
+
/**
|
|
14060
|
+
* List durable orchestrations for an organization with optional filtering. * * **Note:** This is different from `/tools/orchestrations` which handles async tool execution * polling. These durable orchestrations are for long-running batch processing loops. * * **Filter Options:** * - `status`: Filter by orchestration status * - `limit`: Max results (default 20, max 100) * - `cursor`: Pagination cursor
|
|
14061
|
+
* @summary List Durable Orchestrations
|
|
14062
|
+
* @param {string} organisation The organisation machine name
|
|
14063
|
+
* @param {ListOrchestrationsStatusEnum} [status] Filter by orchestration status
|
|
14064
|
+
* @param {number} [limit] Maximum number of results
|
|
14065
|
+
* @param {string} [cursor] Pagination cursor from previous response
|
|
14066
|
+
* @param {*} [options] Override http request option.
|
|
14067
|
+
* @throws {RequiredError}
|
|
14068
|
+
*/
|
|
14069
|
+
listOrchestrations(organisation: string, status?: ListOrchestrationsStatusEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOrchestrations200Response>>;
|
|
14070
|
+
/**
|
|
14071
|
+
* Pause a running orchestration. The current batch will complete, but no new batches will start. Can be resumed later.
|
|
14072
|
+
* @summary Pause Durable Orchestration
|
|
14073
|
+
* @param {string} organisation The organisation machine name
|
|
14074
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14075
|
+
* @param {*} [options] Override http request option.
|
|
14076
|
+
* @throws {RequiredError}
|
|
14077
|
+
*/
|
|
14078
|
+
pauseOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14079
|
+
/**
|
|
14080
|
+
* Resume a paused orchestration. Processing continues from where it left off.
|
|
14081
|
+
* @summary Resume Durable Orchestration
|
|
14082
|
+
* @param {string} organisation The organisation machine name
|
|
14083
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14084
|
+
* @param {*} [options] Override http request option.
|
|
14085
|
+
* @throws {RequiredError}
|
|
14086
|
+
*/
|
|
14087
|
+
resumeOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14088
|
+
/**
|
|
14089
|
+
* Start a pending orchestration. Only works on orchestrations created with `autoStart: false`.
|
|
14090
|
+
* @summary Start Durable Orchestration
|
|
14091
|
+
* @param {string} organisation The organisation machine name
|
|
14092
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14093
|
+
* @param {*} [options] Override http request option.
|
|
14094
|
+
* @throws {RequiredError}
|
|
14095
|
+
*/
|
|
14096
|
+
startOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
14097
|
+
};
|
|
14098
|
+
/**
|
|
14099
|
+
* AIOrchestrationsApi - factory interface
|
|
14100
|
+
* @export
|
|
14101
|
+
*/
|
|
14102
|
+
export declare const AIOrchestrationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14103
|
+
/**
|
|
14104
|
+
* Cancel an orchestration permanently. Cannot be resumed. Any in-progress items will complete, but no new processing starts.
|
|
14105
|
+
* @summary Cancel Durable Orchestration
|
|
14106
|
+
* @param {string} organisation The organisation machine name
|
|
14107
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14108
|
+
* @param {*} [options] Override http request option.
|
|
14109
|
+
* @throws {RequiredError}
|
|
14110
|
+
*/
|
|
14111
|
+
cancelOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
14112
|
+
/**
|
|
14113
|
+
* Create a new durable orchestration for batch processing. * * **Input Sources:** * - `static`: Process a fixed list of items * - `task_query`: Process tasks matching a query * - `generator`: AI generates items from a prompt * * **Stop Conditions:** * - `all_complete`: Stop when all items processed * - `max_iterations`: Stop after N iterations * - `condition`: AI evaluates a prompt to decide * - `manual`: Run until manually stopped * * **Auto-start:** * By default, the orchestration starts immediately. Set `autoStart: false` to create in pending state.
|
|
14114
|
+
* @summary Create Durable Orchestration
|
|
14115
|
+
* @param {string} organisation The organisation machine name
|
|
14116
|
+
* @param {CreateOrchestrationRequest} createOrchestrationRequest
|
|
14117
|
+
* @param {*} [options] Override http request option.
|
|
14118
|
+
* @throws {RequiredError}
|
|
14119
|
+
*/
|
|
14120
|
+
createOrchestration(organisation: string, createOrchestrationRequest: CreateOrchestrationRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
14121
|
+
/**
|
|
14122
|
+
* Delete an orchestration. Can only delete orchestrations in completed, failed, or cancelled status.
|
|
14123
|
+
* @summary Delete Durable Orchestration
|
|
14124
|
+
* @param {string} organisation The organisation machine name
|
|
14125
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14126
|
+
* @param {*} [options] Override http request option.
|
|
14127
|
+
* @throws {RequiredError}
|
|
14128
|
+
*/
|
|
14129
|
+
deleteOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
14130
|
+
/**
|
|
14131
|
+
* Get orchestration details including status and progress. * * **Progress Tracking:** * - `total`: Total items to process * - `completed`: Successfully processed * - `failed`: Failed processing * - `pending`: Awaiting processing
|
|
14132
|
+
* @summary Get Durable Orchestration
|
|
14133
|
+
* @param {string} organisation The organisation machine name
|
|
14134
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14135
|
+
* @param {*} [options] Override http request option.
|
|
14136
|
+
* @throws {RequiredError}
|
|
14137
|
+
*/
|
|
14138
|
+
getOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
14139
|
+
/**
|
|
14140
|
+
* Get history of batches processed by this orchestration. Returns paginated batch records with status and item counts.
|
|
14141
|
+
* @summary List Orchestration Batches
|
|
14142
|
+
* @param {string} organisation The organisation machine name
|
|
14143
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14144
|
+
* @param {number} [limit] Maximum number of batches to return
|
|
14145
|
+
* @param {string} [cursor] Pagination cursor from previous response
|
|
14146
|
+
* @param {*} [options] Override http request option.
|
|
14147
|
+
* @throws {RequiredError}
|
|
14148
|
+
*/
|
|
14149
|
+
listOrchestrationBatches(organisation: string, orchestrationId: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListOrchestrationBatches200Response>;
|
|
14150
|
+
/**
|
|
14151
|
+
* List durable orchestrations for an organization with optional filtering. * * **Note:** This is different from `/tools/orchestrations` which handles async tool execution * polling. These durable orchestrations are for long-running batch processing loops. * * **Filter Options:** * - `status`: Filter by orchestration status * - `limit`: Max results (default 20, max 100) * - `cursor`: Pagination cursor
|
|
14152
|
+
* @summary List Durable Orchestrations
|
|
14153
|
+
* @param {string} organisation The organisation machine name
|
|
14154
|
+
* @param {ListOrchestrationsStatusEnum} [status] Filter by orchestration status
|
|
14155
|
+
* @param {number} [limit] Maximum number of results
|
|
14156
|
+
* @param {string} [cursor] Pagination cursor from previous response
|
|
14157
|
+
* @param {*} [options] Override http request option.
|
|
14158
|
+
* @throws {RequiredError}
|
|
14159
|
+
*/
|
|
14160
|
+
listOrchestrations(organisation: string, status?: ListOrchestrationsStatusEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListOrchestrations200Response>;
|
|
14161
|
+
/**
|
|
14162
|
+
* Pause a running orchestration. The current batch will complete, but no new batches will start. Can be resumed later.
|
|
14163
|
+
* @summary Pause Durable Orchestration
|
|
14164
|
+
* @param {string} organisation The organisation machine name
|
|
14165
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14166
|
+
* @param {*} [options] Override http request option.
|
|
14167
|
+
* @throws {RequiredError}
|
|
14168
|
+
*/
|
|
14169
|
+
pauseOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
14170
|
+
/**
|
|
14171
|
+
* Resume a paused orchestration. Processing continues from where it left off.
|
|
14172
|
+
* @summary Resume Durable Orchestration
|
|
14173
|
+
* @param {string} organisation The organisation machine name
|
|
14174
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14175
|
+
* @param {*} [options] Override http request option.
|
|
14176
|
+
* @throws {RequiredError}
|
|
14177
|
+
*/
|
|
14178
|
+
resumeOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
14179
|
+
/**
|
|
14180
|
+
* Start a pending orchestration. Only works on orchestrations created with `autoStart: false`.
|
|
14181
|
+
* @summary Start Durable Orchestration
|
|
14182
|
+
* @param {string} organisation The organisation machine name
|
|
14183
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14184
|
+
* @param {*} [options] Override http request option.
|
|
14185
|
+
* @throws {RequiredError}
|
|
14186
|
+
*/
|
|
14187
|
+
startOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
14188
|
+
};
|
|
14189
|
+
/**
|
|
14190
|
+
* AIOrchestrationsApi - object-oriented interface
|
|
14191
|
+
* @export
|
|
14192
|
+
* @class AIOrchestrationsApi
|
|
14193
|
+
* @extends {BaseAPI}
|
|
14194
|
+
*/
|
|
14195
|
+
export declare class AIOrchestrationsApi extends BaseAPI {
|
|
14196
|
+
/**
|
|
14197
|
+
* Cancel an orchestration permanently. Cannot be resumed. Any in-progress items will complete, but no new processing starts.
|
|
14198
|
+
* @summary Cancel Durable Orchestration
|
|
14199
|
+
* @param {string} organisation The organisation machine name
|
|
14200
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14201
|
+
* @param {*} [options] Override http request option.
|
|
14202
|
+
* @throws {RequiredError}
|
|
14203
|
+
* @memberof AIOrchestrationsApi
|
|
14204
|
+
*/
|
|
14205
|
+
cancelOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
14206
|
+
/**
|
|
14207
|
+
* Create a new durable orchestration for batch processing. * * **Input Sources:** * - `static`: Process a fixed list of items * - `task_query`: Process tasks matching a query * - `generator`: AI generates items from a prompt * * **Stop Conditions:** * - `all_complete`: Stop when all items processed * - `max_iterations`: Stop after N iterations * - `condition`: AI evaluates a prompt to decide * - `manual`: Run until manually stopped * * **Auto-start:** * By default, the orchestration starts immediately. Set `autoStart: false` to create in pending state.
|
|
14208
|
+
* @summary Create Durable Orchestration
|
|
14209
|
+
* @param {string} organisation The organisation machine name
|
|
14210
|
+
* @param {CreateOrchestrationRequest} createOrchestrationRequest
|
|
14211
|
+
* @param {*} [options] Override http request option.
|
|
14212
|
+
* @throws {RequiredError}
|
|
14213
|
+
* @memberof AIOrchestrationsApi
|
|
14214
|
+
*/
|
|
14215
|
+
createOrchestration(organisation: string, createOrchestrationRequest: CreateOrchestrationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
14216
|
+
/**
|
|
14217
|
+
* Delete an orchestration. Can only delete orchestrations in completed, failed, or cancelled status.
|
|
14218
|
+
* @summary Delete Durable Orchestration
|
|
14219
|
+
* @param {string} organisation The organisation machine name
|
|
14220
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14221
|
+
* @param {*} [options] Override http request option.
|
|
14222
|
+
* @throws {RequiredError}
|
|
14223
|
+
* @memberof AIOrchestrationsApi
|
|
14224
|
+
*/
|
|
14225
|
+
deleteOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
14226
|
+
/**
|
|
14227
|
+
* Get orchestration details including status and progress. * * **Progress Tracking:** * - `total`: Total items to process * - `completed`: Successfully processed * - `failed`: Failed processing * - `pending`: Awaiting processing
|
|
14228
|
+
* @summary Get Durable Orchestration
|
|
14229
|
+
* @param {string} organisation The organisation machine name
|
|
14230
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14231
|
+
* @param {*} [options] Override http request option.
|
|
14232
|
+
* @throws {RequiredError}
|
|
14233
|
+
* @memberof AIOrchestrationsApi
|
|
14234
|
+
*/
|
|
14235
|
+
getOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
14236
|
+
/**
|
|
14237
|
+
* Get history of batches processed by this orchestration. Returns paginated batch records with status and item counts.
|
|
14238
|
+
* @summary List Orchestration Batches
|
|
14239
|
+
* @param {string} organisation The organisation machine name
|
|
14240
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14241
|
+
* @param {number} [limit] Maximum number of batches to return
|
|
14242
|
+
* @param {string} [cursor] Pagination cursor from previous response
|
|
14243
|
+
* @param {*} [options] Override http request option.
|
|
14244
|
+
* @throws {RequiredError}
|
|
14245
|
+
* @memberof AIOrchestrationsApi
|
|
14246
|
+
*/
|
|
14247
|
+
listOrchestrationBatches(organisation: string, orchestrationId: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListOrchestrationBatches200Response, any, {}>>;
|
|
14248
|
+
/**
|
|
14249
|
+
* List durable orchestrations for an organization with optional filtering. * * **Note:** This is different from `/tools/orchestrations` which handles async tool execution * polling. These durable orchestrations are for long-running batch processing loops. * * **Filter Options:** * - `status`: Filter by orchestration status * - `limit`: Max results (default 20, max 100) * - `cursor`: Pagination cursor
|
|
14250
|
+
* @summary List Durable Orchestrations
|
|
14251
|
+
* @param {string} organisation The organisation machine name
|
|
14252
|
+
* @param {ListOrchestrationsStatusEnum} [status] Filter by orchestration status
|
|
14253
|
+
* @param {number} [limit] Maximum number of results
|
|
14254
|
+
* @param {string} [cursor] Pagination cursor from previous response
|
|
14255
|
+
* @param {*} [options] Override http request option.
|
|
14256
|
+
* @throws {RequiredError}
|
|
14257
|
+
* @memberof AIOrchestrationsApi
|
|
14258
|
+
*/
|
|
14259
|
+
listOrchestrations(organisation: string, status?: ListOrchestrationsStatusEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListOrchestrations200Response, any, {}>>;
|
|
14260
|
+
/**
|
|
14261
|
+
* Pause a running orchestration. The current batch will complete, but no new batches will start. Can be resumed later.
|
|
14262
|
+
* @summary Pause Durable Orchestration
|
|
14263
|
+
* @param {string} organisation The organisation machine name
|
|
14264
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14265
|
+
* @param {*} [options] Override http request option.
|
|
14266
|
+
* @throws {RequiredError}
|
|
14267
|
+
* @memberof AIOrchestrationsApi
|
|
14268
|
+
*/
|
|
14269
|
+
pauseOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
14270
|
+
/**
|
|
14271
|
+
* Resume a paused orchestration. Processing continues from where it left off.
|
|
14272
|
+
* @summary Resume Durable Orchestration
|
|
14273
|
+
* @param {string} organisation The organisation machine name
|
|
14274
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14275
|
+
* @param {*} [options] Override http request option.
|
|
14276
|
+
* @throws {RequiredError}
|
|
14277
|
+
* @memberof AIOrchestrationsApi
|
|
14278
|
+
*/
|
|
14279
|
+
resumeOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
14280
|
+
/**
|
|
14281
|
+
* Start a pending orchestration. Only works on orchestrations created with `autoStart: false`.
|
|
14282
|
+
* @summary Start Durable Orchestration
|
|
14283
|
+
* @param {string} organisation The organisation machine name
|
|
14284
|
+
* @param {string} orchestrationId Orchestration identifier
|
|
14285
|
+
* @param {*} [options] Override http request option.
|
|
14286
|
+
* @throws {RequiredError}
|
|
14287
|
+
* @memberof AIOrchestrationsApi
|
|
14288
|
+
*/
|
|
14289
|
+
startOrchestration(organisation: string, orchestrationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
14290
|
+
}
|
|
14291
|
+
/**
|
|
14292
|
+
* @export
|
|
14293
|
+
*/
|
|
14294
|
+
export declare const ListOrchestrationsStatusEnum: {
|
|
14295
|
+
readonly Pending: "pending";
|
|
14296
|
+
readonly Running: "running";
|
|
14297
|
+
readonly Paused: "paused";
|
|
14298
|
+
readonly Completed: "completed";
|
|
14299
|
+
readonly Failed: "failed";
|
|
14300
|
+
readonly Cancelled: "cancelled";
|
|
14301
|
+
};
|
|
14302
|
+
export type ListOrchestrationsStatusEnum = typeof ListOrchestrationsStatusEnum[keyof typeof ListOrchestrationsStatusEnum];
|
|
14303
|
+
/**
|
|
14304
|
+
* AISessionsApi - axios parameter creator
|
|
14305
|
+
* @export
|
|
14306
|
+
*/
|
|
14307
|
+
export declare const AISessionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14308
|
+
/**
|
|
14309
|
+
* Creates an AI session with automatic expiration (60 min default, 24h max). Sessions are isolated by organization. Use userId to identify the user creating the session. Use sessionGroup for logical grouping. Use metadata for additional custom data. Filter sessions by userId or sessionGroup when listing.
|
|
14310
|
+
* @summary Create a new chat session with multi-tenant isolation
|
|
14311
|
+
* @param {string} organisation The organisation ID
|
|
14312
|
+
* @param {CreateAISessionRequest} createAISessionRequest
|
|
14313
|
+
* @param {*} [options] Override http request option.
|
|
14314
|
+
* @throws {RequiredError}
|
|
14315
|
+
*/
|
|
14316
|
+
createAISession: (organisation: string, createAISessionRequest: CreateAISessionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14317
|
+
/**
|
|
14318
|
+
*
|
|
14319
|
+
* @summary Delete a chat session
|
|
14320
|
+
* @param {string} organisation The organisation ID
|
|
14321
|
+
* @param {string} sessionId The session ID
|
|
14322
|
+
* @param {*} [options] Override http request option.
|
|
14323
|
+
* @throws {RequiredError}
|
|
14324
|
+
*/
|
|
14325
|
+
deleteAISession: (organisation: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14326
|
+
/**
|
|
14327
|
+
* Extends the expiration time of an active session. Useful for keeping long-running conversations alive.
|
|
14328
|
+
* @summary Extend Session Expiration
|
|
14329
|
+
* @param {string} organisation The organisation ID
|
|
14330
|
+
* @param {string} sessionId The session ID
|
|
14331
|
+
* @param {ExtendAISessionRequest} [extendAISessionRequest]
|
|
14332
|
+
* @param {*} [options] Override http request option.
|
|
14333
|
+
* @throws {RequiredError}
|
|
14334
|
+
*/
|
|
14335
|
+
extendAISession: (organisation: string, sessionId: string, extendAISessionRequest?: ExtendAISessionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14336
|
+
/**
|
|
14337
|
+
*
|
|
14338
|
+
* @summary Get a specific chat session
|
|
14339
|
+
* @param {string} organisation The organisation ID
|
|
14340
|
+
* @param {string} sessionId The session ID
|
|
14341
|
+
* @param {*} [options] Override http request option.
|
|
14342
|
+
* @throws {RequiredError}
|
|
14343
|
+
*/
|
|
14344
|
+
getAISession: (organisation: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14345
|
+
/**
|
|
14346
|
+
* Lists active sessions for an organization with flexible filtering options. * * **Query Combinations:** * 1. By Organization (default): Returns all sessions in the organization * 2. By Organization + Group: `?sessionGroup=drupal-prod` - Sessions in a specific group * 3. By User: `?userId=user-123` - All sessions for a user * 4. By User + Group: `?userId=user-123&sessionGroup=drupal-prod` - User\'s sessions in a specific group * * **Use Cases:** * - List user\'s conversations in a specific app/environment * - Admin view of all sessions in a customer/tenant group * - User profile showing all AI conversations across apps
|
|
14347
|
+
* @summary List chat sessions with multi-tenant filtering
|
|
14348
|
+
* @param {string} organisation The organisation ID
|
|
14349
|
+
* @param {string} [userId] Filter sessions by user ID
|
|
14350
|
+
* @param {string} [sessionGroup] Filter by session group. Returns only sessions matching the specified group.
|
|
14351
|
+
* @param {number} [limit] Maximum number of sessions to return (default 50, max 100)
|
|
14352
|
+
* @param {number} [offset] Offset for pagination
|
|
14353
|
+
* @param {string} [model] Filter by model ID
|
|
14354
|
+
* @param {*} [options] Override http request option.
|
|
14355
|
+
* @throws {RequiredError}
|
|
14356
|
+
*/
|
|
14357
|
+
listAISessions: (organisation: string, userId?: string, sessionGroup?: string, limit?: number, offset?: number, model?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14358
|
+
/**
|
|
14359
|
+
* Updates session with new conversation messages and tracks token usage. Appends new messages to conversation history and updates session stats. * * **Typical Flow:** * 1. Get session to retrieve conversation history * 2. Call AI inference with full message history * 3. Update session with new user + assistant messages
|
|
14360
|
+
* @summary Update Session
|
|
14361
|
+
* @param {string} organisation The organisation ID
|
|
14362
|
+
* @param {string} sessionId The session ID
|
|
14363
|
+
* @param {UpdateAISessionRequest} updateAISessionRequest
|
|
14364
|
+
* @param {*} [options] Override http request option.
|
|
14365
|
+
* @throws {RequiredError}
|
|
14366
|
+
*/
|
|
14367
|
+
updateAISession: (organisation: string, sessionId: string, updateAISessionRequest: UpdateAISessionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14368
|
+
};
|
|
14369
|
+
/**
|
|
14370
|
+
* AISessionsApi - functional programming interface
|
|
14371
|
+
* @export
|
|
14372
|
+
*/
|
|
14373
|
+
export declare const AISessionsApiFp: (configuration?: Configuration) => {
|
|
14374
|
+
/**
|
|
14375
|
+
* Creates an AI session with automatic expiration (60 min default, 24h max). Sessions are isolated by organization. Use userId to identify the user creating the session. Use sessionGroup for logical grouping. Use metadata for additional custom data. Filter sessions by userId or sessionGroup when listing.
|
|
14376
|
+
* @summary Create a new chat session with multi-tenant isolation
|
|
14377
|
+
* @param {string} organisation The organisation ID
|
|
14378
|
+
* @param {CreateAISessionRequest} createAISessionRequest
|
|
13451
14379
|
* @param {*} [options] Override http request option.
|
|
13452
14380
|
* @throws {RequiredError}
|
|
13453
14381
|
*/
|
|
@@ -13938,8 +14866,8 @@ export type ListTasksStatusEnum = typeof ListTasksStatusEnum[keyof typeof ListTa
|
|
|
13938
14866
|
*/
|
|
13939
14867
|
export declare const AIToolsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
13940
14868
|
/**
|
|
13941
|
-
* Retrieves the status and synthesized result of a multi-tool orchestration. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
13942
|
-
* @summary Get Orchestration Status
|
|
14869
|
+
* Retrieves the status and synthesized result of a multi-tool async execution orchestration. * * **Note:** This endpoint is for async tool execution polling (`/tools/orchestrations`). * For durable batch processing orchestrations, see `GET /orchestrations` endpoints. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
14870
|
+
* @summary Get Tool Orchestration Status (Async Tool Polling)
|
|
13943
14871
|
* @param {string} organisation The organisation ID
|
|
13944
14872
|
* @param {string} orchestrationId Orchestration identifier for aggregated async tool executions
|
|
13945
14873
|
* @param {*} [options] Override http request option.
|
|
@@ -13988,8 +14916,8 @@ export declare const AIToolsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
13988
14916
|
*/
|
|
13989
14917
|
export declare const AIToolsApiFp: (configuration?: Configuration) => {
|
|
13990
14918
|
/**
|
|
13991
|
-
* Retrieves the status and synthesized result of a multi-tool orchestration. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
13992
|
-
* @summary Get Orchestration Status
|
|
14919
|
+
* Retrieves the status and synthesized result of a multi-tool async execution orchestration. * * **Note:** This endpoint is for async tool execution polling (`/tools/orchestrations`). * For durable batch processing orchestrations, see `GET /orchestrations` endpoints. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
14920
|
+
* @summary Get Tool Orchestration Status (Async Tool Polling)
|
|
13993
14921
|
* @param {string} organisation The organisation ID
|
|
13994
14922
|
* @param {string} orchestrationId Orchestration identifier for aggregated async tool executions
|
|
13995
14923
|
* @param {*} [options] Override http request option.
|
|
@@ -14038,8 +14966,8 @@ export declare const AIToolsApiFp: (configuration?: Configuration) => {
|
|
|
14038
14966
|
*/
|
|
14039
14967
|
export declare const AIToolsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14040
14968
|
/**
|
|
14041
|
-
* Retrieves the status and synthesized result of a multi-tool orchestration. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
14042
|
-
* @summary Get Orchestration Status
|
|
14969
|
+
* Retrieves the status and synthesized result of a multi-tool async execution orchestration. * * **Note:** This endpoint is for async tool execution polling (`/tools/orchestrations`). * For durable batch processing orchestrations, see `GET /orchestrations` endpoints. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
14970
|
+
* @summary Get Tool Orchestration Status (Async Tool Polling)
|
|
14043
14971
|
* @param {string} organisation The organisation ID
|
|
14044
14972
|
* @param {string} orchestrationId Orchestration identifier for aggregated async tool executions
|
|
14045
14973
|
* @param {*} [options] Override http request option.
|
|
@@ -14090,8 +15018,8 @@ export declare const AIToolsApiFactory: (configuration?: Configuration, basePath
|
|
|
14090
15018
|
*/
|
|
14091
15019
|
export declare class AIToolsApi extends BaseAPI {
|
|
14092
15020
|
/**
|
|
14093
|
-
* Retrieves the status and synthesized result of a multi-tool orchestration. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
14094
|
-
* @summary Get Orchestration Status
|
|
15021
|
+
* Retrieves the status and synthesized result of a multi-tool async execution orchestration. * * **Note:** This endpoint is for async tool execution polling (`/tools/orchestrations`). * For durable batch processing orchestrations, see `GET /orchestrations` endpoints. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
15022
|
+
* @summary Get Tool Orchestration Status (Async Tool Polling)
|
|
14095
15023
|
* @param {string} organisation The organisation ID
|
|
14096
15024
|
* @param {string} orchestrationId Orchestration identifier for aggregated async tool executions
|
|
14097
15025
|
* @param {*} [options] Override http request option.
|
|
@@ -14172,6 +15100,16 @@ export declare const AIVectorDatabaseApiAxiosParamCreator: (configuration?: Conf
|
|
|
14172
15100
|
* @throws {RequiredError}
|
|
14173
15101
|
*/
|
|
14174
15102
|
deleteVectorCollection: (organisation: string, collectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15103
|
+
/**
|
|
15104
|
+
* Delete documents from a collection. Supports three deletion modes: * * 1. **Purge All** - Set `purgeAll: true` to delete ALL documents in the collection * * 2. **By Document IDs** - Provide `documentIds` array with specific document UUIDs * * 3. **By Metadata** - Provide `metadata` object with `field` and `values` to delete documents where the metadata field matches any of the values * * **Drupal Integration:** * When using with Drupal AI Search, use metadata deletion with: * - `field: \'drupal_entity_id\'` to delete all chunks for specific entities * - `field: \'drupal_long_id\'` to delete specific chunks
|
|
15105
|
+
* @summary Delete Documents from Collection
|
|
15106
|
+
* @param {string} organisation Organisation machine name
|
|
15107
|
+
* @param {string} collectionId Collection UUID
|
|
15108
|
+
* @param {DeleteVectorDocumentsRequest} deleteVectorDocumentsRequest
|
|
15109
|
+
* @param {*} [options] Override http request option.
|
|
15110
|
+
* @throws {RequiredError}
|
|
15111
|
+
*/
|
|
15112
|
+
deleteVectorDocuments: (organisation: string, collectionId: string, deleteVectorDocumentsRequest: DeleteVectorDocumentsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14175
15113
|
/**
|
|
14176
15114
|
* Get detailed information about a specific vector database collection.
|
|
14177
15115
|
* @summary Get Collection Details
|
|
@@ -14233,6 +15171,16 @@ export declare const AIVectorDatabaseApiFp: (configuration?: Configuration) => {
|
|
|
14233
15171
|
* @throws {RequiredError}
|
|
14234
15172
|
*/
|
|
14235
15173
|
deleteVectorCollection(organisation: string, collectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteVectorCollection200Response>>;
|
|
15174
|
+
/**
|
|
15175
|
+
* Delete documents from a collection. Supports three deletion modes: * * 1. **Purge All** - Set `purgeAll: true` to delete ALL documents in the collection * * 2. **By Document IDs** - Provide `documentIds` array with specific document UUIDs * * 3. **By Metadata** - Provide `metadata` object with `field` and `values` to delete documents where the metadata field matches any of the values * * **Drupal Integration:** * When using with Drupal AI Search, use metadata deletion with: * - `field: \'drupal_entity_id\'` to delete all chunks for specific entities * - `field: \'drupal_long_id\'` to delete specific chunks
|
|
15176
|
+
* @summary Delete Documents from Collection
|
|
15177
|
+
* @param {string} organisation Organisation machine name
|
|
15178
|
+
* @param {string} collectionId Collection UUID
|
|
15179
|
+
* @param {DeleteVectorDocumentsRequest} deleteVectorDocumentsRequest
|
|
15180
|
+
* @param {*} [options] Override http request option.
|
|
15181
|
+
* @throws {RequiredError}
|
|
15182
|
+
*/
|
|
15183
|
+
deleteVectorDocuments(organisation: string, collectionId: string, deleteVectorDocumentsRequest: DeleteVectorDocumentsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteVectorDocuments200Response>>;
|
|
14236
15184
|
/**
|
|
14237
15185
|
* Get detailed information about a specific vector database collection.
|
|
14238
15186
|
* @summary Get Collection Details
|
|
@@ -14294,6 +15242,16 @@ export declare const AIVectorDatabaseApiFactory: (configuration?: Configuration,
|
|
|
14294
15242
|
* @throws {RequiredError}
|
|
14295
15243
|
*/
|
|
14296
15244
|
deleteVectorCollection(organisation: string, collectionId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteVectorCollection200Response>;
|
|
15245
|
+
/**
|
|
15246
|
+
* Delete documents from a collection. Supports three deletion modes: * * 1. **Purge All** - Set `purgeAll: true` to delete ALL documents in the collection * * 2. **By Document IDs** - Provide `documentIds` array with specific document UUIDs * * 3. **By Metadata** - Provide `metadata` object with `field` and `values` to delete documents where the metadata field matches any of the values * * **Drupal Integration:** * When using with Drupal AI Search, use metadata deletion with: * - `field: \'drupal_entity_id\'` to delete all chunks for specific entities * - `field: \'drupal_long_id\'` to delete specific chunks
|
|
15247
|
+
* @summary Delete Documents from Collection
|
|
15248
|
+
* @param {string} organisation Organisation machine name
|
|
15249
|
+
* @param {string} collectionId Collection UUID
|
|
15250
|
+
* @param {DeleteVectorDocumentsRequest} deleteVectorDocumentsRequest
|
|
15251
|
+
* @param {*} [options] Override http request option.
|
|
15252
|
+
* @throws {RequiredError}
|
|
15253
|
+
*/
|
|
15254
|
+
deleteVectorDocuments(organisation: string, collectionId: string, deleteVectorDocumentsRequest: DeleteVectorDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteVectorDocuments200Response>;
|
|
14297
15255
|
/**
|
|
14298
15256
|
* Get detailed information about a specific vector database collection.
|
|
14299
15257
|
* @summary Get Collection Details
|
|
@@ -14359,6 +15317,17 @@ export declare class AIVectorDatabaseApi extends BaseAPI {
|
|
|
14359
15317
|
* @memberof AIVectorDatabaseApi
|
|
14360
15318
|
*/
|
|
14361
15319
|
deleteVectorCollection(organisation: string, collectionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteVectorCollection200Response, any, {}>>;
|
|
15320
|
+
/**
|
|
15321
|
+
* Delete documents from a collection. Supports three deletion modes: * * 1. **Purge All** - Set `purgeAll: true` to delete ALL documents in the collection * * 2. **By Document IDs** - Provide `documentIds` array with specific document UUIDs * * 3. **By Metadata** - Provide `metadata` object with `field` and `values` to delete documents where the metadata field matches any of the values * * **Drupal Integration:** * When using with Drupal AI Search, use metadata deletion with: * - `field: \'drupal_entity_id\'` to delete all chunks for specific entities * - `field: \'drupal_long_id\'` to delete specific chunks
|
|
15322
|
+
* @summary Delete Documents from Collection
|
|
15323
|
+
* @param {string} organisation Organisation machine name
|
|
15324
|
+
* @param {string} collectionId Collection UUID
|
|
15325
|
+
* @param {DeleteVectorDocumentsRequest} deleteVectorDocumentsRequest
|
|
15326
|
+
* @param {*} [options] Override http request option.
|
|
15327
|
+
* @throws {RequiredError}
|
|
15328
|
+
* @memberof AIVectorDatabaseApi
|
|
15329
|
+
*/
|
|
15330
|
+
deleteVectorDocuments(organisation: string, collectionId: string, deleteVectorDocumentsRequest: DeleteVectorDocumentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteVectorDocuments200Response, any, {}>>;
|
|
14362
15331
|
/**
|
|
14363
15332
|
* Get detailed information about a specific vector database collection.
|
|
14364
15333
|
* @summary Get Collection Details
|
|
@@ -14895,6 +15864,203 @@ export declare const ListBackupsStatusEnum: {
|
|
|
14895
15864
|
readonly Running: "running";
|
|
14896
15865
|
};
|
|
14897
15866
|
export type ListBackupsStatusEnum = typeof ListBackupsStatusEnum[keyof typeof ListBackupsStatusEnum];
|
|
15867
|
+
/**
|
|
15868
|
+
* CDNMetricsApi - axios parameter creator
|
|
15869
|
+
* @export
|
|
15870
|
+
*/
|
|
15871
|
+
export declare const CDNMetricsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
15872
|
+
/**
|
|
15873
|
+
* Returns the last 30 days of daily metrics data
|
|
15874
|
+
* @summary Get daily metrics
|
|
15875
|
+
* @param {string} organization Organization identifier
|
|
15876
|
+
* @param {string} project Project identifier
|
|
15877
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
15878
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
15879
|
+
* @param {GetDailyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
15880
|
+
* @param {*} [options] Override http request option.
|
|
15881
|
+
* @throws {RequiredError}
|
|
15882
|
+
*/
|
|
15883
|
+
getDailyMetrics: (organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetDailyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15884
|
+
/**
|
|
15885
|
+
* Returns the last hour of minute-by-minute metrics data
|
|
15886
|
+
* @summary Get hourly metrics
|
|
15887
|
+
* @param {string} organization Organization identifier
|
|
15888
|
+
* @param {string} project Project identifier
|
|
15889
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
15890
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
15891
|
+
* @param {GetHourlyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
15892
|
+
* @param {*} [options] Override http request option.
|
|
15893
|
+
* @throws {RequiredError}
|
|
15894
|
+
*/
|
|
15895
|
+
getHourlyMetrics: (organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetHourlyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15896
|
+
/**
|
|
15897
|
+
* Returns the last 12 months of monthly metrics data
|
|
15898
|
+
* @summary Get monthly metrics
|
|
15899
|
+
* @param {string} organization Organization identifier
|
|
15900
|
+
* @param {string} project Project identifier
|
|
15901
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
15902
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
15903
|
+
* @param {GetMonthlyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
15904
|
+
* @param {*} [options] Override http request option.
|
|
15905
|
+
* @throws {RequiredError}
|
|
15906
|
+
*/
|
|
15907
|
+
getMonthlyMetrics: (organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetMonthlyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15908
|
+
};
|
|
15909
|
+
/**
|
|
15910
|
+
* CDNMetricsApi - functional programming interface
|
|
15911
|
+
* @export
|
|
15912
|
+
*/
|
|
15913
|
+
export declare const CDNMetricsApiFp: (configuration?: Configuration) => {
|
|
15914
|
+
/**
|
|
15915
|
+
* Returns the last 30 days of daily metrics data
|
|
15916
|
+
* @summary Get daily metrics
|
|
15917
|
+
* @param {string} organization Organization identifier
|
|
15918
|
+
* @param {string} project Project identifier
|
|
15919
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
15920
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
15921
|
+
* @param {GetDailyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
15922
|
+
* @param {*} [options] Override http request option.
|
|
15923
|
+
* @throws {RequiredError}
|
|
15924
|
+
*/
|
|
15925
|
+
getDailyMetrics(organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetDailyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2MetricsResponse>>;
|
|
15926
|
+
/**
|
|
15927
|
+
* Returns the last hour of minute-by-minute metrics data
|
|
15928
|
+
* @summary Get hourly metrics
|
|
15929
|
+
* @param {string} organization Organization identifier
|
|
15930
|
+
* @param {string} project Project identifier
|
|
15931
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
15932
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
15933
|
+
* @param {GetHourlyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
15934
|
+
* @param {*} [options] Override http request option.
|
|
15935
|
+
* @throws {RequiredError}
|
|
15936
|
+
*/
|
|
15937
|
+
getHourlyMetrics(organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetHourlyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2MetricsResponse>>;
|
|
15938
|
+
/**
|
|
15939
|
+
* Returns the last 12 months of monthly metrics data
|
|
15940
|
+
* @summary Get monthly metrics
|
|
15941
|
+
* @param {string} organization Organization identifier
|
|
15942
|
+
* @param {string} project Project identifier
|
|
15943
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
15944
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
15945
|
+
* @param {GetMonthlyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
15946
|
+
* @param {*} [options] Override http request option.
|
|
15947
|
+
* @throws {RequiredError}
|
|
15948
|
+
*/
|
|
15949
|
+
getMonthlyMetrics(organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetMonthlyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2MetricsResponse>>;
|
|
15950
|
+
};
|
|
15951
|
+
/**
|
|
15952
|
+
* CDNMetricsApi - factory interface
|
|
15953
|
+
* @export
|
|
15954
|
+
*/
|
|
15955
|
+
export declare const CDNMetricsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
15956
|
+
/**
|
|
15957
|
+
* Returns the last 30 days of daily metrics data
|
|
15958
|
+
* @summary Get daily metrics
|
|
15959
|
+
* @param {string} organization Organization identifier
|
|
15960
|
+
* @param {string} project Project identifier
|
|
15961
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
15962
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
15963
|
+
* @param {GetDailyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
15964
|
+
* @param {*} [options] Override http request option.
|
|
15965
|
+
* @throws {RequiredError}
|
|
15966
|
+
*/
|
|
15967
|
+
getDailyMetrics(organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetDailyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig): AxiosPromise<V2MetricsResponse>;
|
|
15968
|
+
/**
|
|
15969
|
+
* Returns the last hour of minute-by-minute metrics data
|
|
15970
|
+
* @summary Get hourly metrics
|
|
15971
|
+
* @param {string} organization Organization identifier
|
|
15972
|
+
* @param {string} project Project identifier
|
|
15973
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
15974
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
15975
|
+
* @param {GetHourlyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
15976
|
+
* @param {*} [options] Override http request option.
|
|
15977
|
+
* @throws {RequiredError}
|
|
15978
|
+
*/
|
|
15979
|
+
getHourlyMetrics(organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetHourlyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig): AxiosPromise<V2MetricsResponse>;
|
|
15980
|
+
/**
|
|
15981
|
+
* Returns the last 12 months of monthly metrics data
|
|
15982
|
+
* @summary Get monthly metrics
|
|
15983
|
+
* @param {string} organization Organization identifier
|
|
15984
|
+
* @param {string} project Project identifier
|
|
15985
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
15986
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
15987
|
+
* @param {GetMonthlyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
15988
|
+
* @param {*} [options] Override http request option.
|
|
15989
|
+
* @throws {RequiredError}
|
|
15990
|
+
*/
|
|
15991
|
+
getMonthlyMetrics(organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetMonthlyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig): AxiosPromise<V2MetricsResponse>;
|
|
15992
|
+
};
|
|
15993
|
+
/**
|
|
15994
|
+
* CDNMetricsApi - object-oriented interface
|
|
15995
|
+
* @export
|
|
15996
|
+
* @class CDNMetricsApi
|
|
15997
|
+
* @extends {BaseAPI}
|
|
15998
|
+
*/
|
|
15999
|
+
export declare class CDNMetricsApi extends BaseAPI {
|
|
16000
|
+
/**
|
|
16001
|
+
* Returns the last 30 days of daily metrics data
|
|
16002
|
+
* @summary Get daily metrics
|
|
16003
|
+
* @param {string} organization Organization identifier
|
|
16004
|
+
* @param {string} project Project identifier
|
|
16005
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
16006
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
16007
|
+
* @param {GetDailyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
16008
|
+
* @param {*} [options] Override http request option.
|
|
16009
|
+
* @throws {RequiredError}
|
|
16010
|
+
* @memberof CDNMetricsApi
|
|
16011
|
+
*/
|
|
16012
|
+
getDailyMetrics(organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetDailyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V2MetricsResponse, any, {}>>;
|
|
16013
|
+
/**
|
|
16014
|
+
* Returns the last hour of minute-by-minute metrics data
|
|
16015
|
+
* @summary Get hourly metrics
|
|
16016
|
+
* @param {string} organization Organization identifier
|
|
16017
|
+
* @param {string} project Project identifier
|
|
16018
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
16019
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
16020
|
+
* @param {GetHourlyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
16021
|
+
* @param {*} [options] Override http request option.
|
|
16022
|
+
* @throws {RequiredError}
|
|
16023
|
+
* @memberof CDNMetricsApi
|
|
16024
|
+
*/
|
|
16025
|
+
getHourlyMetrics(organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetHourlyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V2MetricsResponse, any, {}>>;
|
|
16026
|
+
/**
|
|
16027
|
+
* Returns the last 12 months of monthly metrics data
|
|
16028
|
+
* @summary Get monthly metrics
|
|
16029
|
+
* @param {string} organization Organization identifier
|
|
16030
|
+
* @param {string} project Project identifier
|
|
16031
|
+
* @param {string} [domain] Filter by domain ID or domain name
|
|
16032
|
+
* @param {Array<string>} [metrics] Metrics to return (default: hits, bytes)
|
|
16033
|
+
* @param {GetMonthlyMetricsTimestampFormatEnum} [timestampFormat] Timestamp format in response
|
|
16034
|
+
* @param {*} [options] Override http request option.
|
|
16035
|
+
* @throws {RequiredError}
|
|
16036
|
+
* @memberof CDNMetricsApi
|
|
16037
|
+
*/
|
|
16038
|
+
getMonthlyMetrics(organization: string, project: string, domain?: string, metrics?: Array<string>, timestampFormat?: GetMonthlyMetricsTimestampFormatEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V2MetricsResponse, any, {}>>;
|
|
16039
|
+
}
|
|
16040
|
+
/**
|
|
16041
|
+
* @export
|
|
16042
|
+
*/
|
|
16043
|
+
export declare const GetDailyMetricsTimestampFormatEnum: {
|
|
16044
|
+
readonly Iso8601: "iso8601";
|
|
16045
|
+
readonly Unix: "unix";
|
|
16046
|
+
};
|
|
16047
|
+
export type GetDailyMetricsTimestampFormatEnum = typeof GetDailyMetricsTimestampFormatEnum[keyof typeof GetDailyMetricsTimestampFormatEnum];
|
|
16048
|
+
/**
|
|
16049
|
+
* @export
|
|
16050
|
+
*/
|
|
16051
|
+
export declare const GetHourlyMetricsTimestampFormatEnum: {
|
|
16052
|
+
readonly Iso8601: "iso8601";
|
|
16053
|
+
readonly Unix: "unix";
|
|
16054
|
+
};
|
|
16055
|
+
export type GetHourlyMetricsTimestampFormatEnum = typeof GetHourlyMetricsTimestampFormatEnum[keyof typeof GetHourlyMetricsTimestampFormatEnum];
|
|
16056
|
+
/**
|
|
16057
|
+
* @export
|
|
16058
|
+
*/
|
|
16059
|
+
export declare const GetMonthlyMetricsTimestampFormatEnum: {
|
|
16060
|
+
readonly Iso8601: "iso8601";
|
|
16061
|
+
readonly Unix: "unix";
|
|
16062
|
+
};
|
|
16063
|
+
export type GetMonthlyMetricsTimestampFormatEnum = typeof GetMonthlyMetricsTimestampFormatEnum[keyof typeof GetMonthlyMetricsTimestampFormatEnum];
|
|
14898
16064
|
/**
|
|
14899
16065
|
* CommandsApi - axios parameter creator
|
|
14900
16066
|
* @export
|
|
@@ -17247,6 +18413,17 @@ export declare const KVApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
17247
18413
|
* @throws {RequiredError}
|
|
17248
18414
|
*/
|
|
17249
18415
|
kVItemsUpdate: (organization: string, project: string, storeId: string, key: string, v2StoreItemUpdateRequest: V2StoreItemUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18416
|
+
/**
|
|
18417
|
+
* Share a KV store from the source project with a target project. The store will be accessible in the target project.
|
|
18418
|
+
* @summary Link a KV store to another project
|
|
18419
|
+
* @param {string} organization Organization identifier
|
|
18420
|
+
* @param {string} project Source project identifier
|
|
18421
|
+
* @param {string} storeId KV store identifier
|
|
18422
|
+
* @param {KVLinkToProjectRequest} kVLinkToProjectRequest
|
|
18423
|
+
* @param {*} [options] Override http request option.
|
|
18424
|
+
* @throws {RequiredError}
|
|
18425
|
+
*/
|
|
18426
|
+
kVLinkToProject: (organization: string, project: string, storeId: string, kVLinkToProjectRequest: KVLinkToProjectRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17250
18427
|
/**
|
|
17251
18428
|
*
|
|
17252
18429
|
* @summary List key-value stores
|
|
@@ -17266,6 +18443,16 @@ export declare const KVApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
17266
18443
|
* @throws {RequiredError}
|
|
17267
18444
|
*/
|
|
17268
18445
|
kVShow: (organization: string, project: string, storeId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18446
|
+
/**
|
|
18447
|
+
* Remove access to a linked KV store from this project. The store must be linked (not owned by this project).
|
|
18448
|
+
* @summary Unlink a KV store from this project
|
|
18449
|
+
* @param {string} organization Organization identifier
|
|
18450
|
+
* @param {string} project Project identifier
|
|
18451
|
+
* @param {string} storeId KV store identifier
|
|
18452
|
+
* @param {*} [options] Override http request option.
|
|
18453
|
+
* @throws {RequiredError}
|
|
18454
|
+
*/
|
|
18455
|
+
kVUnlinkFromProject: (organization: string, project: string, storeId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
17269
18456
|
};
|
|
17270
18457
|
/**
|
|
17271
18458
|
* KVApi - functional programming interface
|
|
@@ -17351,6 +18538,17 @@ export declare const KVApiFp: (configuration?: Configuration) => {
|
|
|
17351
18538
|
* @throws {RequiredError}
|
|
17352
18539
|
*/
|
|
17353
18540
|
kVItemsUpdate(organization: string, project: string, storeId: string, key: string, v2StoreItemUpdateRequest: V2StoreItemUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KVItemsCreate200Response>>;
|
|
18541
|
+
/**
|
|
18542
|
+
* Share a KV store from the source project with a target project. The store will be accessible in the target project.
|
|
18543
|
+
* @summary Link a KV store to another project
|
|
18544
|
+
* @param {string} organization Organization identifier
|
|
18545
|
+
* @param {string} project Source project identifier
|
|
18546
|
+
* @param {string} storeId KV store identifier
|
|
18547
|
+
* @param {KVLinkToProjectRequest} kVLinkToProjectRequest
|
|
18548
|
+
* @param {*} [options] Override http request option.
|
|
18549
|
+
* @throws {RequiredError}
|
|
18550
|
+
*/
|
|
18551
|
+
kVLinkToProject(organization: string, project: string, storeId: string, kVLinkToProjectRequest: KVLinkToProjectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KVLinkToProject200Response>>;
|
|
17354
18552
|
/**
|
|
17355
18553
|
*
|
|
17356
18554
|
* @summary List key-value stores
|
|
@@ -17370,6 +18568,16 @@ export declare const KVApiFp: (configuration?: Configuration) => {
|
|
|
17370
18568
|
* @throws {RequiredError}
|
|
17371
18569
|
*/
|
|
17372
18570
|
kVShow(organization: string, project: string, storeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2Store>>;
|
|
18571
|
+
/**
|
|
18572
|
+
* Remove access to a linked KV store from this project. The store must be linked (not owned by this project).
|
|
18573
|
+
* @summary Unlink a KV store from this project
|
|
18574
|
+
* @param {string} organization Organization identifier
|
|
18575
|
+
* @param {string} project Project identifier
|
|
18576
|
+
* @param {string} storeId KV store identifier
|
|
18577
|
+
* @param {*} [options] Override http request option.
|
|
18578
|
+
* @throws {RequiredError}
|
|
18579
|
+
*/
|
|
18580
|
+
kVUnlinkFromProject(organization: string, project: string, storeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KVLinkToProject200Response>>;
|
|
17373
18581
|
};
|
|
17374
18582
|
/**
|
|
17375
18583
|
* KVApi - factory interface
|
|
@@ -17455,6 +18663,17 @@ export declare const KVApiFactory: (configuration?: Configuration, basePath?: st
|
|
|
17455
18663
|
* @throws {RequiredError}
|
|
17456
18664
|
*/
|
|
17457
18665
|
kVItemsUpdate(organization: string, project: string, storeId: string, key: string, v2StoreItemUpdateRequest: V2StoreItemUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<KVItemsCreate200Response>;
|
|
18666
|
+
/**
|
|
18667
|
+
* Share a KV store from the source project with a target project. The store will be accessible in the target project.
|
|
18668
|
+
* @summary Link a KV store to another project
|
|
18669
|
+
* @param {string} organization Organization identifier
|
|
18670
|
+
* @param {string} project Source project identifier
|
|
18671
|
+
* @param {string} storeId KV store identifier
|
|
18672
|
+
* @param {KVLinkToProjectRequest} kVLinkToProjectRequest
|
|
18673
|
+
* @param {*} [options] Override http request option.
|
|
18674
|
+
* @throws {RequiredError}
|
|
18675
|
+
*/
|
|
18676
|
+
kVLinkToProject(organization: string, project: string, storeId: string, kVLinkToProjectRequest: KVLinkToProjectRequest, options?: RawAxiosRequestConfig): AxiosPromise<KVLinkToProject200Response>;
|
|
17458
18677
|
/**
|
|
17459
18678
|
*
|
|
17460
18679
|
* @summary List key-value stores
|
|
@@ -17474,6 +18693,16 @@ export declare const KVApiFactory: (configuration?: Configuration, basePath?: st
|
|
|
17474
18693
|
* @throws {RequiredError}
|
|
17475
18694
|
*/
|
|
17476
18695
|
kVShow(organization: string, project: string, storeId: string, options?: RawAxiosRequestConfig): AxiosPromise<V2Store>;
|
|
18696
|
+
/**
|
|
18697
|
+
* Remove access to a linked KV store from this project. The store must be linked (not owned by this project).
|
|
18698
|
+
* @summary Unlink a KV store from this project
|
|
18699
|
+
* @param {string} organization Organization identifier
|
|
18700
|
+
* @param {string} project Project identifier
|
|
18701
|
+
* @param {string} storeId KV store identifier
|
|
18702
|
+
* @param {*} [options] Override http request option.
|
|
18703
|
+
* @throws {RequiredError}
|
|
18704
|
+
*/
|
|
18705
|
+
kVUnlinkFromProject(organization: string, project: string, storeId: string, options?: RawAxiosRequestConfig): AxiosPromise<KVLinkToProject200Response>;
|
|
17477
18706
|
};
|
|
17478
18707
|
/**
|
|
17479
18708
|
* KVApi - object-oriented interface
|
|
@@ -17568,6 +18797,18 @@ export declare class KVApi extends BaseAPI {
|
|
|
17568
18797
|
* @memberof KVApi
|
|
17569
18798
|
*/
|
|
17570
18799
|
kVItemsUpdate(organization: string, project: string, storeId: string, key: string, v2StoreItemUpdateRequest: V2StoreItemUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<KVItemsCreate200Response, any, {}>>;
|
|
18800
|
+
/**
|
|
18801
|
+
* Share a KV store from the source project with a target project. The store will be accessible in the target project.
|
|
18802
|
+
* @summary Link a KV store to another project
|
|
18803
|
+
* @param {string} organization Organization identifier
|
|
18804
|
+
* @param {string} project Source project identifier
|
|
18805
|
+
* @param {string} storeId KV store identifier
|
|
18806
|
+
* @param {KVLinkToProjectRequest} kVLinkToProjectRequest
|
|
18807
|
+
* @param {*} [options] Override http request option.
|
|
18808
|
+
* @throws {RequiredError}
|
|
18809
|
+
* @memberof KVApi
|
|
18810
|
+
*/
|
|
18811
|
+
kVLinkToProject(organization: string, project: string, storeId: string, kVLinkToProjectRequest: KVLinkToProjectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<KVLinkToProject200Response, any, {}>>;
|
|
17571
18812
|
/**
|
|
17572
18813
|
*
|
|
17573
18814
|
* @summary List key-value stores
|
|
@@ -17589,6 +18830,17 @@ export declare class KVApi extends BaseAPI {
|
|
|
17589
18830
|
* @memberof KVApi
|
|
17590
18831
|
*/
|
|
17591
18832
|
kVShow(organization: string, project: string, storeId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<V2Store, any, {}>>;
|
|
18833
|
+
/**
|
|
18834
|
+
* Remove access to a linked KV store from this project. The store must be linked (not owned by this project).
|
|
18835
|
+
* @summary Unlink a KV store from this project
|
|
18836
|
+
* @param {string} organization Organization identifier
|
|
18837
|
+
* @param {string} project Project identifier
|
|
18838
|
+
* @param {string} storeId KV store identifier
|
|
18839
|
+
* @param {*} [options] Override http request option.
|
|
18840
|
+
* @throws {RequiredError}
|
|
18841
|
+
* @memberof KVApi
|
|
18842
|
+
*/
|
|
18843
|
+
kVUnlinkFromProject(organization: string, project: string, storeId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<KVLinkToProject200Response, any, {}>>;
|
|
17592
18844
|
}
|
|
17593
18845
|
/**
|
|
17594
18846
|
* OrchestrationApi - axios parameter creator
|
|
@@ -17596,8 +18848,8 @@ export declare class KVApi extends BaseAPI {
|
|
|
17596
18848
|
*/
|
|
17597
18849
|
export declare const OrchestrationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
17598
18850
|
/**
|
|
17599
|
-
* Retrieves the status and synthesized result of a multi-tool orchestration. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
17600
|
-
* @summary Get Orchestration Status
|
|
18851
|
+
* Retrieves the status and synthesized result of a multi-tool async execution orchestration. * * **Note:** This endpoint is for async tool execution polling (`/tools/orchestrations`). * For durable batch processing orchestrations, see `GET /orchestrations` endpoints. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
18852
|
+
* @summary Get Tool Orchestration Status (Async Tool Polling)
|
|
17601
18853
|
* @param {string} organisation The organisation ID
|
|
17602
18854
|
* @param {string} orchestrationId Orchestration identifier for aggregated async tool executions
|
|
17603
18855
|
* @param {*} [options] Override http request option.
|
|
@@ -17611,8 +18863,8 @@ export declare const OrchestrationApiAxiosParamCreator: (configuration?: Configu
|
|
|
17611
18863
|
*/
|
|
17612
18864
|
export declare const OrchestrationApiFp: (configuration?: Configuration) => {
|
|
17613
18865
|
/**
|
|
17614
|
-
* Retrieves the status and synthesized result of a multi-tool orchestration. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
17615
|
-
* @summary Get Orchestration Status
|
|
18866
|
+
* Retrieves the status and synthesized result of a multi-tool async execution orchestration. * * **Note:** This endpoint is for async tool execution polling (`/tools/orchestrations`). * For durable batch processing orchestrations, see `GET /orchestrations` endpoints. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
18867
|
+
* @summary Get Tool Orchestration Status (Async Tool Polling)
|
|
17616
18868
|
* @param {string} organisation The organisation ID
|
|
17617
18869
|
* @param {string} orchestrationId Orchestration identifier for aggregated async tool executions
|
|
17618
18870
|
* @param {*} [options] Override http request option.
|
|
@@ -17626,8 +18878,8 @@ export declare const OrchestrationApiFp: (configuration?: Configuration) => {
|
|
|
17626
18878
|
*/
|
|
17627
18879
|
export declare const OrchestrationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
17628
18880
|
/**
|
|
17629
|
-
* Retrieves the status and synthesized result of a multi-tool orchestration. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
17630
|
-
* @summary Get Orchestration Status
|
|
18881
|
+
* Retrieves the status and synthesized result of a multi-tool async execution orchestration. * * **Note:** This endpoint is for async tool execution polling (`/tools/orchestrations`). * For durable batch processing orchestrations, see `GET /orchestrations` endpoints. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
18882
|
+
* @summary Get Tool Orchestration Status (Async Tool Polling)
|
|
17631
18883
|
* @param {string} organisation The organisation ID
|
|
17632
18884
|
* @param {string} orchestrationId Orchestration identifier for aggregated async tool executions
|
|
17633
18885
|
* @param {*} [options] Override http request option.
|
|
@@ -17643,8 +18895,8 @@ export declare const OrchestrationApiFactory: (configuration?: Configuration, ba
|
|
|
17643
18895
|
*/
|
|
17644
18896
|
export declare class OrchestrationApi extends BaseAPI {
|
|
17645
18897
|
/**
|
|
17646
|
-
* Retrieves the status and synthesized result of a multi-tool orchestration. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
17647
|
-
* @summary Get Orchestration Status
|
|
18898
|
+
* Retrieves the status and synthesized result of a multi-tool async execution orchestration. * * **Note:** This endpoint is for async tool execution polling (`/tools/orchestrations`). * For durable batch processing orchestrations, see `GET /orchestrations` endpoints. * * **Orchestration Pattern:** * When the AI requests multiple async tools simultaneously, an orchestration is created * to track all tool executions and synthesize their results into a single coherent response. * * **Flow:** * 1. AI requests multiple async tools (e.g., image generation + web search) * 2. Chat API creates orchestration and returns orchestrationId * 3. Tool Orchestrator Lambda polls all async tools * 4. When all tools complete, Orchestrator synthesizes results using AI * 5. Client polls this endpoint and receives final synthesized response * * **Status Values:** * - pending: Orchestration created, tools not yet started * - polling: Orchestrator is actively polling async tools * - synthesizing: All tools complete, AI is synthesizing response * - complete: Orchestration finished, synthesizedResponse available * - failed: Orchestration failed, error available * * **Polling Recommendations:** * - Poll every 2 seconds * - Maximum poll time: 10 minutes * - Orchestrator handles tool polling internally * * **Benefits over individual polling:** * - Single poll endpoint for multiple async tools * - AI synthesizes all results into coherent response * - Answers the original user question, not just tool summaries
|
|
18899
|
+
* @summary Get Tool Orchestration Status (Async Tool Polling)
|
|
17648
18900
|
* @param {string} organisation The organisation ID
|
|
17649
18901
|
* @param {string} orchestrationId Orchestration identifier for aggregated async tool executions
|
|
17650
18902
|
* @param {*} [options] Override http request option.
|