Skip to main content

RecursiveCharacterChunkModel

ChunkingModel
DashAI.back.models.RAG.chunking_models.RecursiveCharacterChunkModel

Chunking model that recursively splits text using a prioritized list of separators.

Falls back to character-level splitting when no separator fits within the chunk size.

Parameters​

chunk_size : integer, default=1000
Size of each chunk in characters.
chunk_overlap : integer, default=100
Number of characters to overlap between chunks. Must be less than chunk_size.
separators : array, default=['\n\n', '\n', '.', ' ', '']
Ordered list of separators to use for splitting.

Methods​

chunk_text(self, text: str) -> List[str]

Defined on RecursiveCharacterChunkModel

Split text into chunks using recursive separator-based splitting.

chunk(self, document: DashAI.back.dataloaders.classes.dashai_document.DashAIDocument) -> DashAI.back.dataloaders.classes.dashai_document.DashAIDocument

Defined on BaseChunkingModel

Split the text items of a document into a chunked document.

Parameters

document : DashAIDocument
The parsed source document.

Returns

DashAIDocument
One Text item of kind "chunk" per chunk, with page set to the first covered page and attrs holding pages (first and last page) and sources (positions of the covered items).

get_credential(self, name: str)

Defined on ConfigObject

Resolve a registered credential component by name.

Parameters

name : str
Credential component class name (e.g. "HuggingFaceCredential").

Returns

BaseCredential
An instance of the requested credential component.

get_schema(cls) -> dict

Defined on ConfigObject

Generates the component related Json Schema.

Returns

dict
Dictionary representing the Json Schema of the component.

validate_and_transform(self, raw_data: dict) -> dict

Defined on ConfigObject

It takes the data given by the user to initialize the model and returns it with all the objects that the model needs to work.

Parameters

raw_data : dict
A dictionary with the data provided by the user to initialize the model.

Returns

dict
A validated dictionary with the necessary objects.