Package org.apache.tika.inference

Class Chunk

java.lang.Object

org.apache.tika.inference.Chunk

public class Chunk
extends Object

A content chunk with multimodal locators and an optional embedding vector.

The text field holds the textual content of the chunk (may be null for non-text chunks such as image regions or audio segments).

The Locators object identifies where this chunk comes from in the original content across multiple modalities (text offsets, page/bbox, spatial regions, temporal ranges).

Constructor Summary

Constructors

Constructor	Description
Chunk(String text, int startOffset, int endOffset)	Convenience constructor for text-only chunks with character offsets.
Chunk(String text, Locators locators)

Method Summary

Modifier and Type	Method	Description
String	getCorrelator()	The id of the unit this chunk was cut from, assigned by the chunker that defined it, so chunks of one unit written by different bindings (a segment's sound and picture, a region's text and crop) can be grouped; null for a chunk that is its own unit.
int	getEndOffset()	Convenience: returns the end offset from the first TextLocator, or -1 if none.
Locators	getLocators()
Modality	getModality()	What the engine was shown for this vector; null when the writer did not say.
String	getProducer()	The inference binding that wrote this chunk; null for chunks from other sources.
int	getStartOffset()	Convenience: returns the start offset from the first TextLocator, or -1 if none.
String	getText()
float[]	getVector()
void	setCorrelator(String correlator)
void	setModality(Modality modality)
void	setProducer(String producer)
void	setVector(float[] vector)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Chunk

public Chunk(String text,
 Locators locators)

Chunk

public Chunk(String text,
 int startOffset,
 int endOffset)

Convenience constructor for text-only chunks with character offsets.

Method Details

getText

public String getText()

getLocators

public Locators getLocators()

getStartOffset

public int getStartOffset()

Convenience: returns the start offset from the first TextLocator, or -1 if none.

getEndOffset

public int getEndOffset()

Convenience: returns the end offset from the first TextLocator, or -1 if none.

getProducer

public String getProducer()

The inference binding that wrote this chunk; null for chunks from other sources.

setProducer

public void setProducer(String producer)

getModality

public Modality getModality()

What the engine was shown for this vector; null when the writer did not say.

setModality

public void setModality(Modality modality)

getCorrelator

public String getCorrelator()

The id of the unit this chunk was cut from, assigned by the chunker that defined it, so chunks of one unit written by different bindings (a segment's sound and picture, a region's text and crop) can be grouped; null for a chunk that is its own unit.

setCorrelator

public void setCorrelator(String correlator)

getVector

public float[] getVector()

setVector

public void setVector(float[] vector)