Download the PHP package nuglif/chunkytown without Composer

On this page you can find all versions of the php package nuglif/chunkytown. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package chunkytown

ChunkyTown (PHP)

Text chunker for French RAG pipelines. Splits a document into overlapping spans that respect natural boundaries (paragraphs, lists, sentences, words) instead of cutting in the middle of a sentence — and never inside a composed emoji or accented grapheme.

Built on PHP's intl extension (ICU), with a French‑tuned abbreviation filter so common shortcuts (M. Dupont, St. Patrick, cf., etc.) are not mistaken for sentence ends.

Installation

Requires PHP 8.1+ with the intl and mbstring extensions.

Quick start

Reusable analysis (multi‑config runs)

If you chunk the same text under several configs (tuning, A/B sweeps), pre‑compute the boundary detection once with analyze():

Configuration

ChunkerConfig is an immutable value object:

Option Default Meaning
chunkSize 300 Target chunk length in grapheme clusters (user‑perceived characters).
window 50 ± window around the target end to snap to a boundary.
preferOrder ['paragraph', 'list', 'sentence', 'word'] Boundary kinds tried in order when snapping.
overlap 0 Desired overlap (graphemes) between successive chunks.
overlapWindow null (falls back to window) ± window used when locating the start of the next chunk.
normalize false Normalize the input to Unicode NFC before analysis (use for mixed NFC/NFD).

External boundaries

If you already have sentence/paragraph offsets from another parser, merge them in (offsets are in graphemes):

Offsets and slicing

All offsets returned by the chunker are grapheme cluster offsets (emojis with ZWJ, regional‑indicator flags, skin‑tone modifiers and NFD‑decomposed accents all count as a single unit). Slice safely with Chunker::render(), which preserves grapheme integrity for you.

What's special

Testing

The suite covers the grapheme mapper, every boundary detector, ChunkerConfig, TextAnalysis, and end‑to‑end chunking — including parity with the upstream Python implementation on a French fixture.

License

MIT


All versions of chunkytown with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
ext-intl Version *
ext-mbstring Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package nuglif/chunkytown contains the following files

Loading the files please wait ...