Logo

Contents

  • Installation
    • List of optional dependencies
    • Install using pip
    • Install using poetry
  • Usage
    • Chunk Size and Token Counting
    • Overlapping
    • Text Splitters
      • Prebuilt Basic Text Splitters
      • Prebuilt Sentence Text Splitters
      • Custom Text Splitters
    • Size Estimators
      • Prebuilt Size Estimators
      • Custom Size Estimators
    • Examples
  • API Reference
    • chunkipy
      • Chunk
        • Chunk.content
        • Chunk.overlap
        • Chunk.size
        • Chunk.text
        • Chunk.text_parts
      • Chunks
        • Chunks.get_all_text()
        • Chunks.get_all_text_parts()
      • Overlap
        • Overlap.size
      • TextChunker
        • TextChunker.chunk()
        • TextChunker.split_text()
      • TextPart
        • TextPart.size
        • TextPart.text
      • chunkipy.size_estimators
        • BaseSizeEstimator
        • CharSizeEstimator
        • OpenAISizeEstimator
        • WordSizeEstimator
        • chunkipy.size_estimators.base_size_estimator
        • chunkipy.size_estimators.char_size_estimator
        • chunkipy.size_estimators.openai_size_estimator
        • chunkipy.size_estimators.word_size_estimator
      • chunkipy.text_chunker
        • Chunk
        • Chunks
        • Overlap
        • TextChunker
        • TextPart
        • chunkipy.text_chunker.data_models
        • chunkipy.text_chunker.text_chunker
      • chunkipy.text_splitters
        • BaseTextSplitter
        • ColonTextSplitter
        • CommaTextSplitter
        • FullStopTextSplitter
        • NewlineTextSplitter
        • SemicolonTextSplitter
        • SeparatorTextSplitter
        • WordTextSplitter
        • chunkipy.text_splitters.base_text_splitter
        • chunkipy.text_splitters.basic_text_splitters
        • chunkipy.text_splitters.semantic
      • chunkipy.utils
        • MissingDependencyError
        • format_instructions()
        • import_dependencies()
  • Contributing
    • Development
    • Documentation
    • Testing
Chunkipy
  • Search

© Copyright 2023, Gioele Crispo.

Built with Sphinx using a theme provided by Read the Docs.
Other Versions v: v1.1.0
Releases
v1.0.0.post1
v1.0.1
v1.1.0
Branches
main