@botpress/client 0.24.2 → 0.25.1

package/dist/index.d.ts

@@ -132,6 +132,8 @@ interface ListConversationsRequestHeaders {
 }
 interface ListConversationsRequestQuery {
     nextToken?: string;
+    sortField?: "createdAt" | "updatedAt";
+    sortDirection?: "asc" | "desc";
     tags?: {
         [k: string]: string;
     };
@@ -8109,7 +8111,7 @@ interface SearchFilesResponse {
          */
         score: number;
         /**
-         * The passage metadata
+         * The passage metadata.
          */
         meta: {
             /**
@@ -8117,19 +8119,31 @@ interface SearchFilesResponse {
              */
             type?: "chunk";
             /**
-             * The subtype of passage, if any.
+             * The subtype of passage, if available.
              */
-            subtype?: "title" | "subtitle" | "paragraph" | "list" | "note";
+            subtype?: "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | "code";
             /**
              * Page number the passage is located on. Only applicable if the passage was extracted from a PDF file.
              */
             pageNumber?: number;
+            /**
+             * 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.
+             */
+            position?: number;
         };
         file: {
             /**
              * File ID
              */
             id: string;
+            /**
+             * Unique key for the file. Must be unique across the bot (and the integration, when applicable).
+             */
+            key: string;
+            /**
+             * MIME type of the file's content
+             */
+            contentType: string;
             /**
              * The tags of the file as an object of key-value pairs.
              */
@@ -8148,6 +8162,58 @@ interface SearchFilesResponse {
     }[];
 }
 
+interface ListFilePassagesRequestHeaders {
+}
+interface ListFilePassagesRequestQuery {
+    nextToken?: string;
+    limit?: number;
+}
+interface ListFilePassagesRequestParams {
+    fileId: string;
+}
+interface ListFilePassagesRequestBody {
+}
+type ListFilePassagesInput = ListFilePassagesRequestBody & ListFilePassagesRequestHeaders & ListFilePassagesRequestQuery & ListFilePassagesRequestParams;
+interface ListFilePassagesResponse {
+    passages: {
+        /**
+         * Passage ID
+         */
+        id: string;
+        /**
+         * The content of the passage.
+         */
+        content: string;
+        /**
+         * The passage metadata.
+         */
+        meta: {
+            /**
+             * The type of passage
+             */
+            type?: "chunk";
+            /**
+             * The subtype of passage, if available.
+             */
+            subtype?: "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | "code";
+            /**
+             * Page number the passage is located on. Only applicable if the passage was extracted from a PDF file.
+             */
+            pageNumber?: number;
+            /**
+             * 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.
+             */
+            position?: number;
+        };
+    }[];
+    meta: {
+        /**
+         * 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.
+         */
+        nextToken?: string;
+    };
+}
+
 interface ListTablesRequestHeaders {
 }
 interface ListTablesRequestQuery {
@@ -8221,7 +8287,7 @@ interface ListTablesResponse {
                             /**
                              * Model to use when action is "ai"
                              */
-                            model?: "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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -8337,7 +8403,7 @@ interface GetTableResponse {
                             /**
                              * Model to use when action is "ai"
                              */
-                            model?: "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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -8489,7 +8555,7 @@ interface GetOrCreateTableResponse {
                             /**
                              * Model to use when action is "ai"
                              */
-                            model?: "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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -8648,7 +8714,7 @@ interface CreateTableResponse {
                             /**
                              * Model to use when action is "ai"
                              */
-                            model?: "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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -8773,7 +8839,7 @@ interface DuplicateTableResponse {
                             /**
                              * Model to use when action is "ai"
                              */
-                            model?: "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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -8917,7 +8983,7 @@ interface UpdateTableResponse {
                             /**
                              * Model to use when action is "ai"
                              */
-                            model?: "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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -9045,7 +9111,7 @@ interface RenameTableColumnResponse {
                             /**
                              * Model to use when action is "ai"
                              */
-                            model?: "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";
+                            model?: string;
                             /**
                              * ID of Workflow to execute when action is "workflow"
                              */
@@ -10492,7 +10558,7 @@ interface Table {
                         /**
                          * Model to use when action is "ai"
                          */
-                        model?: "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";
+                        model?: string;
                         /**
                          * ID of Workflow to execute when action is "workflow"
                          */
@@ -10570,7 +10636,7 @@ interface Column {
         /**
          * Model to use when action is "ai"
          */
-        model?: "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";
+        model?: string;
         /**
          * ID of Workflow to execute when action is "workflow"
          */
@@ -10800,6 +10866,7 @@ declare class Client$1 {
     readonly getFile: (input: GetFileInput) => Promise<GetFileResponse>;
     readonly updateFileMetadata: (input: UpdateFileMetadataInput) => Promise<UpdateFileMetadataResponse>;
     readonly searchFiles: (input: SearchFilesInput) => Promise<SearchFilesResponse>;
+    readonly listFilePassages: (input: ListFilePassagesInput) => Promise<ListFilePassagesResponse>;
     readonly listTables: (input: ListTablesInput) => Promise<ListTablesResponse>;
     readonly getTable: (input: GetTableInput) => Promise<GetTableResponse>;
     readonly getOrCreateTable: (input: GetOrCreateTableInput) => Promise<GetOrCreateTableResponse>;