Skip to main content

ChunkSmith document Q&A agent over saved multi-indexing outlines.

Project description

chunksmith-agent

Standalone document Q&A over saved ChunkSmith index JSON (no dependency on chunksmith-core, chunksmith-multimodal, or chunksmith-pageindex).

Install

pip install chunksmith-agent
pip install "chunksmith-agent[langchain]"   # LangChain tool-calling Q&A

Usage

from pathlib import Path
from chunksmith_agent import ChunkSmithAgent
from chunksmith_agent.index_builder import build_document_index_from_saved

index = build_document_index_from_saved(
    pageindex_path=Path("runs/my-doc/json/my-doc_pageindex.json"),
)
agent = ChunkSmithAgent(index)
answer = agent.ask("What is this document about?")
print(answer.answer)

JSON artifact contract

The agent reads files produced by chunksmith-cli (or compatible tools) under a run folder:

File Fields used
json/*_pageindex.json doc_name, structure, optional embedded canonical_bundle
json/*_canonical_bundle.json elements[], coded_formate, path_image
Outline nodes node_id, title, summary, start_index/end_index, anchor fields

Environment variables

Same LLM env vars as ChunkSmith CLI / MVL:

  • OPENAI_API_KEY (or CHATGPT_API_KEY)
  • PAGEINDEX_MODEL, CHUNKSMITH_LLM_MODEL, LLM_MODEL
  • Azure: AZURE_API_KEY, AZURE_API_BASE, AZURE_API_VERSION

Integration patterns (loose coupling)

Do not depend on chunksmith-adapters inside this package. Pass data in yourself:

Caller How to load index Agent config
CLI build_document_index_from_saved(pageindex_path=...) load_settings() from .env
MVL app chunksmith_agent_bridge.load_document_index_from_mvl(repo, ...) load_settings() or explicit AgentSettings
Custom app Fetch JSON from your DB/S3 → build_document_index(dict) Your env / settings

Install separately from CLI or MVL:

pip install "chunksmith-agent[langchain]"

Extensibility

  • Outline nodes: come from saved JSON (structure); re-index or edit JSON to add sections.
  • Tools: extend _make_tools() in tool_agent.py (e.g. add get_page_images).
  • Another agent in your app: compose ChunkSmithAgent alongside your own planners/retrievers — this package is one document Q&A brain, not your whole system.

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

chunksmith_agent-0.4.0.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

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

chunksmith_agent-0.4.0-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file chunksmith_agent-0.4.0.tar.gz.

File metadata

  • Download URL: chunksmith_agent-0.4.0.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for chunksmith_agent-0.4.0.tar.gz
Algorithm Hash digest
SHA256 fdd17f5f6bf6bd664b9361b5412cb0e3d32223232449aa179c9c9e4019583f10
MD5 4adfcc2abb3bf8d8e90cc502309a75a1
BLAKE2b-256 2732d3af324d9f41b8e73635529e6d40f75d1202dcac3f419189d037e6c5ca54

See more details on using hashes here.

File details

Details for the file chunksmith_agent-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for chunksmith_agent-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 80c80dfb5c1799a419f2c8110832c151e527ed52b21f964efa620a21393df4f3
MD5 573867c035e616585feaf570b50e9028
BLAKE2b-256 02b4e39eff92ad2dcad3593d41a8cf42f2171f679c357db76ed4a81a78c785f2

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