Logo
Type aliases

CharacterSplitter

CharacterSplitter = object

Defined in: packages/cloud/src/client/types.gen.ts:590

A splitter that splits text into characters.

Properties

include_metadata?

optional include_metadata: boolean

Defined in: packages/cloud/src/client/types.gen.ts:594

Whether or not to consider metadata when splitting.


include_prev_next_rel?

optional include_prev_next_rel: boolean

Defined in: packages/cloud/src/client/types.gen.ts:598

Include prev/next node relationships.


callback_manager?

optional callback_manager: unknown

Defined in: packages/cloud/src/client/types.gen.ts:599


id_func?

optional id_func: string | null

Defined in: packages/cloud/src/client/types.gen.ts:603

Function to generate node IDs.


chunk_size?

optional chunk_size: number

Defined in: packages/cloud/src/client/types.gen.ts:607

The token chunk size for each chunk.


chunk_overlap?

optional chunk_overlap: number

Defined in: packages/cloud/src/client/types.gen.ts:611

The token overlap of each chunk when splitting.


separator?

optional separator: string

Defined in: packages/cloud/src/client/types.gen.ts:615

Default separator for splitting into words


paragraph_separator?

optional paragraph_separator: string

Defined in: packages/cloud/src/client/types.gen.ts:619

Separator between paragraphs.


secondary_chunking_regex?

optional secondary_chunking_regex: string | null

Defined in: packages/cloud/src/client/types.gen.ts:623

Backup regex for splitting into sentences.


class_name?

optional class_name: string

Defined in: packages/cloud/src/client/types.gen.ts:624

On this page