Skip to main content

A semantic and legal text chunker based on LLM analysis

Project description

๐Ÿ”ช LLM Chunker

LLM ๊ธฐ๋ฐ˜ ์˜๋ฏธ๋ก ์  ํ…์ŠคํŠธ ๋ถ„ํ•  ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ

PyPI version License: MIT Python 3.8+

๊ธ€์ž ์ˆ˜๊ฐ€ ์•„๋‹Œ ์˜๋ฏธ ๋‹จ์œ„๋กœ ๋ฌธ์„œ๋ฅผ ๋ถ„ํ• ํ•ฉ๋‹ˆ๋‹ค.

์„ค์น˜ โ€ข ๋น ๋ฅธ ์‹œ์ž‘ โ€ข ์˜ˆ์ œ โ€ข API ๋ ˆํผ๋Ÿฐ์Šค โ€ข English


โœจ ์™œ LLM Chunker์ธ๊ฐ€?

๊ธฐ์กด ์ฒญ์ปค๋Š” ๊ธ€์ž ์ˆ˜๋‚˜ ์ •๊ทœ์‹์œผ๋กœ ํ…์ŠคํŠธ๋ฅผ ๋ถ„ํ• ํ•ด์„œ, ๋ฌธ์žฅ ์ค‘๊ฐ„์—์„œ ์ž˜๋ฆฌ๋Š” ๊ฒฝ์šฐ๊ฐ€ ๋งŽ์Šต๋‹ˆ๋‹ค. LLM Chunker๋Š” ๋งฅ๋ฝ์„ ์ดํ•ดํ•ฉ๋‹ˆ๋‹คโ€”์†Œ์„ค์˜ ๊ฐ์ • ๋ณ€ํ™”, ๋ฒ•๋ฅ  ๋ฌธ์„œ์˜ ์กฐํ•ญ ๊ฒฝ๊ณ„, ํŒŸ์บ์ŠคํŠธ์˜ ์ฃผ์ œ ์ „ํ™˜์„ ๊ฐ์ง€ํ•ฉ๋‹ˆ๋‹ค.

๊ธฐ์กด ์ฒญํ‚น LLM Chunker
๊ธ€์ž ์ˆ˜๋กœ ๋ถ„ํ•  ์˜๋ฏธ ๋‹จ์œ„๋กœ ๋ถ„ํ• 
๋ฌธ์žฅ ์ค‘๊ฐ„์—์„œ ์ž˜๋ฆผ ์™„์ „ํ•œ ๋ฌธ๋งฅ ๋ณด์กด
์ผ๋ฅ ์ ์ธ ๋ฐฉ์‹ ๋„๋ฉ”์ธ ๋งž์ถค ํ”„๋กฌํ”„ํŠธ

๐Ÿ“ฆ ์„ค์น˜

pip install llm-chunker

์š”๊ตฌ์‚ฌํ•ญ:

  • Python 3.8+
  • OpenAI API ํ‚ค (๋˜๋Š” ๋กœ์ปฌ LLM์šฉ Ollama)

๐Ÿš€ ๋น ๋ฅธ ์‹œ์ž‘

from llm_chunker import GenericChunker

import os
os.environ["OPENAI_API_KEY"] = "sk-..."

chunker = GenericChunker()
chunks = chunker.split_text(your_text)

for i, chunk in enumerate(chunks):
    print(f"[์ฒญํฌ {i+1}] {chunk[:100]}...")

๐Ÿ“– ์˜ˆ์ œ

๋ชจ๋ธ ์„ ํƒํ•˜๊ธฐ

from llm_chunker import GenericChunker
from llm_chunker.analyzer import TransitionAnalyzer, create_openai_caller
from llm_chunker.prompts import get_default_prompt

# ๋ฐฉ๋ฒ• 1: model ํŒŒ๋ผ๋ฏธํ„ฐ๋กœ ์ง์ ‘ ์ง€์ •
analyzer = TransitionAnalyzer(
    prompt_generator=get_default_prompt,
    model="gpt-4o"  # ๋˜๋Š” "gpt-5-nano", "gpt-3.5-turbo"
)

