@botpress/api 0.19.4 → 0.20.3

package/src/gen/state.ts

@@ -6700,6 +6700,136 @@ export const state = {
         }
       }
     },
+    "listIntegrationApiKeys": {
+      "name": "listIntegrationApiKeys",
+      "description": "List IAKs (Integration Api Keys) of an integration",
+      "method": "get",
+      "section": "integration",
+      "path": "/v1/admin/integrations/iaks",
+      "parameters": {
+        "integrationVersionId": {
+          "in": "query",
+          "description": "ID of the integration version",
+          "type": "string",
+          "required": true
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "iaks": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "createdAt": {
+                    "type": "string",
+                    "format": "date-time"
+                  },
+                  "note": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "createdAt",
+                  "note"
+                ]
+              }
+            }
+          },
+          "required": [
+            "iaks"
+          ],
+          "title": "listIntegrationApiKeysResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "createIntegrationApiKey": {
+      "name": "createIntegrationApiKey",
+      "description": "Create an IAK",
+      "method": "post",
+      "section": "integration",
+      "path": "/v1/admin/integrations/iaks",
+      "requestBody": {
+        "description": "IAK metadata",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "integrationVersionId": {
+              "type": "string"
+            },
+            "note": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "integrationVersionId"
+          ],
+          "title": "createIntegrationApiKeyBody",
+          "additionalProperties": false
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "createdAt": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "note": {
+              "type": "string"
+            },
+            "value": {
+              "type": "string",
+              "description": "The IAK value. This will only be returned here when created and cannot be retrieved later."
+            }
+          },
+          "required": [
+            "id",
+            "createdAt",
+            "note",
+            "value"
+          ],
+          "title": "createIntegrationApiKeyResponse",
+          "additionalProperties": false
+        }
+      },
+      "parameters": {}
+    },
+    "deleteIntegrationApiKey": {
+      "name": "deleteIntegrationApiKey",
+      "description": "Delete an IAK",
+      "method": "delete",
+      "section": "integration",
+      "path": "/v1/admin/integrations/iaks/{id}",
+      "parameters": {
+        "id": {
+          "type": "string",
+          "description": "ID of Integration Api Key",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "title": "deleteIntegrationApiKeyResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "createIntegration": {
       "name": "createIntegration",
       "description": "Create integration",
@@ -8109,7 +8239,7 @@ export const state = {
           "in": "header"
         },
         "x-index": {
-          "type": "string",
+          "type": "boolean",
           "description": "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.",
           "in": "header"
         },
@@ -8556,9 +8686,14 @@ export const state = {
           "description": "Query expressed in natural language to retrieve matching text passages within all files using semantical search.",
           "required": true
         },
+        "contextDepth": {
+          "in": "query",
+          "type": "integer",
+          "description": "The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage. Default: 0, Maximum: 10"
+        },
         "limit": {
           "in": "query",
-          "type": "string",
+          "type": "integer",
           "description": "The maximum number of passages to return."
         }
       },
@@ -8686,6 +8821,83 @@ export const state = {
         }
       }
     },
+    "getOrCreateTable": {
+      "name": "getOrCreateTable",
+      "path": "/v1/tables/{table}",
+      "description": "Retrieves information about a specific table if it exists; otherwise, creates a new table based on the provided schema.",
+      "parameters": {
+        "table": {
+          "type": "string",
+          "description": "The table's name or unique identifier for targeting specific table operations.",
+          "in": "path"
+        }
+      },
+      "method": "post",
+      "requestBody": {
+        "description": "Schema defining the structure of the table",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "factor": {
+              "default": 1,
+              "type": "number",
+              "minimum": 1,
+              "maximum": 30,
+              "description": "The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1."
+            },
+            "schema": {
+              "type": "object",
+              "additionalProperties": true,
+              "description": "Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed."
+            },
+            "tags": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              },
+              "description": "Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs."
+            }
+          },
+          "required": [
+            "schema"
+          ],
+          "title": "getOrCreateTableBody",
+          "additionalProperties": false
+        }
+      },
+      "section": "tables",
+      "response": {
+        "description": "The retrieved or created table object.",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "table": {
+              "$ref": "#/components/schemas/Table"
+            },
+            "created": {
+              "type": "boolean",
+              "description": "Flag indicating if the table was newly created."
+            },
+            "rows": {
+              "type": "number",
+              "description": "The total number of rows present in the table."
+            },
+            "indexingCount": {
+              "type": "number",
+              "description": "The number of rows pending indexing, relevant for search functionalities."
+            }
+          },
+          "required": [
+            "table",
+            "created",
+            "rows",
+            "indexingCount"
+          ],
+          "title": "getOrCreateTableResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "createTable": {
       "name": "createTable",
       "path": "/v1/tables",
