add missing params to file upload

cheshire-cat-ai · Oct 15, 2024 · d4e7ee8 · d4e7ee8
1 parent 0d9712f
commit d4e7ee8
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 0 deletions.
diff --git a/.changeset/six-steaks-greet.md b/.changeset/six-steaks-greet.md
@@ -0,0 +1,5 @@
+---
+"ccat-api": patch
+---
+
+add missing params to file upload
diff --git a/api/models/BodyUploadFile.ts b/api/models/BodyUploadFile.ts
@@ -4,5 +4,17 @@
 /* eslint-disable */
 export type BodyUploadFile = {
     file: Blob;
+    /**
+     * Maximum length of each chunk after the document is split (in tokens)
+     */
+    chunk_size?: (number | null);
+    /**
+     * Chunk overlap (in tokens)
+     */
+    chunk_overlap?: (number | null);
+    /**
+     * Metadata to be stored with each chunk (e.g. author, category, etc.). Since we are passing this along side form data, must be a JSON string.
+     */
+    metadata?: string;
 };
 
diff --git a/catapi.json b/catapi.json
@@ -2099,6 +2099,36 @@
                         "title": "File",
                         "type": "string",
                         "format": "binary"
+                    },
+                    "chunk_size": {
+                        "anyOf": [
+                            {
+                                "type": "integer"
+                            },
+                            {
+                                "type": "null"
+                            }
+                        ],
+                        "title": "Chunk Size",
+                        "description": "Maximum length of each chunk after the document is split (in tokens)"
+                    },
+                    "chunk_overlap": {
+                        "anyOf": [
+                            {
+                                "type": "integer"
+                            },
+                            {
+                                "type": "null"
+                            }
+                        ],
+                        "title": "Chunk Overlap",
+                        "description": "Chunk overlap (in tokens)"
+                    },
+                    "metadata": {
+                        "type": "string",
+                        "title": "Metadata",
+                        "description": "Metadata to be stored with each chunk (e.g. author, category, etc.). Since we are passing this along side form data, must be a JSON string.",
+                        "default": "{}"
                     }
                 }
             },