Skip to content

CHANGELOG.md

Latest commit

 

History

History
47 lines (36 loc) · 5.12 KB

CHANGELOG.md

File metadata and controls

47 lines (36 loc) · 5.12 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Added

  • update_payload_by_doc_id method on the BaseStorageBackend Protocol for in-place chunk-payload rewrites. Lets callers update per-document metadata without re-embedding: chunk text and vectors are unchanged, only the JSON payload fields are merged in place. SqliteVecBackend implements it via a single UPDATE chunks SET payload = ? per chunk filtered by json_extract(payload, '$.doc_id'). QdrantBackend implements it via set_payload(points=Filter(... doc_id ...)). Built-in payload keys (text, source, doc_id) are never overwritten — the caller passes only the metadata dict. Required by the studio's post-upload metadata editor so the KB chunk count stays stable across edits.

Fixed

  • Agent._run_loop now uses a while loop so mutations to max_steps inside before_iteration_callback actually extend the run. Previously range(self.max_steps) was evaluated once at loop start, making runtime extension a no-op.

Added

  • Observability primitives: emit, set_hook, on_step, ObservabilityContext, and a typed event vocabulary (LLMCallEvent, EmbeddingEvent, RAGEvent, MCPEvent, GuardrailEvent, AgentStepEvent, OrchestratorEvent, PipelineStepEvent) for structured event emission from core call sites.
  • Agent.run(delegated_to=...) parameter for caller correlation across Orchestrator sub-agents. Sub-agent events carry the delegating agent's name in their payload.
  • total_billable_tokens field on Agent.run() result. Resolves the previous ambiguity in the prompt + completion + reasoning math: reasoning_tokens is a subset of completion_tokens and is not additive.
  • observability.print_hook() helper for examples and ad-hoc debugging.
  • RecordingHook pytest fixture in tests/conftest.py.
  • CONTRIBUTING.md and SECURITY.md at the repo root, covering setup, test commands, pre-PR checklist, commit format, supported versions, the reporting process, and a 90-day disclosure timeline.
  • LICENSE (MIT) and this CHANGELOG.md.
  • CLAUDE.md agent instructions and issues/ tracker at the repo root.
  • mypy and pytest-cov added to the dev dependency group for CI type-checking and coverage reporting.
  • GitHub Actions CI workflow (.github/workflows/ci.yaml) running ruff, mypy, and unit tests on every push to main and on pull requests.
  • CI workflow extended with gitleaks (full-history secret scan, runs first to fail fast), bandit (Python security scan), and deptry (declared-dep audit, scoped to library + tests). bandit and deptry added to the dev group via uv add.

Changed

  • Renamed package from llm-framework to hoid for first PyPI publish. All import paths change from from llm_framework.X to from hoid.X. Install becomes uv pip install hoid[std]. The MCP clientInfo.name sent to servers is now "hoid". The PyPI distribution is hoid; consumers pinning the old GitHub Release URL must switch to pip install hoid==X.Y.Z.
  • Agent and Orchestrator no longer accept an on_event callback. Subscribe via hoid.observability.set_hook() (global) or the per-instance on_step parameter.
  • Orchestrator.delegate() no longer mutates sub-agent state at call time. Sub-agent events carry delegated_to in the payload instead.
  • Agent.run() docstring now documents the token accounting contract explicitly: completion_tokens is OpenAI-compatible (includes reasoning); total_billable_tokens is the actual bill.
  • All example scripts and integration tests migrated from the on_event=... pattern to the new hook pattern.
  • Observability primitives moved from hoid.observability to hoid.core.observability; the old path remains as a silent backward-compat re-export.
  • The internal AgentEvent TypedDict was removed from core/agent.py. The agent loop now constructs AgentStepEvent directly via a private helper, eliminating the dual event representation.
  • pyproject.toml now declares classifiers, keywords, and a [project.urls] block (Homepage, Documentation, Issues) so the package renders correctly on PyPI.

Removed

  • hoid.tools.* and hoid.mcp_servers.*. The reference tool implementations and MCP-server entry-point scripts now live in examples/tools/ and examples/mcp_servers/. The knowledge-server and memory-server console scripts moved to the examples project — run them via cd examples && uv run <server>. The [server] extra was removed (uvicorn is no longer a library dependency; it ships transitively via examples/).

Fixed

  • Token accounting no longer double-counts reasoning_tokens as a separate billable quantity. Consumers reading prompt_tokens + completion_tokens + reasoning_tokens were being charged twice for reasoning tokens; the new total_billable_tokens field gives the correct sum.
  • Lazy import dataclasses inside observability._attach_ctx hoisted to the module-level imports.