@botpress/api 0.35.0 → 0.36.0

package/dist/index.js

@@ -274862,7 +274862,7 @@ var state = {
         "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"
+          "description": "The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage (default: 1, minimum: 0, maximum: 10)."
         },
         "limit": {
           "in": "query",
@@ -274909,14 +274909,18 @@ var state = {
                           "table",
                           "code"
                         ],
-                        "description": "The subtype of passage, if any."
+                        "description": "The subtype of passage, if available."
                       },
                       "pageNumber": {
                         "type": "integer",
                         "description": "Page number the passage is located on. Only applicable if the passage was extracted from a PDF file."
+                      },
+                      "position": {
+                        "type": "integer",
+                        "description": "Position number of the passage in the file relative to the other passages, if available. Can be used to know the order of passages within a file."
                       }
                     },
-                    "description": "The passage metadata"
+                    "description": "The passage metadata."
                   },
                   "file": {
                     "type": "object",
@@ -274967,6 +274971,109 @@ var state = {
         }
       }
     },
+    "listFilePassages": {
+      "name": "listFilePassages",
+      "path": "/v1/files/{fileId}/passages",
+      "description": "List passages for a file",
+      "method": "get",
+      "section": "files",
+      "parameters": {
+        "nextToken": {
+          "in": "query",
+          "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
+          "type": "string"
+        },
+        "limit": {
+          "type": "number",
+          "description": "The maximum number of passages to return per request (optional, default: 20, max: 200).",
+          "in": "query"
+        },
+        "fileId": {
+          "type": "string",
+          "description": "File ID",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Returns the list of passages extracted from a file.",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "passages": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "description": "Passage ID"
+                  },
+                  "content": {
+                    "type": "string",
+                    "description": "The content of the passage."
+                  },
+                  "meta": {
+                    "type": "object",
+                    "properties": {
+                      "type": {
+                        "type": "string",
+                        "enum": [
+                          "chunk"
+                        ],
+                        "description": "The type of passage"
+                      },
+                      "subtype": {
+                        "type": "string",
+                        "enum": [
+                          "title",
+                          "subtitle",
+                          "paragraph",
+                          "list",
+                          "blockquote",
+                          "table",
+                          "code"
+                        ],
+                        "description": "The subtype of passage, if available."
+                      },
+                      "pageNumber": {
+                        "type": "integer",
+                        "description": "Page number the passage is located on. Only applicable if the passage was extracted from a PDF file."
+                      },
+                      "position": {
+                        "type": "integer",
+                        "description": "Position number of the passage in the file relative to the other passages, if available. Can be used to know the order of passages within a file."
+                      }
+                    },
+                    "description": "The passage metadata."
+                  }
+                },
+                "required": [
+                  "id",
+                  "content",
+                  "meta"
+                ]
+              }
+            },
+            "meta": {
+              "type": "object",
+              "properties": {
+                "nextToken": {
+                  "type": "string",
+                  "description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "passages",
+            "meta"
+          ],
+          "title": "listFilePassagesResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listTables": {
       "name": "listTables",
       "path": "/v1/tables",
@@ -275868,7 +275975,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.35.0",
+    "version": "0.36.0",
     "prefix": "v1"
   },
   "errors": [
@@ -276168,6 +276275,7 @@ var state = {
       "getFileResponse": true,
       "updateFileMetadataResponse": true,
       "searchFilesResponse": true,
+      "listFilePassagesResponse": true,
       "listTablesResponse": true,
       "getTableResponse": true,
       "getOrCreateTableResponse": true,
@@ -278323,21 +278431,12 @@ var state = {
                             "model": {
                               "default": "gpt-4o",
                               "type": "string",
-                              "enum": [
-                                "gpt-3.5-turbo",
-                                "gpt-3.5-turbo-0125",
-                                "gpt-3.5-turbo-1106",
-                                "gpt-3.5-turbo-16k",
-                                "gpt-4o",
-                                "gpt-4",
-                                "gpt-4-turbo",
-                                "gpt-4-0125-preview",
-                                "gpt-4-1106-preview"
-                              ],
+                              "maxLength": 80,
                               "description": 'Model to use when action is "ai"'
                             },
                             "workflowId": {
                               "type": "string",
+                              "maxLength": 20,
                               "description": 'ID of Workflow to execute when action is "workflow"'
                             },
                             "enabled": {
@@ -278489,21 +278588,12 @@ var state = {
               "model": {
                 "default": "gpt-4o",
                 "type": "string",
-                "enum": [
-                  "gpt-3.5-turbo",
-                  "gpt-3.5-turbo-0125",
-                  "gpt-3.5-turbo-1106",
-                  "gpt-3.5-turbo-16k",
-                  "gpt-4o",
-                  "gpt-4",
-                  "gpt-4-turbo",
-                  "gpt-4-0125-preview",
-                  "gpt-4-1106-preview"
-                ],
+                "maxLength": 80,
                 "description": 'Model to use when action is "ai"'
               },
               "workflowId": {
                 "type": "string",
+                "maxLength": 20,
                 "description": 'ID of Workflow to execute when action is "workflow"'
               },
               "enabled": {
@@ -278970,7 +279060,8 @@ var state = {
         "listFiles",
         "getFile",
         "updateFileMetadata",
-        "searchFiles"
+        "searchFiles",
+        "listFilePassages"
       ],
       "schema": "File"
     }

package/dist/src/gen/state.d.ts

@@ -8773,6 +8773,10 @@ export declare const state: {
                                                 type: "integer";
                                                 description: string;
                                             };
+                                            position: {
+                                                type: "integer";
+                                                description: string;
+                                            };
                                         };
                                         description: string;
                                     };
@@ -8813,6 +8817,92 @@ export declare const state: {
                 };
             };
         };
+        listFilePassages: {
+            name: string;
+            path: string;
+            description: string;
+            method: "get";
+            section: "files";
+            parameters: {
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                };
+                limit: {
+                    type: "number";
+                    description: string;
+                    in: "query";
+                };
+                fileId: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        passages: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                        description: string;
+                                    };
+                                    content: {
+                                        type: "string";
+                                        description: string;
+                                    };
+                                    meta: {
+                                        type: "object";
+                                        properties: {
+                                            type: {
+                                                type: "string";
+                                                enum: string[];
+                                                description: string;
+                                            };
+                                            subtype: {
+                                                type: "string";
+                                                enum: string[];
+                                                description: string;
+                                            };
+                                            pageNumber: {
+                                                type: "integer";
+                                                description: string;
+                                            };
+                                            position: {
+                                                type: "integer";
+                                                description: string;
+                                            };
+                                        };
+                                        description: string;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                        meta: {
+                            type: "object";
+                            properties: {
+                                nextToken: {
+                                    type: "string";
+                                    description: string;
+                                };
+                            };
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         listTables: {
             name: string;
             path: string;
@@ -9880,6 +9970,7 @@ export declare const state: {
             getFileResponse: true;
             updateFileMetadataResponse: true;
             searchFilesResponse: true;
+            listFilePassagesResponse: true;
             listTablesResponse: true;
             getTableResponse: true;
             getOrCreateTableResponse: true;
@@ -11673,11 +11764,12 @@ export declare const state: {
                                                         model: {
                                                             default: string;
                                                             type: "string";
-                                                            enum: string[];
+                                                            maxLength: number;
                                                             description: string;
                                                         };
                                                         workflowId: {
                                                             type: "string";
+                                                            maxLength: number;
                                                             description: string;
                                                         };
                                                         enabled: {
@@ -11800,11 +11892,12 @@ export declare const state: {
                             model: {
                                 default: string;
                                 type: "string";
-                                enum: string[];
+                                maxLength: number;
                                 description: string;
                             };
                             workflowId: {
                                 type: "string";
+                                maxLength: number;
                                 description: string;
                             };
                             enabled: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.35.0",
+  "version": "0.36.0",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {

package/src/gen/metadata.json

@@ -1 +1 @@
-{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":[]},{"description":"","title":"State","name":"state","operations":["getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents","listBotVersions","getBotVersion","createBotVersion","deployBotVersion"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Interface","description":"","name":"interface","operations":["createInterface","getInterface","getInterfaceByName","updateInterface","deleteInterface","listInterfaces"],"schema":"Interface"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","listPublicWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","getWorkspaceMember","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage","getMultipleUsages"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","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 Word, HTML, Markdown, 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.","name":"files","operations":["upsertFile","deleteFile","listFiles","getFile","updateFileMetadata","searchFiles"],"schema":"File"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren't linked together."},{"status":409,"type":"ReferenceConstraint","description":"The resource cannot be deleted because it's referenced by another resource"},{"status":409,"type":"ResourceLockedConflict","description":"The resource is current locked and cannot be operated on until the lock is released."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."},{"status":400,"type":"BreakingChanges","description":"Request payload contains breaking changes which is not allowed for this resource without a version increment."}]}
+{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":[]},{"description":"","title":"State","name":"state","operations":["getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","getBotIssue","listBotIssues","deleteBotIssue","listBotIssueEvents","listBotVersions","getBotVersion","createBotVersion","deployBotVersion"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Interface","description":"","name":"interface","operations":["createInterface","getInterface","getInterfaceByName","updateInterface","deleteInterface","listInterfaces"],"schema":"Interface"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","listPublicWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","getWorkspaceMember","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage","getMultipleUsages"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","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 Word, HTML, Markdown, 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.","name":"files","operations":["upsertFile","deleteFile","listFiles","getFile","updateFileMetadata","searchFiles","listFilePassages"],"schema":"File"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren't linked together."},{"status":409,"type":"ReferenceConstraint","description":"The resource cannot be deleted because it's referenced by another resource"},{"status":409,"type":"ResourceLockedConflict","description":"The resource is current locked and cannot be operated on until the lock is released."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."},{"status":400,"type":"BreakingChanges","description":"Request payload contains breaking changes which is not allowed for this resource without a version increment."}]}