agentturn

package module

Go to main page

Versions in this module

v0

v0.0.18

Oct 4, 2026

v0.0.17

Oct 4, 2026

v0.0.16

Oct 2, 2026

Changes in this version

+ func ContextWithAskedCall(ctx context.Context, call AskedCall) context.Context

+ func ContextWithOrigins(ctx context.Context, origins map[string]string) context.Context

+ func OriginFromContext(ctx context.Context, callID string) string

type Answer

+ Origin string

+ func (a Answer) WithOrigin(origin string) Answer

+ type AskedCall struct

+ Args json.RawMessage

+ CallID string

+ Decision *ToolDecision

+ Name string

+ Parent string

+ func AskedCallFrom(ctx context.Context) (AskedCall, bool)

+ type InputMode string

+ const InputContinued

+ const InputDeliver

+ const InputFollowUp

+ const InputHook

+ const InputPrompt

+ const InputResume

+ const InputSteer

+ const InputTool

type PendingCall

+ Ran *openresponses.FunctionCallOutput

+ RanWhere string

+ Refused string

type ToolCallInfo

+ Parent string

type ToolDecision

+ func Ask(ctx context.Context, call AskedCall) (*ToolDecision, bool)

+ type TurnInput struct

+ Item openresponses.Item

+ Mode InputMode

+ Trigger Trigger

type TurnStart

+ Arrived []TurnInput

type TurnStartInfo

+ Inputs []TurnInput

v0.0.15

Oct 1, 2026

Changes in this version

+ func ContextWithReasoningModels(ctx context.Context, m ReasoningModels) context.Context

type Option

+ func WithReasoningModels(m ReasoningModels) Option

+ type ReasoningModels map[*openresponses.ReasoningItem]string

+ func (m ReasoningModels) Attribute(modelName string, items openresponses.Items)

+ func (m ReasoningModels) For(modelName string, t Transcript) Transcript

v0.0.14

Oct 1, 2026

v0.0.13

Oct 1, 2026

Changes in this version

+ const WithheldCallOutput

type ResponseEnd

+ Withheld bool

type RunEnd

+ Withheld bool

v0.0.12

Sep 29, 2026

Changes in this version

+ const RunAgainKeyedReason

+ const RunAgainSafeReason

+ func ContextWithReservedCallIDs(ctx context.Context, ids ...string) context.Context

type Agent

+ func (a *Agent) ReserveCallIDs(ids ...string) error

type ItemEnd

+ ModelCallID string

type Option

+ func WithReservedCallIDs(ids []string) Option

type PendingReason

+ const PendingRejected

v0.0.11

Sep 29, 2026

Changes in this version

+ const OutcomeUnknownReason

+ const RunAgainReason

+ var ErrAmbiguousCall = errors.New("agentturn: a call that may have run cannot run again")

+ var ErrCallAnswered = errors.New("agentturn: an answered call is owed its output and nothing else")

+ var ErrTriggerExtra = errors.New("agentturn: trigger extra cannot be written")

+ func ContextWithReasons(ctx context.Context, reasons map[string]string) context.Context

+ func ReasonFromContext(ctx context.Context, callID string) string

type Agent

+ func (a *Agent) Deliver(ctx context.Context, items ...openresponses.Item) (joined bool, end *RunEnd, err error)

+ func (a *Agent) SetPending(pending []PendingCall) error

type Answer

+ IdempotencyKey string

+ Reason string

+ RunAgain bool

+ func OutcomeUnknown(callID string) Answer

+ func (a Answer) WithIdempotencyKey(key string) Answer

+ func (a Answer) WithReason(reason string) Answer

+ func (a Answer) WithRunAgain() Answer

type ItemEnd

+ Trigger Trigger

type Option

+ func WithPending(pending []PendingCall) Option

type PendingCall

+ Args json.RawMessage

+ Dispatched bool

+ IdempotencyKey string

+ func (p PendingCall) MayHaveRun() bool

type PendingReason

+ const PendingAnswered

type RunEnd

+ func (e *RunEnd) Answer() (string, bool)

type ToolDispatch

+ IdempotencyKey string

type Trigger

+ Extra map[string]any

+ func (t Trigger) Validate() error

v0.0.10

Sep 29, 2026

Changes in this version

+ func ChainTransform(fns ...func(context.Context, Transcript) (Transcript, error)) func(context.Context, Transcript) (Transcript, error)

