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.6.1.tar.gz (71.5 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.6.1-py3-none-any.whl (94.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chunksmith_agent-0.6.1.tar.gz
  • Upload date:
  • Size: 71.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for chunksmith_agent-0.6.1.tar.gz
Algorithm Hash digest
SHA256 0ae3e2ee0087d7bcbab04c159960e8b5c0d9d76e85f974938f9758710f8b596d
MD5 bd8541b96a5ab32f8eafae011832edc3
BLAKE2b-256 2da1b66b7c7e75a4a50e2106b3bb6837c38230cc8739b2494d931aeff84175f0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chunksmith_agent-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 94.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for chunksmith_agent-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ca448ed08182e2162d326e46cdb63504f2747668546b79e86cde34e7c30bfe9f
MD5 a2043574fc19d618f5eae4b33b21b4c6
BLAKE2b-256 277e3689d3849869c85d7ab6782dc3581e7bbbeb00c06df702dbb9c14a6877be

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