@botpress/cognitive 0.3.14 → 0.3.15

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.
@@ -1,19 +1,19 @@
1
1
 
2
- > @botpress/cognitive@0.3.14 build /home/runner/work/botpress/botpress/packages/cognitive
2
+ > @botpress/cognitive@0.3.15 build /home/runner/work/botpress/botpress/packages/cognitive
3
3
  > pnpm build:type && pnpm build:neutral && size-limit
4
4
 
5
5
 
6
- > @botpress/cognitive@0.3.14 build:type /home/runner/work/botpress/botpress/packages/cognitive
6
+ > @botpress/cognitive@0.3.15 build:type /home/runner/work/botpress/botpress/packages/cognitive
7
7
  > tsup --tsconfig tsconfig.build.json ./src/index.ts --dts-resolve --dts-only --clean
8
8
 
9
9
  CLI Building entry: ./src/index.ts
10
10
  CLI Using tsconfig: tsconfig.build.json
11
11
  CLI tsup v8.0.2
12
12
  DTS Build start
13
- DTS ⚡️ Build success in 7162ms
14
- DTS dist/index.d.ts 670.76 KB
13
+ DTS ⚡️ Build success in 6935ms
14
+ DTS dist/index.d.ts 660.05 KB
15
15
 
16
- > @botpress/cognitive@0.3.14 build:neutral /home/runner/work/botpress/botpress/packages/cognitive
16
+ > @botpress/cognitive@0.3.15 build:neutral /home/runner/work/botpress/botpress/packages/cognitive
17
17
  > ts-node -T ./build.ts --neutral
18
18
 
19
19
  Done
