JChunk

A Java Library for Text Chunking

JChunk project is simple library that enables different types of text splitting strategies, essential for RAG applications.

Docs

Chunkers

• Fixed Chunker
• Recursive Character Chunker
• Semantic Chunker

More

• Jchunk Documentation

Installing

Maven

<dependency>
    <groupId>io.jchunk</groupId>
    <artifactId>jchunk-...</artifactId> <!-- replace dots with desired module name -->
    <version>${jchunk.version}</version>
</dependency>

Gradle

implementation group: 'io.jchunk', name: 'jchunk-...', version: "${JCHUNK_VERSION}" // replace dots with desired module name

Building

To build with tests

./mvnw clean verify -Dgpg.skip=true

To reformat using the java-format plugin

./mvnw spotless:apply

To check javadocs using the javadoc:javadoc

./mvnw javadoc:javadoc -Pjavadoc

Building the docs locally

You can build and preview the Antora documentation locally without installing anything globally.

Prerequisites:

• Node.js 18+ (20 recommended).
  • Download from https://nodejs.org/

Build the site:

npx -y -p @antora/cli@3.1 -p @antora/site-generator@3.1 antora -r @antora/site-generator antora-playbook.yml

Open the generated site:

• build/site/index.html

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.