@@ -8748,6 +8960,62 @@ export const state = {
       },
       "parameters": {}
     },
+    "duplicateTable": {
+      "name": "duplicateTable",
+      "path": "/v1/tables/{sourceTableId}/duplicate",
+      "description": "Duplicates the table schema & content",
+      "parameters": {
+        "sourceTableId": {
+          "type": "string",
+          "description": "The table's unique identifier",
+          "in": "path"
+        }
+      },
+      "method": "post",
+      "requestBody": {
+        "description": "Schema defining the structure of the new table",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "tableName": {
+              "type": "string"
+            },
+            "schemaOnly": {
+              "type": "boolean",
+              "description": "Only duplicate the schema, not the content"
+            },
+            "factor": {
+              "type": "number",
+              "description": "Use a different factor for the table. Leave empty to use the same as the duplicated table."
+            }
+          },
+          "title": "duplicateTableBody",
+          "additionalProperties": false
+        }
+      },
+      "section": "tables",
+      "response": {
+        "description": "The created table object.",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "table": {
+              "$ref": "#/components/schemas/Table"
+            },
+            "rows": {
+              "type": "number",
+              "description": "The total number of rows present in the table."
+            }
+          },
+          "required": [
+            "table",
+            "rows"
+          ],
+          "title": "duplicateTableResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "updateTable": {
       "name": "updateTable",
       "path": "/v1/tables/{table}",
@@ -9315,7 +9583,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.19.4",
+    "version": "0.20.3",
     "prefix": "v1"
   },
   "errors": [
@@ -9471,13 +9739,16 @@ export const state = {
       "changeWorkspacePlanBody": true,
       "createWorkspaceMemberBody": true,
       "updateWorkspaceMemberBody": true,
+      "createIntegrationApiKeyBody": true,
       "createIntegrationBody": true,
       "updateIntegrationBody": true,
       "changeAISpendQuotaBody": true,
       "introspectBody": true,
       "createFileBody": true,
       "updateFileMetadataBody": true,
+      "getOrCreateTableBody": true,
       "createTableBody": true,
+      "duplicateTableBody": true,
       "updateTableBody": true,
       "renameTableColumnBody": true,
       "findTableRowsBody": true,
@@ -9569,6 +9840,9 @@ export const state = {
       "deleteWorkspaceMemberResponse": true,
       "createWorkspaceMemberResponse": true,
       "updateWorkspaceMemberResponse": true,
+      "listIntegrationApiKeysResponse": true,
+      "createIntegrationApiKeyResponse": true,
+      "deleteIntegrationApiKeyResponse": true,
       "createIntegrationResponse": true,
       "updateIntegrationResponse": true,
       "listIntegrationsResponse": true,
@@ -9590,7 +9864,9 @@ export const state = {
       "searchFilesResponse": true,
       "listTablesResponse": true,
       "getTableResponse": true,
+      "getOrCreateTableResponse": true,
       "createTableResponse": true,
+      "duplicateTableResponse": true,
       "updateTableResponse": true,
       "renameTableColumnResponse": true,
       "deleteTableResponse": true,
@@ -11813,6 +12089,9 @@ export const state = {
       "description": "",
       "name": "integration",
       "operations": [
+        "listIntegrationApiKeys",
+        "createIntegrationApiKey",
+        "deleteIntegrationApiKey",
         "createIntegration",
         "updateIntegration",
         "listIntegrations",
@@ -11918,7 +12197,9 @@ export const state = {
       "operations": [
         "listTables",
         "getTable",
+        "getOrCreateTable",
         "createTable",
+        "duplicateTable",
         "updateTable",
         "renameTableColumn",
         "deleteTable",