Skip to content

Commit

Permalink
updating docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
davidsbatista committed Dec 17, 2024
1 parent 71ce15b commit 3a9d290
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions haystack/components/preprocessors/recursive_splitter.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,10 @@ def __init__( # pylint: disable=too-many-positional-arguments
"""
Initializes a RecursiveDocumentSplitter.
:param split_length: The maximum length of each chunk in characters.
:param split_length: The maximum length of each chunk by default in characters, but can be in words.
See the `split_units` parameter.
:param split_overlap: The number of characters to overlap between consecutive chunks.
:param split_units: The unit of the split_length parameter. It can be either "words" or "char".
:param split_units: The unit of the split_length parameter. It can be either "word" or "char".
:param separators: An optional list of separator strings to use for splitting the text. The string
separators will be treated as regular expressions unless the separator is "sentence", in that case the
text will be split into sentences using a custom sentence tokenizer based on NLTK.
Expand Down

0 comments on commit 3a9d290

Please sign in to comment.