@botpress/cognitive 0.1.30 → 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.30 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.30 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 11594ms
14
- DTS dist/index.d.ts 603.20 KB
13
+ DTS ⚡️ Build success in 14525ms
14
+ DTS dist/index.d.ts 616.19 KB
15
15
 
16
- > @botpress/cognitive@0.1.30 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
@@ -3,8 +3,11 @@ import { Unsubscribe } from 'nanoevents';
3
3
  type GenerateContentInput = {
4
4
  /** Model to use for content generation */
5
5
  model?: any;
6
- /** Reasoning effort level to use for models that support reasoning */
7
- reasoningEffort?: 'low' | 'medium' | 'high';
6
+ /**
7
+ * Reasoning effort level to use for models that support reasoning. Specifying "none" will indicate the LLM to not use reasoning (for models that support optional reasoning). A "dynamic" effort will indicate the provider to automatically determine the reasoning effort (if supported by the provider). If not provided the model will not use reasoning for models with optional reasoning or use the default reasoning effort specified by the provider for reasoning-only models.
8
+ * Note: A higher reasoning effort will incur in higher output token charges from the LLM provider.
9
+ */
10
+ reasoningEffort?: 'low' | 'medium' | 'high' | 'dynamic' | 'none';
8
11
  /** Optional system prompt to guide the model */
9
12
  systemPrompt?: string;
10
13
  /** Array of messages for the model to process */
@@ -1141,9 +1144,9 @@ interface UpsertFileRequestBody$1 {
1141
1144
  generateMasterSummary?: boolean;
1142
1145
  };
1143
1146
  /**
1144
- * Internal setting, cannot be set manually.
1147
+ * If not set, the default indexing stack will be used.
1145
1148
  */
1146
- stack?: "realtime-v1";
1149
+ stack?: "legacy" | "realtime-v1";
1147
1150
  vision?: {
1148
1151
  /**
1149
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.
@@ -3934,6 +3937,10 @@ interface GetOrCreateWorkflowRequestBody {
3934
3937
  * Event id must be specified if the workflow is created with the status in_progress
3935
3938
  */
3936
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[];
3937
3944
  }
3938
3945
  type GetOrCreateWorkflowInput = GetOrCreateWorkflowRequestBody & GetOrCreateWorkflowRequestHeaders & GetOrCreateWorkflowRequestQuery & GetOrCreateWorkflowRequestParams;
3939
3946
  interface GetOrCreateWorkflowResponse {
@@ -4263,9 +4270,14 @@ interface ListPublicIntegrationsResponse {
4263
4270
  */
4264
4271
  iconUrl: string;
4265
4272
  /**
4266
- * 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.
4267
4275
  */
4268
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";
4269
4281
  /**
4270
4282
  * Status of the integration version verification
4271
4283
  */
@@ -4696,9 +4708,14 @@ interface GetPublicIntegrationByIdResponse {
4696
4708
  */
4697
4709
  readmeUrl: string;
4698
4710
  /**
4699
- * 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.
4700
4713
  */
4701
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";
4702
4719
  /**
4703
4720
  * Status of the integration version verification
4704
4721
  */
@@ -5103,9 +5120,14 @@ interface GetPublicIntegrationResponse {
5103
5120
  */
5104
5121
  readmeUrl: string;
5105
5122
  /**
5106
- * 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.
5107
5125
  */
5108
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";
5109
5131
  /**
5110
5132
  * Status of the integration version verification
5111
5133
  */
@@ -6520,9 +6542,14 @@ interface CreateBotResponse {
6520
6542
  */
6521
6543
  iconUrl: string;
6522
6544
  /**
6523
- * 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.
6524
6547
  */
6525
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";
6526
6553
  /**
6527
6554
  * Status of the integration version verification
6528
6555
  */
@@ -6552,6 +6579,7 @@ interface CreateBotResponse {
6552
6579
  interfaces?: {
6553
6580
  [k: string]: {
6554
6581
  integrationId: string;
6582
+ interfaceId: string;
6555
6583
  };
6556
6584
  };
6557
6585
  /**
@@ -7048,10 +7076,6 @@ interface UpdateBotRequestBody {
7048
7076
  };
7049
7077
  } | null;
7050
7078
  };
7051
- /**
7052
- * 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
7053
- */
7054
- shouldMergePlugins?: boolean;
7055
7079
  subscriptions?: {
7056
7080
  events: {
7057
7081
  [k: string]: {} | null;
@@ -7073,6 +7097,10 @@ interface UpdateBotRequestBody {
7073
7097
  name: string;
7074
7098
  }[];
7075
7099
  layers?: string[];
7100
+ /**
7101
+ * UNUSED. Please ignore this field. It will be removed in the near future.
7102
+ */
7103
+ shouldMergePlugins?: boolean;
7076
7104
  }
7077
7105
  type UpdateBotInput = UpdateBotRequestBody & UpdateBotRequestHeaders & UpdateBotRequestQuery & UpdateBotRequestParams;
7078
7106
  interface UpdateBotResponse {
@@ -7145,9 +7173,14 @@ interface UpdateBotResponse {
7145
7173
  */
7146
7174
  iconUrl: string;
7147
7175
  /**
7148
- * 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.
7149
7178
  */
7150
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";
7151
7184
  /**
7152
7185
  * Status of the integration version verification
7153
7186
  */
@@ -7177,6 +7210,7 @@ interface UpdateBotResponse {
7177
7210
  interfaces?: {
7178
7211
  [k: string]: {
7179
7212
  integrationId: string;
7213
+ interfaceId: string;
7180
7214
  };
7181
7215
  };
7182
7216
  /**
@@ -7602,9 +7636,14 @@ interface GetBotResponse {
7602
7636
  */
7603
7637
  iconUrl: string;
7604
7638
  /**
7605
- * 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.
7606
7641
  */
7607
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";
7608
7647
  /**
7609
7648
  * Status of the integration version verification
7610
7649
  */
@@ -7634,6 +7673,7 @@ interface GetBotResponse {
7634
7673
  interfaces?: {
7635
7674
  [k: string]: {
7636
7675
  integrationId: string;
7676
+ interfaceId: string;
7637
7677
  };
7638
7678
  };
7639
7679
  /**
@@ -8406,6 +8446,49 @@ type DeleteBotApiKeyInput = DeleteBotApiKeyRequestBody & DeleteBotApiKeyRequestH
8406
8446
  interface DeleteBotApiKeyResponse {
8407
8447
  }
8408
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
+
8409
8492
  interface ListWorkspaceInvoicesRequestHeaders {
8410
8493
  }
8411
8494
  interface ListWorkspaceInvoicesRequestQuery {
@@ -8929,6 +9012,34 @@ interface GetAuditRecordsResponse {
8929
9012
  };
8930
9013
  }
8931
9014
 
9015
+ interface SetWorkspacePreferenceRequestHeaders {
9016
+ }
9017
+ interface SetWorkspacePreferenceRequestQuery {
9018
+ }
9019
+ interface SetWorkspacePreferenceRequestParams {
9020
+ key: string;
9021
+ }
9022
+ interface SetWorkspacePreferenceRequestBody {
9023
+ value?: any;
9024
+ }
9025
+ type SetWorkspacePreferenceInput = SetWorkspacePreferenceRequestBody & SetWorkspacePreferenceRequestHeaders & SetWorkspacePreferenceRequestQuery & SetWorkspacePreferenceRequestParams;
9026
+ interface SetWorkspacePreferenceResponse {
9027
+ }
9028
+
9029
+ interface GetWorkspacePreferenceRequestHeaders {
9030
+ }
9031
+ interface GetWorkspacePreferenceRequestQuery {
9032
+ }
9033
+ interface GetWorkspacePreferenceRequestParams {
9034
+ key: string;
9035
+ }
9036
+ interface GetWorkspacePreferenceRequestBody {
9037
+ }
9038
+ type GetWorkspacePreferenceInput = GetWorkspacePreferenceRequestBody & GetWorkspacePreferenceRequestHeaders & GetWorkspacePreferenceRequestQuery & GetWorkspacePreferenceRequestParams;
9039
+ interface GetWorkspacePreferenceResponse {
9040
+ value?: any;
9041
+ }
9042
+
8932
9043
  interface ListWorkspaceMembersRequestHeaders {
8933
9044
  }
8934
9045
  interface ListWorkspaceMembersRequestQuery {
@@ -9419,9 +9530,14 @@ interface CreateIntegrationRequestBody {
9419
9530
  */
9420
9531
  description?: string;
9421
9532
  /**
9422
- * 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.
9423
9535
  */
9424
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";
9425
9541
  layers?: string[];
9426
9542
  }
9427
9543
  type CreateIntegrationInput = CreateIntegrationRequestBody & CreateIntegrationRequestHeaders & CreateIntegrationRequestQuery & CreateIntegrationRequestParams;
@@ -9798,9 +9914,14 @@ interface CreateIntegrationResponse {
9798
9914
  */
9799
9915
  readmeUrl: string;
9800
9916
  /**
9801
- * 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.
9802
9919
  */
9803
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";
9804
9925
  /**
9805
9926
  * Status of the integration version verification
9806
9927
  */
@@ -10147,9 +10268,14 @@ interface ValidateIntegrationCreationRequestBody {
10147
10268
  */
10148
10269
  description?: string;
10149
10270
  /**
10150
- * 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.
10151
10273
  */
10152
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";
10153
10279
  layers?: string[];
10154
10280
  }
10155
10281
  type ValidateIntegrationCreationInput = ValidateIntegrationCreationRequestBody & ValidateIntegrationCreationRequestHeaders & ValidateIntegrationCreationRequestQuery & ValidateIntegrationCreationRequestParams;
@@ -10478,9 +10604,14 @@ interface UpdateIntegrationRequestBody {
10478
10604
  */
10479
10605
  url?: string | null;
10480
10606
  /**
10481
- * 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.
10482
10609
  */
10483
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";
10484
10615
  layers?: string[];
10485
10616
  }
10486
10617
  type UpdateIntegrationInput = UpdateIntegrationRequestBody & UpdateIntegrationRequestHeaders & UpdateIntegrationRequestQuery & UpdateIntegrationRequestParams;
@@ -10857,9 +10988,14 @@ interface UpdateIntegrationResponse {
10857
10988
  */
10858
10989
  readmeUrl: string;
10859
10990
  /**
10860
- * 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.
10861
10993
  */
10862
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";
10863
10999
  /**
10864
11000
  * Status of the integration version verification
10865
11001
  */
@@ -11193,9 +11329,14 @@ interface ValidateIntegrationUpdateRequestBody {
11193
11329
  */
11194
11330
  url?: string | null;
11195
11331
  /**
11196
- * 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.
11197
11334
  */
11198
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";
11199
11340
  layers?: string[];
11200
11341
  }
11201
11342
  type ValidateIntegrationUpdateInput = ValidateIntegrationUpdateRequestBody & ValidateIntegrationUpdateRequestHeaders & ValidateIntegrationUpdateRequestQuery & ValidateIntegrationUpdateRequestParams;
@@ -11259,9 +11400,14 @@ interface ListIntegrationsResponse {
11259
11400
  */
11260
11401
  iconUrl: string;
11261
11402
  /**
11262
- * 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.
11263
11405
  */
11264
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";
11265
11411
  /**
11266
11412
  * Status of the integration version verification
11267
11413
  */
@@ -11688,9 +11834,14 @@ interface GetIntegrationResponse {
11688
11834
  */
11689
11835
  readmeUrl: string;
11690
11836
  /**
11691
- * 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.
11692
11839
  */
11693
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";
11694
11845
  /**
11695
11846
  * Status of the integration version verification
11696
11847
  */
@@ -12115,9 +12266,14 @@ interface GetIntegrationByNameResponse {
12115
12266
  */
12116
12267
  readmeUrl: string;
12117
12268
  /**
12118
- * 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.
12119
12271
  */
12120
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";
12121
12277
  /**
12122
12278
  * Status of the integration version verification
12123
12279
  */
@@ -13302,18 +13458,6 @@ interface CreatePluginRequestBody {
13302
13458
  };
13303
13459
  };
13304
13460
  };
13305
- dependencies?: {
13306
- interfaces?: {
13307
- [k: string]: {
13308
- id: string;
13309
- };
13310
- };
13311
- integrations?: {
13312
- [k: string]: {
13313
- id: string;
13314
- };
13315
- };
13316
- };
13317
13461
  /**
13318
13462
  * Optional attributes
13319
13463
  */
@@ -13350,6 +13494,46 @@ interface CreatePluginRequestBody {
13350
13494
  * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
13351
13495
  */
13352
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
+ };
13353
13537
  }
13354
13538
  type CreatePluginInput = CreatePluginRequestBody & CreatePluginRequestHeaders & CreatePluginRequestQuery & CreatePluginRequestParams;
13355
13539
  interface CreatePluginResponse {
@@ -14326,18 +14510,6 @@ interface UpdatePluginRequestBody {
14326
14510
  } | null;
14327
14511
  };
14328
14512
  };
14329
- dependencies?: {
14330
- interfaces?: {
14331
- [k: string]: {
14332
- id: string;
14333
- } | null;
14334
- };
14335
- integrations?: {
14336
- [k: string]: {
14337
- id: string;
14338
- } | null;
14339
- };
14340
- };
14341
14513
  /**
14342
14514
  * Optional attributes. Set attributes to null to remove them
14343
14515
  */
@@ -14374,6 +14546,46 @@ interface UpdatePluginRequestBody {
14374
14546
  * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
14375
14547
  */
14376
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
+ };
14377
14589
  }
14378
14590
  type UpdatePluginInput = UpdatePluginRequestBody & UpdatePluginRequestHeaders & UpdatePluginRequestQuery & UpdatePluginRequestParams;
14379
14591
  interface UpdatePluginResponse {
@@ -14987,9 +15199,9 @@ interface UpsertFileRequestBody {
14987
15199
  generateMasterSummary?: boolean;
14988
15200
  };
14989
15201
  /**
14990
- * Internal setting, cannot be set manually.
15202
+ * If not set, the default indexing stack will be used.
14991
15203
  */
14992
- stack?: "realtime-v1";
15204
+ stack?: "legacy" | "realtime-v1";
14993
15205
  vision?: {
14994
15206
  /**
14995
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.
@@ -15602,6 +15814,7 @@ interface SearchFilesRequestQuery {
15602
15814
  limit?: number;
15603
15815
  consolidate?: boolean;
15604
15816
  includeBreadcrumb?: boolean;
15817
+ withContext?: boolean;
15605
15818
  }
15606
15819
  interface SearchFilesRequestParams {
15607
15820
  }
@@ -15671,8 +15884,14 @@ interface SearchFilesResponse {
15671
15884
  */
15672
15885
  updatedAt: string;
15673
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
+ */
15674
15890
  context?: {
15675
- id: string;
15891
+ /**
15892
+ * The ID of the vector that the context passage belongs to. Omitted for breadcrumbs.
15893
+ */
15894
+ id?: string;
15676
15895
  text: string;
15677
15896
  /**
15678
15897
  * Position of the context passage relative to the current passage. Negative for preceding passages, positive for subsequent, ommited for breadcrumbs.
@@ -15681,7 +15900,7 @@ interface SearchFilesResponse {
15681
15900
  /**
15682
15901
  * The type of context passage
15683
15902
  */
15684
- type: "preceding" | "subsequent" | "breadcrumb";
15903
+ type: "preceding" | "subsequent" | "current" | "breadcrumb";
15685
15904
  }[];
15686
15905
  }[];
15687
15906
  }
@@ -15821,6 +16040,9 @@ interface CreateKnowledgeBaseRequestBody {
15821
16040
  * Name of the knowledge base.
15822
16041
  */
15823
16042
  name: string;
16043
+ tags?: {
16044
+ [k: string]: string;
16045
+ };
15824
16046
  }
15825
16047
  type CreateKnowledgeBaseInput = CreateKnowledgeBaseRequestBody & CreateKnowledgeBaseRequestHeaders & CreateKnowledgeBaseRequestQuery & CreateKnowledgeBaseRequestParams;
15826
16048
  interface CreateKnowledgeBaseResponse {
@@ -15833,6 +16055,9 @@ interface CreateKnowledgeBaseResponse {
15833
16055
  * Name of the knowledge base.
15834
16056
  */
15835
16057
  name: string;
16058
+ tags: {
16059
+ [k: string]: string;
16060
+ };
15836
16061
  };
15837
16062
  }
15838
16063
 
@@ -15861,6 +16086,12 @@ interface UpdateKnowledgeBaseRequestBody {
15861
16086
  * New name of the knowledge base.
15862
16087
  */
15863
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
+ };
15864
16095
  }
15865
16096
  type UpdateKnowledgeBaseInput = UpdateKnowledgeBaseRequestBody & UpdateKnowledgeBaseRequestHeaders & UpdateKnowledgeBaseRequestQuery & UpdateKnowledgeBaseRequestParams;
15866
16097
  interface UpdateKnowledgeBaseResponse {
@@ -15873,6 +16104,9 @@ interface UpdateKnowledgeBaseResponse {
15873
16104
  * Name of the knowledge base.
15874
16105
  */
15875
16106
  name: string;
16107
+ tags: {
16108
+ [k: string]: string;
16109
+ };
15876
16110
  };
15877
16111
  }
15878
16112
 
@@ -15880,6 +16114,7 @@ interface ListKnowledgeBasesRequestHeaders {
15880
16114
  }
15881
16115
  interface ListKnowledgeBasesRequestQuery {
15882
16116
  nextToken?: string;
16117
+ tags?: any;
15883
16118
  }
15884
16119
  interface ListKnowledgeBasesRequestParams {
15885
16120
  }
@@ -15900,6 +16135,9 @@ interface ListKnowledgeBasesResponse {
15900
16135
  * Knowledge base creation timestamp in ISO 8601 format
15901
16136
  */
15902
16137
  createdAt: string;
16138
+ tags: {
16139
+ [k: string]: string;
16140
+ };
15903
16141
  }[];
15904
16142
  meta: {
15905
16143
  /**
@@ -17635,6 +17873,8 @@ declare class Client$1 {
17635
17873
  readonly listBotApiKeys: (input: ListBotApiKeysInput) => Promise<ListBotApiKeysResponse>;
17636
17874
  readonly createBotApiKey: (input: CreateBotApiKeyInput) => Promise<CreateBotApiKeyResponse>;
17637
17875
  readonly deleteBotApiKey: (input: DeleteBotApiKeyInput) => Promise<DeleteBotApiKeyResponse>;
17876
+ readonly getBotAllowlist: (input: GetBotAllowlistInput) => Promise<GetBotAllowlistResponse>;
17877
+ readonly updateBotAllowlist: (input: UpdateBotAllowlistInput) => Promise<UpdateBotAllowlistResponse>;
17638
17878
  readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput) => Promise<ListWorkspaceInvoicesResponse>;
17639
17879
  readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput) => Promise<GetUpcomingInvoiceResponse>;
17640
17880
  readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput) => Promise<ChargeWorkspaceUnpaidInvoicesResponse>;
@@ -17652,6 +17892,8 @@ declare class Client$1 {
17652
17892
  readonly listPublicWorkspaces: (input: ListPublicWorkspacesInput) => Promise<ListPublicWorkspacesResponse>;
17653
17893
  readonly deleteWorkspace: (input: DeleteWorkspaceInput) => Promise<DeleteWorkspaceResponse>;
17654
17894
  readonly getAuditRecords: (input: GetAuditRecordsInput) => Promise<GetAuditRecordsResponse>;
17895
+ readonly setWorkspacePreference: (input: SetWorkspacePreferenceInput) => Promise<SetWorkspacePreferenceResponse>;
17896
+ readonly getWorkspacePreference: (input: GetWorkspacePreferenceInput) => Promise<GetWorkspacePreferenceResponse>;
17655
17897
  readonly listWorkspaceMembers: (input: ListWorkspaceMembersInput) => Promise<ListWorkspaceMembersResponse>;
17656
17898
  readonly getWorkspaceMember: (input: GetWorkspaceMemberInput) => Promise<GetWorkspaceMemberResponse>;
17657
17899
  readonly deleteWorkspaceMember: (input: DeleteWorkspaceMemberInput) => Promise<DeleteWorkspaceMemberResponse>;
@@ -17877,6 +18119,7 @@ declare class Client extends Client$1 implements IClient {
17877
18119
  description: string;
17878
18120
  iconUrl: string;
17879
18121
  public: boolean;
18122
+ visibility: "public" | "private" | "unlisted";
17880
18123
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
17881
18124
  ownerWorkspace: {
17882
18125
  id: string;
@@ -17962,6 +18205,7 @@ declare class Client extends Client$1 implements IClient {
17962
18205
  description: string;
17963
18206
  iconUrl: string;
17964
18207
  public: boolean;
18208
+ visibility: "public" | "private" | "unlisted";
17965
18209
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
17966
18210
  matchedOn?: {
17967
18211
  name?: boolean;
@@ -18094,6 +18338,10 @@ declare class Client extends Client$1 implements IClient {
18094
18338
  sourceUrl?: string;
18095
18339
  };
18096
18340
  }>;
18341
+ fileTags: (props: {}) => AsyncCollection<string>;
18342
+ fileTagValues: (props: {
18343
+ tag: string;
18344
+ }) => AsyncCollection<string>;
18097
18345
  usageActivity: (props: {
18098
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";
18099
18347
  id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/cognitive",
3
- "version": "0.1.30",
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",
@@ -30,7 +30,7 @@
30
30
  "devDependencies": {
31
31
  "@botpress/client": "workspace:*",
32
32
  "@botpress/common": "workspace:*",
33
- "@bpinternal/zui": "^1.0.0",
33
+ "@bpinternal/zui": "^1.0.1",
34
34
  "@size-limit/file": "^11.1.6",
35
35
  "@types/axios": "^0.14.4",
36
36
  "@types/debug": "^4.1.12",