# ๋ฐฉ๋ฒ• 2: ํŒฉํ† ๋ฆฌ ํ•จ์ˆ˜ ์‚ฌ์šฉ
analyzer = TransitionAnalyzer(
    prompt_generator=get_default_prompt,
    llm_caller=create_openai_caller("gpt-4o-mini")
)

chunker = GenericChunker(analyzer=analyzer)

๋ฒ•๋ฅ  ๋ฌธ์„œ ์ฒญํ‚น

from llm_chunker import GenericChunker
from llm_chunker.analyzer import TransitionAnalyzer
from llm_chunker.prompts import get_legal_prompt

analyzer = TransitionAnalyzer(
    prompt_generator=get_legal_prompt,
    model="gpt-4o"
)

chunker = GenericChunker(
    analyzer=analyzer,
    significance_threshold=6,  # ๋‚ฎ์„์ˆ˜๋ก ๋” ๋งŽ์ด ๋ถ„ํ• 
    min_chunk_gap=500          # ์ฒญํฌ ๊ฐ„ ์ตœ์†Œ ๊ฑฐ๋ฆฌ (๊ธ€์ž์ˆ˜)
)

chunks = chunker.split_text(legal_document)

๋กœ์ปฌ LLM ์‚ฌ์šฉ (Ollama)

from llm_chunker import GenericChunker
from llm_chunker.analyzer import TransitionAnalyzer, create_ollama_caller

analyzer = TransitionAnalyzer(
    prompt_generator=get_default_prompt,
    llm_caller=create_ollama_caller("llama3")  # ๋˜๋Š” "mistral", "codellama"
)

chunker = GenericChunker(analyzer=analyzer)

์ปค์Šคํ…€ ํ”„๋กฌํ”„ํŠธ (PromptBuilder)

PromptBuilder๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด ํ•จ์ˆ˜๋ฅผ ์ง์ ‘ ์ž‘์„ฑํ•˜์ง€ ์•Š๊ณ ๋„ ์ปค์Šคํ…€ ํ”„๋กฌํ”„ํŠธ๋ฅผ ์‰ฝ๊ฒŒ ๋งŒ๋“ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค:

from llm_chunker import GenericChunker, TransitionAnalyzer, PromptBuilder

# ๋ฐฉ๋ฒ• 1: ๋ฏธ๋ฆฌ ๋งŒ๋“ค์–ด์ง„ ํ”„๋ฆฌ์…‹ ์‚ฌ์šฉ
prompt = PromptBuilder.podcast(language="ko")
chunker = GenericChunker(analyzer=TransitionAnalyzer(prompt_generator=prompt))

# ๋ฐฉ๋ฒ• 2: ์ปค์Šคํ…€ ์˜ต์…˜์œผ๋กœ ์ƒ์„ฑ
prompt = PromptBuilder.create(
    domain="novel",           # podcast, novel, legal, news, meeting etc..
    find="speaker changes",   # topic changes, emotional shifts, scene changes
    language="ko",
    extra_fields=["speaker_name"]
)

์‚ฌ์šฉ ๊ฐ€๋Šฅํ•œ ํ”„๋ฆฌ์…‹:

๋ฉ”์„œ๋“œ ์šฉ๋„
PromptBuilder.podcast() ํŒŸ์บ์ŠคํŠธ ์ฃผ์ œ ๋ณ€๊ฒฝ
PromptBuilder.novel_speaker() ์†Œ์„ค ํ™”์ž ๋ณ€๊ฒฝ
PromptBuilder.novel_scene() ์†Œ์„ค ์žฅ๋ฉด ์ „ํ™˜
PromptBuilder.meeting() ํšŒ์˜๋ก ์•ˆ๊ฑด ๋ณ€๊ฒฝ

๐Ÿ“š API ๋ ˆํผ๋Ÿฐ์Šค

GenericChunker

ํŒŒ๋ผ๋ฏธํ„ฐ ํƒ€์ž… ๊ธฐ๋ณธ๊ฐ’ ์„ค๋ช…
analyzer TransitionAnalyzer None ์ปค์Šคํ…€ ๋ถ„์„๊ธฐ
significance_threshold int 7 ์ตœ์†Œ ์ค‘์š”๋„ ์ ์ˆ˜ (1-10)
min_chunk_gap int 200 ๋ถ„ํ•  ์ง€์  ๊ฐ„ ์ตœ์†Œ ๊ฑฐ๋ฆฌ
max_chunk_size int 5000 ํด๋ฐฑ ์ฒญํฌ ํฌ๊ธฐ
verbose bool False ์ƒ์„ธ ๋กœ๊ทธ ์ถœ๋ ฅ

