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

DocumentPurpose
../README.md, and its zh-CN, ja, ko, de translationsProduct overview, quick start, packages, and examples.
../AGENTS.mdFinal architecture boundaries, invariants, and release gates.
api-reference.mdComplete public API and option scopes.
tools.mdProvider-neutral host-defined Tools, schemas, errors, lifecycle, security, and Thread compatibility.
streaming.mdUnified Event consumption, cancellation, backpressure, AG-UI, and SSE.
streaming-adapter-contract.mdStreaming and event obligations for Driver authors.
structured-output.mdTyped and JSON-schema output.
a2a.mdA2A bridge, client, delegation, and exposure policy.
run-policy.mdSandbox, feature, approval, timeout, fallback, and retry policy.
public-errors.mdPublic sentinels, typed errors, and errors.Is / errors.As guidance.
profile-resource-provider-matrix.mdProvider support and materialization behavior for profile resources.