@botpress/cognitive 0.1.31 → 0.1.32

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.1.31 build /home/runner/work/botpress/botpress/packages/cognitive
2
+ > @botpress/cognitive@0.1.32 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.1.31 build:type /home/runner/work/botpress/botpress/packages/cognitive
6
+ > @botpress/cognitive@0.1.32 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 3669ms
14
- DTS dist/index.d.ts 604.87 KB
13
+ DTS ⚡️ Build success in 14525ms
14
+ DTS dist/index.d.ts 616.19 KB
15
15
 
16
- > @botpress/cognitive@0.1.31 build:neutral /home/runner/work/botpress/botpress/packages/cognitive
16
+ > @botpress/cognitive@0.1.32 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
@@ -1144,9 +1144,9 @@ interface UpsertFileRequestBody$1 {
1144
1144
  generateMasterSummary?: boolean;
1145
1145
  };
1146
1146
  /**
1147
- * Internal setting, cannot be set manually.
1147
+ * If not set, the default indexing stack will be used.
1148
1148
  */
1149
- stack?: "realtime-v1";
1149
+ stack?: "legacy" | "realtime-v1";
1150
1150
  vision?: {
1151
1151
  /**
1152
1152
  * (Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to transcribe each page of the PDF as standalone vectors and index them.
@@ -3937,6 +3937,10 @@ interface GetOrCreateWorkflowRequestBody {
3937
3937
  * Event id must be specified if the workflow is created with the status in_progress
3938
3938
  */
3939
3939
  eventId?: string;
3940
+ /**
3941
+ * Optional list of tag names to use for strict matching when looking up existing workflows. If provided, all specified tags must match exactly for a workflow to be considered a match. For example, with an existing workflow whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
3942
+ */
3943
+ discriminateByTags?: string[];
3940
3944
  }
3941
3945
  type GetOrCreateWorkflowInput = GetOrCreateWorkflowRequestBody & GetOrCreateWorkflowRequestHeaders & GetOrCreateWorkflowRequestQuery & GetOrCreateWorkflowRequestParams;