TransitionAnalyzer

ํŒŒ๋ผ๋ฏธํ„ฐ ํƒ€์ž… ๊ธฐ๋ณธ๊ฐ’ ์„ค๋ช…
prompt_generator Callable ํ•„์ˆ˜ LLM ํ”„๋กฌํ”„ํŠธ ์ƒ์„ฑ ํ•จ์ˆ˜
model str None OpenAI ๋ชจ๋ธ๋ช…
llm_caller Callable None ์ปค์Šคํ…€ LLM ํ˜ธ์ถœ ํ•จ์ˆ˜

ํŒฉํ† ๋ฆฌ ํ•จ์ˆ˜

# OpenAI
create_openai_caller(model="gpt-4o") -> Callable

# Ollama (๋กœ์ปฌ)
create_ollama_caller(model="llama3") -> Callable

๐Ÿ—๏ธ ์ž‘๋™ ์›๋ฆฌ

โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚                      ๊ธด ํ…์ŠคํŠธ ์ž…๋ ฅ                          โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                            โ”‚
                            โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚ 1. ๋ถ„ํ•       LLM ์ปจํ…์ŠคํŠธ ํฌ๊ธฐ์— ๋งž๊ฒŒ ์œˆ๋„์šฐ ๋ถ„ํ•  (~2600์ž)   โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                            โ”‚
                            โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚ 2. ๋ถ„์„      LLM์ด ์ „ํ™˜์  ๊ฐ์ง€                               โ”‚
โ”‚              "์—ฌ๊ธฐ์„œ ๊ธฐ์จ์—์„œ ์Šฌํ””์œผ๋กœ ๊ฐ์ •์ด ๋ฐ”๋€œ"           โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                            โ”‚
                            โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚ 3. ํ•„ํ„ฐ๋ง    ๋‚ฎ์€ ์ค‘์š”๋„ & ์ค‘๋ณต ํฌ์ธํŠธ ์ œ๊ฑฐ                   โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                            โ”‚
                            โ–ผ
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
โ”‚ 4. ์Šฌ๋ผ์ด์‹ฑ  ๊ฒ€์ฆ๋œ ์ „ํ™˜์ ์—์„œ ํ…์ŠคํŠธ ๋ถ„ํ•                     โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                            โ”‚
                            โ–ผ
               [์ฒญํฌ 1] [์ฒญํฌ 2] [์ฒญํฌ 3] ...

๐Ÿ“„ ๋ผ์ด์„ ์Šค

MIT License - LICENSE ์ฐธ์กฐ


โญ Star History

Star History Chart

๋” ๋‚˜์€ RAG ํŒŒ์ดํ”„๋ผ์ธ์„ ์œ„ํ•ด โค๏ธ

์œ ์šฉํ•˜์…จ๋‹ค๋ฉด โญ ์Šคํƒ€๋ฅผ ๋ˆŒ๋Ÿฌ์ฃผ์„ธ์š”!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

llm_chunker-0.1.2.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llm_chunker-0.1.2-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file llm_chunker-0.1.2.tar.gz.

File metadata

  • Download URL: llm_chunker-0.1.2.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for llm_chunker-0.1.2.tar.gz
Algorithm Hash digest
SHA256 453a193e937d7db6415a04427726211449bff46428bfea5c4eaa75471f3da866
MD5 3fe347be6c30cefccb8d15f89cd1abeb
BLAKE2b-256 c8af1579db6b891ffb3b35440974336c06d7fc15fb8e5d22265f26debdbf68c6

See more details on using hashes here.

File details

Details for the file llm_chunker-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: llm_chunker-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for llm_chunker-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 44df0a591b375d89030ecf9c4a4747705a73b93ef2a06ac7171cc1c61771cb86
MD5 0a2fb3e7ed526738f0b31eebae4479e0
BLAKE2b-256 5f57cf691e3851f66df2fb89d90532f8a149b75d7309902af7832232125c27b3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page