Skip to content

Update doc for SplitRecursively about language. #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
badmonster0 merged 1 commit into from
Mar 16, 2025
Merged

Update doc for SplitRecursively about language. #148

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/docs/ops/functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ Input data:
* `text` (type: `str`, required): The text to split.
* `chunk_size` (type: `int`, required): The maximum size of each chunk, in bytes.
* `chunk_overlap` (type: `int`, optional): The maximum overlap size between adjacent chunks, in bytes.
* `language` (type: `str`, optional): The language of the document. Currently it supports `markdown`, `python` and `javascript`. If unspecified, will treat it as plain text.
* `language` (type: `str`, optional): The language of the document.
Can be a langauge name (e.g. `Python`, `Javascript`, `Markdown`) or a file extension (e.g. `.py`, `.js`, `.md`).
To see all supported language names and extensions, see [the code](https://github.com/search?q=org%3Acocoindex-io+lang%3Arust++%22static+TREE_SITTER_LANGUAGE_BY_LANG%22&type=code).
If it's unspecified or the specified language is not supported, it will be treated as plain text.

Return type: `Table`, each row represents a chunk, with the following sub fields:

Expand Down