3942
3946
  interface GetOrCreateWorkflowResponse {
@@ -4266,9 +4270,14 @@ interface ListPublicIntegrationsResponse {
4266
4270
  */
4267
4271
  iconUrl: string;
4268
4272
  /**
4269
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
4273
+ * @deprecated
4274
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
4270
4275
  */
4271
4276
  public: boolean;
4277
+ /**
4278
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
4279
+ */
4280
+ visibility: "public" | "private" | "unlisted";
4272
4281
  /**
4273
4282
  * Status of the integration version verification
4274
4283
  */
@@ -4699,9 +4708,14 @@ interface GetPublicIntegrationByIdResponse {
4699
4708
  */
4700
4709
  readmeUrl: string;
4701
4710
  /**
4702
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
4711
+ * @deprecated
4712
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
4703
4713
  */
4704
4714
  public: boolean;
4715
+ /**
4716
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
4717
+ */
4718
+ visibility: "public" | "private" | "unlisted";
4705
4719
  /**
4706
4720
  * Status of the integration version verification
4707
4721
  */
@@ -5106,9 +5120,14 @@ interface GetPublicIntegrationResponse {
5106
5120
  */
5107
5121
  readmeUrl: string;
5108
5122
  /**
5109
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
5123
+ * @deprecated
5124
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
5110
5125
  */
5111
5126
  public: boolean;
5127
+ /**
5128
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
5129
+ */
5130
+ visibility: "public" | "private" | "unlisted";
5112
5131
  /**
5113
5132
  * Status of the integration version verification
5114
5133
  */
@@ -6523,9 +6542,14 @@ interface CreateBotResponse {
6523
6542
  */
6524
6543
  iconUrl: string;
6525
6544
  /**
6526
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
6545
+ * @deprecated
6546
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
6527
6547
  */
6528
6548
  public: boolean;
6549
+ /**
6550
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
6551
+ */
6552
+ visibility: "public" | "private" | "unlisted";
6529
6553
  /**
6530
6554
  * Status of the integration version verification
6531
6555
  */
@@ -6555,6 +6579,7 @@ interface CreateBotResponse {
6555
6579
  interfaces?: {
6556
6580
  [k: string]: {
6557
6581
  integrationId: string;
6582
+ interfaceId: string;
6558
6583
  };
6559
6584
  };
6560
6585
  /**
@@ -7051,10 +7076,6 @@ interface UpdateBotRequestBody {
7051
7076
  };
7052
7077
  } | null;
7053
7078
  };
7054
- /**
7055
- * If true, plugins will be merged into the bot and entity references will be resolved. If you are uncertain about this field, you should probably set it to true
7056
- */
7057
- shouldMergePlugins?: boolean;
7058
7079
  subscriptions?: {
7059
7080
  events: {
7060
7081
  [k: string]: {} | null;
@@ -7076,6 +7097,10 @@ interface UpdateBotRequestBody {
7076
7097
  name: string;
7077
7098
  }[];
7078
7099
  layers?: string[];
7100
+ /**
7101
+ * UNUSED. Please ignore this field. It will be removed in the near future.
7102
+ */
7103
+ shouldMergePlugins?: boolean;
7079
7104
  }
7080
7105
  type UpdateBotInput = UpdateBotRequestBody & UpdateBotRequestHeaders & UpdateBotRequestQuery & UpdateBotRequestParams;
7081
7106
  interface UpdateBotResponse {
@@ -7148,9 +7173,14 @@ interface UpdateBotResponse {
7148
7173
  */
7149
7174
  iconUrl: string;
7150
7175
  /**
7151
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
7176
+ * @deprecated
7177
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
7152
7178
  */
7153
7179
  public: boolean;
7180
+ /**
7181
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
7182
+ */
7183
+ visibility: "public" | "private" | "unlisted";
7154
7184
  /**
7155
7185
  * Status of the integration version verification
7156
7186
  */
@@ -7180,6 +7210,7 @@ interface UpdateBotResponse {
7180
7210
  interfaces?: {
7181
7211
  [k: string]: {
7182
7212
  integrationId: string;
7213
+ interfaceId: string;
7183
7214
  };
7184
7215
  };
7185
7216
  /**
@@ -7605,9 +7636,14 @@ interface GetBotResponse {
7605
7636
  */
7606
7637
  iconUrl: string;
7607
7638
  /**
7608
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
7639
+ * @deprecated
7640
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
7609
7641
  */
7610
7642
  public: boolean;
7643
+ /**
7644
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
7645
+ */
7646
+ visibility: "public" | "private" | "unlisted";
7611
7647
  /**
7612
7648
  * Status of the integration version verification
7613
7649
  */
@@ -7637,6 +7673,7 @@ interface GetBotResponse {
7637
7673
  interfaces?: {
7638
7674
  [k: string]: {
7639
7675
  integrationId: string;
7676
+ interfaceId: string;
7640
7677
  };
7641
7678
  };
7642
7679
  /**
@@ -8409,6 +8446,49 @@ type DeleteBotApiKeyInput = DeleteBotApiKeyRequestBody & DeleteBotApiKeyRequestH
8409
8446
  interface DeleteBotApiKeyResponse {
8410
8447
  }
8411
8448
 
8449
+ interface GetBotAllowlistRequestHeaders {
8450
+ }
8451
+ interface GetBotAllowlistRequestQuery {
8452
+ }
8453
+ interface GetBotAllowlistRequestParams {
8454
+ botId: string;
8455
+ }
8456
+ interface GetBotAllowlistRequestBody {
8457
+ }
8458
+ type GetBotAllowlistInput = GetBotAllowlistRequestBody & GetBotAllowlistRequestHeaders & GetBotAllowlistRequestQuery & GetBotAllowlistRequestParams;
8459
+ interface GetBotAllowlistResponse {
8460
+ /**
8461
+ * Allowlist setting of the bot
8462
+ */
8463
+ setting: "ALL_WORKSPACE_USERS" | "SELECTED_USERS";
8464
+ users: {
8465
+ id: string;
8466
+ }[];
8467
+ }
8468
+
8469
+ interface UpdateBotAllowlistRequestHeaders {
8470
+ }
8471
+ interface UpdateBotAllowlistRequestQuery {
8472
+ }
8473
+ interface UpdateBotAllowlistRequestParams {
8474
+ botId: string;
8475
+ }
8476
+ interface UpdateBotAllowlistRequestBody {
8477
+ /**
8478
+ * Allowlist setting of the bot
8479
+ */
8480
+ setting?: "ALL_WORKSPACE_USERS" | "SELECTED_USERS";
8481
+ users?: {
8482
+ /**
8483
+ * If `true`, the user should be added to the allowlist. If `false`, the user should be removed from the allowlist. This performs a partial update, so any existing users not included here will be kept in the allowlist
8484
+ */
8485
+ [k: string]: boolean;
8486
+ };
8487
+ }
8488
+ type UpdateBotAllowlistInput = UpdateBotAllowlistRequestBody & UpdateBotAllowlistRequestHeaders & UpdateBotAllowlistRequestQuery & UpdateBotAllowlistRequestParams;
8489
+ interface UpdateBotAllowlistResponse {
8490
+ }
8491
+
8412
8492
  interface ListWorkspaceInvoicesRequestHeaders {
8413
8493
  }
8414
8494
  interface ListWorkspaceInvoicesRequestQuery {
@@ -9450,9 +9530,14 @@ interface CreateIntegrationRequestBody {
9450
9530
  */
9451
9531
  description?: string;
9452
9532
  /**
9453
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
9533
+ * @deprecated
9534
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
9454
9535
  */
9455
9536
  public?: boolean;
9537
+ /**
9538
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
9539
+ */
9540
+ visibility?: "public" | "private" | "unlisted";
9456
9541
  layers?: string[];
9457
9542
  }
9458
9543
  type CreateIntegrationInput = CreateIntegrationRequestBody & CreateIntegrationRequestHeaders & CreateIntegrationRequestQuery & CreateIntegrationRequestParams;
@@ -9829,9 +9914,14 @@ interface CreateIntegrationResponse {
9829
9914
  */
9830
9915
  readmeUrl: string;
9831
9916
  /**
9832
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
9917
+ * @deprecated
9918
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
9833
9919
  */
9834
9920
  public: boolean;
9921
+ /**
9922
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
9923
+ */
9924
+ visibility: "public" | "private" | "unlisted";
9835
9925
  /**
9836
9926
  * Status of the integration version verification
9837
9927
  */
@@ -10178,9 +10268,14 @@ interface ValidateIntegrationCreationRequestBody {
10178
10268
  */
10179
10269
  description?: string;
10180
10270
  /**
10181
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
10271
+ * @deprecated
10272
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
10182
10273
  */
10183
10274
  public?: boolean;
10275
+ /**
10276
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
10277
+ */
10278
+ visibility?: "public" | "private" | "unlisted";
10184
10279
  layers?: string[];
10185
10280
  }
10186
10281
  type ValidateIntegrationCreationInput = ValidateIntegrationCreationRequestBody & ValidateIntegrationCreationRequestHeaders & ValidateIntegrationCreationRequestQuery & ValidateIntegrationCreationRequestParams;
@@ -10509,9 +10604,14 @@ interface UpdateIntegrationRequestBody {
10509
10604
  */
10510
10605
  url?: string | null;
10511
10606
  /**
10512
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
10607
+ * @deprecated
10608
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
10513
10609
  */
10514
10610
  public?: boolean;
10611
+ /**
10612
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
10613
+ */
10614
+ visibility?: "public" | "private" | "unlisted";
10515
10615
  layers?: string[];
10516
10616
  }
10517
10617
  type UpdateIntegrationInput = UpdateIntegrationRequestBody & UpdateIntegrationRequestHeaders & UpdateIntegrationRequestQuery & UpdateIntegrationRequestParams;
@@ -10888,9 +10988,14 @@ interface UpdateIntegrationResponse {
10888
10988
  */
10889
10989
  readmeUrl: string;
10890
10990
  /**
10891
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
10991
+ * @deprecated
10992
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
10892
10993
  */
10893
10994
  public: boolean;
10995
+ /**
10996
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
10997
+ */
10998
+ visibility: "public" | "private" | "unlisted";
10894
10999
  /**
10895
11000
  * Status of the integration version verification
10896
11001
  */
@@ -11224,9 +11329,14 @@ interface ValidateIntegrationUpdateRequestBody {
11224
11329
  */
11225
11330
  url?: string | null;
11226
11331
  /**
11227
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
11332
+ * @deprecated
11333
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
11228
11334
  */
11229
11335
  public?: boolean;
11336
+ /**
11337
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
11338
+ */
11339
+ visibility?: "public" | "private" | "unlisted";
11230
11340
  layers?: string[];
11231
11341
  }
11232
11342
  type ValidateIntegrationUpdateInput = ValidateIntegrationUpdateRequestBody & ValidateIntegrationUpdateRequestHeaders & ValidateIntegrationUpdateRequestQuery & ValidateIntegrationUpdateRequestParams;
@@ -11290,9 +11400,14 @@ interface ListIntegrationsResponse {
11290
11400
  */
11291
11401
  iconUrl: string;
11292
11402
  /**
11293
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
11403
+ * @deprecated
11404
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
11294
11405
  */
11295
11406
  public: boolean;
11407
+ /**
11408
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
11409
+ */
11410
+ visibility: "public" | "private" | "unlisted";
11296
11411
  /**
11297
11412
  * Status of the integration version verification
11298
11413
  */
@@ -11719,9 +11834,14 @@ interface GetIntegrationResponse {
11719
11834
  */
11720
11835
  readmeUrl: string;
11721
11836
  /**
11722
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
11837
+ * @deprecated
11838
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
11723
11839
  */
11724
11840
  public: boolean;
11841
+ /**
11842
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
11843
+ */
11844
+ visibility: "public" | "private" | "unlisted";
11725
11845
  /**
11726
11846
  * Status of the integration version verification
11727
11847
  */
@@ -12146,9 +12266,14 @@ interface GetIntegrationByNameResponse {
12146
12266
  */
12147
12267
  readmeUrl: string;
12148
12268
  /**
12149
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
12269
+ * @deprecated
12270
+ * [DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
12150
12271
  */
12151
12272
  public: boolean;
12273
+ /**
12274
+ * The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
12275
+ */
12276
+ visibility: "public" | "private" | "unlisted";
12152
12277
  /**
12153
12278
  * Status of the integration version verification
12154
12279
  */
@@ -13333,18 +13458,6 @@ interface CreatePluginRequestBody {
13333
13458
  };
13334
13459
  };
13335
13460
  };
13336
- dependencies?: {
13337
- interfaces?: {
13338
- [k: string]: {
13339
- id: string;
13340
- };
13341
- };
13342
- integrations?: {
13343
- [k: string]: {
13344
- id: string;
13345
- };
13346
- };
13347
- };
13348
13461
  /**
13349
13462
  * Optional attributes
13350
13463
  */
@@ -13381,6 +13494,46 @@ interface CreatePluginRequestBody {
13381
13494
  * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
13382
13495
  */
13383
13496
  public?: boolean;
13497
+ dependencies?: {
13498
+ /**
13499
+ * Mapping of interface aliases to interface references
13500
+ */
13501
+ interfaces?: {
13502
+ [k: string]: {
13503
+ /**
13504
+ * Id of the interface. If provided, "name" and "version" are ignored
13505
+ */
13506
+ id?: string;
13507
+ /**
13508
+ * Name of the interface
13509
+ */
13510
+ name?: string;
13511
+ /**
13512
+ * Version of the interface. Accepts semver versions and version ranges
13513
+ */
13514
+ version?: string;
13515
+ };
13516
+ };
13517
+ /**
13518
+ * Mapping of integration aliases to integration references
13519
+ */
13520
+ integrations?: {
13521
+ [k: string]: {
13522
+ /**
13523
+ * Id of the integration. If provided, "name" and "version" are ignored
13524
+ */
13525
+ id?: string;
13526
+ /**
13527
+ * Name of the integration
13528
+ */
13529
+ name?: string;
13530
+ /**
13531
+ * Version of the integration. Accepts semver versions and version ranges
13532
+ */
13533
+ version?: string;
13534
+ };
13535
+ };
13536
+ };
13384
13537
  }
13385
13538
  type CreatePluginInput = CreatePluginRequestBody & CreatePluginRequestHeaders & CreatePluginRequestQuery & CreatePluginRequestParams;
13386
13539
  interface CreatePluginResponse {
@@ -14357,18 +14510,6 @@ interface UpdatePluginRequestBody {
14357
14510
  } | null;
14358
14511
  };
14359
14512
  };
14360
- dependencies?: {
14361
- interfaces?: {
14362
- [k: string]: {
14363
- id: string;
14364
- } | null;
14365
- };
14366
- integrations?: {
14367
- [k: string]: {
14368
- id: string;
14369
- } | null;
14370
- };
14371
- };
14372
14513
  /**
14373
14514
  * Optional attributes. Set attributes to null to remove them
14374
14515
  */
@@ -14405,6 +14546,46 @@ interface UpdatePluginRequestBody {
14405
14546
  * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
14406
14547
  */
14407
14548
  public?: boolean;
14549
+ dependencies?: {
14550
+ /**
14551
+ * Mapping of interface aliases to interface references
14552
+ */
14553
+ interfaces?: {
14554
+ [k: string]: {
14555
+ /**
14556
+ * Id of the interface. If provided, "name" and "version" are ignored
14557
+ */
14558
+ id?: string;
14559
+ /**
14560
+ * Name of the interface
14561
+ */
14562
+ name?: string;
14563
+ /**
14564
+ * Version of the interface. Accepts semver versions and version ranges
14565
+ */
14566
+ version?: string;
14567
+ } | null;
14568
+ };
14569
+ /**
14570
+ * Mapping of integration aliases to integration references
14571
+ */
14572
+ integrations?: {
14573
+ [k: string]: {
14574
+ /**
14575
+ * Id of the integration. If provided, "name" and "version" are ignored
14576
+ */
14577
+ id?: string;
14578
+ /**
14579
+ * Name of the integration
14580
+ */
14581
+ name?: string;
14582
+ /**
14583
+ * Version of the integration. Accepts semver versions and version ranges
14584
+ */
14585
+ version?: string;
14586
+ } | null;
14587
+ };
14588
+ };
14408
14589
  }
14409
14590
  type UpdatePluginInput = UpdatePluginRequestBody & UpdatePluginRequestHeaders & UpdatePluginRequestQuery & UpdatePluginRequestParams;
14410
14591
  interface UpdatePluginResponse {
@@ -15018,9 +15199,9 @@ interface UpsertFileRequestBody {
15018
15199
  generateMasterSummary?: boolean;
15019
15200
  };
15020
15201
  /**
15021
- * Internal setting, cannot be set manually.
15202
+ * If not set, the default indexing stack will be used.
15022
15203
  */
15023
- stack?: "realtime-v1";
15204
+ stack?: "legacy" | "realtime-v1";
15024
15205
  vision?: {
15025
15206
  /**
15026
15207
  * (Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to transcribe each page of the PDF as standalone vectors and index them.
@@ -15633,6 +15814,7 @@ interface SearchFilesRequestQuery {
15633
15814
  limit?: number;
15634
15815
  consolidate?: boolean;
15635
15816
  includeBreadcrumb?: boolean;
15817
+ withContext?: boolean;
15636
15818
  }
15637
15819
  interface SearchFilesRequestParams {
15638
15820
  }
@@ -15702,8 +15884,14 @@ interface SearchFilesResponse {
15702
15884
  */
15703
15885
  updatedAt: string;
15704
15886
  };
15887
+ /**
15888
+ * Surrounding passages including the current passage, based on the requested `contextDepth`. Only returned if the `withContext` parameter is set to `true`. Not supported when using the `consolidate` option.
15889
+ */
15705
15890
  context?: {
15706
- id: string;
15891
+ /**
15892
+ * The ID of the vector that the context passage belongs to. Omitted for breadcrumbs.
15893
+ */
15894
+ id?: string;
15707
15895
  text: string;
15708
15896
  /**
15709
15897
  * Position of the context passage relative to the current passage. Negative for preceding passages, positive for subsequent, ommited for breadcrumbs.
@@ -15712,7 +15900,7 @@ interface SearchFilesResponse {
15712
15900
  /**
15713
15901
  * The type of context passage
15714
15902
  */
15715
- type: "preceding" | "subsequent" | "breadcrumb";
15903
+ type: "preceding" | "subsequent" | "current" | "breadcrumb";
15716
15904
  }[];
15717
15905
  }[];
15718
15906
  }
@@ -15852,6 +16040,9 @@ interface CreateKnowledgeBaseRequestBody {
15852
16040
  * Name of the knowledge base.
15853
16041
  */
15854
16042
  name: string;
16043
+ tags?: {
16044
+ [k: string]: string;
16045
+ };
15855
16046
  }
15856
16047
  type CreateKnowledgeBaseInput = CreateKnowledgeBaseRequestBody & CreateKnowledgeBaseRequestHeaders & CreateKnowledgeBaseRequestQuery & CreateKnowledgeBaseRequestParams;
15857
16048
  interface CreateKnowledgeBaseResponse {
@@ -15864,6 +16055,9 @@ interface CreateKnowledgeBaseResponse {
15864
16055
  * Name of the knowledge base.
15865
16056
  */
15866
16057
  name: string;
16058
+ tags: {
16059
+ [k: string]: string;
16060
+ };
15867
16061
  };
15868
16062
  }
15869
16063
 
@@ -15892,6 +16086,12 @@ interface UpdateKnowledgeBaseRequestBody {
15892
16086
  * New name of the knowledge base.
15893
16087
  */
15894
16088
  name: string;
16089
+ /**
16090
+ * The knowledge base tags to update as an object of key-value pairs with `string` (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`.
16091
+ */
16092
+ tags?: {
16093
+ [k: string]: string | null;
16094
+ };
15895
16095
  }
15896
16096
  type UpdateKnowledgeBaseInput = UpdateKnowledgeBaseRequestBody & UpdateKnowledgeBaseRequestHeaders & UpdateKnowledgeBaseRequestQuery & UpdateKnowledgeBaseRequestParams;
15897
16097
  interface UpdateKnowledgeBaseResponse {
@@ -15904,6 +16104,9 @@ interface UpdateKnowledgeBaseResponse {
15904
16104
  * Name of the knowledge base.
15905
16105
  */
15906
16106
  name: string;
16107
+ tags: {
16108
+ [k: string]: string;
16109
+ };
15907
16110
  };
15908
16111
  }
15909
16112
 
@@ -15911,6 +16114,7 @@ interface ListKnowledgeBasesRequestHeaders {
15911
16114
  }
15912
16115
  interface ListKnowledgeBasesRequestQuery {
15913
16116
  nextToken?: string;
16117
+ tags?: any;
15914
16118
  }
15915
16119
  interface ListKnowledgeBasesRequestParams {
15916
16120
  }
@@ -15931,6 +16135,9 @@ interface ListKnowledgeBasesResponse {
15931
16135
  * Knowledge base creation timestamp in ISO 8601 format
15932
16136
  */
15933
16137
  createdAt: string;
16138
+ tags: {
16139
+ [k: string]: string;
16140
+ };
15934
16141
  }[];
15935
16142
  meta: {
15936
16143
  /**
@@ -17666,6 +17873,8 @@ declare class Client$1 {
17666
17873
  readonly listBotApiKeys: (input: ListBotApiKeysInput) => Promise<ListBotApiKeysResponse>;
17667
17874
  readonly createBotApiKey: (input: CreateBotApiKeyInput) => Promise<CreateBotApiKeyResponse>;
17668
17875
  readonly deleteBotApiKey: (input: DeleteBotApiKeyInput) => Promise<DeleteBotApiKeyResponse>;
17876
+ readonly getBotAllowlist: (input: GetBotAllowlistInput) => Promise<GetBotAllowlistResponse>;
17877
+ readonly updateBotAllowlist: (input: UpdateBotAllowlistInput) => Promise<UpdateBotAllowlistResponse>;
17669
17878
  readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput) => Promise<ListWorkspaceInvoicesResponse>;
17670
17879
  readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput) => Promise<GetUpcomingInvoiceResponse>;
17671
17880
  readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput) => Promise<ChargeWorkspaceUnpaidInvoicesResponse>;
@@ -17910,6 +18119,7 @@ declare class Client extends Client$1 implements IClient {
17910
18119
  description: string;
17911
18120
  iconUrl: string;
17912
18121
  public: boolean;
18122
+ visibility: "public" | "private" | "unlisted";
17913
18123
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
17914
18124
  ownerWorkspace: {
17915
18125
  id: string;
@@ -17995,6 +18205,7 @@ declare class Client extends Client$1 implements IClient {
17995
18205
  description: string;
17996
18206
  iconUrl: string;
17997
18207
  public: boolean;
18208
+ visibility: "public" | "private" | "unlisted";
17998
18209
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
17999
18210
  matchedOn?: {
18000
18211
  name?: boolean;
@@ -18127,6 +18338,10 @@ declare class Client extends Client$1 implements IClient {
18127
18338
  sourceUrl?: string;
18128
18339
  };
18129
18340
  }>;
18341
+ fileTags: (props: {}) => AsyncCollection<string>;
18342
+ fileTagValues: (props: {
18343
+ tag: string;
18344
+ }) => AsyncCollection<string>;
18130
18345
  usageActivity: (props: {
18131
18346
  type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive";
18132
18347
  id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/cognitive",
3
- "version": "0.1.31",
3
+ "version": "0.1.32",
4
4
  "description": "Wrapper around the Botpress Client to call LLMs",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.mjs",