@botpress/cognitive 0.3.14 → 0.3.16
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/.turbo/turbo-build.log +7 -7
- package/dist/index.cjs +353 -38
- package/dist/index.cjs.map +2 -2
- package/dist/index.d.ts +315 -512
- package/dist/index.mjs +353 -38
- package/dist/index.mjs.map +2 -2
- package/package.json +1 -1
- package/refresh-models.ts +3 -2
package/dist/index.d.ts
CHANGED
|
@@ -1385,7 +1385,8 @@ interface CreateConversationResponse {
|
|
|
1385
1385
|
*/
|
|
1386
1386
|
id: string;
|
|
1387
1387
|
/**
|
|
1388
|
-
*
|
|
1388
|
+
* @deprecated
|
|
1389
|
+
* Unused. This field will be removed in the future.
|
|
1389
1390
|
*/
|
|
1390
1391
|
currentTaskId?: string;
|
|
1391
1392
|
/**
|
|
@@ -1437,7 +1438,8 @@ interface GetConversationResponse {
|
|
|
1437
1438
|
*/
|
|
1438
1439
|
id: string;
|
|
1439
1440
|
/**
|
|
1440
|
-
*
|
|
1441
|
+
* @deprecated
|
|
1442
|
+
* Unused. This field will be removed in the future.
|
|
1441
1443
|
*/
|
|
1442
1444
|
currentTaskId?: string;
|
|
1443
1445
|
/**
|
|
@@ -1496,7 +1498,8 @@ interface ListConversationsResponse {
|
|
|
1496
1498
|
*/
|
|
1497
1499
|
id: string;
|
|
1498
1500
|
/**
|
|
1499
|
-
*
|
|
1501
|
+
* @deprecated
|
|
1502
|
+
* Unused. This field will be removed in the future.
|
|
1500
1503
|
*/
|
|
1501
1504
|
currentTaskId?: string;
|
|
1502
1505
|
/**
|
|
@@ -1572,7 +1575,8 @@ interface GetOrCreateConversationResponse {
|
|
|
1572
1575
|
*/
|
|
1573
1576
|
id: string;
|
|
1574
1577
|
/**
|
|
1575
|
-
*
|
|
1578
|
+
* @deprecated
|
|
1579
|
+
* Unused. This field will be removed in the future.
|
|
1576
1580
|
*/
|
|
1577
1581
|
currentTaskId?: string;
|
|
1578
1582
|
/**
|
|
@@ -1602,6 +1606,9 @@ interface GetOrCreateConversationResponse {
|
|
|
1602
1606
|
[k: string]: string;
|
|
1603
1607
|
};
|
|
1604
1608
|
};
|
|
1609
|
+
meta: {
|
|
1610
|
+
created: boolean;
|
|
1611
|
+
};
|
|
1605
1612
|
}
|
|
1606
1613
|
|
|
1607
1614
|
interface UpdateConversationRequestHeaders {
|
|
@@ -1612,6 +1619,10 @@ interface UpdateConversationRequestParams {
|
|
|
1612
1619
|
id: string;
|
|
1613
1620
|
}
|
|
1614
1621
|
interface UpdateConversationRequestBody {
|
|
1622
|
+
/**
|
|
1623
|
+
* @deprecated
|
|
1624
|
+
* Unused. This parameter will be ignored if provided and should not be used when updating a conversation.
|
|
1625
|
+
*/
|
|
1615
1626
|
currentTaskId?: string;
|
|
1616
1627
|
/**
|
|
1617
1628
|
* Tags for the [Conversation](#schema_conversation)
|
|
@@ -1631,7 +1642,8 @@ interface UpdateConversationResponse {
|
|
|
1631
1642
|
*/
|
|
1632
1643
|
id: string;
|
|
1633
1644
|
/**
|
|
1634
|
-
*
|
|
1645
|
+
* @deprecated
|
|
1646
|
+
* Unused. This field will be removed in the future.
|
|
1635
1647
|
*/
|
|
1636
1648
|
currentTaskId?: string;
|
|
1637
1649
|
/**
|
|
@@ -2519,7 +2531,7 @@ interface InitializeIncomingMessageRequestBody {
|
|
|
2519
2531
|
*/
|
|
2520
2532
|
pictureUrl?: string;
|
|
2521
2533
|
/**
|
|
2522
|
-
* Optional attributes
|
|
2534
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
|
|
2523
2535
|
*/
|
|
2524
2536
|
attributes?: {
|
|
2525
2537
|
[k: string]: string;
|
|
@@ -2623,7 +2635,8 @@ interface InitializeIncomingMessageResponse {
|
|
|
2623
2635
|
*/
|
|
2624
2636
|
id: string;
|
|
2625
2637
|
/**
|
|
2626
|
-
*
|
|
2638
|
+
* @deprecated
|
|
2639
|
+
* Unused. This field will be removed in the future.
|
|
2627
2640
|
*/
|
|
2628
2641
|
currentTaskId?: string;
|
|
2629
2642
|
/**
|
|
@@ -2826,7 +2839,7 @@ interface CreateUserRequestBody {
|
|
|
2826
2839
|
*/
|
|
2827
2840
|
pictureUrl?: string;
|
|
2828
2841
|
/**
|
|
2829
|
-
* Optional attributes
|
|
2842
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
|
|
2830
2843
|
*/
|
|
2831
2844
|
attributes?: {
|
|
2832
2845
|
[k: string]: string;
|
|
@@ -3012,7 +3025,7 @@ interface GetOrCreateUserRequestBody {
|
|
|
3012
3025
|
*/
|
|
3013
3026
|
pictureUrl?: string;
|
|
3014
3027
|
/**
|
|
3015
|
-
* Optional attributes
|
|
3028
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
|
|
3016
3029
|
*/
|
|
3017
3030
|
attributes?: {
|
|
3018
3031
|
[k: string]: string;
|
|
@@ -3086,7 +3099,7 @@ interface UpdateUserRequestBody {
|
|
|
3086
3099
|
*/
|
|
3087
3100
|
pictureUrl?: string | null;
|
|
3088
3101
|
/**
|
|
3089
|
-
* Optional attributes. Set attributes to null to remove them
|
|
3102
|
+
* EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations. Set individual attributes to null to remove them.
|
|
3090
3103
|
*/
|
|
3091
3104
|
attributes?: {
|
|
3092
3105
|
[k: string]: string | null;
|
|
@@ -3151,7 +3164,7 @@ interface SetStateExpiryRequestHeaders {
|
|
|
3151
3164
|
interface SetStateExpiryRequestQuery {
|
|
3152
3165
|
}
|
|
3153
3166
|
interface SetStateExpiryRequestParams {
|
|
3154
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
3167
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
3155
3168
|
id: string;
|
|
3156
3169
|
name: string;
|
|
3157
3170
|
}
|
|
@@ -3196,9 +3209,9 @@ interface SetStateExpiryResponse {
|
|
|
3196
3209
|
*/
|
|
3197
3210
|
name: string;
|
|
3198
3211
|
/**
|
|
3199
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
3212
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
3200
3213
|
*/
|
|
3201
|
-
type: "conversation" | "user" | "bot" | "
|
|
3214
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
3202
3215
|
/**
|
|
3203
3216
|
* Payload is the content of the state defined by your bot.
|
|
3204
3217
|
*/
|
|
@@ -3213,7 +3226,7 @@ interface GetStateRequestHeaders {
|
|
|
3213
3226
|
interface GetStateRequestQuery {
|
|
3214
3227
|
}
|
|
3215
3228
|
interface GetStateRequestParams {
|
|
3216
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
3229
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
3217
3230
|
id: string;
|
|
3218
3231
|
name: string;
|
|
3219
3232
|
}
|
|
@@ -3254,9 +3267,9 @@ interface GetStateResponse {
|
|
|
3254
3267
|
*/
|
|
3255
3268
|
name: string;
|
|
3256
3269
|
/**
|
|
3257
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
3270
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
3258
3271
|
*/
|
|
3259
|
-
type: "conversation" | "user" | "bot" | "
|
|
3272
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
3260
3273
|
/**
|
|
3261
3274
|
* Payload is the content of the state defined by your bot.
|
|
3262
3275
|
*/
|
|
@@ -3274,7 +3287,7 @@ interface SetStateRequestHeaders {
|
|
|
3274
3287
|
interface SetStateRequestQuery {
|
|
3275
3288
|
}
|
|
3276
3289
|
interface SetStateRequestParams {
|
|
3277
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
3290
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
3278
3291
|
id: string;
|
|
3279
3292
|
name: string;
|
|
3280
3293
|
}
|
|
@@ -3325,9 +3338,9 @@ interface SetStateResponse {
|
|
|
3325
3338
|
*/
|
|
3326
3339
|
name: string;
|
|
3327
3340
|
/**
|
|
3328
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
3341
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
3329
3342
|
*/
|
|
3330
|
-
type: "conversation" | "user" | "bot" | "
|
|
3343
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
3331
3344
|
/**
|
|
3332
3345
|
* Payload is the content of the state defined by your bot.
|
|
3333
3346
|
*/
|
|
@@ -3342,7 +3355,7 @@ interface GetOrSetStateRequestHeaders {
|
|
|
3342
3355
|
interface GetOrSetStateRequestQuery {
|
|
3343
3356
|
}
|
|
3344
3357
|
interface GetOrSetStateRequestParams {
|
|
3345
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
3358
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
3346
3359
|
id: string;
|
|
3347
3360
|
name: string;
|
|
3348
3361
|
}
|
|
@@ -3393,9 +3406,9 @@ interface GetOrSetStateResponse {
|
|
|
3393
3406
|
*/
|
|
3394
3407
|
name: string;
|
|
3395
3408
|
/**
|
|
3396
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
3409
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
3397
3410
|
*/
|
|
3398
|
-
type: "conversation" | "user" | "bot" | "
|
|
3411
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
3399
3412
|
/**
|
|
3400
3413
|
* Payload is the content of the state defined by your bot.
|
|
3401
3414
|
*/
|
|
@@ -3413,7 +3426,7 @@ interface PatchStateRequestHeaders {
|
|
|
3413
3426
|
interface PatchStateRequestQuery {
|
|
3414
3427
|
}
|
|
3415
3428
|
interface PatchStateRequestParams {
|
|
3416
|
-
type: "conversation" | "user" | "bot" | "integration" | "
|
|
3429
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
3417
3430
|
id: string;
|
|
3418
3431
|
name: string;
|
|
3419
3432
|
}
|
|
@@ -3460,9 +3473,9 @@ interface PatchStateResponse {
|
|
|
3460
3473
|
*/
|
|
3461
3474
|
name: string;
|
|
3462
3475
|
/**
|
|
3463
|
-
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `
|
|
3476
|
+
* Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
|
|
3464
3477
|
*/
|
|
3465
|
-
type: "conversation" | "user" | "bot" | "
|
|
3478
|
+
type: "conversation" | "user" | "bot" | "integration" | "workflow";
|
|
3466
3479
|
/**
|
|
3467
3480
|
* Payload is the content of the state defined by your bot.
|
|
3468
3481
|
*/
|
|
@@ -3512,422 +3525,19 @@ interface ConfigureIntegrationRequestParams {
|
|
|
3512
3525
|
interface ConfigureIntegrationRequestBody {
|
|
3513
3526
|
/**
|
|
3514
3527
|
* Unique identifier of the integration that was installed on the bot
|
|
3515
|
-
*/
|
|
3516
|
-
identifier?: string | null;
|
|
3517
|
-
/**
|
|
3518
|
-
* Recurring schedule on which `register()` will be called on the integration
|
|
3519
|
-
*/
|
|
3520
|
-
scheduleRegisterCall?: "hourly" | "daily" | "weekly" | "bi-weekly" | "monthly" | "bi-monthly" | "quarterly" | "yearly";
|
|
3521
|
-
/**
|
|
3522
|
-
* **EXPERIMENTAL** Sandbox identifiers for the integration. Setting this to null will remove all sandbox identifiers. This is an experimental feature meant to be used by specific integrations.
|
|
3523
|
-
*/
|
|
3524
|
-
sandboxIdentifiers?: {} | null;
|
|
3525
|
-
}
|
|
3526
|
-
type ConfigureIntegrationInput = ConfigureIntegrationRequestBody & ConfigureIntegrationRequestHeaders & ConfigureIntegrationRequestQuery & ConfigureIntegrationRequestParams;
|
|
3527
|
-
interface ConfigureIntegrationResponse {
|
|
3528
|
-
}
|
|
3529
|
-
|
|
3530
|
-
interface GetTaskRequestHeaders {
|
|
3531
|
-
}
|
|
3532
|
-
interface GetTaskRequestQuery {
|
|
3533
|
-
}
|
|
3534
|
-
interface GetTaskRequestParams {
|
|
3535
|
-
id: string;
|
|
3536
|
-
}
|
|
3537
|
-
interface GetTaskRequestBody {
|
|
3538
|
-
}
|
|
3539
|
-
type GetTaskInput = GetTaskRequestBody & GetTaskRequestHeaders & GetTaskRequestQuery & GetTaskRequestParams;
|
|
3540
|
-
interface GetTaskResponse {
|
|
3541
|
-
/**
|
|
3542
|
-
* Task definition
|
|
3543
|
-
*/
|
|
3544
|
-
task: {
|
|
3545
|
-
/**
|
|
3546
|
-
* Id of the [Task](#schema_task)
|
|
3547
|
-
*/
|
|
3548
|
-
id: string;
|
|
3549
|
-
/**
|
|
3550
|
-
* Title describing the task
|
|
3551
|
-
*/
|
|
3552
|
-
title: string;
|
|
3553
|
-
/**
|
|
3554
|
-
* All the notes related to the execution of the current task
|
|
3555
|
-
*/
|
|
3556
|
-
description: string;
|
|
3557
|
-
/**
|
|
3558
|
-
* Type of the task
|
|
3559
|
-
*/
|
|
3560
|
-
type: string;
|
|
3561
|
-
/**
|
|
3562
|
-
* Content related to the task
|
|
3563
|
-
*/
|
|
3564
|
-
data: {
|
|
3565
|
-
[k: string]: any;
|
|
3566
|
-
};
|
|
3567
|
-
/**
|
|
3568
|
-
* Status of the task
|
|
3569
|
-
*/
|
|
3570
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
3571
|
-
/**
|
|
3572
|
-
* Parent task id is the parent task that created this task
|
|
3573
|
-
*/
|
|
3574
|
-
parentTaskId?: string;
|
|
3575
|
-
/**
|
|
3576
|
-
* Conversation id related to this task
|
|
3577
|
-
*/
|
|
3578
|
-
conversationId?: string;
|
|
3579
|
-
/**
|
|
3580
|
-
* Specific user related to this task
|
|
3581
|
-
*/
|
|
3582
|
-
userId?: string;
|
|
3583
|
-
/**
|
|
3584
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
3585
|
-
*/
|
|
3586
|
-
timeoutAt: string;
|
|
3587
|
-
/**
|
|
3588
|
-
* Creation date of the task in ISO 8601 format
|
|
3589
|
-
*/
|
|
3590
|
-
createdAt: string;
|
|
3591
|
-
/**
|
|
3592
|
-
* Updating date of the task in ISO 8601 format
|
|
3593
|
-
*/
|
|
3594
|
-
updatedAt: string;
|
|
3595
|
-
/**
|
|
3596
|
-
* If the task fails this is the reason behind it
|
|
3597
|
-
*/
|
|
3598
|
-
failureReason?: string;
|
|
3599
|
-
/**
|
|
3600
|
-
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them.
|
|
3601
|
-
*/
|
|
3602
|
-
tags: {
|
|
3603
|
-
[k: string]: string;
|
|
3604
|
-
};
|
|
3605
|
-
};
|
|
3606
|
-
}
|
|
3607
|
-
|
|
3608
|
-
interface CreateTaskRequestHeaders {
|
|
3609
|
-
}
|
|
3610
|
-
interface CreateTaskRequestQuery {
|
|
3611
|
-
}
|
|
3612
|
-
interface CreateTaskRequestParams {
|
|
3613
|
-
}
|
|
3614
|
-
interface CreateTaskRequestBody {
|
|
3615
|
-
/**
|
|
3616
|
-
* Title describing the task
|
|
3617
|
-
*/
|
|
3618
|
-
title?: string;
|
|
3619
|
-
/**
|
|
3620
|
-
* All the notes related to the execution of the current task
|
|
3621
|
-
*/
|
|
3622
|
-
description?: string;
|
|
3623
|
-
/**
|
|
3624
|
-
* Type of the task
|
|
3625
|
-
*/
|
|
3626
|
-
type: string;
|
|
3627
|
-
/**
|
|
3628
|
-
* Content related to the task
|
|
3629
|
-
*/
|
|
3630
|
-
data?: {
|
|
3631
|
-
[k: string]: any;
|
|
3632
|
-
};
|
|
3633
|
-
/**
|
|
3634
|
-
* Parent task id is the parent task that created this task
|
|
3635
|
-
*/
|
|
3636
|
-
parentTaskId?: string;
|
|
3637
|
-
/**
|
|
3638
|
-
* Conversation id related to this task
|
|
3639
|
-
*/
|
|
3640
|
-
conversationId: string;
|
|
3641
|
-
/**
|
|
3642
|
-
* Specific user related to this task
|
|
3643
|
-
*/
|
|
3644
|
-
userId?: string;
|
|
3645
|
-
/**
|
|
3646
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
3647
|
-
*/
|
|
3648
|
-
timeoutAt?: string;
|
|
3649
|
-
/**
|
|
3650
|
-
* Tags for the [Task](#schema_task)
|
|
3651
|
-
*/
|
|
3652
|
-
tags?: {
|
|
3653
|
-
[k: string]: string;
|
|
3654
|
-
};
|
|
3655
|
-
}
|
|
3656
|
-
type CreateTaskInput = CreateTaskRequestBody & CreateTaskRequestHeaders & CreateTaskRequestQuery & CreateTaskRequestParams;
|
|
3657
|
-
interface CreateTaskResponse {
|
|
3658
|
-
/**
|
|
3659
|
-
* Task definition
|
|
3660
|
-
*/
|
|
3661
|
-
task: {
|
|
3662
|
-
/**
|
|
3663
|
-
* Id of the [Task](#schema_task)
|
|
3664
|
-
*/
|
|
3665
|
-
id: string;
|
|
3666
|
-
/**
|
|
3667
|
-
* Title describing the task
|
|
3668
|
-
*/
|
|
3669
|
-
title: string;
|
|
3670
|
-
/**
|
|
3671
|
-
* All the notes related to the execution of the current task
|
|
3672
|
-
*/
|
|
3673
|
-
description: string;
|
|
3674
|
-
/**
|
|
3675
|
-
* Type of the task
|
|
3676
|
-
*/
|
|
3677
|
-
type: string;
|
|
3678
|
-
/**
|
|
3679
|
-
* Content related to the task
|
|
3680
|
-
*/
|
|
3681
|
-
data: {
|
|
3682
|
-
[k: string]: any;
|
|
3683
|
-
};
|
|
3684
|
-
/**
|
|
3685
|
-
* Status of the task
|
|
3686
|
-
*/
|
|
3687
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
3688
|
-
/**
|
|
3689
|
-
* Parent task id is the parent task that created this task
|
|
3690
|
-
*/
|
|
3691
|
-
parentTaskId?: string;
|
|
3692
|
-
/**
|
|
3693
|
-
* Conversation id related to this task
|
|
3694
|
-
*/
|
|
3695
|
-
conversationId?: string;
|
|
3696
|
-
/**
|
|
3697
|
-
* Specific user related to this task
|
|
3698
|
-
*/
|
|
3699
|
-
userId?: string;
|
|
3700
|
-
/**
|
|
3701
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
3702
|
-
*/
|
|
3703
|
-
timeoutAt: string;
|
|
3704
|
-
/**
|
|
3705
|
-
* Creation date of the task in ISO 8601 format
|
|
3706
|
-
*/
|
|
3707
|
-
createdAt: string;
|
|
3708
|
-
/**
|
|
3709
|
-
* Updating date of the task in ISO 8601 format
|
|
3710
|
-
*/
|
|
3711
|
-
updatedAt: string;
|
|
3712
|
-
/**
|
|
3713
|
-
* If the task fails this is the reason behind it
|
|
3714
|
-
*/
|
|
3715
|
-
failureReason?: string;
|
|
3716
|
-
/**
|
|
3717
|
-
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them.
|
|
3718
|
-
*/
|
|
3719
|
-
tags: {
|
|
3720
|
-
[k: string]: string;
|
|
3721
|
-
};
|
|
3722
|
-
};
|
|
3723
|
-
}
|
|
3724
|
-
|
|
3725
|
-
interface UpdateTaskRequestHeaders {
|
|
3726
|
-
}
|
|
3727
|
-
interface UpdateTaskRequestQuery {
|
|
3728
|
-
}
|
|
3729
|
-
interface UpdateTaskRequestParams {
|
|
3730
|
-
id: string;
|
|
3731
|
-
}
|
|
3732
|
-
interface UpdateTaskRequestBody {
|
|
3733
|
-
/**
|
|
3734
|
-
* Title describing the task
|
|
3735
|
-
*/
|
|
3736
|
-
title?: string;
|
|
3737
|
-
/**
|
|
3738
|
-
* All the notes related to the execution of the current task
|
|
3739
|
-
*/
|
|
3740
|
-
description?: string;
|
|
3741
|
-
/**
|
|
3742
|
-
* Content related to the task
|
|
3743
|
-
*/
|
|
3744
|
-
data?: {
|
|
3745
|
-
[k: string]: any;
|
|
3746
|
-
};
|
|
3747
|
-
/**
|
|
3748
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
3749
|
-
*/
|
|
3750
|
-
timeoutAt?: string;
|
|
3751
|
-
/**
|
|
3752
|
-
* Status of the task
|
|
3753
|
-
*/
|
|
3754
|
-
status?: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
3755
|
-
/**
|
|
3756
|
-
* Tags for the [Task](#schema_task)
|
|
3757
|
-
*/
|
|
3758
|
-
tags?: {
|
|
3759
|
-
[k: string]: string;
|
|
3760
|
-
};
|
|
3761
|
-
}
|
|
3762
|
-
type UpdateTaskInput = UpdateTaskRequestBody & UpdateTaskRequestHeaders & UpdateTaskRequestQuery & UpdateTaskRequestParams;
|
|
3763
|
-
interface UpdateTaskResponse {
|
|
3764
|
-
/**
|
|
3765
|
-
* Task definition
|
|
3766
|
-
*/
|
|
3767
|
-
task: {
|
|
3768
|
-
/**
|
|
3769
|
-
* Id of the [Task](#schema_task)
|
|
3770
|
-
*/
|
|
3771
|
-
id: string;
|
|
3772
|
-
/**
|
|
3773
|
-
* Title describing the task
|
|
3774
|
-
*/
|
|
3775
|
-
title: string;
|
|
3776
|
-
/**
|
|
3777
|
-
* All the notes related to the execution of the current task
|
|
3778
|
-
*/
|
|
3779
|
-
description: string;
|
|
3780
|
-
/**
|
|
3781
|
-
* Type of the task
|
|
3782
|
-
*/
|
|
3783
|
-
type: string;
|
|
3784
|
-
/**
|
|
3785
|
-
* Content related to the task
|
|
3786
|
-
*/
|
|
3787
|
-
data: {
|
|
3788
|
-
[k: string]: any;
|
|
3789
|
-
};
|
|
3790
|
-
/**
|
|
3791
|
-
* Status of the task
|
|
3792
|
-
*/
|
|
3793
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
3794
|
-
/**
|
|
3795
|
-
* Parent task id is the parent task that created this task
|
|
3796
|
-
*/
|
|
3797
|
-
parentTaskId?: string;
|
|
3798
|
-
/**
|
|
3799
|
-
* Conversation id related to this task
|
|
3800
|
-
*/
|
|
3801
|
-
conversationId?: string;
|
|
3802
|
-
/**
|
|
3803
|
-
* Specific user related to this task
|
|
3804
|
-
*/
|
|
3805
|
-
userId?: string;
|
|
3806
|
-
/**
|
|
3807
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
3808
|
-
*/
|
|
3809
|
-
timeoutAt: string;
|
|
3810
|
-
/**
|
|
3811
|
-
* Creation date of the task in ISO 8601 format
|
|
3812
|
-
*/
|
|
3813
|
-
createdAt: string;
|
|
3814
|
-
/**
|
|
3815
|
-
* Updating date of the task in ISO 8601 format
|
|
3816
|
-
*/
|
|
3817
|
-
updatedAt: string;
|
|
3818
|
-
/**
|
|
3819
|
-
* If the task fails this is the reason behind it
|
|
3820
|
-
*/
|
|
3821
|
-
failureReason?: string;
|
|
3822
|
-
/**
|
|
3823
|
-
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them.
|
|
3824
|
-
*/
|
|
3825
|
-
tags: {
|
|
3826
|
-
[k: string]: string;
|
|
3827
|
-
};
|
|
3828
|
-
};
|
|
3829
|
-
}
|
|
3830
|
-
|
|
3831
|
-
interface DeleteTaskRequestHeaders {
|
|
3832
|
-
}
|
|
3833
|
-
interface DeleteTaskRequestQuery {
|
|
3834
|
-
}
|
|
3835
|
-
interface DeleteTaskRequestParams {
|
|
3836
|
-
id: string;
|
|
3837
|
-
}
|
|
3838
|
-
interface DeleteTaskRequestBody {
|
|
3839
|
-
}
|
|
3840
|
-
type DeleteTaskInput = DeleteTaskRequestBody & DeleteTaskRequestHeaders & DeleteTaskRequestQuery & DeleteTaskRequestParams;
|
|
3841
|
-
interface DeleteTaskResponse {
|
|
3842
|
-
}
|
|
3843
|
-
|
|
3844
|
-
interface ListTasksRequestHeaders {
|
|
3845
|
-
}
|
|
3846
|
-
interface ListTasksRequestQuery {
|
|
3847
|
-
nextToken?: string;
|
|
3848
|
-
tags?: {
|
|
3849
|
-
[k: string]: string;
|
|
3850
|
-
};
|
|
3851
|
-
conversationId?: string;
|
|
3852
|
-
userId?: string;
|
|
3853
|
-
parentTaskId?: string;
|
|
3854
|
-
status?: ("pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled")[];
|
|
3855
|
-
type?: string;
|
|
3856
|
-
}
|
|
3857
|
-
interface ListTasksRequestParams {
|
|
3858
|
-
}
|
|
3859
|
-
interface ListTasksRequestBody {
|
|
3860
|
-
}
|
|
3861
|
-
type ListTasksInput = ListTasksRequestBody & ListTasksRequestHeaders & ListTasksRequestQuery & ListTasksRequestParams;
|
|
3862
|
-
interface ListTasksResponse {
|
|
3863
|
-
tasks: {
|
|
3864
|
-
/**
|
|
3865
|
-
* Id of the [Task](#schema_task)
|
|
3866
|
-
*/
|
|
3867
|
-
id: string;
|
|
3868
|
-
/**
|
|
3869
|
-
* Title describing the task
|
|
3870
|
-
*/
|
|
3871
|
-
title: string;
|
|
3872
|
-
/**
|
|
3873
|
-
* All the notes related to the execution of the current task
|
|
3874
|
-
*/
|
|
3875
|
-
description: string;
|
|
3876
|
-
/**
|
|
3877
|
-
* Type of the task
|
|
3878
|
-
*/
|
|
3879
|
-
type: string;
|
|
3880
|
-
/**
|
|
3881
|
-
* Content related to the task
|
|
3882
|
-
*/
|
|
3883
|
-
data: {
|
|
3884
|
-
[k: string]: any;
|
|
3885
|
-
};
|
|
3886
|
-
/**
|
|
3887
|
-
* Status of the task
|
|
3888
|
-
*/
|
|
3889
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
3890
|
-
/**
|
|
3891
|
-
* Parent task id is the parent task that created this task
|
|
3892
|
-
*/
|
|
3893
|
-
parentTaskId?: string;
|
|
3894
|
-
/**
|
|
3895
|
-
* Conversation id related to this task
|
|
3896
|
-
*/
|
|
3897
|
-
conversationId?: string;
|
|
3898
|
-
/**
|
|
3899
|
-
* Specific user related to this task
|
|
3900
|
-
*/
|
|
3901
|
-
userId?: string;
|
|
3902
|
-
/**
|
|
3903
|
-
* The timeout date where the task should be failed in the ISO 8601 format
|
|
3904
|
-
*/
|
|
3905
|
-
timeoutAt: string;
|
|
3906
|
-
/**
|
|
3907
|
-
* Creation date of the task in ISO 8601 format
|
|
3908
|
-
*/
|
|
3909
|
-
createdAt: string;
|
|
3910
|
-
/**
|
|
3911
|
-
* Updating date of the task in ISO 8601 format
|
|
3912
|
-
*/
|
|
3913
|
-
updatedAt: string;
|
|
3914
|
-
/**
|
|
3915
|
-
* If the task fails this is the reason behind it
|
|
3916
|
-
*/
|
|
3917
|
-
failureReason?: string;
|
|
3918
|
-
/**
|
|
3919
|
-
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them.
|
|
3920
|
-
*/
|
|
3921
|
-
tags: {
|
|
3922
|
-
[k: string]: string;
|
|
3923
|
-
};
|
|
3924
|
-
}[];
|
|
3925
|
-
meta: {
|
|
3926
|
-
/**
|
|
3927
|
-
* The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
|
|
3928
|
-
*/
|
|
3929
|
-
nextToken?: string;
|
|
3930
|
-
};
|
|
3528
|
+
*/
|
|
3529
|
+
identifier?: string | null;
|
|
3530
|
+
/**
|
|
3531
|
+
* Recurring schedule on which `register()` will be called on the integration
|
|
3532
|
+
*/
|
|
3533
|
+
scheduleRegisterCall?: "hourly" | "daily" | "weekly" | "bi-weekly" | "monthly" | "bi-monthly" | "quarterly" | "yearly";
|
|
3534
|
+
/**
|
|
3535
|
+
* **EXPERIMENTAL** Sandbox identifiers for the integration. Setting this to null will remove all sandbox identifiers. This is an experimental feature meant to be used by specific integrations.
|
|
3536
|
+
*/
|
|
3537
|
+
sandboxIdentifiers?: {} | null;
|
|
3538
|
+
}
|
|
3539
|
+
type ConfigureIntegrationInput = ConfigureIntegrationRequestBody & ConfigureIntegrationRequestHeaders & ConfigureIntegrationRequestQuery & ConfigureIntegrationRequestParams;
|
|
3540
|
+
interface ConfigureIntegrationResponse {
|
|
3931
3541
|
}
|
|
3932
3542
|
|
|
3933
3543
|
interface CreateWorkflowRequestHeaders {
|
|
@@ -4511,6 +4121,10 @@ interface CaptureObservationRequestQuery {
|
|
|
4511
4121
|
interface CaptureObservationRequestParams {
|
|
4512
4122
|
}
|
|
4513
4123
|
interface CaptureObservationRequestBody {
|
|
4124
|
+
/**
|
|
4125
|
+
* Caller-defined identifier for the observation (e.g. llmz context ID). Uniqueness is not enforced nor guaranteed.
|
|
4126
|
+
*/
|
|
4127
|
+
id?: string;
|
|
4514
4128
|
/**
|
|
4515
4129
|
* Name of the observation
|
|
4516
4130
|
*/
|
|
@@ -4819,6 +4433,12 @@ interface ListPublicIntegrationsResponse {
|
|
|
4819
4433
|
*/
|
|
4820
4434
|
interfaces?: string[];
|
|
4821
4435
|
};
|
|
4436
|
+
/**
|
|
4437
|
+
* Optional key-value attributes from the integration definition
|
|
4438
|
+
*/
|
|
4439
|
+
attributes?: {
|
|
4440
|
+
[k: string]: string;
|
|
4441
|
+
};
|
|
4822
4442
|
}[];
|
|
4823
4443
|
meta: {
|
|
4824
4444
|
/**
|
|
@@ -5793,9 +5413,9 @@ interface GetPublicPluginByIdResponse {
|
|
|
5793
5413
|
states: {
|
|
5794
5414
|
[k: string]: {
|
|
5795
5415
|
/**
|
|
5796
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
5416
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
5797
5417
|
*/
|
|
5798
|
-
type: "conversation" | "user" | "bot"
|
|
5418
|
+
type: "conversation" | "user" | "bot";
|
|
5799
5419
|
/**
|
|
5800
5420
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
5801
5421
|
*/
|
|
@@ -5921,6 +5541,26 @@ interface GetPublicPluginByIdResponse {
|
|
|
5921
5541
|
};
|
|
5922
5542
|
};
|
|
5923
5543
|
};
|
|
5544
|
+
/**
|
|
5545
|
+
* Message object configuration
|
|
5546
|
+
*/
|
|
5547
|
+
message: {
|
|
5548
|
+
tags: {
|
|
5549
|
+
/**
|
|
5550
|
+
* Definition of a tag that can be provided on the object
|
|
5551
|
+
*/
|
|
5552
|
+
[k: string]: {
|
|
5553
|
+
/**
|
|
5554
|
+
* Title of the tag
|
|
5555
|
+
*/
|
|
5556
|
+
title?: string;
|
|
5557
|
+
/**
|
|
5558
|
+
* Description of the tag
|
|
5559
|
+
*/
|
|
5560
|
+
description?: string;
|
|
5561
|
+
};
|
|
5562
|
+
};
|
|
5563
|
+
};
|
|
5924
5564
|
/**
|
|
5925
5565
|
* Optional attributes
|
|
5926
5566
|
*/
|
|
@@ -6022,9 +5662,9 @@ interface GetDereferencedPublicPluginByIdResponse {
|
|
|
6022
5662
|
states: {
|
|
6023
5663
|
[k: string]: {
|
|
6024
5664
|
/**
|
|
6025
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
5665
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
6026
5666
|
*/
|
|
6027
|
-
type: "conversation" | "user" | "bot"
|
|
5667
|
+
type: "conversation" | "user" | "bot";
|
|
6028
5668
|
/**
|
|
6029
5669
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
6030
5670
|
*/
|
|
@@ -6150,6 +5790,26 @@ interface GetDereferencedPublicPluginByIdResponse {
|
|
|
6150
5790
|
};
|
|
6151
5791
|
};
|
|
6152
5792
|
};
|
|
5793
|
+
/**
|
|
5794
|
+
* Message object configuration
|
|
5795
|
+
*/
|
|
5796
|
+
message: {
|
|
5797
|
+
tags: {
|
|
5798
|
+
/**
|
|
5799
|
+
* Definition of a tag that can be provided on the object
|
|
5800
|
+
*/
|
|
5801
|
+
[k: string]: {
|
|
5802
|
+
/**
|
|
5803
|
+
* Title of the tag
|
|
5804
|
+
*/
|
|
5805
|
+
title?: string;
|
|
5806
|
+
/**
|
|
5807
|
+
* Description of the tag
|
|
5808
|
+
*/
|
|
5809
|
+
description?: string;
|
|
5810
|
+
};
|
|
5811
|
+
};
|
|
5812
|
+
};
|
|
6153
5813
|
/**
|
|
6154
5814
|
* Optional attributes
|
|
6155
5815
|
*/
|
|
@@ -6243,9 +5903,9 @@ interface GetPublicPluginResponse {
|
|
|
6243
5903
|
states: {
|
|
6244
5904
|
[k: string]: {
|
|
6245
5905
|
/**
|
|
6246
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
5906
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
6247
5907
|
*/
|
|
6248
|
-
type: "conversation" | "user" | "bot"
|
|
5908
|
+
type: "conversation" | "user" | "bot";
|
|
6249
5909
|
/**
|
|
6250
5910
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
6251
5911
|
*/
|
|
@@ -6371,6 +6031,26 @@ interface GetPublicPluginResponse {
|
|
|
6371
6031
|
};
|
|
6372
6032
|
};
|
|
6373
6033
|
};
|
|
6034
|
+
/**
|
|
6035
|
+
* Message object configuration
|
|
6036
|
+
*/
|
|
6037
|
+
message: {
|
|
6038
|
+
tags: {
|
|
6039
|
+
/**
|
|
6040
|
+
* Definition of a tag that can be provided on the object
|
|
6041
|
+
*/
|
|
6042
|
+
[k: string]: {
|
|
6043
|
+
/**
|
|
6044
|
+
* Title of the tag
|
|
6045
|
+
*/
|
|
6046
|
+
title?: string;
|
|
6047
|
+
/**
|
|
6048
|
+
* Description of the tag
|
|
6049
|
+
*/
|
|
6050
|
+
description?: string;
|
|
6051
|
+
};
|
|
6052
|
+
};
|
|
6053
|
+
};
|
|
6374
6054
|
/**
|
|
6375
6055
|
* Optional attributes
|
|
6376
6056
|
*/
|
|
@@ -6831,9 +6511,9 @@ interface CreateBotRequestBody {
|
|
|
6831
6511
|
states?: {
|
|
6832
6512
|
[k: string]: {
|
|
6833
6513
|
/**
|
|
6834
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
6514
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
6835
6515
|
*/
|
|
6836
|
-
type: "conversation" | "user" | "bot"
|
|
6516
|
+
type: "conversation" | "user" | "bot";
|
|
6837
6517
|
/**
|
|
6838
6518
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
6839
6519
|
*/
|
|
@@ -7269,9 +6949,9 @@ interface CreateBotResponse {
|
|
|
7269
6949
|
states: {
|
|
7270
6950
|
[k: string]: {
|
|
7271
6951
|
/**
|
|
7272
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
6952
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
7273
6953
|
*/
|
|
7274
|
-
type: "conversation" | "user" | "bot"
|
|
6954
|
+
type: "conversation" | "user" | "bot";
|
|
7275
6955
|
/**
|
|
7276
6956
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
7277
6957
|
*/
|
|
@@ -7597,9 +7277,9 @@ interface UpdateBotRequestBody {
|
|
|
7597
7277
|
states?: {
|
|
7598
7278
|
[k: string]: {
|
|
7599
7279
|
/**
|
|
7600
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
7280
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
7601
7281
|
*/
|
|
7602
|
-
type: "conversation" | "user" | "bot"
|
|
7282
|
+
type: "conversation" | "user" | "bot";
|
|
7603
7283
|
/**
|
|
7604
7284
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
7605
7285
|
*/
|
|
@@ -7949,9 +7629,9 @@ interface UpdateBotResponse {
|
|
|
7949
7629
|
states: {
|
|
7950
7630
|
[k: string]: {
|
|
7951
7631
|
/**
|
|
7952
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
7632
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
7953
7633
|
*/
|
|
7954
|
-
type: "conversation" | "user" | "bot"
|
|
7634
|
+
type: "conversation" | "user" | "bot";
|
|
7955
7635
|
/**
|
|
7956
7636
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
7957
7637
|
*/
|
|
@@ -8457,9 +8137,9 @@ interface GetBotResponse {
|
|
|
8457
8137
|
states: {
|
|
8458
8138
|
[k: string]: {
|
|
8459
8139
|
/**
|
|
8460
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
8140
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
8461
8141
|
*/
|
|
8462
|
-
type: "conversation" | "user" | "bot"
|
|
8142
|
+
type: "conversation" | "user" | "bot";
|
|
8463
8143
|
/**
|
|
8464
8144
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
8465
8145
|
*/
|
|
@@ -12183,6 +11863,12 @@ interface ListIntegrationsResponse {
|
|
|
12183
11863
|
handle: string | null;
|
|
12184
11864
|
name: string;
|
|
12185
11865
|
};
|
|
11866
|
+
/**
|
|
11867
|
+
* Optional key-value attributes from the integration definition
|
|
11868
|
+
*/
|
|
11869
|
+
attributes?: {
|
|
11870
|
+
[k: string]: string;
|
|
11871
|
+
};
|
|
12186
11872
|
}[];
|
|
12187
11873
|
meta: {
|
|
12188
11874
|
/**
|
|
@@ -14105,9 +13791,9 @@ interface CreatePluginRequestBody {
|
|
|
14105
13791
|
states?: {
|
|
14106
13792
|
[k: string]: {
|
|
14107
13793
|
/**
|
|
14108
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
13794
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
14109
13795
|
*/
|
|
14110
|
-
type: "conversation" | "user" | "bot"
|
|
13796
|
+
type: "conversation" | "user" | "bot";
|
|
14111
13797
|
/**
|
|
14112
13798
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
14113
13799
|
*/
|
|
@@ -14217,6 +13903,26 @@ interface CreatePluginRequestBody {
|
|
|
14217
13903
|
};
|
|
14218
13904
|
};
|
|
14219
13905
|
};
|
|
13906
|
+
/**
|
|
13907
|
+
* Message object configuration
|
|
13908
|
+
*/
|
|
13909
|
+
message?: {
|
|
13910
|
+
tags: {
|
|
13911
|
+
/**
|
|
13912
|
+
* Definition of a tag that can be provided on the object
|
|
13913
|
+
*/
|
|
13914
|
+
[k: string]: {
|
|
13915
|
+
/**
|
|
13916
|
+
* Title of the tag
|
|
13917
|
+
*/
|
|
13918
|
+
title?: string;
|
|
13919
|
+
/**
|
|
13920
|
+
* Description of the tag
|
|
13921
|
+
*/
|
|
13922
|
+
description?: string;
|
|
13923
|
+
};
|
|
13924
|
+
};
|
|
13925
|
+
};
|
|
14220
13926
|
/**
|
|
14221
13927
|
* Optional attributes
|
|
14222
13928
|
*/
|
|
@@ -14345,9 +14051,9 @@ interface CreatePluginResponse {
|
|
|
14345
14051
|
states: {
|
|
14346
14052
|
[k: string]: {
|
|
14347
14053
|
/**
|
|
14348
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
14054
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
14349
14055
|
*/
|
|
14350
|
-
type: "conversation" | "user" | "bot"
|
|
14056
|
+
type: "conversation" | "user" | "bot";
|
|
14351
14057
|
/**
|
|
14352
14058
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
14353
14059
|
*/
|
|
@@ -14473,6 +14179,26 @@ interface CreatePluginResponse {
|
|
|
14473
14179
|
};
|
|
14474
14180
|
};
|
|
14475
14181
|
};
|
|
14182
|
+
/**
|
|
14183
|
+
* Message object configuration
|
|
14184
|
+
*/
|
|
14185
|
+
message: {
|
|
14186
|
+
tags: {
|
|
14187
|
+
/**
|
|
14188
|
+
* Definition of a tag that can be provided on the object
|
|
14189
|
+
*/
|
|
14190
|
+
[k: string]: {
|
|
14191
|
+
/**
|
|
14192
|
+
* Title of the tag
|
|
14193
|
+
*/
|
|
14194
|
+
title?: string;
|
|
14195
|
+
/**
|
|
14196
|
+
* Description of the tag
|
|
14197
|
+
*/
|
|
14198
|
+
description?: string;
|
|
14199
|
+
};
|
|
14200
|
+
};
|
|
14201
|
+
};
|
|
14476
14202
|
/**
|
|
14477
14203
|
* Optional attributes
|
|
14478
14204
|
*/
|
|
@@ -14565,9 +14291,9 @@ interface GetPluginResponse {
|
|
|
14565
14291
|
states: {
|
|
14566
14292
|
[k: string]: {
|
|
14567
14293
|
/**
|
|
14568
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
14294
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
14569
14295
|
*/
|
|
14570
|
-
type: "conversation" | "user" | "bot"
|
|
14296
|
+
type: "conversation" | "user" | "bot";
|
|
14571
14297
|
/**
|
|
14572
14298
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
14573
14299
|
*/
|
|
@@ -14693,6 +14419,26 @@ interface GetPluginResponse {
|
|
|
14693
14419
|
};
|
|
14694
14420
|
};
|
|
14695
14421
|
};
|
|
14422
|
+
/**
|
|
14423
|
+
* Message object configuration
|
|
14424
|
+
*/
|
|
14425
|
+
message: {
|
|
14426
|
+
tags: {
|
|
14427
|
+
/**
|
|
14428
|
+
* Definition of a tag that can be provided on the object
|
|
14429
|
+
*/
|
|
14430
|
+
[k: string]: {
|
|
14431
|
+
/**
|
|
14432
|
+
* Title of the tag
|
|
14433
|
+
*/
|
|
14434
|
+
title?: string;
|
|
14435
|
+
/**
|
|
14436
|
+
* Description of the tag
|
|
14437
|
+
*/
|
|
14438
|
+
description?: string;
|
|
14439
|
+
};
|
|
14440
|
+
};
|
|
14441
|
+
};
|
|
14696
14442
|
/**
|
|
14697
14443
|
* Optional attributes
|
|
14698
14444
|
*/
|
|
@@ -14794,9 +14540,9 @@ interface GetDereferencedPluginResponse {
|
|
|
14794
14540
|
states: {
|
|
14795
14541
|
[k: string]: {
|
|
14796
14542
|
/**
|
|
14797
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
14543
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
14798
14544
|
*/
|
|
14799
|
-
type: "conversation" | "user" | "bot"
|
|
14545
|
+
type: "conversation" | "user" | "bot";
|
|
14800
14546
|
/**
|
|
14801
14547
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
14802
14548
|
*/
|
|
@@ -14922,6 +14668,26 @@ interface GetDereferencedPluginResponse {
|
|
|
14922
14668
|
};
|
|
14923
14669
|
};
|
|
14924
14670
|
};
|
|
14671
|
+
/**
|
|
14672
|
+
* Message object configuration
|
|
14673
|
+
*/
|
|
14674
|
+
message: {
|
|
14675
|
+
tags: {
|
|
14676
|
+
/**
|
|
14677
|
+
* Definition of a tag that can be provided on the object
|
|
14678
|
+
*/
|
|
14679
|
+
[k: string]: {
|
|
14680
|
+
/**
|
|
14681
|
+
* Title of the tag
|
|
14682
|
+
*/
|
|
14683
|
+
title?: string;
|
|
14684
|
+
/**
|
|
14685
|
+
* Description of the tag
|
|
14686
|
+
*/
|
|
14687
|
+
description?: string;
|
|
14688
|
+
};
|
|
14689
|
+
};
|
|
14690
|
+
};
|
|
14925
14691
|
/**
|
|
14926
14692
|
* Optional attributes
|
|
14927
14693
|
*/
|
|
@@ -15015,9 +14781,9 @@ interface GetPluginByNameResponse {
|
|
|
15015
14781
|
states: {
|
|
15016
14782
|
[k: string]: {
|
|
15017
14783
|
/**
|
|
15018
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
14784
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
15019
14785
|
*/
|
|
15020
|
-
type: "conversation" | "user" | "bot"
|
|
14786
|
+
type: "conversation" | "user" | "bot";
|
|
15021
14787
|
/**
|
|
15022
14788
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
15023
14789
|
*/
|
|
@@ -15143,6 +14909,26 @@ interface GetPluginByNameResponse {
|
|
|
15143
14909
|
};
|
|
15144
14910
|
};
|
|
15145
14911
|
};
|
|
14912
|
+
/**
|
|
14913
|
+
* Message object configuration
|
|
14914
|
+
*/
|
|
14915
|
+
message: {
|
|
14916
|
+
tags: {
|
|
14917
|
+
/**
|
|
14918
|
+
* Definition of a tag that can be provided on the object
|
|
14919
|
+
*/
|
|
14920
|
+
[k: string]: {
|
|
14921
|
+
/**
|
|
14922
|
+
* Title of the tag
|
|
14923
|
+
*/
|
|
14924
|
+
title?: string;
|
|
14925
|
+
/**
|
|
14926
|
+
* Description of the tag
|
|
14927
|
+
*/
|
|
14928
|
+
description?: string;
|
|
14929
|
+
};
|
|
14930
|
+
};
|
|
14931
|
+
};
|
|
15146
14932
|
/**
|
|
15147
14933
|
* Optional attributes
|
|
15148
14934
|
*/
|
|
@@ -15211,9 +14997,9 @@ interface UpdatePluginRequestBody {
|
|
|
15211
14997
|
states?: {
|
|
15212
14998
|
[k: string]: {
|
|
15213
14999
|
/**
|
|
15214
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
15000
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
15215
15001
|
*/
|
|
15216
|
-
type: "conversation" | "user" | "bot"
|
|
15002
|
+
type: "conversation" | "user" | "bot";
|
|
15217
15003
|
/**
|
|
15218
15004
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
15219
15005
|
*/
|
|
@@ -15311,6 +15097,23 @@ interface UpdatePluginRequestBody {
|
|
|
15311
15097
|
} | null;
|
|
15312
15098
|
};
|
|
15313
15099
|
};
|
|
15100
|
+
message?: {
|
|
15101
|
+
tags: {
|
|
15102
|
+
/**
|
|
15103
|
+
* Definition of a tag that can be provided on the object
|
|
15104
|
+
*/
|
|
15105
|
+
[k: string]: {
|
|
15106
|
+
/**
|
|
15107
|
+
* Title of the tag
|
|
15108
|
+
*/
|
|
15109
|
+
title?: string;
|
|
15110
|
+
/**
|
|
15111
|
+
* Description of the tag
|
|
15112
|
+
*/
|
|
15113
|
+
description?: string;
|
|
15114
|
+
} | null;
|
|
15115
|
+
};
|
|
15116
|
+
};
|
|
15314
15117
|
/**
|
|
15315
15118
|
* Optional attributes. Set attributes to null to remove them
|
|
15316
15119
|
*/
|
|
@@ -15439,9 +15242,9 @@ interface UpdatePluginResponse {
|
|
|
15439
15242
|
states: {
|
|
15440
15243
|
[k: string]: {
|
|
15441
15244
|
/**
|
|
15442
|
-
* Type of the [State](#schema_state) (`conversation`, `user
|
|
15245
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
|
|
15443
15246
|
*/
|
|
15444
|
-
type: "conversation" | "user" | "bot"
|
|
15247
|
+
type: "conversation" | "user" | "bot";
|
|
15445
15248
|
/**
|
|
15446
15249
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
15447
15250
|
*/
|
|
@@ -15567,6 +15370,26 @@ interface UpdatePluginResponse {
|
|
|
15567
15370
|
};
|
|
15568
15371
|
};
|
|
15569
15372
|
};
|
|
15373
|
+
/**
|
|
15374
|
+
* Message object configuration
|
|
15375
|
+
*/
|
|
15376
|
+
message: {
|
|
15377
|
+
tags: {
|
|
15378
|
+
/**
|
|
15379
|
+
* Definition of a tag that can be provided on the object
|
|
15380
|
+
*/
|
|
15381
|
+
[k: string]: {
|
|
15382
|
+
/**
|
|
15383
|
+
* Title of the tag
|
|
15384
|
+
*/
|
|
15385
|
+
title?: string;
|
|
15386
|
+
/**
|
|
15387
|
+
* Description of the tag
|
|
15388
|
+
*/
|
|
15389
|
+
description?: string;
|
|
15390
|
+
};
|
|
15391
|
+
};
|
|
15392
|
+
};
|
|
15570
15393
|
/**
|
|
15571
15394
|
* Optional attributes
|
|
15572
15395
|
*/
|
|
@@ -17865,9 +17688,13 @@ interface DuplicateTableResponse {
|
|
|
17865
17688
|
updatedAt?: string;
|
|
17866
17689
|
};
|
|
17867
17690
|
/**
|
|
17868
|
-
* The total number of rows present in the table.
|
|
17691
|
+
* The total number of rows present in the source table.
|
|
17869
17692
|
*/
|
|
17870
17693
|
rows: number;
|
|
17694
|
+
job?: {
|
|
17695
|
+
id: string;
|
|
17696
|
+
status: string;
|
|
17697
|
+
};
|
|
17871
17698
|
}
|
|
17872
17699
|
|
|
17873
17700
|
interface ExportTableRequestHeaders {
|
|
@@ -17887,7 +17714,7 @@ interface ExportTableResponse {
|
|
|
17887
17714
|
id: string;
|
|
17888
17715
|
botId: string;
|
|
17889
17716
|
tableId: string;
|
|
17890
|
-
type: "export" | "import" | "clear_column" | "clear_vectors";
|
|
17717
|
+
type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
|
|
17891
17718
|
status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
|
|
17892
17719
|
progress?: number;
|
|
17893
17720
|
inputFileId: string | null;
|
|
@@ -17912,7 +17739,7 @@ interface GetTableJobsResponse {
|
|
|
17912
17739
|
id: string;
|
|
17913
17740
|
botId: string;
|
|
17914
17741
|
tableId: string;
|
|
17915
|
-
type: "export" | "import" | "clear_column" | "clear_vectors";
|
|
17742
|
+
type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
|
|
17916
17743
|
status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
|
|
17917
17744
|
progress?: number;
|
|
17918
17745
|
inputFileId: string | null;
|
|
@@ -17941,7 +17768,7 @@ interface ImportTableResponse {
|
|
|
17941
17768
|
id: string;
|
|
17942
17769
|
botId: string;
|
|
17943
17770
|
tableId: string;
|
|
17944
|
-
type: "export" | "import" | "clear_column" | "clear_vectors";
|
|
17771
|
+
type: "export" | "import" | "clear_column" | "clear_vectors" | "delete_rows" | "duplicate_table";
|
|
17945
17772
|
status: "pending" | "in_progress" | "finalizing" | "completed" | "failed";
|
|
17946
17773
|
progress?: number;
|
|
17947
17774
|
inputFileId: string | null;
|
|
@@ -18517,7 +18344,7 @@ interface DeleteTableRowsRequestBody {
|
|
|
18517
18344
|
*/
|
|
18518
18345
|
ids?: number[];
|
|
18519
18346
|
/**
|
|
18520
|
-
* Filter to apply when deleting rows. Example: \{ "
|
|
18347
|
+
* Filter to apply when deleting rows. Deletion with a filter is performed asynchronously in batches and returns a job object to track progress. Example: \{ "createdAt": \{ "$lt": "2026-01-01" \} \}
|
|
18521
18348
|
*/
|
|
18522
18349
|
filter?: {
|
|
18523
18350
|
[k: string]: any;
|
|
@@ -18530,6 +18357,10 @@ interface DeleteTableRowsRequestBody {
|
|
|
18530
18357
|
type DeleteTableRowsInput = DeleteTableRowsRequestBody & DeleteTableRowsRequestHeaders & DeleteTableRowsRequestQuery & DeleteTableRowsRequestParams;
|
|
18531
18358
|
interface DeleteTableRowsResponse {
|
|
18532
18359
|
deletedRows: number;
|
|
18360
|
+
job?: {
|
|
18361
|
+
id: string;
|
|
18362
|
+
status: string;
|
|
18363
|
+
};
|
|
18533
18364
|
}
|
|
18534
18365
|
|
|
18535
18366
|
interface UpdateTableRowsRequestHeaders {
|
|
@@ -18740,11 +18571,6 @@ declare class Client$1 {
|
|
|
18740
18571
|
readonly patchState: (input: PatchStateInput) => Promise<PatchStateResponse>;
|
|
18741
18572
|
readonly callAction: (input: CallActionInput) => Promise<CallActionResponse>;
|
|
18742
18573
|
readonly configureIntegration: (input: ConfigureIntegrationInput) => Promise<ConfigureIntegrationResponse>;
|
|
18743
|
-
readonly getTask: (input: GetTaskInput) => Promise<GetTaskResponse>;
|
|
18744
|
-
readonly createTask: (input: CreateTaskInput) => Promise<CreateTaskResponse>;
|
|
18745
|
-
readonly updateTask: (input: UpdateTaskInput) => Promise<UpdateTaskResponse>;
|
|
18746
|
-
readonly deleteTask: (input: DeleteTaskInput) => Promise<DeleteTaskResponse>;
|
|
18747
|
-
readonly listTasks: (input: ListTasksInput) => Promise<ListTasksResponse>;
|
|
18748
18574
|
readonly createWorkflow: (input: CreateWorkflowInput) => Promise<CreateWorkflowResponse>;
|
|
18749
18575
|
readonly getWorkflow: (input: GetWorkflowInput) => Promise<GetWorkflowResponse>;
|
|
18750
18576
|
readonly updateWorkflow: (input: UpdateWorkflowInput) => Promise<UpdateWorkflowResponse>;
|
|
@@ -19017,35 +18843,6 @@ declare class Client extends Client$1 implements IClient {
|
|
|
19017
18843
|
[k: string]: string;
|
|
19018
18844
|
};
|
|
19019
18845
|
}>;
|
|
19020
|
-
tasks: (props: {
|
|
19021
|
-
status?: ("timeout" | "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "cancelled")[] | undefined;
|
|
19022
|
-
tags?: {
|
|
19023
|
-
[x: string]: string;
|
|
19024
|
-
} | undefined;
|
|
19025
|
-
type?: string | undefined;
|
|
19026
|
-
userId?: string | undefined;
|
|
19027
|
-
conversationId?: string | undefined;
|
|
19028
|
-
parentTaskId?: string | undefined;
|
|
19029
|
-
}) => AsyncCollection<{
|
|
19030
|
-
id: string;
|
|
19031
|
-
title: string;
|
|
19032
|
-
description: string;
|
|
19033
|
-
type: string;
|
|
19034
|
-
data: {
|
|
19035
|
-
[k: string]: any;
|
|
19036
|
-
};
|
|
19037
|
-
status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
|
|
19038
|
-
parentTaskId?: string;
|
|
19039
|
-
conversationId?: string;
|
|
19040
|
-
userId?: string;
|
|
19041
|
-
timeoutAt: string;
|
|
19042
|
-
createdAt: string;
|
|
19043
|
-
updatedAt: string;
|
|
19044
|
-
failureReason?: string;
|
|
19045
|
-
tags: {
|
|
19046
|
-
[k: string]: string;
|
|
19047
|
-
};
|
|
19048
|
-
}>;
|
|
19049
18846
|
publicIntegrations: (props: {
|
|
19050
18847
|
search?: string | undefined;
|
|
19051
18848
|
name?: string | undefined;
|
|
@@ -19086,6 +18883,9 @@ declare class Client extends Client$1 implements IClient {
|
|
|
19086
18883
|
actions?: string[];
|
|
19087
18884
|
interfaces?: string[];
|
|
19088
18885
|
};
|
|
18886
|
+
attributes?: {
|
|
18887
|
+
[k: string]: string;
|
|
18888
|
+
};
|
|
19089
18889
|
}>;
|
|
19090
18890
|
bots: (props: {
|
|
19091
18891
|
tags?: {
|
|
@@ -19169,6 +18969,9 @@ declare class Client extends Client$1 implements IClient {
|
|
|
19169
18969
|
handle: string | null;
|
|
19170
18970
|
name: string;
|
|
19171
18971
|
};
|
|
18972
|
+
attributes?: {
|
|
18973
|
+
[k: string]: string;
|
|
18974
|
+
};
|
|
19172
18975
|
}>;
|
|
19173
18976
|
interfaces: (props: {
|
|
19174
18977
|
name?: string | undefined;
|
|
@@ -19346,7 +19149,7 @@ declare class Client extends Client$1 implements IClient {
|
|
|
19346
19149
|
conversationId?: string | undefined;
|
|
19347
19150
|
name?: string | undefined;
|
|
19348
19151
|
parentWorkflowId?: string | undefined;
|
|
19349
|
-
statuses?: ("pending" | "failed" | "in_progress" | "
|
|
19152
|
+
statuses?: ("pending" | "failed" | "in_progress" | "listening" | "completed" | "paused" | "timedout" | "cancelled")[] | undefined;
|
|
19350
19153
|
}) => AsyncCollection<{
|
|
19351
19154
|
id: string;
|
|
19352
19155
|
name: string;
|
|
@@ -19881,7 +19684,7 @@ declare class Cognitive {
|
|
|
19881
19684
|
private _generateContent;
|
|
19882
19685
|
}
|
|
19883
19686
|
|
|
19884
|
-
type Models = 'auto' | 'best' | 'fast' | 'anthropic:claude-
|
|
19687
|
+
type Models = 'auto' | 'best' | 'fast' | 'anthropic:claude-haiku-4-5-20251001' | 'anthropic:claude-haiku-4-5-reasoning-20251001' | 'anthropic:claude-opus-4-6' | 'anthropic:claude-sonnet-4-20250514' | 'anthropic:claude-sonnet-4-5-20250929' | 'anthropic:claude-sonnet-4-6' | 'cerebras:gpt-oss-120b' | 'cerebras:llama-4-scout-17b-16e-instruct' | 'cerebras:llama3.1-8b' | 'cerebras:llama3.3-70b' | 'cerebras:qwen-3-32b' | 'fireworks-ai:deepseek-r1-0528' | 'fireworks-ai:deepseek-v3-0324' | 'fireworks-ai:gpt-oss-120b' | 'fireworks-ai:gpt-oss-20b' | 'fireworks-ai:llama-v3p1-8b-instruct' | 'fireworks-ai:llama-v3p3-70b-instruct' | 'fireworks-ai:llama4-maverick-instruct-basic' | 'fireworks-ai:llama4-scout-instruct-basic' | 'google-ai:gemini-2.0-flash' | 'google-ai:gemini-2.5-flash' | 'google-ai:gemini-2.5-pro' | 'google-ai:gemini-3-flash' | 'google-ai:gemini-3-pro' | 'groq:gpt-oss-120b' | 'groq:gpt-oss-20b' | 'groq:llama-3.1-8b-instant' | 'groq:llama-3.3-70b-versatile' | 'openai:gpt-4.1-2025-04-14' | 'openai:gpt-4.1-mini-2025-04-14' | 'openai:gpt-4.1-nano-2025-04-14' | 'openai:gpt-4o-2024-11-20' | 'openai:gpt-4o-mini-2024-07-18' | 'openai:gpt-5-2025-08-07' | 'openai:gpt-5-mini-2025-08-07' | 'openai:gpt-5-nano-2025-08-07' | 'openai:gpt-5.1-2025-11-13' | 'openai:gpt-5.2-2025-12-11' | 'openai:gpt-5.4-2026-03-05' | 'openai:o1-2024-12-17' | 'openai:o1-mini-2024-09-12' | 'openai:o3-2025-04-16' | 'openai:o3-mini-2025-01-31' | 'openai:o4-mini-2025-04-16' | 'openrouter:gpt-oss-120b' | 'xai:grok-3' | 'xai:grok-3-mini' | 'xai:grok-4-0709' | 'xai:grok-4-fast-non-reasoning' | 'xai:grok-4-fast-reasoning' | 'xai:grok-code-fast-1' | 'openai:gpt-5.4' | 'openai:gpt-5' | 'openai:gpt-5-mini' | 'openai:gpt-5-nano' | 'openai:o4-mini' | 'openai:o3' | 'openai:gpt-4.1' | 'openai:gpt-4.1-mini' | 'openai:gpt-4.1-nano' | 'openai:o3-mini' | 'openai:o1-mini' | 'openai:gpt-4o-mini' | 'openai:gpt-4o' | 'anthropic:claude-sonnet-4-5' | 'anthropic:claude-sonnet-4' | 'anthropic:claude-sonnet-4-reasoning' | 'anthropic:claude-haiku-4-5' | 'anthropic:claude-haiku-4-5-reasoning' | 'google-ai:gemini-3.1-pro-preview' | 'google-ai:gemini-3-flash-preview' | 'google-ai:models/gemini-2.0-flash' | 'groq:openai/gpt-oss-20b' | 'groq:openai/gpt-oss-120b' | 'fireworks-ai:accounts/fireworks/models/gpt-oss-20b' | 'fireworks-ai:accounts/fireworks/models/gpt-oss-120b' | 'fireworks-ai:accounts/fireworks/models/deepseek-r1-0528' | 'fireworks-ai:accounts/fireworks/models/deepseek-v3-0324' | 'fireworks-ai:accounts/fireworks/models/llama4-maverick-instruct-basic' | 'fireworks-ai:accounts/fireworks/models/llama4-scout-instruct-basic' | 'fireworks-ai:accounts/fireworks/models/llama-v3p3-70b-instruct' | 'fireworks-ai:accounts/fireworks/models/deepseek-r1' | 'fireworks-ai:accounts/fireworks/models/deepseek-r1-basic' | 'fireworks-ai:accounts/fireworks/models/deepseek-v3' | 'fireworks-ai:accounts/fireworks/models/llama-v3p1-405b-instruct' | 'fireworks-ai:accounts/fireworks/models/llama-v3p1-70b-instruct' | 'fireworks-ai:accounts/fireworks/models/llama-v3p1-8b-instruct' | 'fireworks-ai:accounts/fireworks/models/mixtral-8x22b-instruct' | 'fireworks-ai:accounts/fireworks/models/mixtral-8x7b-instruct' | 'fireworks-ai:accounts/fireworks/models/mythomax-l2-13b' | 'fireworks-ai:accounts/fireworks/models/gemma2-9b-it' | ({} & string);
|
|
19885
19688
|
type CognitiveRequest = {
|
|
19886
19689
|
/**
|
|
19887
19690
|
* @minItems 1
|