package/dist/index.d.ts CHANGED
@@ -1385,7 +1385,8 @@ interface CreateConversationResponse {
1385
1385
  */
1386
1386
  id: string;
1387
1387
  /**
1388
- * Id of the current [Task](#schema_task)
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
- * Id of the current [Task](#schema_task)
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
- * Id of the current [Task](#schema_task)
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
- * Id of the current [Task](#schema_task)
1578
+ * @deprecated
1579
+ * Unused. This field will be removed in the future.
1576
1580
  */
1577
1581
  currentTaskId?: string;
1578
1582
  /**
@@ -1612,6 +1616,10 @@ interface UpdateConversationRequestParams {
1612
1616
  id: string;
1613
1617
  }
1614
1618
  interface UpdateConversationRequestBody {
1619
+ /**
1620
+ * @deprecated
1621
+ * Unused. This parameter will be ignored if provided and should not be used when updating a conversation.
1622
+ */
1615
1623
  currentTaskId?: string;
1616
1624
  /**
1617
1625
  * Tags for the [Conversation](#schema_conversation)
@@ -1631,7 +1639,8 @@ interface UpdateConversationResponse {
1631
1639
  */
1632
1640
  id: string;
1633
1641
  /**
1634
- * Id of the current [Task](#schema_task)
1642
+ * @deprecated
1643
+ * Unused. This field will be removed in the future.
1635
1644
  */
1636
1645
  currentTaskId?: string;
1637
1646
  /**
@@ -2519,7 +2528,7 @@ interface InitializeIncomingMessageRequestBody {
2519
2528
  */
2520
2529
  pictureUrl?: string;
2521
2530
  /**
2522
- * Optional attributes
2531
+ * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
2523
2532
  */
2524
2533
  attributes?: {
2525
2534
  [k: string]: string;
@@ -2623,7 +2632,8 @@ interface InitializeIncomingMessageResponse {
2623
2632
  */
2624
2633
  id: string;
2625
2634
  /**
2626
- * Id of the current [Task](#schema_task)
2635
+ * @deprecated
2636
+ * Unused. This field will be removed in the future.
2627
2637
  */
2628
2638
  currentTaskId?: string;
2629
2639
  /**
@@ -2826,7 +2836,7 @@ interface CreateUserRequestBody {
2826
2836
  */
2827
2837
  pictureUrl?: string;
2828
2838
  /**
2829
- * Optional attributes
2839
+ * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
2830
2840
  */
2831
2841
  attributes?: {
2832
2842
  [k: string]: string;
@@ -3012,7 +3022,7 @@ interface GetOrCreateUserRequestBody {
3012
3022
  */
3013
3023
  pictureUrl?: string;
3014
3024
  /**
3015
- * Optional attributes
3025
+ * EXPERIMENTAL - Optional shared attributes that can be accessed and modified by both the bot and any of its integrations.
3016
3026
  */
3017
3027
  attributes?: {
3018
3028
  [k: string]: string;
@@ -3086,7 +3096,7 @@ interface UpdateUserRequestBody {
3086
3096
  */
3087
3097
  pictureUrl?: string | null;
3088
3098
  /**
3089
- * Optional attributes. Set attributes to null to remove them
3099
+ * 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
3100
  */
3091
3101
  attributes?: {
3092
3102
  [k: string]: string | null;
@@ -3151,7 +3161,7 @@ interface SetStateExpiryRequestHeaders {
3151
3161
  interface SetStateExpiryRequestQuery {
3152
3162
  }
3153
3163
  interface SetStateExpiryRequestParams {
3154
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
3164
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
3155
3165
  id: string;
3156
3166
  name: string;
3157
3167
  }
@@ -3196,9 +3206,9 @@ interface SetStateExpiryResponse {
3196
3206
  */
3197
3207
  name: string;
3198
3208
  /**
3199
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
3209
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
3200
3210
  */
3201
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
3211
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
3202
3212
  /**
3203
3213
  * Payload is the content of the state defined by your bot.
3204
3214
  */
@@ -3213,7 +3223,7 @@ interface GetStateRequestHeaders {
3213
3223
  interface GetStateRequestQuery {
3214
3224
  }
3215
3225
  interface GetStateRequestParams {
3216
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
3226
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
3217
3227
  id: string;
3218
3228
  name: string;
3219
3229
  }
@@ -3254,9 +3264,9 @@ interface GetStateResponse {
3254
3264
  */
3255
3265
  name: string;
3256
3266
  /**
3257
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
3267
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
3258
3268
  */
3259
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
3269
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
3260
3270
  /**
3261
3271
  * Payload is the content of the state defined by your bot.
3262
3272
  */
@@ -3274,7 +3284,7 @@ interface SetStateRequestHeaders {
3274
3284
  interface SetStateRequestQuery {
3275
3285
  }
3276
3286
  interface SetStateRequestParams {
3277
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
3287
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
3278
3288
  id: string;
3279
3289
  name: string;
3280
3290
  }
@@ -3325,9 +3335,9 @@ interface SetStateResponse {
3325
3335
  */
3326
3336
  name: string;
3327
3337
  /**
3328
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
3338
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
3329
3339
  */
3330
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
3340
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
3331
3341
  /**
3332
3342
  * Payload is the content of the state defined by your bot.
3333
3343
  */
@@ -3342,7 +3352,7 @@ interface GetOrSetStateRequestHeaders {
3342
3352
  interface GetOrSetStateRequestQuery {
3343
3353
  }
3344
3354
  interface GetOrSetStateRequestParams {
3345
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
3355
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
3346
3356
  id: string;
3347
3357
  name: string;
3348
3358
  }
@@ -3393,9 +3403,9 @@ interface GetOrSetStateResponse {
3393
3403
  */
3394
3404
  name: string;
3395
3405
  /**
3396
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
3406
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
3397
3407
  */
3398
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
3408
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
3399
3409
  /**
3400
3410
  * Payload is the content of the state defined by your bot.
3401
3411
  */
@@ -3413,7 +3423,7 @@ interface PatchStateRequestHeaders {
3413
3423
  interface PatchStateRequestQuery {
3414
3424
  }
3415
3425
  interface PatchStateRequestParams {
3416
- type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
3426
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
3417
3427
  id: string;
3418
3428
  name: string;
3419
3429
  }
@@ -3460,9 +3470,9 @@ interface PatchStateResponse {
3460
3470
  */
3461
3471
  name: string;
3462
3472
  /**
3463
- * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
3473
+ * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `integration` or `workflow`) that the state is related to
3464
3474
  */
3465
- type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
3475
+ type: "conversation" | "user" | "bot" | "integration" | "workflow";
3466
3476
  /**
3467
3477
  * Payload is the content of the state defined by your bot.
3468
3478
  */
@@ -3527,409 +3537,6 @@ type ConfigureIntegrationInput = ConfigureIntegrationRequestBody & ConfigureInte
3527
3537
  interface ConfigureIntegrationResponse {
3528
3538
  }
3529
3539
 
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
- };
3931
- }
3932
-
3933
3540
  interface CreateWorkflowRequestHeaders {
3934
3541
  }
3935
3542
  interface CreateWorkflowRequestQuery {
@@ -4511,6 +4118,10 @@ interface CaptureObservationRequestQuery {
4511
4118
  interface CaptureObservationRequestParams {
4512
4119
  }
4513
4120
  interface CaptureObservationRequestBody {
4121
+ /**
4122
+ * Caller-defined identifier for the observation (e.g. llmz context ID). Uniqueness is not enforced nor guaranteed.
4123
+ */
4124
+ id?: string;
4514
4125
  /**
4515
4126
  * Name of the observation
4516
4127
  */
@@ -4819,6 +4430,12 @@ interface ListPublicIntegrationsResponse {
4819
4430
  */
4820
4431
  interfaces?: string[];
4821
4432
  };
4433
+ /**
4434
+ * Optional key-value attributes from the integration definition
4435
+ */
4436
+ attributes?: {
4437
+ [k: string]: string;
4438
+ };
4822
4439
  }[];
4823
4440
  meta: {
4824
4441
  /**
@@ -5793,9 +5410,9 @@ interface GetPublicPluginByIdResponse {
5793
5410
  states: {
5794
5411
  [k: string]: {
5795
5412
  /**
5796
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
5413
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
5797
5414
  */
5798
- type: "conversation" | "user" | "bot" | "task";
5415
+ type: "conversation" | "user" | "bot";
5799
5416
  /**
5800
5417
  * 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
5418
  */
@@ -6022,9 +5639,9 @@ interface GetDereferencedPublicPluginByIdResponse {
6022
5639
  states: {
6023
5640
  [k: string]: {
6024
5641
  /**
6025
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
5642
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
6026
5643
  */
6027
- type: "conversation" | "user" | "bot" | "task";
5644
+ type: "conversation" | "user" | "bot";
6028
5645
  /**
6029
5646
  * 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
5647
  */
@@ -6243,9 +5860,9 @@ interface GetPublicPluginResponse {
6243
5860
  states: {
6244
5861
  [k: string]: {
6245
5862
  /**
6246
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
5863
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
6247
5864
  */
6248
- type: "conversation" | "user" | "bot" | "task";
5865
+ type: "conversation" | "user" | "bot";
6249
5866
  /**
6250
5867
  * 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
5868
  */
@@ -6831,9 +6448,9 @@ interface CreateBotRequestBody {
6831
6448
  states?: {
6832
6449
  [k: string]: {
6833
6450
  /**
6834
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
6451
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
6835
6452
  */
6836
- type: "conversation" | "user" | "bot" | "task";
6453
+ type: "conversation" | "user" | "bot";
6837
6454
  /**
6838
6455
  * 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
6456
  */
@@ -7269,9 +6886,9 @@ interface CreateBotResponse {
7269
6886
  states: {
7270
6887
  [k: string]: {
7271
6888
  /**
7272
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
6889
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
7273
6890
  */
7274
- type: "conversation" | "user" | "bot" | "task";
6891
+ type: "conversation" | "user" | "bot";
7275
6892
  /**
7276
6893
  * 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
6894
  */
@@ -7597,9 +7214,9 @@ interface UpdateBotRequestBody {
7597
7214
  states?: {
7598
7215
  [k: string]: {
7599
7216
  /**
7600
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
7217
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
7601
7218
  */
7602
- type: "conversation" | "user" | "bot" | "task";
7219
+ type: "conversation" | "user" | "bot";
7603
7220
  /**
7604
7221
  * 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
7222
  */
@@ -7949,9 +7566,9 @@ interface UpdateBotResponse {
7949
7566
  states: {
7950
7567
  [k: string]: {
7951
7568
  /**
7952
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
7569
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
7953
7570
  */
7954
- type: "conversation" | "user" | "bot" | "task";
7571
+ type: "conversation" | "user" | "bot";
7955
7572
  /**
7956
7573
  * 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
7574
  */
@@ -8457,9 +8074,9 @@ interface GetBotResponse {
8457
8074
  states: {
8458
8075
  [k: string]: {
8459
8076
  /**
8460
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
8077
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
8461
8078
  */
8462
- type: "conversation" | "user" | "bot" | "task";
8079
+ type: "conversation" | "user" | "bot";
8463
8080
  /**
8464
8081
  * 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
8082
  */
@@ -12183,6 +11800,12 @@ interface ListIntegrationsResponse {
12183
11800
  handle: string | null;
12184
11801
  name: string;
12185
11802
  };
11803
+ /**
11804
+ * Optional key-value attributes from the integration definition
11805
+ */
11806
+ attributes?: {
11807
+ [k: string]: string;
11808
+ };
12186
11809
  }[];
12187
11810
  meta: {
12188
11811
  /**
@@ -14105,9 +13728,9 @@ interface CreatePluginRequestBody {
14105
13728
  states?: {
14106
13729
  [k: string]: {
14107
13730
  /**
14108
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
13731
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
14109
13732
  */
14110
- type: "conversation" | "user" | "bot" | "task";
13733
+ type: "conversation" | "user" | "bot";
14111
13734
  /**
14112
13735
  * 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
13736
  */
@@ -14345,9 +13968,9 @@ interface CreatePluginResponse {
14345
13968
  states: {
14346
13969
  [k: string]: {
14347
13970
  /**
14348
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
13971
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
14349
13972
  */
14350
- type: "conversation" | "user" | "bot" | "task";
13973
+ type: "conversation" | "user" | "bot";
14351
13974
  /**
14352
13975
  * 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
13976
  */
@@ -14565,9 +14188,9 @@ interface GetPluginResponse {
14565
14188
  states: {
14566
14189
  [k: string]: {
14567
14190
  /**
14568
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
14191
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
14569
14192
  */
14570
- type: "conversation" | "user" | "bot" | "task";
14193
+ type: "conversation" | "user" | "bot";
14571
14194
  /**
14572
14195
  * 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
14196
  */
@@ -14794,9 +14417,9 @@ interface GetDereferencedPluginResponse {
14794
14417
  states: {
14795
14418
  [k: string]: {
14796
14419
  /**
14797
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
14420
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
14798
14421
  */
14799
- type: "conversation" | "user" | "bot" | "task";
14422
+ type: "conversation" | "user" | "bot";
14800
14423
  /**
14801
14424
  * 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
14425
  */
@@ -15015,9 +14638,9 @@ interface GetPluginByNameResponse {
15015
14638
  states: {
15016
14639
  [k: string]: {
15017
14640
  /**
15018
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
14641
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
15019
14642
  */
15020
- type: "conversation" | "user" | "bot" | "task";
14643
+ type: "conversation" | "user" | "bot";
15021
14644
  /**
15022
14645
  * 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
14646
  */
@@ -15211,9 +14834,9 @@ interface UpdatePluginRequestBody {
15211
14834
  states?: {
15212
14835
  [k: string]: {
15213
14836
  /**
15214
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
14837
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
15215
14838
  */
15216
- type: "conversation" | "user" | "bot" | "task";
14839
+ type: "conversation" | "user" | "bot";
15217
14840
  /**
15218
14841
  * 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
14842
  */
@@ -15439,9 +15062,9 @@ interface UpdatePluginResponse {
15439
15062
  states: {
15440
15063
  [k: string]: {
15441
15064
  /**
15442
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
15065
+ * Type of the [State](#schema_state) (`conversation`, `user` or `bot`)
15443
15066
  */
15444
- type: "conversation" | "user" | "bot" | "task";
15067
+ type: "conversation" | "user" | "bot";
15445
15068
  /**
15446
15069
  * 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
15070
  */
@@ -18740,11 +18363,6 @@ declare class Client$1 {
18740
18363
  readonly patchState: (input: PatchStateInput) => Promise<PatchStateResponse>;
18741
18364
  readonly callAction: (input: CallActionInput) => Promise<CallActionResponse>;
18742
18365
  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
18366
  readonly createWorkflow: (input: CreateWorkflowInput) => Promise<CreateWorkflowResponse>;
18749
18367
  readonly getWorkflow: (input: GetWorkflowInput) => Promise<GetWorkflowResponse>;
18750
18368
  readonly updateWorkflow: (input: UpdateWorkflowInput) => Promise<UpdateWorkflowResponse>;
@@ -19017,35 +18635,6 @@ declare class Client extends Client$1 implements IClient {
19017
18635
  [k: string]: string;
19018
18636
  };
19019
18637
  }>;
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
18638
  publicIntegrations: (props: {
19050
18639
  search?: string | undefined;
19051
18640
  name?: string | undefined;
@@ -19086,6 +18675,9 @@ declare class Client extends Client$1 implements IClient {
19086
18675
  actions?: string[];
19087
18676
  interfaces?: string[];
19088
18677
  };
18678
+ attributes?: {
18679
+ [k: string]: string;
18680
+ };
19089
18681
  }>;
19090
18682
  bots: (props: {
19091
18683
  tags?: {
@@ -19169,6 +18761,9 @@ declare class Client extends Client$1 implements IClient {
19169
18761
  handle: string | null;
19170
18762
  name: string;
19171
18763
  };
18764
+ attributes?: {
18765
+ [k: string]: string;
18766
+ };
19172
18767
  }>;
19173
18768
  interfaces: (props: {
19174
18769
  name?: string | undefined;
@@ -19346,7 +18941,7 @@ declare class Client extends Client$1 implements IClient {
19346
18941
  conversationId?: string | undefined;
19347
18942
  name?: string | undefined;
19348
18943
  parentWorkflowId?: string | undefined;
19349
- statuses?: ("pending" | "failed" | "in_progress" | "completed" | "paused" | "cancelled" | "listening" | "timedout")[] | undefined;
18944
+ statuses?: ("pending" | "failed" | "in_progress" | "listening" | "completed" | "paused" | "timedout" | "cancelled")[] | undefined;
19350
18945
  }) => AsyncCollection<{
19351
18946
  id: string;
19352
18947
  name: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/cognitive",
3
- "version": "0.3.14",
3
+ "version": "0.3.15",
4
4
  "description": "Wrapper around the Botpress Client to call LLMs",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.mjs",