ChunkerProtocol#

class scikitplot.corpus.ChunkerProtocol(*args, **kwargs)[source]#

Structural interface every chunker must satisfy.

Any class that implements chunk and chunk_batch with the correct signatures is considered a valid chunker, regardless of inheritance.

Notes

runtime_checkable enables isinstance(obj, ChunkerProtocol) in pipeline validation and registry lookups.

chunk(text, doc_id=None, extra_metadata=None)[source]#

Split a single document into chunks.

Parameters:

textstr

Raw document text.

doc_idstr, optional

Document identifier propagated into chunk metadata.

extra_metadataMetadataDict, optional

Extra key/value pairs merged into the result metadata.

Returns:

ChunkResult

Parameters:

• text (str)

• doc_id (str | None)

• extra_metadata (dict[str, Any] | None)

Return type:

ChunkResult

chunk_batch(texts, doc_ids=None, extra_metadata=None)[source]#

Split a list of documents into chunks.

Parameters:

textslist[str]

Input documents.

doc_idslist[str], optional

Parallel document identifiers.

extra_metadataMetadataDict, optional

Shared extra metadata for every result.

Returns:

list[ChunkResult]

Parameters:

• texts (list[str])

• doc_ids (list[str] | None)

• extra_metadata (dict[str, Any] | None)

Return type:

list[ChunkResult]