@botpress/client 0.12.1 → 0.12.3
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 +9 -9
- package/dist/bundle.cjs.map +3 -3
- package/dist/gen/api.d.ts +78 -264
- 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/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.19.
|
|
5
|
+
* The version of the OpenAPI document: 0.19.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1408,13 +1408,19 @@ export interface CreateFileResponseFile {
|
|
|
1408
1408
|
* @type {string}
|
|
1409
1409
|
* @memberof CreateFileResponseFile
|
|
1410
1410
|
*/
|
|
1411
|
-
'
|
|
1411
|
+
'name': string;
|
|
1412
1412
|
/**
|
|
1413
1413
|
*
|
|
1414
1414
|
* @type {number}
|
|
1415
1415
|
* @memberof CreateFileResponseFile
|
|
1416
1416
|
*/
|
|
1417
|
-
'
|
|
1417
|
+
'size': number | null;
|
|
1418
|
+
/**
|
|
1419
|
+
*
|
|
1420
|
+
* @type {string}
|
|
1421
|
+
* @memberof CreateFileResponseFile
|
|
1422
|
+
*/
|
|
1423
|
+
'contentType': string;
|
|
1418
1424
|
/**
|
|
1419
1425
|
* Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value.
|
|
1420
1426
|
* @type {{ [key: string]: string; }}
|
|
@@ -4794,13 +4800,27 @@ export interface ListFilesResponseFilesInner {
|
|
|
4794
4800
|
* @type {string}
|
|
4795
4801
|
* @memberof ListFilesResponseFilesInner
|
|
4796
4802
|
*/
|
|
4797
|
-
'
|
|
4803
|
+
'name': string;
|
|
4798
4804
|
/**
|
|
4799
4805
|
*
|
|
4800
4806
|
* @type {number}
|
|
4801
4807
|
* @memberof ListFilesResponseFilesInner
|
|
4802
4808
|
*/
|
|
4803
|
-
'
|
|
4809
|
+
'size': number | null;
|
|
4810
|
+
/**
|
|
4811
|
+
*
|
|
4812
|
+
* @type {string}
|
|
4813
|
+
* @memberof ListFilesResponseFilesInner
|
|
4814
|
+
*/
|
|
4815
|
+
'contentType': string;
|
|
4816
|
+
/**
|
|
4817
|
+
* Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value.
|
|
4818
|
+
* @type {{ [key: string]: string; }}
|
|
4819
|
+
* @memberof ListFilesResponseFilesInner
|
|
4820
|
+
*/
|
|
4821
|
+
'tags': {
|
|
4822
|
+
[key: string]: string;
|
|
4823
|
+
};
|
|
4804
4824
|
/**
|
|
4805
4825
|
*
|
|
4806
4826
|
* @type {string}
|
|
@@ -5494,13 +5514,19 @@ export interface ModelFile {
|
|
|
5494
5514
|
* @type {string}
|
|
5495
5515
|
* @memberof ModelFile
|
|
5496
5516
|
*/
|
|
5497
|
-
'
|
|
5517
|
+
'name': string;
|
|
5498
5518
|
/**
|
|
5499
5519
|
*
|
|
5500
5520
|
* @type {number}
|
|
5501
5521
|
* @memberof ModelFile
|
|
5502
5522
|
*/
|
|
5503
|
-
'
|
|
5523
|
+
'size': number | null;
|
|
5524
|
+
/**
|
|
5525
|
+
*
|
|
5526
|
+
* @type {string}
|
|
5527
|
+
* @memberof ModelFile
|
|
5528
|
+
*/
|
|
5529
|
+
'contentType': string;
|
|
5504
5530
|
/**
|
|
5505
5531
|
* Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value.
|
|
5506
5532
|
* @type {{ [key: string]: string; }}
|
|
@@ -8010,21 +8036,17 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8010
8036
|
createEvent: (createEventBody?: CreateEventBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8011
8037
|
/**
|
|
8012
8038
|
* Creates a file.
|
|
8013
|
-
* @param {string}
|
|
8014
|
-
* @param {string} xBotId Bot id
|
|
8039
|
+
* @param {string} xName File name
|
|
8015
8040
|
* @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
|
|
8016
|
-
* @param {string} [xAccessPolicies] File access policies
|
|
8041
|
+
* @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
8042
|
* @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
|
|
8043
|
+
* @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
8044
|
* @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
8045
|
* @param {CreateFileBody} [createFileBody] The file to upload.
|
|
8024
8046
|
* @param {*} [options] Override http request option.
|
|
8025
8047
|
* @throws {RequiredError}
|
|
8026
8048
|
*/
|
|
8027
|
-
createFile: (
|
|
8049
|
+
createFile: (xName: string, xTags?: string, xAccessPolicies?: string, xIndex?: string, contentType?: string, contentLength?: string, createFileBody?: CreateFileBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8028
8050
|
/**
|
|
8029
8051
|
* Create integration
|
|
8030
8052
|
* @param {CreateIntegrationBody} [createIntegrationBody] Integration
|
|
@@ -8114,14 +8136,10 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8114
8136
|
/**
|
|
8115
8137
|
* Deletes a file.
|
|
8116
8138
|
* @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
8139
|
* @param {*} [options] Override http request option.
|
|
8122
8140
|
* @throws {RequiredError}
|
|
8123
8141
|
*/
|
|
8124
|
-
deleteFile: (id: string,
|
|
8142
|
+
deleteFile: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8125
8143
|
/**
|
|
8126
8144
|
* Delete integration
|
|
8127
8145
|
* @param {string} id Integration ID
|
|
@@ -8272,25 +8290,17 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8272
8290
|
/**
|
|
8273
8291
|
* Returns a presigned URL to download the file content.
|
|
8274
8292
|
* @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
8293
|
* @param {*} [options] Override http request option.
|
|
8280
8294
|
* @throws {RequiredError}
|
|
8281
8295
|
*/
|
|
8282
|
-
getFileContent: (id: string,
|
|
8296
|
+
getFileContent: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8283
8297
|
/**
|
|
8284
8298
|
* Get file metadata
|
|
8285
8299
|
* @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
8300
|
* @param {*} [options] Override http request option.
|
|
8291
8301
|
* @throws {RequiredError}
|
|
8292
8302
|
*/
|
|
8293
|
-
getFileMetadata: (id: string,
|
|
8303
|
+
getFileMetadata: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8294
8304
|
/**
|
|
8295
8305
|
* Get integration
|
|
8296
8306
|
* @param {string} id Integration ID
|
|
@@ -8525,17 +8535,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8525
8535
|
listEvents: (nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8526
8536
|
/**
|
|
8527
8537
|
* List files for bot
|
|
8528
|
-
* @param {string} xBotId Bot id
|
|
8529
8538
|
* @param {string} botId Bot ID
|
|
8530
8539
|
* @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.
|
|
8540
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
8535
8541
|
* @param {*} [options] Override http request option.
|
|
8536
8542
|
* @throws {RequiredError}
|
|
8537
8543
|
*/
|
|
8538
|
-
listFiles: (
|
|
8544
|
+
listFiles: (botId: string, nextToken?: string, tags?: {
|
|
8545
|
+
[key: string]: string;
|
|
8546
|
+
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8539
8547
|
/**
|
|
8540
8548
|
* List integrations
|
|
8541
8549
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -8696,18 +8704,16 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8696
8704
|
runVrl: (runVrlBody?: RunVrlBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8697
8705
|
/**
|
|
8698
8706
|
* Search files
|
|
8699
|
-
* @param {string} xBotId Bot id
|
|
8700
8707
|
* @param {string} botId Bot ID
|
|
8701
8708
|
* @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} [xUserId] User id
|
|
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.
|
|
8709
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
8706
8710
|
* @param {string} [limit] The maximum number of passages to return.
|
|
8707
8711
|
* @param {*} [options] Override http request option.
|
|
8708
8712
|
* @throws {RequiredError}
|
|
8709
8713
|
*/
|
|
8710
|
-
searchFiles: (
|
|
8714
|
+
searchFiles: (botId: string, query: string, tags?: {
|
|
8715
|
+
[key: string]: string;
|
|
8716
|
+
} | undefined, limit?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8711
8717
|
/**
|
|
8712
8718
|
* Set a preference for the account
|
|
8713
8719
|
* @param {string} key Preference key
|
|
@@ -8768,15 +8774,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
8768
8774
|
/**
|
|
8769
8775
|
* Update file metadata
|
|
8770
8776
|
* @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
8777
|
* @param {UpdateFileMetadataBody} [updateFileMetadataBody] File metadata to update.
|
|
8776
8778
|
* @param {*} [options] Override http request option.
|
|
8777
8779
|
* @throws {RequiredError}
|
|
8778
8780
|
*/
|
|
8779
|
-
updateFileMetadata: (id: string,
|
|
8781
|
+
updateFileMetadata: (id: string, updateFileMetadataBody?: UpdateFileMetadataBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8780
8782
|
/**
|
|
8781
8783
|
* Update integration
|
|
8782
8784
|
* @param {string} id Integration ID
|
|
@@ -8939,21 +8941,17 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
8939
8941
|
createEvent(createEventBody?: CreateEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventResponse>>;
|
|
8940
8942
|
/**
|
|
8941
8943
|
* Creates a file.
|
|
8942
|
-
* @param {string}
|
|
8943
|
-
* @param {string} xBotId Bot id
|
|
8944
|
+
* @param {string} xName File name
|
|
8944
8945
|
* @param {string} [xTags] File tags as URL-encoded JSON string representing an object of key-value pairs.
|
|
8945
|
-
* @param {string} [xAccessPolicies] File access policies
|
|
8946
|
+
* @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
8947
|
* @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
|
|
8948
|
+
* @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
8949
|
* @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
8950
|
* @param {CreateFileBody} [createFileBody] The file to upload.
|
|
8953
8951
|
* @param {*} [options] Override http request option.
|
|
8954
8952
|
* @throws {RequiredError}
|
|
8955
8953
|
*/
|
|
8956
|
-
createFile(
|
|
8954
|
+
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
8955
|
/**
|
|
8958
8956
|
* Create integration
|
|
8959
8957
|
* @param {CreateIntegrationBody} [createIntegrationBody] Integration
|
|
@@ -9043,14 +9041,10 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9043
9041
|
/**
|
|
9044
9042
|
* Deletes a file.
|
|
9045
9043
|
* @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
9044
|
* @param {*} [options] Override http request option.
|
|
9051
9045
|
* @throws {RequiredError}
|
|
9052
9046
|
*/
|
|
9053
|
-
deleteFile(id: string,
|
|
9047
|
+
deleteFile(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
9054
9048
|
/**
|
|
9055
9049
|
* Delete integration
|
|
9056
9050
|
* @param {string} id Integration ID
|
|
@@ -9203,25 +9197,17 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9203
9197
|
/**
|
|
9204
9198
|
* Returns a presigned URL to download the file content.
|
|
9205
9199
|
* @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
9200
|
* @param {*} [options] Override http request option.
|
|
9211
9201
|
* @throws {RequiredError}
|
|
9212
9202
|
*/
|
|
9213
|
-
getFileContent(id: string,
|
|
9203
|
+
getFileContent(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileContentResponse>>;
|
|
9214
9204
|
/**
|
|
9215
9205
|
* Get file metadata
|
|
9216
9206
|
* @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
9207
|
* @param {*} [options] Override http request option.
|
|
9222
9208
|
* @throws {RequiredError}
|
|
9223
9209
|
*/
|
|
9224
|
-
getFileMetadata(id: string,
|
|
9210
|
+
getFileMetadata(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFileMetadataResponse>>;
|
|
9225
9211
|
/**
|
|
9226
9212
|
* Get integration
|
|
9227
9213
|
* @param {string} id Integration ID
|
|
@@ -9456,17 +9442,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9456
9442
|
listEvents(nextToken?: string, type?: string, conversationId?: string, userId?: string, messageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
|
|
9457
9443
|
/**
|
|
9458
9444
|
* List files for bot
|
|
9459
|
-
* @param {string} xBotId Bot id
|
|
9460
9445
|
* @param {string} botId Bot ID
|
|
9461
9446
|
* @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.
|
|
9447
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
9466
9448
|
* @param {*} [options] Override http request option.
|
|
9467
9449
|
* @throws {RequiredError}
|
|
9468
9450
|
*/
|
|
9469
|
-
listFiles(
|
|
9451
|
+
listFiles(botId: string, nextToken?: string, tags?: {
|
|
9452
|
+
[key: string]: string;
|
|
9453
|
+
} | undefined, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFilesResponse>>;
|
|
9470
9454
|
/**
|
|
9471
9455
|
* List integrations
|
|
9472
9456
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
@@ -9627,18 +9611,16 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9627
9611
|
runVrl(runVrlBody?: RunVrlBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunVrlResponse>>;
|
|
9628
9612
|
/**
|
|
9629
9613
|
* Search files
|
|
9630
|
-
* @param {string} xBotId Bot id
|
|
9631
9614
|
* @param {string} botId Bot ID
|
|
9632
9615
|
* @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} [xUserId] User id
|
|
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.
|
|
9616
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
9637
9617
|
* @param {string} [limit] The maximum number of passages to return.
|
|
9638
9618
|
* @param {*} [options] Override http request option.
|
|
9639
9619
|
* @throws {RequiredError}
|
|
9640
9620
|
*/
|
|
9641
|
-
searchFiles(
|
|
9621
|
+
searchFiles(botId: string, query: string, tags?: {
|
|
9622
|
+
[key: string]: string;
|
|
9623
|
+
} | undefined, limit?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchFilesResponse>>;
|
|
9642
9624
|
/**
|
|
9643
9625
|
* Set a preference for the account
|
|
9644
9626
|
* @param {string} key Preference key
|
|
@@ -9699,15 +9681,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
9699
9681
|
/**
|
|
9700
9682
|
* Update file metadata
|
|
9701
9683
|
* @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
9684
|
* @param {UpdateFileMetadataBody} [updateFileMetadataBody] File metadata to update.
|
|
9707
9685
|
* @param {*} [options] Override http request option.
|
|
9708
9686
|
* @throws {RequiredError}
|
|
9709
9687
|
*/
|
|
9710
|
-
updateFileMetadata(id: string,
|
|
9688
|
+
updateFileMetadata(id: string, updateFileMetadataBody?: UpdateFileMetadataBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFileMetadataResponse>>;
|
|
9711
9689
|
/**
|
|
9712
9690
|
* Update integration
|
|
9713
9691
|
* @param {string} id Integration ID
|
|
@@ -10761,13 +10739,7 @@ export interface DefaultApiCreateFileRequest {
|
|
|
10761
10739
|
* @type {string}
|
|
10762
10740
|
* @memberof DefaultApiCreateFile
|
|
10763
10741
|
*/
|
|
10764
|
-
readonly
|
|
10765
|
-
/**
|
|
10766
|
-
* Bot id
|
|
10767
|
-
* @type {string}
|
|
10768
|
-
* @memberof DefaultApiCreateFile
|
|
10769
|
-
*/
|
|
10770
|
-
readonly xBotId: string;
|
|
10742
|
+
readonly xName: string;
|
|
10771
10743
|
/**
|
|
10772
10744
|
* File tags as URL-encoded JSON string representing an object of key-value pairs.
|
|
10773
10745
|
* @type {string}
|
|
@@ -10775,7 +10747,7 @@ export interface DefaultApiCreateFileRequest {
|
|
|
10775
10747
|
*/
|
|
10776
10748
|
readonly xTags?: string;
|
|
10777
10749
|
/**
|
|
10778
|
-
* File access policies
|
|
10750
|
+
* 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
10751
|
* @type {string}
|
|
10780
10752
|
* @memberof DefaultApiCreateFile
|
|
10781
10753
|
*/
|
|
@@ -10787,7 +10759,7 @@ export interface DefaultApiCreateFileRequest {
|
|
|
10787
10759
|
*/
|
|
10788
10760
|
readonly xIndex?: string;
|
|
10789
10761
|
/**
|
|
10790
|
-
* File content type
|
|
10762
|
+
* 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
10763
|
* @type {string}
|
|
10792
10764
|
* @memberof DefaultApiCreateFile
|
|
10793
10765
|
*/
|
|
@@ -10798,24 +10770,6 @@ export interface DefaultApiCreateFileRequest {
|
|
|
10798
10770
|
* @memberof DefaultApiCreateFile
|
|
10799
10771
|
*/
|
|
10800
10772
|
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
10773
|
/**
|
|
10820
10774
|
* The file to upload.
|
|
10821
10775
|
* @type {CreateFileBody}
|
|
@@ -11003,30 +10957,6 @@ export interface DefaultApiDeleteFileRequest {
|
|
|
11003
10957
|
* @memberof DefaultApiDeleteFile
|
|
11004
10958
|
*/
|
|
11005
10959
|
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
10960
|
}
|
|
11031
10961
|
/**
|
|
11032
10962
|
* Request parameters for deleteIntegration operation in DefaultApi.
|
|
@@ -11328,30 +11258,6 @@ export interface DefaultApiGetFileContentRequest {
|
|
|
11328
11258
|
* @memberof DefaultApiGetFileContent
|
|
11329
11259
|
*/
|
|
11330
11260
|
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
11261
|
}
|
|
11356
11262
|
/**
|
|
11357
11263
|
* Request parameters for getFileMetadata operation in DefaultApi.
|
|
@@ -11365,30 +11271,6 @@ export interface DefaultApiGetFileMetadataRequest {
|
|
|
11365
11271
|
* @memberof DefaultApiGetFileMetadata
|
|
11366
11272
|
*/
|
|
11367
11273
|
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
11274
|
}
|
|
11393
11275
|
/**
|
|
11394
11276
|
* Request parameters for getIntegration operation in DefaultApi.
|
|
@@ -11937,12 +11819,6 @@ export interface DefaultApiListEventsRequest {
|
|
|
11937
11819
|
* @interface DefaultApiListFilesRequest
|
|
11938
11820
|
*/
|
|
11939
11821
|
export interface DefaultApiListFilesRequest {
|
|
11940
|
-
/**
|
|
11941
|
-
* Bot id
|
|
11942
|
-
* @type {string}
|
|
11943
|
-
* @memberof DefaultApiListFiles
|
|
11944
|
-
*/
|
|
11945
|
-
readonly xBotId: string;
|
|
11946
11822
|
/**
|
|
11947
11823
|
* Bot ID
|
|
11948
11824
|
* @type {string}
|
|
@@ -11956,29 +11832,13 @@ export interface DefaultApiListFilesRequest {
|
|
|
11956
11832
|
*/
|
|
11957
11833
|
readonly nextToken?: string;
|
|
11958
11834
|
/**
|
|
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}
|
|
11835
|
+
* Filter by tags
|
|
11836
|
+
* @type {{ [key: string]: string; }}
|
|
11979
11837
|
* @memberof DefaultApiListFiles
|
|
11980
11838
|
*/
|
|
11981
|
-
readonly tags?:
|
|
11839
|
+
readonly tags?: {
|
|
11840
|
+
[key: string]: string;
|
|
11841
|
+
};
|
|
11982
11842
|
}
|
|
11983
11843
|
/**
|
|
11984
11844
|
* Request parameters for listIntegrations operation in DefaultApi.
|
|
@@ -12365,12 +12225,6 @@ export interface DefaultApiRunVrlRequest {
|
|
|
12365
12225
|
* @interface DefaultApiSearchFilesRequest
|
|
12366
12226
|
*/
|
|
12367
12227
|
export interface DefaultApiSearchFilesRequest {
|
|
12368
|
-
/**
|
|
12369
|
-
* Bot id
|
|
12370
|
-
* @type {string}
|
|
12371
|
-
* @memberof DefaultApiSearchFiles
|
|
12372
|
-
*/
|
|
12373
|
-
readonly xBotId: string;
|
|
12374
12228
|
/**
|
|
12375
12229
|
* Bot ID
|
|
12376
12230
|
* @type {string}
|
|
@@ -12384,29 +12238,13 @@ export interface DefaultApiSearchFilesRequest {
|
|
|
12384
12238
|
*/
|
|
12385
12239
|
readonly query: string;
|
|
12386
12240
|
/**
|
|
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}
|
|
12401
|
-
* @memberof DefaultApiSearchFiles
|
|
12402
|
-
*/
|
|
12403
|
-
readonly xUserRole?: string;
|
|
12404
|
-
/**
|
|
12405
|
-
* Tags to filter files by as a JSON string representing an object of key-value pairs to match files\' tags against.
|
|
12406
|
-
* @type {string}
|
|
12241
|
+
* Filter by tags
|
|
12242
|
+
* @type {{ [key: string]: string; }}
|
|
12407
12243
|
* @memberof DefaultApiSearchFiles
|
|
12408
12244
|
*/
|
|
12409
|
-
readonly tags?:
|
|
12245
|
+
readonly tags?: {
|
|
12246
|
+
[key: string]: string;
|
|
12247
|
+
};
|
|
12410
12248
|
/**
|
|
12411
12249
|
* The maximum number of passages to return.
|
|
12412
12250
|
* @type {string}
|
|
@@ -12565,30 +12403,6 @@ export interface DefaultApiUpdateFileMetadataRequest {
|
|
|
12565
12403
|
* @memberof DefaultApiUpdateFileMetadata
|
|
12566
12404
|
*/
|
|
12567
12405
|
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
12406
|
/**
|
|
12593
12407
|
* File metadata to update.
|
|
12594
12408
|
* @type {UpdateFileMetadataBody}
|
package/dist/gen/base.d.ts
CHANGED
package/dist/gen/client.d.ts
CHANGED
|
@@ -115,12 +115,12 @@ export declare class ApiClient {
|
|
|
115
115
|
changeAISpendQuota: (changeAISpendQuotaBody: ChangeAISpendQuotaProps) => Promise<object>;
|
|
116
116
|
listActivities: (props: ListActivitiesProps) => Promise<import("./api").ListActivitiesResponse>;
|
|
117
117
|
introspect: (introspectBody: IntrospectProps) => Promise<import("./api").IntrospectResponse>;
|
|
118
|
-
createFile: ({
|
|
118
|
+
createFile: ({ xName, xTags, xAccessPolicies, xIndex, contentType, contentLength, ...createFileBody }: CreateFileProps) => Promise<import("./api").CreateFileResponse>;
|
|
119
119
|
deleteFile: (props: DeleteFileProps) => Promise<object>;
|
|
120
120
|
listFiles: (props: ListFilesProps) => Promise<import("./api").ListFilesResponse>;
|
|
121
121
|
getFileMetadata: (props: GetFileMetadataProps) => Promise<import("./api").GetFileMetadataResponse>;
|
|
122
122
|
getFileContent: (props: GetFileContentProps) => Promise<import("./api").GetFileContentResponse>;
|
|
123
|
-
updateFileMetadata: ({ id,
|
|
123
|
+
updateFileMetadata: ({ id, ...updateFileMetadataBody }: UpdateFileMetadataProps) => Promise<import("./api").UpdateFileMetadataResponse>;
|
|
124
124
|
searchFiles: (props: SearchFilesProps) => Promise<import("./api").SearchFilesResponse>;
|
|
125
125
|
listTables: (props: ListTablesProps) => Promise<import("./api").ListTablesResponse>;
|
|
126
126
|
getTable: (props: GetTableProps) => Promise<import("./api").GetTableResponse>;
|
package/dist/gen/common.d.ts
CHANGED
package/dist/gen/index.d.ts
CHANGED