@botpress/api 0.29.3 → 0.29.5
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/index.js +17 -17
- package/package.json +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +17 -17
package/src/gen/state.ts
CHANGED
|
@@ -8167,7 +8167,7 @@ export const state = {
|
|
|
8167
8167
|
"type": "string",
|
|
8168
8168
|
"maxLength": 1000
|
|
8169
8169
|
},
|
|
8170
|
-
"description": "File tags as an object of key
|
|
8170
|
+
"description": "File tags as an object of key-value pairs. Tag values should be of `string` (text) type."
|
|
8171
8171
|
},
|
|
8172
8172
|
"size": {
|
|
8173
8173
|
"type": "number",
|
|
@@ -8274,11 +8274,11 @@ export const state = {
|
|
|
8274
8274
|
"indexing_failed",
|
|
8275
8275
|
"indexing_completed"
|
|
8276
8276
|
],
|
|
8277
|
-
"description": "Status of the file. If the status is
|
|
8277
|
+
"description": "Status of the file. If the status is `upload_pending`, the file content has not been uploaded yet. The status will be set to `upload_completed` once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to `upload_failed` and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the `indexing_pending` status (the `upload_completed` status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to `indexing_completed`. If the indexing failed the status will be set to `indexing_failed` and the reason for the failure will be available in the `failedStatusReason` field."
|
|
8278
8278
|
},
|
|
8279
8279
|
"failedStatusReason": {
|
|
8280
8280
|
"type": "string",
|
|
8281
|
-
"description": "If the file status is
|
|
8281
|
+
"description": "If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure."
|
|
8282
8282
|
},
|
|
8283
8283
|
"uploadUrl": {
|
|
8284
8284
|
"type": "string",
|
|
@@ -8347,7 +8347,7 @@ export const state = {
|
|
|
8347
8347
|
},
|
|
8348
8348
|
"tags": {
|
|
8349
8349
|
"in": "query",
|
|
8350
|
-
"description": "Filter by tags",
|
|
8350
|
+
"description": "Filter files by tags. Tags should be passed as a URL-encoded JSON object of key-value pairs that must be present in the tags of a file.",
|
|
8351
8351
|
"type": "object",
|
|
8352
8352
|
"schema": {
|
|
8353
8353
|
"type": "object",
|
|
@@ -8435,11 +8435,11 @@ export const state = {
|
|
|
8435
8435
|
"indexing_failed",
|
|
8436
8436
|
"indexing_completed"
|
|
8437
8437
|
],
|
|
8438
|
-
"description": "Status of the file. If the status is
|
|
8438
|
+
"description": "Status of the file. If the status is `upload_pending`, the file content has not been uploaded yet. The status will be set to `upload_completed` once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to `upload_failed` and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the `indexing_pending` status (the `upload_completed` status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to `indexing_completed`. If the indexing failed the status will be set to `indexing_failed` and the reason for the failure will be available in the `failedStatusReason` field."
|
|
8439
8439
|
},
|
|
8440
8440
|
"failedStatusReason": {
|
|
8441
8441
|
"type": "string",
|
|
8442
|
-
"description": "If the file status is
|
|
8442
|
+
"description": "If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure."
|
|
8443
8443
|
}
|
|
8444
8444
|
},
|
|
8445
8445
|
"required": [
|
|
@@ -8567,11 +8567,11 @@ export const state = {
|
|
|
8567
8567
|
"indexing_failed",
|
|
8568
8568
|
"indexing_completed"
|
|
8569
8569
|
],
|
|
8570
|
-
"description": "Status of the file. If the status is
|
|
8570
|
+
"description": "Status of the file. If the status is `upload_pending`, the file content has not been uploaded yet. The status will be set to `upload_completed` once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to `upload_failed` and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the `indexing_pending` status (the `upload_completed` status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to `indexing_completed`. If the indexing failed the status will be set to `indexing_failed` and the reason for the failure will be available in the `failedStatusReason` field."
|
|
8571
8571
|
},
|
|
8572
8572
|
"failedStatusReason": {
|
|
8573
8573
|
"type": "string",
|
|
8574
|
-
"description": "If the file status is
|
|
8574
|
+
"description": "If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure."
|
|
8575
8575
|
}
|
|
8576
8576
|
},
|
|
8577
8577
|
"required": [
|
|
@@ -8624,7 +8624,7 @@ export const state = {
|
|
|
8624
8624
|
"maxLength": 1000,
|
|
8625
8625
|
"nullable": true
|
|
8626
8626
|
},
|
|
8627
|
-
"description": "The file tags to update as an object of key
|
|
8627
|
+
"description": "The file 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`."
|
|
8628
8628
|
},
|
|
8629
8629
|
"accessPolicies": {
|
|
8630
8630
|
"type": "array",
|
|
@@ -8718,11 +8718,11 @@ export const state = {
|
|
|
8718
8718
|
"indexing_failed",
|
|
8719
8719
|
"indexing_completed"
|
|
8720
8720
|
],
|
|
8721
|
-
"description": "Status of the file. If the status is
|
|
8721
|
+
"description": "Status of the file. If the status is `upload_pending`, the file content has not been uploaded yet. The status will be set to `upload_completed` once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to `upload_failed` and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the `indexing_pending` status (the `upload_completed` status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to `indexing_completed`. If the indexing failed the status will be set to `indexing_failed` and the reason for the failure will be available in the `failedStatusReason` field."
|
|
8722
8722
|
},
|
|
8723
8723
|
"failedStatusReason": {
|
|
8724
8724
|
"type": "string",
|
|
8725
|
-
"description": "If the file status is
|
|
8725
|
+
"description": "If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure."
|
|
8726
8726
|
}
|
|
8727
8727
|
},
|
|
8728
8728
|
"required": [
|
|
@@ -8759,7 +8759,7 @@ export const state = {
|
|
|
8759
8759
|
"parameters": {
|
|
8760
8760
|
"tags": {
|
|
8761
8761
|
"in": "query",
|
|
8762
|
-
"description": "Filter by tags",
|
|
8762
|
+
"description": "Filter files by tags. Tags should be passed as a URL-encoded JSON object of key-value pairs that must be present in the tags of a file.",
|
|
8763
8763
|
"type": "object",
|
|
8764
8764
|
"schema": {
|
|
8765
8765
|
"type": "object",
|
|
@@ -8821,7 +8821,7 @@ export const state = {
|
|
|
8821
8821
|
"type": "string",
|
|
8822
8822
|
"maxLength": 1000
|
|
8823
8823
|
},
|
|
8824
|
-
"description": "The tags of the file as an object of key
|
|
8824
|
+
"description": "The tags of the file as an object of key-value pairs."
|
|
8825
8825
|
},
|
|
8826
8826
|
"createdAt": {
|
|
8827
8827
|
"type": "string",
|
|
@@ -9758,7 +9758,7 @@ export const state = {
|
|
|
9758
9758
|
"title": "Botpress API",
|
|
9759
9759
|
"description": "API for Botpress Cloud",
|
|
9760
9760
|
"server": "https://api.botpress.cloud",
|
|
9761
|
-
"version": "0.29.
|
|
9761
|
+
"version": "0.29.5",
|
|
9762
9762
|
"prefix": "v1"
|
|
9763
9763
|
},
|
|
9764
9764
|
"errors": [
|
|
@@ -12282,11 +12282,11 @@ export const state = {
|
|
|
12282
12282
|
"indexing_failed",
|
|
12283
12283
|
"indexing_completed"
|
|
12284
12284
|
],
|
|
12285
|
-
"description": "Status of the file. If the status is
|
|
12285
|
+
"description": "Status of the file. If the status is `upload_pending`, the file content has not been uploaded yet. The status will be set to `upload_completed` once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to `upload_failed` and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the `indexing_pending` status (the `upload_completed` status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to `indexing_completed`. If the indexing failed the status will be set to `indexing_failed` and the reason for the failure will be available in the `failedStatusReason` field."
|
|
12286
12286
|
},
|
|
12287
12287
|
"failedStatusReason": {
|
|
12288
12288
|
"type": "string",
|
|
12289
|
-
"description": "If the file status is
|
|
12289
|
+
"description": "If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure."
|
|
12290
12290
|
}
|
|
12291
12291
|
},
|
|
12292
12292
|
"required": [
|
|
@@ -12564,7 +12564,7 @@ export const state = {
|
|
|
12564
12564
|
},
|
|
12565
12565
|
{
|
|
12566
12566
|
"title": "Files",
|
|
12567
|
-
"description": "
|
|
12567
|
+
"description": "The Files API allows you to create, manage, and index files that can be used by your bots and integrations. Files can be in any text or binary format, and documents (such as PDF, Microsoft Office, HTML, CSV, etc.) can be indexed to be used for semantic search in RAG (Retrieval Augmented Generation) implementations. Files are private by default but can be made publicly accessible through a permanent URL that's unique for each file.",
|
|
12568
12568
|
"name": "files",
|
|
12569
12569
|
"operations": [
|
|
12570
12570
|
"createFile",
|