@botpress/client 0.12.2 → 0.12.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bundle.cjs +10 -10
- package/dist/bundle.cjs.map +3 -3
- package/dist/gen/api.d.ts +124 -260
- package/dist/gen/base.d.ts +1 -1
- package/dist/gen/client.d.ts +2 -2
- package/dist/gen/common.d.ts +1 -1
- package/dist/gen/configuration.d.ts +1 -1
- package/dist/gen/errors.d.ts +9 -2
- package/dist/gen/index.d.ts +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +3 -3
- package/dist/index.d.ts +35 -2
- package/dist/index.mjs +1 -1
- package/package.json +2 -2
package/dist/gen/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Botpress API
|
|
3
3
|
* API for Botpress Cloud
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.20.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -418,6 +418,12 @@ export interface BotIntegrationsValue {
|
|
|
418
418
|
* @memberof BotIntegrationsValue
|
|
419
419
|
*/
|
|
420
420
|
'iconUrl': string;
|
|
421
|
+
/**
|
|
422
|
+
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
423
|
+
* @type {boolean}
|
|
424
|
+
* @memberof BotIntegrationsValue
|
|
425
|
+
*/
|
|
426
|
+
'public': boolean;
|
|
421
427
|
}
|
|
422
428
|
export declare const BotIntegrationsValueStatusEnum: {
|
|
423
429
|
readonly RegistrationPending: "registration_pending";
|
|
@@ -1408,13 +1414,19 @@ export interface CreateFileResponseFile {
|
|
|
1408
1414
|
* @type {string}
|
|
1409
1415
|
* @memberof CreateFileResponseFile
|
|
1410
1416
|
*/
|
|
1411
|
-
'
|
|
1417
|
+
'name': string;
|
|
1412
1418
|
/**
|
|
1413
1419
|
*
|
|
1414
1420
|
* @type {number}
|
|
1415
1421
|
* @memberof CreateFileResponseFile
|
|
1416
1422
|
*/
|
|
1417
|
-
'
|
|
1423
|
+
'size': number | null;
|
|
1424
|
+
/**
|
|
1425
|
+
*
|
|
1426
|
+
* @type {string}
|
|
1427
|
+
* @memberof CreateFileResponseFile
|
|
1428
|
+
*/
|
|
1429
|
+
'contentType': string;
|
|
1418
1430
|
/**
|
|
1419
1431
|
* Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value.
|
|
1420
1432
|
* @type {{ [key: string]: string; }}
|
|
@@ -1587,6 +1599,12 @@ export interface CreateIntegrationBody {
|
|
|
1587
1599
|
* @memberof CreateIntegrationBody
|
|
1588
1600
|
*/
|
|
1589
1601
|
'description'?: string;
|
|
1602
|
+
/**
|
|
1603
|
+
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
1604
|
+
* @type {boolean}
|
|
1605
|
+
* @memberof CreateIntegrationBody
|
|
1606
|
+
*/
|
|
1607
|
+
'public'?: boolean;
|
|
1590
1608
|
}
|
|
1591
1609
|
/**
|
|
1592
1610
|
*
|
|
@@ -3296,6 +3314,12 @@ export interface GetPublicIntegrationByIdResponseIntegration {
|
|
|
3296
3314
|
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3297
3315
|
*/
|
|
3298
3316
|
'readmeUrl': string;
|
|
3317
|
+
/**
|
|
3318
|
+
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
3319
|
+
* @type {boolean}
|
|
3320
|
+
* @memberof GetPublicIntegrationByIdResponseIntegration
|
|
3321
|
+
*/
|
|
3322
|
+
'public': boolean;
|
|
3299
3323
|
/**
|
|
3300
3324
|
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
3301
3325
|
* @type {Array<string>}
|
|
@@ -4305,6 +4329,12 @@ export interface Integration {
|
|
|
4305
4329
|
* @memberof Integration
|
|
4306
4330
|
*/
|
|
4307
4331
|
'readmeUrl': string;
|
|
4332
|
+
/**
|
|
4333
|
+
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
4334
|
+
* @type {boolean}
|
|
4335
|
+
* @memberof Integration
|
|
4336
|
+
*/
|
|
4337
|
+
'public': boolean;
|
|
4308
4338
|
/**
|
|
4309
4339
|
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
4310
4340
|
* @type {Array<string>}
|
|
@@ -4794,13 +4824,27 @@ export interface ListFilesResponseFilesInner {
|
|
|
4794
4824
|
* @type {string}
|
|
4795
4825
|
* @memberof ListFilesResponseFilesInner
|
|
4796
4826
|
*/
|
|
4797
|
-
'
|
|
4827
|
+
'name': string;
|
|
4798
4828
|
/**
|
|
4799
4829
|
*
|
|
4800
4830
|
* @type {number}
|
|
4801
4831
|
* @memberof ListFilesResponseFilesInner
|
|
4802
4832
|
*/
|
|
4803
|
-
'
|
|
4833
|
+
'size': number | null;
|
|
4834
|
+
/**
|
|
4835
|
+
*
|
|
4836
|
+
* @type {string}
|
|
4837
|
+
* @memberof ListFilesResponseFilesInner
|
|
4838
|
+
*/
|
|
4839
|
+
'contentType': string;
|
|
4840
|
+
/**
|
|
4841
|
+
* Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value.
|
|
4842
|
+
* @type {{ [key: string]: string; }}
|
|
4843
|
+
* @memberof ListFilesResponseFilesInner
|
|
4844
|
+
*/
|
|
4845
|
+
'tags': {
|
|
4846
|
+
[key: string]: string;
|
|
4847
|
+
};
|
|
4804
4848
|
/**
|
|
4805
4849
|
*
|
|
4806
4850
|
* @type {string}
|
|
@@ -4912,6 +4956,12 @@ export interface ListIntegrationsResponseIntegrationsInner {
|
|
|
4912
4956
|
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
4913
4957
|
*/
|
|
4914
4958
|
'iconUrl': string;
|
|
4959
|
+
/**
|
|
4960
|
+
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
4961
|
+
* @type {boolean}
|
|
4962
|
+
* @memberof ListIntegrationsResponseIntegrationsInner
|
|
4963
|
+
*/
|
|
4964
|
+
'public': boolean;
|
|
4915
4965
|
}
|
|
4916
4966
|
/**
|
|
4917
4967
|
*
|
|
@@ -5062,6 +5112,12 @@ export interface ListPublicIntegrationsResponseIntegrationsInner {
|
|
|
5062
5112
|
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
5063
5113
|
*/
|
|
5064
5114
|
'iconUrl': string;
|
|
5115
|
+
/**
|
|
5116
|
+
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
5117
|
+
* @type {boolean}
|
|
5118
|
+
* @memberof ListPublicIntegrationsResponseIntegrationsInner
|
|
5119
|
+
*/
|
|
5120
|
+
'public': boolean;
|
|
5065
5121
|
/**
|
|
5066
5122
|
*
|
|
5067
5123
|
* @type {ListPublicIntegrationsResponseIntegrationsInnerOwnerWorkspace}
|
|
@@ -5494,13 +5550,19 @@ export interface ModelFile {
|
|
|
5494
5550
|
* @type {string}
|
|
5495
5551
|
* @memberof ModelFile
|
|
5496
5552
|
*/
|
|
5497
|
-
'
|
|
5553
|
+
'name': string;
|
|
5498
5554
|
/**
|
|
5499
5555
|
*
|
|
5500
5556
|
* @type {number}
|
|
5501
5557
|
* @memberof ModelFile
|
|
5502
5558
|
*/
|
|
5503
|
-
'
|
|
5559
|
+
'size': number | null;
|
|
5560
|
+
/**
|
|
5561
|
+
*
|
|
5562
|
+
* @type {string}
|
|
5563
|
+
* @memberof ModelFile
|
|
5564
|
+
*/
|
|
5565
|
+
'contentType': string;
|
|
5504
5566
|
/**
|
|
5505
5567
|
* Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value.
|
|
5506
5568
|
* @type {{ [key: string]: string; }}
|
|
@@ -6735,6 +6797,12 @@ export interface UpdateIntegrationBody {
|
|
|
6735
6797
|
* @memberof UpdateIntegrationBody
|
|
6736
6798
|
*/
|
|
6737
6799
|
'url'?: string;
|
|
6800
|
+
/**
|
|
6801
|
+
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
6802
|
+
* @type {boolean}
|
|
6803
|
+
* @memberof UpdateIntegrationBody
|
|
6804
|
+
*/
|
|
6805
|
+
'public'?: boolean;
|
|
6738
6806
|
}
|
|
6739
6807
|
/**
|
|
6740
6808
|
*
|
|
@@ -8010,21 +8078,17 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8010
8078
|
createEvent: (createEventBody?: CreateEventBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8011
8079
|
/**
|
|
8012
8080
|
* Creates a file.
|
|
8013
|
-
* @param {string}
|
|
8014
|
-
* @param {string} xBotId Bot id
|
|
8081
|
+
* @param {string} xName File name
|
|
8015
8082
|
* @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
|
|
8016
|
-
* @param {string} [xAccessPolicies] File access policies
|
|
8083
|
+
* @param {string} [xAccessPolicies] File access policies, comma-separated. Add \"public_content\" to allow public access to the file content. Add \"integrations\" to allo read, search and list operations for any integration installed in the bot.
|
|
8017
8084
|
* @param {string} [xIndex] Set to a value of \"true\" to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
|
|
8018
|
-
* @param {string} [contentType] File content type
|
|
8085
|
+
* @param {string} [contentType] File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \"application/octet-stream\".
|
|
8019
8086
|
* @param {string} [contentLength] File content length
|
|
8020
|
-
* @param {string} [xIntegrationId] Integration id
|
|
8021
|
-
* @param {string} [xUserId] User id
|
|
8022
|
-
* @param {string} [xUserRole] User role
|
|
8023
8087
|
* @param {CreateFileBody} [createFileBody] The file to upload.
|
|
8024
8088
|
* @param {*} [options] Override http request option.
|
|
8025
8089
|
* @throws {RequiredError}
|
|
8026
8090
|
*/
|
|
8027
|
-
createFile: (
|
|
8091
|
+
createFile: (xName: string, xTags?: string, xAccessPolicies?: string, xIndex?: string, contentType?: string, contentLength?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8028
8092
|
/**
|
|
8029
8093
|
* Create integration
|
|
8030
8094
|
* @param {CreateIntegrationBody} [createIntegrationBody] Integration
|
|
@@ -8114,14 +8178,10 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8114
8178
|
/**
|
|
8115
8179
|
* Deletes a file.
|
|
8116
8180
|
* @param {string} id File ID
|
|
8117
|
-
* @param {string} xBotId Bot id
|
|
8118
|
-
* @param {string} [xIntegrationId] Integration id
|
|
8119
|
-
* @param {string} [xUserId] User id
|
|
8120
|
-
* @param {string} [xUserRole] User role
|
|
8121
8181
|
* @param {*} [options] Override http request option.
|
|
8122
8182
|
* @throws {RequiredError}
|
|
8123
8183
|
*/
|
|
8124
|
-
deleteFile: (id: string,
|
|
8184
|
+
deleteFile: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8125
8185
|
/**
|
|
8126
8186
|
* Delete integration
|
|
8127
8187
|
* @param {string} id Integration ID
|
|
@@ -8272,25 +8332,17 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8272
8332
|
/**
|
|
8273
8333
|
* Returns a presigned URL to download the file content.
|
|
8274
8334
|
* @param {string} id File ID
|
|
8275
|
-
* @param {string} xBotId Bot id
|
|
8276
|
-
* @param {string} [xIntegrationId] Integration id
|
|
8277
|
-
* @param {string} [xUserId] User id
|
|
8278
|
-
* @param {string} [xUserRole] User role
|
|
8279
8335
|
* @param {*} [options] Override http request option.
|
|
8280
8336
|
* @throws {RequiredError}
|
|
8281
8337
|
*/
|
|
8282
|
-
getFileContent: (id: string,
|
|
8338
|
+
getFileContent: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8283
8339
|
/**
|
|
8284
8340
|
* Get file metadata
|
|
8285
8341
|
* @param {string} id File ID
|
|
8286
|
-
* @param {string} xBotId Bot id
|
|
8287
|
-
* @param {string} [xIntegrationId] Integration id
|
|
8288
|
-
* @param {string} [xUserId] User id
|
|
8289
|
-
* @param {string} [xUserRole] User role
|
|
8290
8342
|
* @param {*} [options] Override http request option.
|
|
8291
8343
|
* @throws {RequiredError}
|
|
8292
8344
|
*/
|
|
8293
|
-
getFileMetadata: (id: string,
|
|
8345
|
+
getFileMetadata: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8294
8346
|
/**
|
|
8295
8347
|
* Get integration
|
|
8296
8348
|
* @param {string} id Integration ID
|
|
@@ -8525,17 +8577,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8525
8577
|
listEvents: (nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8526
8578
|
/**
|
|
8527
8579
|
* List files for bot
|
|
8528
|
-
* @param {string} xBotId Bot id
|
|
8529
8580
|
* @param {string} botId Bot ID
|
|
8530
8581
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
8531
|
-
* @param {string} [
|
|
8532
|
-
* @param {string} [xUserId] User id
|
|
8533
|
-
* @param {string} [xUserRole] User role
|
|
8534
|
-
* @param {string} [tags] Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
8582
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
8535
8583
|
* @param {*} [options] Override http request option.
|
|
8536
8584
|
* @throws {RequiredError}
|
|
8537
8585
|
*/
|
|
8538
|
-
listFiles: (
|
|
8586
|
+
listFiles: (botId: string, nextToken?: string, tags?: {
|
|
8587
|
+
[key: string]: string;
|
|
8588
|
+
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8539
8589
|
/**
|
|
8540
8590
|
* List integrations
|
|
8541
8591
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -8696,18 +8746,17 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8696
8746
|
runVrl: (runVrlBody?: RunVrlBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8697
8747
|
/**
|
|
8698
8748
|
* Search files
|
|
8699
|
-
* @param {string} xBotId Bot id
|
|
8700
8749
|
* @param {string} botId Bot ID
|
|
8701
8750
|
* @param {string} query Query expressed in natural language to retrieve matching text passages within all files using semantical search.
|
|
8702
|
-
* @param {string} [
|
|
8703
|
-
* @param {string} [
|
|
8704
|
-
* @param {string} [xUserRole] User role
|
|
8705
|
-
* @param {string} [tags] Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
8751
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
8752
|
+
* @param {string} [contextDepth] The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage. Default: 0, Maximum: 10
|
|
8706
8753
|
* @param {string} [limit] The maximum number of passages to return.
|
|
8707
8754
|
* @param {*} [options] Override http request option.
|
|
8708
8755
|
* @throws {RequiredError}
|
|
8709
8756
|
*/
|
|
8710
|
-
searchFiles: (
|
|
8757
|
+
searchFiles: (botId: string, query: string, tags?: {
|
|
8758
|
+
[key: string]: string;
|
|
8759
|
+
} | undefined, contextDepth?: string, limit?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8711
8760
|
/**
|
|
8712
8761
|
* Set a preference for the account
|
|
8713
8762
|
* @param {string} key Preference key
|
|
@@ -8768,15 +8817,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8768
8817
|
/**
|
|
8769
8818
|
* Update file metadata
|
|
8770
8819
|
* @param {string} id File ID
|
|
8771
|
-
* @param {string} xBotId Bot id
|
|
8772
|
-
* @param {string} [xIntegrationId] Integration id
|
|
8773
|
-
* @param {string} [xUserId] User id
|
|
8774
|
-
* @param {string} [xUserRole] User role
|
|
8775
8820
|
* @param {UpdateFileMetadataBody} [updateFileMetadataBody] File metadata to update.
|
|
8776
8821
|
* @param {*} [options] Override http request option.
|
|
8777
8822
|
* @throws {RequiredError}
|
|
8778
8823
|
*/
|
|
8779
|
-
updateFileMetadata: (id: string,
|
|
8824
|
+
updateFileMetadata: (id: string, updateFileMetadataBody?: UpdateFileMetadataBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8780
8825
|
/**
|
|
8781
8826
|
* Update integration
|
|
8782
8827
|
* @param {string} id Integration ID
|
|
@@ -8939,21 +8984,17 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8939
8984
|
createEvent(createEventBody?: CreateEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventResponse>>;
|
|
8940
8985
|
/**
|
|
8941
8986
|
* Creates a file.
|
|
8942
|
-
* @param {string}
|
|
8943
|
-
* @param {string} xBotId Bot id
|
|
8987
|
+
* @param {string} xName File name
|
|
8944
8988
|
* @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
|
|
8945
|
-
* @param {string} [xAccessPolicies] File access policies
|
|
8989
|
+
* @param {string} [xAccessPolicies] File access policies, comma-separated. Add \"public_content\" to allow public access to the file content. Add \"integrations\" to allo read, search and list operations for any integration installed in the bot.
|
|
8946
8990
|
* @param {string} [xIndex] Set to a value of \"true\" to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
|
|
8947
|
-
* @param {string} [contentType] File content type
|
|
8991
|
+
* @param {string} [contentType] File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \"application/octet-stream\".
|
|
8948
8992
|
* @param {string} [contentLength] File content length
|
|
8949
|
-
* @param {string} [xIntegrationId] Integration id
|
|
8950
|
-
* @param {string} [xUserId] User id
|
|
8951
|
-
* @param {string} [xUserRole] User role
|
|
8952
8993
|
* @param {CreateFileBody} [createFileBody] The file to upload.
|
|
8953
8994
|
* @param {*} [options] Override http request option.
|
|
8954
8995
|
* @throws {RequiredError}
|
|
8955
8996
|
*/
|
|
8956
|
-
createFile(
|
|
8997
|
+
createFile(xName: string, xTags?: string, xAccessPolicies?: string, xIndex?: string, contentType?: string, contentLength?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFileResponse>>;
|
|
8957
8998
|
/**
|
|
8958
8999
|
* Create integration
|
|
8959
9000
|
* @param {CreateIntegrationBody} [createIntegrationBody] Integration
|
|
@@ -9043,14 +9084,10 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9043
9084
|
/**
|
|
9044
9085
|
* Deletes a file.
|
|
9045
9086
|
* @param {string} id File ID
|
|
9046
|
-
* @param {string} xBotId Bot id
|
|
9047
|
-
* @param {string} [xIntegrationId] Integration id
|
|
9048
|
-
* @param {string} [xUserId] User id
|
|
9049
|
-
* @param {string} [xUserRole] User role
|
|
9050
9087
|
* @param {*} [options] Override http request option.
|
|
9051
9088
|
* @throws {RequiredError}
|
|
9052
9089
|
*/
|
|
9053
|
-
deleteFile(id: string,
|
|
9090
|
+
deleteFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
9054
9091
|
/**
|
|
9055
9092
|
* Delete integration
|
|
9056
9093
|
* @param {string} id Integration ID
|
|
@@ -9203,25 +9240,17 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9203
9240
|
/**
|
|
9204
9241
|
* Returns a presigned URL to download the file content.
|
|
9205
9242
|
* @param {string} id File ID
|
|
9206
|
-
* @param {string} xBotId Bot id
|
|
9207
|
-
* @param {string} [xIntegrationId] Integration id
|
|
9208
|
-
* @param {string} [xUserId] User id
|
|
9209
|
-
* @param {string} [xUserRole] User role
|
|
9210
9243
|
* @param {*} [options] Override http request option.
|
|
9211
9244
|
* @throws {RequiredError}
|
|
9212
9245
|
*/
|
|
9213
|
-
getFileContent(id: string,
|
|
9246
|
+
getFileContent(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileContentResponse>>;
|
|
9214
9247
|
/**
|
|
9215
9248
|
* Get file metadata
|
|
9216
9249
|
* @param {string} id File ID
|
|
9217
|
-
* @param {string} xBotId Bot id
|
|
9218
|
-
* @param {string} [xIntegrationId] Integration id
|
|
9219
|
-
* @param {string} [xUserId] User id
|
|
9220
|
-
* @param {string} [xUserRole] User role
|
|
9221
9250
|
* @param {*} [options] Override http request option.
|
|
9222
9251
|
* @throws {RequiredError}
|
|
9223
9252
|
*/
|
|
9224
|
-
getFileMetadata(id: string,
|
|
9253
|
+
getFileMetadata(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileMetadataResponse>>;
|
|
9225
9254
|
/**
|
|
9226
9255
|
* Get integration
|
|
9227
9256
|
* @param {string} id Integration ID
|
|
@@ -9456,17 +9485,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9456
9485
|
listEvents(nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
|
|
9457
9486
|
/**
|
|
9458
9487
|
* List files for bot
|
|
9459
|
-
* @param {string} xBotId Bot id
|
|
9460
9488
|
* @param {string} botId Bot ID
|
|
9461
9489
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
9462
|
-
* @param {string} [
|
|
9463
|
-
* @param {string} [xUserId] User id
|
|
9464
|
-
* @param {string} [xUserRole] User role
|
|
9465
|
-
* @param {string} [tags] Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
9490
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
9466
9491
|
* @param {*} [options] Override http request option.
|
|
9467
9492
|
* @throws {RequiredError}
|
|
9468
9493
|
*/
|
|
9469
|
-
listFiles(
|
|
9494
|
+
listFiles(botId: string, nextToken?: string, tags?: {
|
|
9495
|
+
[key: string]: string;
|
|
9496
|
+
} | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
|
|
9470
9497
|
/**
|
|
9471
9498
|
* List integrations
|
|
9472
9499
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -9627,18 +9654,17 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9627
9654
|
runVrl(runVrlBody?: RunVrlBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunVrlResponse>>;
|
|
9628
9655
|
/**
|
|
9629
9656
|
* Search files
|
|
9630
|
-
* @param {string} xBotId Bot id
|
|
9631
9657
|
* @param {string} botId Bot ID
|
|
9632
9658
|
* @param {string} query Query expressed in natural language to retrieve matching text passages within all files using semantical search.
|
|
9633
|
-
* @param {string} [
|
|
9634
|
-
* @param {string} [
|
|
9635
|
-
* @param {string} [xUserRole] User role
|
|
9636
|
-
* @param {string} [tags] Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
9659
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
9660
|
+
* @param {string} [contextDepth] The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage. Default: 0, Maximum: 10
|
|
9637
9661
|
* @param {string} [limit] The maximum number of passages to return.
|
|
9638
9662
|
* @param {*} [options] Override http request option.
|
|
9639
9663
|
* @throws {RequiredError}
|
|
9640
9664
|
*/
|
|
9641
|
-
searchFiles(
|
|
9665
|
+
searchFiles(botId: string, query: string, tags?: {
|
|
9666
|
+
[key: string]: string;
|
|
9667
|
+
} | undefined, contextDepth?: string, limit?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchFilesResponse>>;
|
|
9642
9668
|
/**
|
|
9643
9669
|
* Set a preference for the account
|
|
9644
9670
|
* @param {string} key Preference key
|
|
@@ -9699,15 +9725,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9699
9725
|
/**
|
|
9700
9726
|
* Update file metadata
|
|
9701
9727
|
* @param {string} id File ID
|
|
9702
|
-
* @param {string} xBotId Bot id
|
|
9703
|
-
* @param {string} [xIntegrationId] Integration id
|
|
9704
|
-
* @param {string} [xUserId] User id
|
|
9705
|
-
* @param {string} [xUserRole] User role
|
|
9706
9728
|
* @param {UpdateFileMetadataBody} [updateFileMetadataBody] File metadata to update.
|
|
9707
9729
|
* @param {*} [options] Override http request option.
|
|
9708
9730
|
* @throws {RequiredError}
|
|
9709
9731
|
*/
|
|
9710
|
-
updateFileMetadata(id: string,
|
|
9732
|
+
updateFileMetadata(id: string, updateFileMetadataBody?: UpdateFileMetadataBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFileMetadataResponse>>;
|
|
9711
9733
|
/**
|
|
9712
9734
|
* Update integration
|
|
9713
9735
|
* @param {string} id Integration ID
|
|
@@ -10761,13 +10783,7 @@ export interface DefaultApiCreateFileRequest {
|
|
|
10761
10783
|
* @type {string}
|
|
10762
10784
|
* @memberof DefaultApiCreateFile
|
|
10763
10785
|
*/
|
|
10764
|
-
readonly
|
|
10765
|
-
/**
|
|
10766
|
-
* Bot id
|
|
10767
|
-
* @type {string}
|
|
10768
|
-
* @memberof DefaultApiCreateFile
|
|
10769
|
-
*/
|
|
10770
|
-
readonly xBotId: string;
|
|
10786
|
+
readonly xName: string;
|
|
10771
10787
|
/**
|
|
10772
10788
|
* File tags as URL-encoded JSON string representing an object of key-value pairs.
|
|
10773
10789
|
* @type {string}
|
|
@@ -10775,7 +10791,7 @@ export interface DefaultApiCreateFileRequest {
|
|
|
10775
10791
|
*/
|
|
10776
10792
|
readonly xTags?: string;
|
|
10777
10793
|
/**
|
|
10778
|
-
* File access policies
|
|
10794
|
+
* File access policies, comma-separated. Add \"public_content\" to allow public access to the file content. Add \"integrations\" to allo read, search and list operations for any integration installed in the bot.
|
|
10779
10795
|
* @type {string}
|
|
10780
10796
|
* @memberof DefaultApiCreateFile
|
|
10781
10797
|
*/
|
|
@@ -10787,7 +10803,7 @@ export interface DefaultApiCreateFileRequest {
|
|
|
10787
10803
|
*/
|
|
10788
10804
|
readonly xIndex?: string;
|
|
10789
10805
|
/**
|
|
10790
|
-
* File content type
|
|
10806
|
+
* File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \"application/octet-stream\".
|
|
10791
10807
|
* @type {string}
|
|
10792
10808
|
* @memberof DefaultApiCreateFile
|
|
10793
10809
|
*/
|
|
@@ -10798,24 +10814,6 @@ export interface DefaultApiCreateFileRequest {
|
|
|
10798
10814
|
* @memberof DefaultApiCreateFile
|
|
10799
10815
|
*/
|
|
10800
10816
|
readonly contentLength?: string;
|
|
10801
|
-
/**
|
|
10802
|
-
* Integration id
|
|
10803
|
-
* @type {string}
|
|
10804
|
-
* @memberof DefaultApiCreateFile
|
|
10805
|
-
*/
|
|
10806
|
-
readonly xIntegrationId?: string;
|
|
10807
|
-
/**
|
|
10808
|
-
* User id
|
|
10809
|
-
* @type {string}
|
|
10810
|
-
* @memberof DefaultApiCreateFile
|
|
10811
|
-
*/
|
|
10812
|
-
readonly xUserId?: string;
|
|
10813
|
-
/**
|
|
10814
|
-
* User role
|
|
10815
|
-
* @type {string}
|
|
10816
|
-
* @memberof DefaultApiCreateFile
|
|
10817
|
-
*/
|
|
10818
|
-
readonly xUserRole?: string;
|
|
10819
10817
|
/**
|
|
10820
10818
|
* The file to upload.
|
|
10821
10819
|
* @type {CreateFileBody}
|
|
@@ -11003,30 +11001,6 @@ export interface DefaultApiDeleteFileRequest {
|
|
|
11003
11001
|
* @memberof DefaultApiDeleteFile
|
|
11004
11002
|
*/
|
|
11005
11003
|
readonly id: string;
|
|
11006
|
-
/**
|
|
11007
|
-
* Bot id
|
|
11008
|
-
* @type {string}
|
|
11009
|
-
* @memberof DefaultApiDeleteFile
|
|
11010
|
-
*/
|
|
11011
|
-
readonly xBotId: string;
|
|
11012
|
-
/**
|
|
11013
|
-
* Integration id
|
|
11014
|
-
* @type {string}
|
|
11015
|
-
* @memberof DefaultApiDeleteFile
|
|
11016
|
-
*/
|
|
11017
|
-
readonly xIntegrationId?: string;
|
|
11018
|
-
/**
|
|
11019
|
-
* User id
|
|
11020
|
-
* @type {string}
|
|
11021
|
-
* @memberof DefaultApiDeleteFile
|
|
11022
|
-
*/
|
|
11023
|
-
readonly xUserId?: string;
|
|
11024
|
-
/**
|
|
11025
|
-
* User role
|
|
11026
|
-
* @type {string}
|
|
11027
|
-
* @memberof DefaultApiDeleteFile
|
|
11028
|
-
*/
|
|
11029
|
-
readonly xUserRole?: string;
|
|
11030
11004
|
}
|
|
11031
11005
|
/**
|
|
11032
11006
|
* Request parameters for deleteIntegration operation in DefaultApi.
|
|
@@ -11328,30 +11302,6 @@ export interface DefaultApiGetFileContentRequest {
|
|
|
11328
11302
|
* @memberof DefaultApiGetFileContent
|
|
11329
11303
|
*/
|
|
11330
11304
|
readonly id: string;
|
|
11331
|
-
/**
|
|
11332
|
-
* Bot id
|
|
11333
|
-
* @type {string}
|
|
11334
|
-
* @memberof DefaultApiGetFileContent
|
|
11335
|
-
*/
|
|
11336
|
-
readonly xBotId: string;
|
|
11337
|
-
/**
|
|
11338
|
-
* Integration id
|
|
11339
|
-
* @type {string}
|
|
11340
|
-
* @memberof DefaultApiGetFileContent
|
|
11341
|
-
*/
|
|
11342
|
-
readonly xIntegrationId?: string;
|
|
11343
|
-
/**
|
|
11344
|
-
* User id
|
|
11345
|
-
* @type {string}
|
|
11346
|
-
* @memberof DefaultApiGetFileContent
|
|
11347
|
-
*/
|
|
11348
|
-
readonly xUserId?: string;
|
|
11349
|
-
/**
|
|
11350
|
-
* User role
|
|
11351
|
-
* @type {string}
|
|
11352
|
-
* @memberof DefaultApiGetFileContent
|
|
11353
|
-
*/
|
|
11354
|
-
readonly xUserRole?: string;
|
|
11355
11305
|
}
|
|
11356
11306
|
/**
|
|
11357
11307
|
* Request parameters for getFileMetadata operation in DefaultApi.
|
|
@@ -11365,30 +11315,6 @@ export interface DefaultApiGetFileMetadataRequest {
|
|
|
11365
11315
|
* @memberof DefaultApiGetFileMetadata
|
|
11366
11316
|
*/
|
|
11367
11317
|
readonly id: string;
|
|
11368
|
-
/**
|
|
11369
|
-
* Bot id
|
|
11370
|
-
* @type {string}
|
|
11371
|
-
* @memberof DefaultApiGetFileMetadata
|
|
11372
|
-
*/
|
|
11373
|
-
readonly xBotId: string;
|
|
11374
|
-
/**
|
|
11375
|
-
* Integration id
|
|
11376
|
-
* @type {string}
|
|
11377
|
-
* @memberof DefaultApiGetFileMetadata
|
|
11378
|
-
*/
|
|
11379
|
-
readonly xIntegrationId?: string;
|
|
11380
|
-
/**
|
|
11381
|
-
* User id
|
|
11382
|
-
* @type {string}
|
|
11383
|
-
* @memberof DefaultApiGetFileMetadata
|
|
11384
|
-
*/
|
|
11385
|
-
readonly xUserId?: string;
|
|
11386
|
-
/**
|
|
11387
|
-
* User role
|
|
11388
|
-
* @type {string}
|
|
11389
|
-
* @memberof DefaultApiGetFileMetadata
|
|
11390
|
-
*/
|
|
11391
|
-
readonly xUserRole?: string;
|
|
11392
11318
|
}
|
|
11393
11319
|
/**
|
|
11394
11320
|
* Request parameters for getIntegration operation in DefaultApi.
|
|
@@ -11937,12 +11863,6 @@ export interface DefaultApiListEventsRequest {
|
|
|
11937
11863
|
* @interface DefaultApiListFilesRequest
|
|
11938
11864
|
*/
|
|
11939
11865
|
export interface DefaultApiListFilesRequest {
|
|
11940
|
-
/**
|
|
11941
|
-
* Bot id
|
|
11942
|
-
* @type {string}
|
|
11943
|
-
* @memberof DefaultApiListFiles
|
|
11944
|
-
*/
|
|
11945
|
-
readonly xBotId: string;
|
|
11946
11866
|
/**
|
|
11947
11867
|
* Bot ID
|
|
11948
11868
|
* @type {string}
|
|
@@ -11956,29 +11876,13 @@ export interface DefaultApiListFilesRequest {
|
|
|
11956
11876
|
*/
|
|
11957
11877
|
readonly nextToken?: string;
|
|
11958
11878
|
/**
|
|
11959
|
-
*
|
|
11960
|
-
* @type {string}
|
|
11961
|
-
* @memberof DefaultApiListFiles
|
|
11962
|
-
*/
|
|
11963
|
-
readonly xIntegrationId?: string;
|
|
11964
|
-
/**
|
|
11965
|
-
* User id
|
|
11966
|
-
* @type {string}
|
|
11967
|
-
* @memberof DefaultApiListFiles
|
|
11968
|
-
*/
|
|
11969
|
-
readonly xUserId?: string;
|
|
11970
|
-
/**
|
|
11971
|
-
* User role
|
|
11972
|
-
* @type {string}
|
|
11973
|
-
* @memberof DefaultApiListFiles
|
|
11974
|
-
*/
|
|
11975
|
-
readonly xUserRole?: string;
|
|
11976
|
-
/**
|
|
11977
|
-
* Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
11978
|
-
* @type {string}
|
|
11879
|
+
* Filter by tags
|
|
11880
|
+
* @type {{ [key: string]: string; }}
|
|
11979
11881
|
* @memberof DefaultApiListFiles
|
|
11980
11882
|
*/
|
|
11981
|
-
readonly tags?:
|
|
11883
|
+
readonly tags?: {
|
|
11884
|
+
[key: string]: string;
|
|
11885
|
+
};
|
|
11982
11886
|
}
|
|
11983
11887
|
/**
|
|
11984
11888
|
* Request parameters for listIntegrations operation in DefaultApi.
|
|
@@ -12365,12 +12269,6 @@ export interface DefaultApiRunVrlRequest {
|
|
|
12365
12269
|
* @interface DefaultApiSearchFilesRequest
|
|
12366
12270
|
*/
|
|
12367
12271
|
export interface DefaultApiSearchFilesRequest {
|
|
12368
|
-
/**
|
|
12369
|
-
* Bot id
|
|
12370
|
-
* @type {string}
|
|
12371
|
-
* @memberof DefaultApiSearchFiles
|
|
12372
|
-
*/
|
|
12373
|
-
readonly xBotId: string;
|
|
12374
12272
|
/**
|
|
12375
12273
|
* Bot ID
|
|
12376
12274
|
* @type {string}
|
|
@@ -12384,29 +12282,19 @@ export interface DefaultApiSearchFilesRequest {
|
|
|
12384
12282
|
*/
|
|
12385
12283
|
readonly query: string;
|
|
12386
12284
|
/**
|
|
12387
|
-
*
|
|
12388
|
-
* @type {string}
|
|
12389
|
-
* @memberof DefaultApiSearchFiles
|
|
12390
|
-
*/
|
|
12391
|
-
readonly xIntegrationId?: string;
|
|
12392
|
-
/**
|
|
12393
|
-
* User id
|
|
12394
|
-
* @type {string}
|
|
12395
|
-
* @memberof DefaultApiSearchFiles
|
|
12396
|
-
*/
|
|
12397
|
-
readonly xUserId?: string;
|
|
12398
|
-
/**
|
|
12399
|
-
* User role
|
|
12400
|
-
* @type {string}
|
|
12285
|
+
* Filter by tags
|
|
12286
|
+
* @type {{ [key: string]: string; }}
|
|
12401
12287
|
* @memberof DefaultApiSearchFiles
|
|
12402
12288
|
*/
|
|
12403
|
-
readonly
|
|
12289
|
+
readonly tags?: {
|
|
12290
|
+
[key: string]: string;
|
|
12291
|
+
};
|
|
12404
12292
|
/**
|
|
12405
|
-
*
|
|
12293
|
+
* The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage. Default: 0, Maximum: 10
|
|
12406
12294
|
* @type {string}
|
|
12407
12295
|
* @memberof DefaultApiSearchFiles
|
|
12408
12296
|
*/
|
|
12409
|
-
readonly
|
|
12297
|
+
readonly contextDepth?: string;
|
|
12410
12298
|
/**
|
|
12411
12299
|
* The maximum number of passages to return.
|
|
12412
12300
|
* @type {string}
|
|
@@ -12565,30 +12453,6 @@ export interface DefaultApiUpdateFileMetadataRequest {
|
|
|
12565
12453
|
* @memberof DefaultApiUpdateFileMetadata
|
|
12566
12454
|
*/
|
|
12567
12455
|
readonly id: string;
|
|
12568
|
-
/**
|
|
12569
|
-
* Bot id
|
|
12570
|
-
* @type {string}
|
|
12571
|
-
* @memberof DefaultApiUpdateFileMetadata
|
|
12572
|
-
*/
|
|
12573
|
-
readonly xBotId: string;
|
|
12574
|
-
/**
|
|
12575
|
-
* Integration id
|
|
12576
|
-
* @type {string}
|
|
12577
|
-
* @memberof DefaultApiUpdateFileMetadata
|
|
12578
|
-
*/
|
|
12579
|
-
readonly xIntegrationId?: string;
|
|
12580
|
-
/**
|
|
12581
|
-
* User id
|
|
12582
|
-
* @type {string}
|
|
12583
|
-
* @memberof DefaultApiUpdateFileMetadata
|
|
12584
|
-
*/
|
|
12585
|
-
readonly xUserId?: string;
|
|
12586
|
-
/**
|
|
12587
|
-
* User role
|
|
12588
|
-
* @type {string}
|
|
12589
|
-
* @memberof DefaultApiUpdateFileMetadata
|
|
12590
|
-
*/
|
|
12591
|
-
readonly xUserRole?: string;
|
|
12592
12456
|
/**
|
|
12593
12457
|
* File metadata to update.
|
|
12594
12458
|
* @type {UpdateFileMetadataBody}
|