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.6.tar.gz (77.2 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.6-py3-none-any.whl (99.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chunksmith_agent-0.6.6.tar.gz
  • Upload date:
  • Size: 77.2 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.6.6.tar.gz
Algorithm Hash digest
SHA256 5a3348a5401ec4ee0bb6180d8fc0f43f5bece7aef23c57ea40e0b8ba247e4841
MD5 b55b832cfd162b2677e7d9413feb9561
BLAKE2b-256 4e4c60028167ef91f5243683a1c69c83c677081029f47055a439ec323f4e9040

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chunksmith_agent-0.6.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0ea7b325c8f78566835c67fb9d840359c8b29a176e340994bb8f64b918e009d8
MD5 390c0b44ff20d3b1e1e335d3ea8e7f60
BLAKE2b-256 9927c435d0a474100d6a39ffc414dfb1b4558f7ec2e64c8ead57b199076c7568

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