Overlap Refinery

Adds overlapping context (prefix or suffix) to a list of provided chunks based on specified arguments.

post/v1/refine/overlap

Request body

tokenizer_or_token_counterstring

Tokenizer identifier (e.g., 'gpt2') or 'character' for character counting.

mode'token' | 'recursive'

Mode for calculating overlap ('token' or 'recursive').

method'suffix' | 'prefix'

Method for adding context ('suffix' from next, 'prefix' from previous).

rulesobject

Recursive rules definition (object representation) if mode is 'recursive'.

mergeboolean

If true, merge context into chunk text; otherwise, store in 'context' field.

Successful Response: A list of Chunk objects with added overlap context.

textstring

The actual text content of the chunk.

start_indexinteger

The starting character index of the chunk within the original input text.

end_indexinteger

The ending character index (exclusive) of the chunk within the original input text.

token_countinteger

The number of tokens in this specific chunk, according to the tokenizer used.

contextstring nullable

Chunk context.

Changed in 1 of the 20 revisions of this API.1