Releases: cognesy/instructor-events
v2.2.0
title: 'v2.2.0'
What's New
v2.2.0 adds deeper telemetry across the stack. More parts of the system now share stable IDs,
correlation data, and smaller event payloads, so it is easier to trace one run from agent control,
through structured output and inference, down to HTTP.
There are also a few user-facing changes: hub can now filter examples by tag, streamed tool events
in agent-ctrl are more accurate, and agent stop handling is more predictable.
Agents And Agent Control
Telemetry from runs, tools, and subagents
agent-ctrl now assigns one executionId to each run and keeps it through the whole bridge flow.
That run can now be traced more clearly in events and in the final response.
Streamed tool events for Claude Code and Gemini were also reworked. Tool-use events now wait for the
matching tool result, so they report the real tool name, input, output, and error state instead of a
placeholder.
Cleaner stop handling in agents
AgentLoop now checks whether execution should stop before the first step and again after beforeStep.
This lets hooks stop a run cleanly without forcing another model or tool cycle.
When multiple stop signals exist, agents now picks the highest-priority reason instead of the first
one that happened to be recorded. That makes the final stop reason more consistent.
Tool calls and subagents also carry stable IDs and trace data, which makes it easier to connect parent
and child work in telemetry and logs.
Structured Output, Inference, And HTTP
End-to-end telemetry in instructor and polyglot
instructor now emits structured-output events with stable request, execution, and attempt IDs.
Streaming and non-streaming runs also report the same kind of response summary data, including finish
reason, token usage, and tool-call counts.
polyglot now carries telemetry correlation from InferenceRequest down into the underlying
HttpRequest. Stream finalization was also tightened up, so completed and failed streamed runs update
execution state more reliably.
Better request correlation in HTTP layers
http-client and http-pool now keep requestId attached more consistently, including pooled
responses and streamed HTTP events. This makes it easier to match a response or stream event back to
the request that created it, and to keep one trace chain across higher-level and lower-level layers.
Failure events in instructor and polyglot were also cleaned up so they report smaller, safer
summaries instead of large raw payloads.
Hub
hub list now supports --tag and --tags, and examples can carry normalized tag metadata. This
makes it easier to find examples by topic without scanning the whole catalog.
Upgrade Notes
- If you read raw event payloads from
agent-ctrl,agents,instructor,polyglot,http-client, orhttp-pool, review them before upgrading. Several events now include new IDs, summary fields, and different payload shapes. - In
agents, the final stop reason may differ from earlier releases because stop signals are now resolved by priority. - In
agent-ctrl, some streamed tool events are emitted later than before, but they now contain the actual tool result data.
v2.1.0
title: 'v2.1.0'
What's New
SessionRuntime::create() — single entry point for session creation
SessionRuntime now exposes a create(AgentDefinition $definition, ?AgentState $seed = null) method
that handles the full session creation lifecycle: instantiation, hook processing, persistence, and
event emission — all in one call.
Before:
$stateFactory = new DefinitionStateFactory();
$sessionFactory = new SessionFactory($stateFactory);
$session = $repo->create($sessionFactory->create($definition));After:
$session = $runtime->create($definition);The new method runs through the same hook and event pipeline as execute(), so session controllers
fire consistently for both creation and updates.
Dedicated BeforeCreate / AfterCreate hook stages
The AgentSessionStage enum gains two new cases: BeforeCreate and AfterCreate.
During SessionRuntime::create(), hooks fire in this order:
BeforeCreate— create-only pre-persist logic (e.g. set defaults, assign IDs)BeforeSave— shared pre-persist logic (fires on both create and execute)- persist
AfterSave— shared post-persist logic (fires on both create and execute)AfterCreate— create-only post-persist logic (e.g. send notifications)
The execute() pipeline is unchanged — it continues to fire only BeforeSave / AfterSave.
This layered approach (inspired by Eloquent's creating/saving/saved/created events)
lets hooks distinguish between first-time creation and subsequent updates.
SessionFactory is now injectable
SessionRuntime accepts an optional ?SessionFactory constructor parameter. It defaults to
new SessionFactory(new DefinitionStateFactory()) when omitted, so existing call sites are
unaffected — but custom state factories can now be injected for testing or advanced use cases.
CanManageAgentSessions contract updated
The CanManageAgentSessions interface now includes create():
interface CanManageAgentSessions
{
public function create(AgentDefinition $definition, ?AgentState $seed = null): AgentSession;
public function listSessions(): SessionInfoList;
public function getSessionInfo(SessionId $sessionId): AgentSessionInfo;
public function getSession(SessionId $sessionId): AgentSession;
public function execute(SessionId $sessionId, CanExecuteSessionAction $action): AgentSession;
}When to use SessionFactory + repo directly
SessionFactory and SessionRepository::create() remain available for the one case where
you already have a fully constructed AgentSession — forking. ForkSession returns a
concrete session instance, so you persist that branch via $repo->create($forked) rather
than going through SessionRuntime::create().
v2.0.0
title: 'v2.0.0'
What's New
v2.0 is a ground-up rework focused on performance, type safety, and a tighter API surface.
- Faster, leaner — streaming is more memory efficient, execution is lazy by default,
and internal code paths have been consolidated. - Tighter APIs — both Instructor and Polyglot have cleaner, more type-safe public APIs
with explicit fields instead of mode-based configuration. - More reliable — extensive unit, feature, integration tests and benchmarks back this
release. A substantial number of bugs have been fixed across the stack. - Agent building blocks — new
cognesy/agentspackage for custom agents, and an expanded
cognesy/agent-ctrlto interact with CLI coding agents from PHP.
Breaking Changes
- Instructor's public API centers on
StructuredOutput,StructuredOutputRuntime,
PendingStructuredOutput,StructuredOutputResponse, andStructuredOutputStream. - Polyglot uses explicit LLM API fields (
responseFormat,tools,toolChoice) instead
of output modes. Streaming moves tostream()->deltas().
Instructor
- Execution flows through
StructuredOutputRuntime, with lazy execution viaPendingStructuredOutput. - Streaming is Instructor-owned:
StructuredOutputStreamexposesresponses(),partials(),
andsequence().StructuredOutputStreamStateaccumulates state internally. - Configuration, validation, transformation, deserialization, and extraction are explicit
parts of the runtime rather than scattered across older code paths.
Polyglot
InferenceRuntimeandEmbeddingsRuntimesit behind theInferenceandEmbeddingsfacades.- New inference drivers:
openai-responses,openresponses,glm,qwen. - Built-in pricing via
Pricing\Cost, per-model pricing objects, and cost calculators. - Polyglot handles raw transport — structured value ownership belongs to Instructor.
Agents (cognesy/agents)
New package. Building blocks for custom agents: AgentLoop, AgentBuilder, hooks, guards,
templates, subagents, skills, and SessionRuntime for persisted workflows.
Compose agents from capabilities like bash, file tools, structured outputs, summarization,
self-critique, planning, execution history, and broadcasting.
Two built-in drivers: ToolCallingDriver (native tool-calling APIs) and ReActDriver
(Thought/Action/Observation loops).
AgentCtrl (cognesy/agent-ctrl)
Unified PHP API for interacting with CLI coding agents — Claude Code, Codex, OpenCode,
Pi (new), and Gemini (new).
AgentCtrl::make()and dedicated builders (::codex(),::openCode(),::pi(),
::gemini()) return normalizedAgentResponseobjects.- Streaming callbacks, session resume/continue, typed IDs (
AgentSessionId,
AgentToolCallId), andAgentCtrlConsoleLoggerfor observability.
Migrating from v1.x
- Instructor: use
->get(),->response(), and->stream(). For partial snapshots,
switch tostream()->responses(),stream()->partials(), orstream()->sequence(). - Polyglot: replace mode-based JSON/tool config with
responseFormat,tools,
toolChoice, and delta-based streaming. - See
packages/instructor/docs/upgrade.mdandpackages/polyglot/docs/upgrade.mdfor details.
v1.22.0
title: 'v1.22.0'
Highlights
- Agent builder and capability namespaces are reorganized into
Cognesy\Addons\AgentBuilder\*, with agent templates inCognesy\Addons\AgentTemplate\*. - Structured extraction is reworked with
ExtractionInput,ResponseContent, and streaming-friendlyExtractingBuffer+PartialJsonExtractor. - Hub example discovery now supports configurable sources and grouping via YAML config files.
Breaking Changes
- Agent builder, capabilities, and tool registry classes moved from
Cognesy\Addons\Agent\*toCognesy\Addons\AgentBuilder\*. - Agent template definitions, registries, and blueprints moved to
Cognesy\Addons\AgentTemplate\*;AgentContractis nowAgentInterfaceandfromConfig()returns anAgentInterface(noResultwrapper). - Task planning capability (
UseTaskPlanning,Todo*classes) andLlmQueryToolwere removed. - Instructor extraction contracts changed:
CanExtractResponse::extract()now acceptsExtractionInputand returns an array, throwing on failure.CanExtractContent,CanParseContent,DataFormat,JsonParser, andExtractingJsonBufferwere removed.
Addons / Agents
- Agent builder moved to
Cognesy\Addons\AgentBuilder\AgentBuilderwith capabilities underCognesy\Addons\AgentBuilder\Capabilities\*. - New
SubagentProvider/SubagentDefinitioncontracts andEmptySubagentProvider;AgentTemplate\Registry\AgentRegistryimplementsSubagentProvider. - Agent template registry and definition flow now live under
Cognesy\Addons\AgentTemplate\*with explicit blueprint exceptions.
Instructor
ResponseExtractornow consumesExtractionInputand usesResponseContentfor tool-mode extraction.- Streaming extraction uses
ExtractingBufferandPartialJsonExtractorfor more resilient partial JSON handling.
Hub
- Example sources can be configured via
config/examples.yaml(multiple source roots supported). - Example grouping and ordering can be configured via
config/examples-groups.yaml(subgroup include/exclude rules).
Migration from v1.21.0
- Update imports to
Cognesy\Addons\AgentBuilder\*(includingAgentBuilder, allCapabilities, andCapabilities\Tools). - Move agent templates and registries to
Cognesy\Addons\AgentTemplate\*and updateAgentContractimplementations toAgentBuilder\Contracts\AgentInterfacewithfromConfig()returning anAgentInterface. - Remove task planning usage (
UseTaskPlanning,Todo*) andLlmQueryToolreferences; replace with custom tools or direct inference calls. - Update custom extractors to
CanExtractResponse::extract(ExtractionInput $input): arrayand throwExtractionException(or anyThrowable); call withExtractionInput::fromResponse(...)orExtractionInput::fromContent(...). - Replace any direct usage of
ExtractingJsonBuffer/JsonParser/DataFormatwithExtractingBufferand the new extractor chain.
v1.21.0
title: 'v1.21.0'
Highlights
- StepResult pattern across Agent, Chat, ToolUse, and Collaboration with immutable steps and explicit continuation outcomes.
- Continuation evaluation is unified around
ContinuationEvaluationandContinuationOutcome, with clearer stop reasons. - Retry policy handling is explicit for Inference and Embeddings (no more
retryPolicyinside options). - Hub status persistence now tolerates malformed UTF-8 output instead of failing to write status data.
Breaking Changes
- Continuation interfaces
CanDecideToContinue,CanExplainContinuation, andCanProvideStopReasonwere removed. Custom criteria must implementCanEvaluateContinuationand returnContinuationEvaluation. - Error handling classes moved from
Cognesy\Addons\StepByStep\ContinuationtoCognesy\Addons\StepByStep\ErrorHandling. retryPolicyis no longer accepted inoptionsorLLMConfigoptions. Use explicit retry policy objects.- Continuation outcomes are no longer stored on step objects. Use
StepResultor state accessors instead.
Agent, Chat, ToolUse, Collaboration
- States now store
StepResultcollections and serialize them. canContinue()reads from the last step result; mismatches between steps and step results now raise a logic error.- Message compilation supports
summaryandbuffersections for inference context. - Token usage is accumulated before continuation evaluation so usage limits are accurate.
StepByStep / Continuation
ContinuationCriteriacomposesCanEvaluateContinuationcriteria and exposesevaluateAll()with aggregated outcomes.- Criteria classes return richer
ContinuationEvaluationobjects with explicit decisions and stop reasons. - New outcome helpers provide derived decision, resolver, and stop reason from evaluations.
Polyglot / Inference and Embeddings
InferenceRequestandEmbeddingsRequestnow carry retry policies explicitly.InferenceRequestBuilderand request builder traits exposewithRetryPolicy().PendingInferenceandPendingEmbeddingspull retry policies from requests rather thanoptions.
Hub
- Status JSON encoding now substitutes invalid UTF-8 bytes to avoid failures when saving example output.
Migration from v1.20.0
- Update custom continuation criteria to implement
CanEvaluateContinuationand returnContinuationEvaluation(replaceCanDecideToContinue,CanExplainContinuation,CanProvideStopReason). - Update imports to the new error handling namespace:
Cognesy\Addons\StepByStep\ErrorHandling\*. - Remove
retryPolicyfrom LLM or request options. UsewithRetryPolicy()on inference/embeddings builders or requests. - Replace any step-level continuation outcome access with
state->continuationOutcome()orstate->lastStepResult().
v1.20.0
title: 'v1.20.0'
Breaking Changes
Renames
ReverbAgentEventAdapter→AgentEventEnvelopeAdapterToolRegistryContract→ToolRegistryInterfaceDeterministicDriver→DeterministicAgentDriver
Agent
AgentStatenow implementsCanMarkExecutionStarted,CanMarkStepStarted,CanTrackExecutionTime- Added
AgentState::recordStep(),AgentState::failWith(),AgentState::withAddedExecutionTime() Agent::applyStep()andAgent::handleError()delegate toAgentStatemethods
StepByStep / Continuation
- New
CanProvideStopReasoninterface for criteria to provide explicit stop reasons - All continuation criteria implement
CanProvideStopReason:StepsLimit→StopReason::StepsLimitReachedTokenUsageLimit→StopReason::TokenLimitReachedExecutionTimeLimit,CumulativeExecutionTimeLimit→StopReason::TimeLimitReachedErrorPolicyCriterion→StopReason::ErrorForbadeFinishReasonCheck→StopReason::FinishReasonReceivedErrorPresenceCheck,RetryLimit→StopReason::GuardForbade
ContinuationEvaluationincludesstopReasonfield- Removed
ContinuationCriteria::inferStopReason()(stop reasons now come from criteria directly) - New state contracts:
CanMarkExecutionStarted,CanMarkStepStarted,CanTrackExecutionTime
Command Builders (agent-ctrl)
ClaudeCommandBuilder, CodexCommandBuilder, OpenCodeCommandBuilder:
stdbuf -o0prefix now conditional (checks availability)- Skipped on Windows
- Skipped when
stdbufnot found on PATH (fixes macOS) - Override via
COGNESY_STDBUFenv var:0= disable,1= force
Polyglot / Inference
InferenceExecution::usage(): fixed double-counting of current attemptInferenceResponse: added<think>...</think>tag parsing for reasoning content fallback- New
ReasoningContentSplitdata class AnthropicBodyFormat: cache marking applies only to last message in sequence (was all messages)DeepseekResponseAdapter: supportsreasoning,analysisfields as alternatives toreasoning_contentInference::with(): parameters now nullable (passnullto skip, was required empty values)PendingInference::asJson(),asJsonData(): use proper JSON extraction with output mode
HTTP Client
CurlHandle::close(): removedcurl_close()call (no-op since PHP 8.0, deprecated in PHP 8.5)
Instructor
StructuredOutputStream: fixed execution reference update during streaming to capture accumulated usage
v1.19.0
Release Notes - v1.19.0
Highlights
- Cleaned inference attempt lifecycle and event ownership in Polyglot.
- Fixed serialization and caching edge cases across inference requests/partials.
- Structured output handling is more robust with safer validation and immutable models.
Breaking Changes
InferenceExecution::withNewResponse()renamed towithSuccessfulAttempt().InferenceExecution::withFailedResponse()renamed towithFailedAttempt().InferenceExecution::withFailedFinalizedResponse()removed.InferenceAttempt::withFailedResponse()removed; create attempts viastartAttempt()/InferenceAttempt::started().Usage::accumulate()removed; usewithAccumulated()for immutable usage totals.ValidationResult::invalid()now acceptsValidationError|ValidationError[]only.ResponseModel::setPropertyValues()removed; usewithPropertyValues().
Fixes and Improvements
Polyglot
InferenceRequest::toArray()now serializesmessagesandresponse_formatas arrays.InferenceRequest::hasMessages()andwithCacheApplied()use explicit emptiness checks.PartialInferenceResponse::toArray()now serializesresponse_data, with clearer tool accumulation.InferenceStreamno longer double-dispatches completion events.HandlesRequestBuilder::withToolChoice()acceptsstring|array.
Instructor
StructuredOutputStreamreuses its generator and emitsStructuredOutputStartedonce.- Response validation captures thrown exceptions as
ValidationResult::invalid(). - Tool-call JSON encoding failures return
Resulterrors instead of throwing. ResponseModel::toArray()guards non-object instances; fluent methods returnstatic.
Tests
- Added coverage for attempt IDs, streaming completion events, serialization, validation failures, and ResponseModel immutability.
v1.18.4
Release Notes - v1.18.4
Highlights
- YAML agent definitions with strict parsing, validation, and version checks.
- Blueprint and capability registries for mapping definitions to implementations.
- Definition loading and auto-discovery from files, directories, and
.claude/agents.
New Features
Agent Definitions
- Added
AgentDefinitionDTO with LLM, execution, tool allow/deny, capabilities, and metadata. - Added
AgentDefinitionParserwith strict key validation and version enforcement. - Added
AgentDefinitionLoaderfor loading definitions from files/directories (recursive supported). - Added
AgentDefinitionRegistrywith auto-discovery and error collection.
Blueprint and Capability Registries
- Added
AgentBlueprintRegistryfor alias-to-class resolution. - Added
AgentDefinitionFactoryto build agents from definitions via blueprints. - Added
AgentCapabilityRegistryfor instance/factory resolution.
Tests
- Added unit tests for definition parsing/loading/registry and blueprint/capability registries.
v1.18.3
Release Notes - v1.18.3
Highlights
- Tool discovery registry with metadata/full-spec layering for progressive tool discovery.
- New
toolstool for list/help/search of available tools without loading full specs. - Capability to wire tool registries into agents for dynamic tool catalogs.
New Features
Tool Registry
- Added
ToolRegistryContractandToolRegistryfor registering tool instances or factories. - Added
ToolPolicyfiltering for allow/deny tool lists. - Added metadata and full-spec resolution helpers to support progressive discovery.
Tools Tool
- Added
ToolsToolforlist,help, andsearchactions (plus CLI-likecommandparsing). - Supports locale-aware metadata/full spec rendering via registry.
Agent Capability
- Added
UseToolRegistrycapability for agent blueprints to expose registries as tools.
Tests
- Added registry and tools discovery tests for metadata/full spec, search, and help flows.
v1.18.2
Release Notes - v1.18.2
Highlights
- Continuation-safe agent state persistence with new serialization helpers.
- MessageStore serialization is now round-trip safe and section-aware.
- Metadata preservation fixes for slim agent state snapshots.
Behavior Changes
MessageStore toArray Structure
MessageStore::toArray()now returns a structured payload withsectionsandparametersinstead of a flat messages list.- Use
MessageStore::toFlatArray()to obtain the previous flat messages array format.
New Features
Agent Continuation APIs
- Added
AgentState::withUserMessage()for multi-turn continuation. - Added
AgentState::forContinuation()to reset execution state (steps, cache, usage, timing) while preserving conversation history.
Continuation Serializer
- Added
ContinuationAgentStateSerializerwithContinuationSerializationConfigto persist multi-turn state with retention limits. - Supports truncation, tool-result omission, and tool-arg redaction while preserving
_metadata.
Bug Fixes
Metadata Preservation
SlimAgentStateSerializernow emits_metadata(withmetadataalias support) so tool calls/results survive round-trips.MessageInput::fromArray()now acceptsmetadataas a fallback alias for_metadata.
Serialization Round-Trip
- MessageStore serialization now round-trips sections, messages, and parameters without data loss.
Tests
- Added round-trip tests for MessageStore and continuation serialization.
- Added AgentState continuation tests covering reset semantics and message appending.