Skip to main content

Core Contract v0.1

This document is the versioned runtime contract for v0.1.x.

Public Surface

  • Runnables (Runnable, RunnableLambda, RunnableSequence, RunnableParallel, RunnableMap, RunnablePassthrough, ModelRunnable)
  • Prompting (PromptTemplate)
  • Output parsing (StringOutputParser, JsonOutputParser)
  • Agent runtime (Agent)
  • Tools (tool, ToolRegistry)
  • Workflow (Workflow)
  • Errors (framework error classes and codes)

Stability Guarantees

  • Public APIs documented in API reference are stable within v0.1.x.
  • Behavior-changing updates require tests and changelog entries.
  • Breaking changes require RFC approval and a new contract version.

Runtime Guarantees

  • Agent loop enforces maxSteps.
  • Tool calls are validated against schema before execution.
  • Unknown tool names raise a framework error.
  • Model/provider failures are wrapped as ModelError.
  • Prompt and parser failures raise framework errors.

Error Contract

See error-codes.md for canonical error code mappings and handling guidance.

Change Control

Breaking-change workflow:

  1. Author RFC using the repository RFC template.
  2. Record migration impact and compatibility risks.
  3. Approve RFC before implementation merge.
  4. Publish next versioned contract doc.