Documentation map
July 31, 2026 ยท View on GitHub
The public v1 model is Agent, Thread, Stream, Event, Result, and Driver. Start with the current integration documents below; design and implementation records are background material rather than usage references.
Current integration documents
| Document | Purpose |
|---|---|
../README.md, and its zh-CN, ja, ko, de translations | Product overview, quick start, packages, and examples. |
../AGENTS.md | Final architecture boundaries, invariants, and release gates. |
api-reference.md | Complete public API and option scopes. |
tools.md | Provider-neutral host-defined Tools, schemas, errors, lifecycle, security, and Thread compatibility. |
streaming.md | Unified Event consumption, cancellation, backpressure, AG-UI, and SSE. |
streaming-adapter-contract.md | Streaming and event obligations for Driver authors. |
structured-output.md | Typed and JSON-schema output. |
a2a.md | A2A bridge, client, delegation, and exposure policy. |
run-policy.md | Sandbox, feature, approval, timeout, fallback, and retry policy. |
public-errors.md | Public sentinels, typed errors, and errors.Is / errors.As guidance. |
profile-resource-provider-matrix.md | Provider support and materialization behavior for profile resources. |