@botpress/api 0.35.1 → 0.36.0

package/src/gen/state.ts

@@ -9956,7 +9956,7 @@ export const 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",
@@ -10003,14 +10003,18 @@ export const 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",
@@ -10061,6 +10065,109 @@ export const 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",
@@ -10962,7 +11069,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.35.1",
+    "version": "0.36.0",
     "prefix": "v1"
   },
   "errors": [
@@ -11262,6 +11369,7 @@ export const state = {
       "getFileResponse": true,
       "updateFileMetadataResponse": true,
       "searchFilesResponse": true,
+      "listFilePassagesResponse": true,
       "listTablesResponse": true,
       "getTableResponse": true,
       "getOrCreateTableResponse": true,
@@ -14046,7 +14154,8 @@ export const state = {
         "listFiles",
         "getFile",
         "updateFileMetadata",
-        "searchFiles"
+        "searchFiles",
+        "listFilePassages"
       ],
       "schema": "File"
     }