@botpress/api 0.29.2 → 0.29.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/index.js +42 -42
- package/package.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +42 -42
package/src/gen/state.ts
CHANGED
|
@@ -8150,7 +8150,7 @@ export const state = {
|
|
|
8150
8150
|
"createFile": {
|
|
8151
8151
|
"name": "createFile",
|
|
8152
8152
|
"path": "/v1/files",
|
|
8153
|
-
"description": "Creates a file.",
|
|
8153
|
+
"description": "Creates a file. Once the file is created, use the uploadUrl from the response body to upload the file content, using a PUT request.",
|
|
8154
8154
|
"method": "post",
|
|
8155
8155
|
"requestBody": {
|
|
8156
8156
|
"description": "The file to upload.",
|
|
@@ -8267,18 +8267,18 @@ export const state = {
|
|
|
8267
8267
|
"status": {
|
|
8268
8268
|
"type": "string",
|
|
8269
8269
|
"enum": [
|
|
8270
|
-
"
|
|
8271
|
-
"
|
|
8272
|
-
"
|
|
8273
|
-
"
|
|
8274
|
-
"
|
|
8275
|
-
"
|
|
8270
|
+
"upload_pending",
|
|
8271
|
+
"upload_failed",
|
|
8272
|
+
"upload_completed",
|
|
8273
|
+
"indexing_pending",
|
|
8274
|
+
"indexing_failed",
|
|
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",
|
|
@@ -8428,18 +8428,18 @@ export const state = {
|
|
|
8428
8428
|
"status": {
|
|
8429
8429
|
"type": "string",
|
|
8430
8430
|
"enum": [
|
|
8431
|
-
"
|
|
8432
|
-
"
|
|
8433
|
-
"
|
|
8434
|
-
"
|
|
8435
|
-
"
|
|
8436
|
-
"
|
|
8431
|
+
"upload_pending",
|
|
8432
|
+
"upload_failed",
|
|
8433
|
+
"upload_completed",
|
|
8434
|
+
"indexing_pending",
|
|
8435
|
+
"indexing_failed",
|
|
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": [
|
|
@@ -8560,18 +8560,18 @@ export const state = {
|
|
|
8560
8560
|
"status": {
|
|
8561
8561
|
"type": "string",
|
|
8562
8562
|
"enum": [
|
|
8563
|
-
"
|
|
8564
|
-
"
|
|
8565
|
-
"
|
|
8566
|
-
"
|
|
8567
|
-
"
|
|
8568
|
-
"
|
|
8563
|
+
"upload_pending",
|
|
8564
|
+
"upload_failed",
|
|
8565
|
+
"upload_completed",
|
|
8566
|
+
"indexing_pending",
|
|
8567
|
+
"indexing_failed",
|
|
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": [
|
|
@@ -8711,18 +8711,18 @@ export const state = {
|
|
|
8711
8711
|
"status": {
|
|
8712
8712
|
"type": "string",
|
|
8713
8713
|
"enum": [
|
|
8714
|
-
"
|
|
8715
|
-
"
|
|
8716
|
-
"
|
|
8717
|
-
"
|
|
8718
|
-
"
|
|
8719
|
-
"
|
|
8714
|
+
"upload_pending",
|
|
8715
|
+
"upload_failed",
|
|
8716
|
+
"upload_completed",
|
|
8717
|
+
"indexing_pending",
|
|
8718
|
+
"indexing_failed",
|
|
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": [
|
|
@@ -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.3",
|
|
9762
9762
|
"prefix": "v1"
|
|
9763
9763
|
},
|
|
9764
9764
|
"errors": [
|
|
@@ -12275,18 +12275,18 @@ export const state = {
|
|
|
12275
12275
|
"status": {
|
|
12276
12276
|
"type": "string",
|
|
12277
12277
|
"enum": [
|
|
12278
|
-
"
|
|
12279
|
-
"
|
|
12280
|
-
"
|
|
12281
|
-
"
|
|
12282
|
-
"
|
|
12283
|
-
"
|
|
12278
|
+
"upload_pending",
|
|
12279
|
+
"upload_failed",
|
|
12280
|
+
"upload_completed",
|
|
12281
|
+
"indexing_pending",
|
|
12282
|
+
"indexing_failed",
|
|
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": [
|