+ func RunContext(ctx context.Context) (context.Context, bool)

+ func Steered(ctx context.Context) <-chan struct

type Agent

+ func (a *Agent) Queue(ctx context.Context, mode QueueMode, items ...openresponses.Item)

type Config

+ ToolElicitor agenttool.Elicitor

type OutputInfo

+ Output openresponses.Items

type PendingCall

+ Tool agenttool.Tool

type PendingReason

+ const PendingUndispatched

type Queued

+ Trigger Trigger

type ToolEnd

+ Reason string

type Trigger

+ Source string

v0.0.9

Sep 28, 2026

Changes in this version

+ const EventToolDispatch

type Config

+ ToolRecorder agenttool.RecordFunc

+ type ToolDispatch struct

+ CallID string

+ Name string

+ Parent string

+ RunID string

+ Turn int

+ func (*ToolDispatch) EventType() string

v0.0.8

Sep 24, 2026

v0.0.7

Sep 24, 2026

Changes in this version

+ const EventQueued

+ var ErrNoInvoker = errors.New("agentturn: no loop on the context to invoke a tool through")

+ func ChainBeforeModelCall(fns ...func(context.Context, *openresponses.Request) error) func(context.Context, *openresponses.Request) error

+ func ChainBeforeToolCall(fns ...func(context.Context, ToolCallInfo) (*ToolDecision, error)) func(context.Context, ToolCallInfo) (*ToolDecision, error)

+ func ChainBeforeTurn(fns ...func(context.Context, TurnStartInfo) (openresponses.Items, error)) func(context.Context, TurnStartInfo) (openresponses.Items, error)

+ func ChainOutputGuard(fns ...func(context.Context, OutputInfo) (*openresponses.Message, error)) func(context.Context, OutputInfo) (*openresponses.Message, error)

+ func ChainShouldStopAfterTurn(fns ...func(context.Context, TurnInfo) (bool, error)) func(context.Context, TurnInfo) (bool, error)

+ func ContextWithDeciders(ctx context.Context, by map[string]string) context.Context

+ func DeciderFromContext(ctx context.Context, callID string) string

+ func Hidden(item openresponses.Item) openresponses.Item

+ func Invoke(ctx context.Context, name string, args json.RawMessage) (agenttool.Result, error)

+ func Unhide(item openresponses.Item) (openresponses.Item, bool)

type Agent

+ func (a *Agent) AbortCause(cause error)

type Answer

+ By string

+ func (a Answer) WithBy(by string) Answer

type ItemEnd

+ Hidden bool

type ItemStart

+ Hidden bool

type ModelRetry

+ Request openresponses.Request

+ type QueueMode string

+ const QueueFollowUp

+ const QueueSteer

+ type Queued struct

+ Hidden bool

+ Item openresponses.Item

+ Mode QueueMode

+ RunID string

+ func (*Queued) EventType() string

type Retry

+ Revise func(attempt int, req *openresponses.Request, err error) *openresponses.Request

type ToolEnd

+ Parent string

type ToolStart

+ Parent string

v0.0.6

Sep 20, 2026

Changes in this version

+ const EventModelBlocked

+ var ErrGuard = errors.New("agentturn: guard stopped the run")

+ func ContextWithTrigger(ctx context.Context, t Trigger) context.Context

+ func PendingCalls(pending []PendingCall) []*openresponses.FunctionCall

type Answer

+ Note string

+ Terminate bool

+ func Refuse(out *openresponses.FunctionCallOutput) Answer

+ func (a Answer) WithNote(note string) Answer

type Config

+ BeforeTurn func(context.Context, TurnStartInfo) (openresponses.Items, error)

+ OutputGuard func(context.Context, OutputInfo) (*openresponses.Message, error)

+ type ModelBlocked struct

+ Err error

+ Request openresponses.Request

+ RunID string

+ Turn int

+ func (*ModelBlocked) EventType() string

+ type OutputInfo struct

+ Message *openresponses.Message

+ ResponseID string

+ RunID string

+ Turn int

+ type PendingCall struct

+ Call *openresponses.FunctionCall

+ Reason PendingReason

+ type PendingReason string

+ const PendingAborted

+ const PendingDeferred

+ const PendingUnknown

type RunEnd

+ Cause StopCause

type RunStart

+ Source Source

+ Trigger Trigger

+ type Source string

+ const SourceInput

+ const SourceResume

type State

+ Queued openresponses.Items

