Merge pull request #382 from ueberdosis:feature/ai-toolkit-updated-chunk-format

feat: new chunk format in ai toolkit

Author: arnaugomez

src/content/content-ai/capabilities/ai-toolkit/changelog/ai-toolkit.mdx

@@ -8,6 +8,13 @@ meta:
 
 # @tiptap-pro/ai-toolkit
 
+## 3.0.0-alpha.7
+
+### Major Changes
+
+- Improved chunk format: now it includes the range of the chunk in the document
+- Improve accuracy of `getHtmlRange`, `getJsonRange`, and `getTextRange` methods when returning the chunk index
+
 ## 3.0.0-alpha.6
 
 ### Patch Changes

src/content/content-ai/capabilities/ai-toolkit/primitives/read-the-document.mdx

@@ -210,7 +210,12 @@ Split the document into text chunks for large-content processing.
 
 ### Returns
 
-`string[]`: Array of text chunks
+`TextChunk[]`: Array of text chunks, where each chunk contains:
+
+- `content` (`string`): The text content of the chunk
+- `range` (`Range`): The range in the document where the chunk starts and ends
+  - `from` (`number`): Start position in the document
+  - `to` (`number`): End position in the document
 
 ### Example
 
@@ -231,7 +236,12 @@ Split the document into HTML chunks for large-content processing.
 
 ### Returns
 
-`string[]`: Array of HTML chunks
+`HtmlChunk[]`: Array of HTML chunks, where each chunk contains:
+
+- `content` (`string`): The HTML content of the chunk
+- `range` (`Range`): The range in the document where the chunk starts and ends
+  - `from` (`number`): Start position in the document
+  - `to` (`number`): End position in the document
 
 ### Example
 
@@ -252,7 +262,12 @@ Split the document into Tiptap JSON chunks for large-content processing.
 
 ### Returns
 
-`any[]`: Array of Tiptap JSON chunks
+`JsonChunk[]`: Array of Tiptap JSON chunks, where each chunk contains:
+
+- `content` (`any`): The Tiptap JSON content of the chunk. It is the JSON of a Fragment of the document.
+- `range` (`Range`): The range in the document where the chunk starts and ends
+  - `from` (`number`): Start position in the document
+  - `to` (`number`): End position in the document
 
 ### Example