+ Steered openresponses.Items

+ type StopCause string

+ const StopGuard

+ const StopHook

+ const StopMaxTurns

+ const StopPartialTerminate

+ const StopRefused

+ const StopTerminate

type ToolCallInfo

+ Batch []*openresponses.FunctionCall

+ Index int

type ToolDecision

+ By string

+ Note string

type ToolStart

+ Decision *ToolDecision

+ type Trigger struct

+ Kind string

+ Ref string

+ func TriggerFromContext(ctx context.Context) Trigger

+ func (t Trigger) IsZero() bool

+ func (t Trigger) String() string

type TurnInfo

+ Final bool

type TurnStart

+ Inputs openresponses.Items

+ type TurnStartInfo struct

+ RunID string

+ Transcript Transcript

+ Turn int

v0.0.5

Sep 20, 2026

Changes in this version

+ func ContextWithRunID(ctx context.Context, runID string) context.Context

+ func RunIDFromContext(ctx context.Context) string

+ type Answer struct

+ Args json.RawMessage

+ CallID string

+ Output *openresponses.FunctionCallOutput

+ func Approve(callID string) Answer

+ func ApproveWith(callID string, args json.RawMessage) Answer

+ func Output(out *openresponses.FunctionCallOutput) Answer

v0.0.4

Sep 20, 2026

Changes in this version

+ const EventBuffer

+ const EventModelRetry

+ func CanContinue(t Transcript) bool

+ func ContextWithTranscript(ctx context.Context, t Transcript) context.Context

+ func DefaultBackoff(attempt int, err error) time.Duration

+ func DefaultRetryable(err error) bool

type Agent

+ func (a *Agent) SetConfig(cfg Config) error

+ func (a *Agent) SetTranscript(t Transcript) error

type Config

+ Retry Retry

+ func (c Config) ResolveTools(ctx context.Context) []agenttool.Tool

type ExecutionMode

+ const ExecParallel

+ const ExecSequential

+ type ModelRetry struct

+ Attempt int

+ Delay time.Duration

+ Err error

+ RunID string

+ Turn int

+ func (*ModelRetry) EventType() string

+ type Retry struct

+ Backoff func(attempt int, err error) time.Duration

+ MaxAttempts int

+ Retryable func(error) bool

+ type ToolAction int

+ const Allow

+ const Block

+ const Defer

type ToolDecision

+ Action ToolAction

type Transcript

+ func TranscriptFromContext(ctx context.Context) (Transcript, bool)

v0.0.2

Sep 19, 2026

v0.0.1

Sep 19, 2026

Changes in this version

+ const EventItemEnd

+ const EventItemStart

+ const EventItemUpdate

+ const EventResponseEnd

+ const EventRunEnd

+ const EventRunStart

+ const EventToolEnd

+ const EventToolStart

+ const EventToolUpdate

+ const EventTurnEnd

+ const EventTurnStart

+ var ErrAborted = errors.New("agentturn: run aborted")

+ var ErrCannotContinue = errors.New(...)

+ var ErrInputRequired = errors.New("agentturn: pending tool calls must be resumed before continuing")

+ var ErrNoModel = errors.New("agentturn: config has no model")

+ var ErrNoPrompt = errors.New("agentturn: no prompt items")

+ var ErrNotPending = errors.New("agentturn: output does not answer a pending call")

+ var ErrRunning = errors.New("agentturn: agent is already running")

+ func Continue(ctx context.Context, t Transcript, cfg Config) iter.Seq2[Event, error]

+ func DefaultFilter(t Transcript) openresponses.Items

+ func Run(ctx context.Context, t Transcript, prompts openresponses.Items, cfg Config) iter.Seq2[Event, error]

+ func VisibleFilter(visible ...string) func(Transcript) openresponses.Items

+ type Agent struct

+ func New(cfg Config, opts ...Option) *Agent

+ func (a *Agent) Abort()

+ func (a *Agent) Config() Config

+ func (a *Agent) Continue(ctx context.Context) error

+ func (a *Agent) FollowUp(item openresponses.Item)

+ func (a *Agent) Prompt(ctx context.Context, items ...openresponses.Item) error

+ func (a *Agent) Resume(ctx context.Context, outputs ...*openresponses.FunctionCallOutput) error

+ func (a *Agent) State() State

+ func (a *Agent) Steer(item openresponses.Item)

+ func (a *Agent) Subscribe(fn func(context.Context, Event) error) (unsubscribe func())

+ func (a *Agent) WaitForIdle(ctx context.Context) error

+ type Config struct

+ AfterToolCall func(context.Context, ToolResultInfo) (*ToolOverride, error)

+ BeforeModelCall func(context.Context, *openresponses.Request) error

+ BeforeToolCall func(context.Context, ToolCallInfo) (*ToolDecision, error)

+ Description string

+ Filter func(Transcript) openresponses.Items

+ Instructions string

+ MaxParallelTools int

+ MaxTurns int

+ Model Model

+ ModelName string

+ Name string

+ Reasoning openresponses.ReasoningConfig

+ Request openresponses.Request

+ RequestExtra map[string]any

+ ShouldStopAfterTurn func(context.Context, TurnInfo) (bool, error)

+ Text openresponses.TextConfig

+ ToolExecution ExecutionMode

+ ToolProvider func(ctx context.Context) []agenttool.Tool

+ Tools []agenttool.Tool

+ Transform func(context.Context, Transcript) (Transcript, error)

+ func (c Config) BaseRequest(ctx context.Context) openresponses.Request

+ type Event interface

+ EventType func() string

+ type ExecutionMode int

+ const Parallel

+ const Sequential

+ type ItemEnd struct

+ Item openresponses.Item

+ ResponseID string

+ RunID string

+ Turn int

+ func (*ItemEnd) EventType() string

+ type ItemStart struct

+ Item openresponses.Item

+ ResponseID string

+ RunID string

+ Turn int

+ func (*ItemStart) EventType() string

+ type ItemUpdate struct

+ Item openresponses.Item

+ ResponseID string

+ RunID string

+ Stream openresponses.StreamEvent

+ Turn int

+ func (*ItemUpdate) EventType() string

+ type Model = openresponses.Streamer

+ type Option func(*Agent)

+ func WithTranscript(t Transcript) Option

+ type Reason string

+ const ReasonAborted

+ const ReasonDone

+ const ReasonError

+ const ReasonInputRequired

+ const ReasonStopped

+ type ResponseEnd struct

+ Response *openresponses.Response

+ RunID string

+ Turn int

+ func (*ResponseEnd) EventType() string

+ type RunEnd struct

+ Err error

+ Items Transcript

+ Pending []*openresponses.FunctionCall

+ Reason Reason

+ RunID string

+ func (*RunEnd) EventType() string

+ type RunStart struct

+ RunID string

+ func (*RunStart) EventType() string

+ type State struct

+ FollowUps int

+ Pending []*openresponses.FunctionCall

+ RunID string

+ Running bool

+ Steering int

+ Transcript Transcript

+ Turn int

+ type ToolCallInfo struct

+ Args json.RawMessage

+ Call *openresponses.FunctionCall

+ RunID string

+ Tool agenttool.Tool

+ Turn int

+ type ToolDecision struct

+ Args json.RawMessage

+ Block bool

+ Defer bool

+ Reason string

+ Terminate bool

+ type ToolEnd struct

+ Blocked bool

+ CallID string

+ Deferred bool

+ Err error

+ Name string

+ Result agenttool.Result

+ RunID string

+ Turn int

+ func (*ToolEnd) EventType() string

+ type ToolOverride struct

+ Err error

+ Result agenttool.Result

+ type ToolResultInfo struct

+ Args json.RawMessage

+ Call *openresponses.FunctionCall

+ Err error

+ Result agenttool.Result

+ RunID string

+ Tool agenttool.Tool

+ Turn int

+ type ToolStart struct

+ Args json.RawMessage

+ CallID string

+ Name string

+ RunID string

+ Turn int

+ func (*ToolStart) EventType() string

+ type ToolUpdate struct

+ CallID string

+ Name string

+ Partial agenttool.Result

+ RunID string

+ Turn int

+ func (*ToolUpdate) EventType() string

+ type Transcript = openresponses.Items

+ type TurnEnd struct

+ Response *openresponses.Response

+ RunID string

+ ToolResults []agenttool.Result

+ Turn int

+ func (*TurnEnd) EventType() string

+ type TurnInfo struct

+ Response *openresponses.Response

+ RunID string

+ ToolResults []agenttool.Result

+ Transcript Transcript

+ Turn int

+ type TurnStart struct

+ Request openresponses.Request

+ RunID string

+ Turn int

+ func (*TurnStart) EventType() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL