runtime

package
v1.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 2, 2025 License: Apache-2.0 Imports: 26 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentChoiceEvent 

type AgentChoiceEvent struct {
	Type    string `json:"type"`
	Content string `json:"content"`
	AgentContext
}

type AgentChoiceReasoningEvent added in v1.0.5 

type AgentChoiceReasoningEvent struct {
	Type    string `json:"type"`
	Content string `json:"content"`
	AgentContext
}

type AgentContext 

type AgentContext struct {
	AgentName string `json:"agent_name,omitempty"`
}

AgentContext carries optional agent attribution for an event.

func (AgentContext) GetAgentName 

func (a AgentContext) GetAgentName() string

GetAgentName returns the agent name for events embedding AgentContext.

type AuthorizationRequiredEvent added in v1.2.0 

type AuthorizationRequiredEvent struct {
	Type         string `json:"type"`
	ServerURL    string `json:"server_url"`
	ServerType   string `json:"server_type"`
	Confirmation string `json:"confirmation"` // only  "pending" | "confirmed" | "denied"
	AgentContext
}

func (*AuthorizationRequiredEvent) GetAgentName added in v1.2.0 

func (e *AuthorizationRequiredEvent) GetAgentName() string

type Client added in v1.3.1 

type Client struct {
	// contains filtered or unexported fields
}

Client is an HTTP client for the cagent server API

func NewClient added in v1.3.1 

func NewClient(baseURL string, opts ...ClientOption) (*Client, error)

NewClient creates a new HTTP client for the cagent server

func (*Client) CreateAgent added in v1.3.1 

func (c *Client) CreateAgent(ctx context.Context, prompt string) (*api.CreateAgentResponse, error)

CreateAgent creates a new agent using a prompt

func (*Client) CreateAgentConfig added in v1.3.1 

func (c *Client) CreateAgentConfig(ctx context.Context, filename, model, description, instruction string) (*api.CreateAgentConfigResponse, error)

CreateAgentConfig creates a new agent manually with YAML configuration

func (*Client) CreateSession added in v1.3.1 

func (c *Client) CreateSession(ctx context.Context, sessTemplate *session.Session) (*session.Session, error)

CreateSession creates a new session

func (*Client) DeleteAgent added in v1.3.1 

func (c *Client) DeleteAgent(ctx context.Context, filePath string) (*api.DeleteAgentResponse, error)

DeleteAgent deletes an agent by file path

func (*Client) DeleteSession added in v1.3.1 

func (c *Client) DeleteSession(ctx context.Context, id string) error

DeleteSession deletes a session by ID

func (*Client) EditAgentConfig added in v1.3.1 

func (c *Client) EditAgentConfig(ctx context.Context, filename string, config v2.Config) (*api.EditAgentConfigResponse, error)

EditAgentConfig edits an agent configuration

func (*Client) ExportAgents added in v1.3.1 

func (c *Client) ExportAgents(ctx context.Context) (*api.ExportAgentsResponse, error)

ExportAgents exports multiple agents as a zip file

func (*Client) GetAgent added in v1.3.1 

func (c *Client) GetAgent(ctx context.Context, id string) (*v2.Config, error)

GetAgent retrieves an agent by ID

func (*Client) GetAgents added in v1.3.1 

func (c *Client) GetAgents(ctx context.Context) ([]api.Agent, error)

GetAgents retrieves all available agents

func (*Client) GetDesktopToken added in v1.3.1 

func (c *Client) GetDesktopToken(ctx context.Context) (*api.DesktopTokenResponse, error)

GetDesktopToken retrieves a desktop authentication token

func (*Client) GetSession added in v1.3.1 

func (c *Client) GetSession(ctx context.Context, id string) (*api.SessionResponse, error)

GetSession retrieves a session by ID

func (*Client) GetSessions added in v1.3.1 

func (c *Client) GetSessions(ctx context.Context) ([]api.SessionsResponse, error)

GetSessions retrieves all sessions

func (*Client) ImportAgent added in v1.3.1 

func (c *Client) ImportAgent(ctx context.Context, filePath string) (*api.ImportAgentResponse, error)

ImportAgent imports an agent from a file path

func (*Client) PullAgent added in v1.3.1 

func (c *Client) PullAgent(ctx context.Context, name string) (*api.PullAgentResponse, error)

PullAgent pulls an agent from a remote registry

func (*Client) PushAgent added in v1.3.1 

func (c *Client) PushAgent(ctx context.Context, filepath, tag string) (*api.PushAgentResponse, error)

PushAgent pushes an agent to a remote registry

func (*Client) ResumeCodeReceived added in v1.3.1 

func (c *Client) ResumeCodeReceived(ctx context.Context, code, state string) error

func (*Client) ResumeSession added in v1.3.1 

func (c *Client) ResumeSession(ctx context.Context, id, confirmation string) error

ResumeSession resumes a session by ID

func (*Client) ResumeStartAuthorizationFlow added in v1.3.1 

func (c *Client) ResumeStartAuthorizationFlow(ctx context.Context, id string, confirmation bool) error

func (*Client) RunAgent added in v1.3.1 

func (c *Client) RunAgent(ctx context.Context, sessionID, agent string, messages []api.Message) (<-chan Event, error)

RunAgent executes an agent and returns a channel of streaming events

func (*Client) RunAgentWithAgentName added in v1.3.1 

func (c *Client) RunAgentWithAgentName(ctx context.Context, sessionID, agent, agentName string, messages []api.Message) (<-chan Event, error)

RunAgentWithAgentName executes an agent with a specific agent name and returns a channel of streaming events

type ClientOption added in v1.3.1 

type ClientOption func(*Client)

ClientOption is a function for configuring the Client

func WithHTTPClient added in v1.3.1 

func WithHTTPClient(client *http.Client) ClientOption

WithHTTPClient sets a custom HTTP client

func WithTimeout added in v1.3.1 

func WithTimeout(timeout time.Duration) ClientOption

WithTimeout sets the HTTP client timeout

type ErrorEvent 

type ErrorEvent struct {
	Type  string `json:"type"`
	Error string `json:"error"`
	AgentContext
}

type ErrorResponse added in v1.3.1 

type ErrorResponse struct {
	Error string `json:"error"`
}

ErrorResponse represents an error response from the API

type Event 

type Event interface {
	GetAgentName() string
	// contains filtered or unexported methods
}

func AgentChoice 

func AgentChoice(agentName, content string) Event

func AgentChoiceReasoning added in v1.0.5 

func AgentChoiceReasoning(agentName, content string) Event

func AuthorizationRequired added in v1.2.0 

func AuthorizationRequired(serverURL, serverType, confirmation, agentName string) Event

func Error 

func Error(msg string) Event

func MaxIterationsReached added in v1.3.5 

func MaxIterationsReached(maxIterations int) Event

func PartialToolCall 

func PartialToolCall(toolCall tools.ToolCall, toolDefinition tools.Tool, agentName string) Event

func SessionCompaction 

func SessionCompaction(sessionID, status, agentName string) Event

func SessionSummary 

func SessionSummary(sessionID, summary, agentName string) Event

func SessionTitle 

func SessionTitle(sessionID, title, agentName string) Event

func ShellOutput added in v1.0.0 

func ShellOutput(output string) Event

func StreamStarted 

func StreamStarted(sessionID, agentName string) Event

func StreamStopped 

func StreamStopped(sessionID, agentName string) Event

func TokenUsage 

func TokenUsage(inputTokens, outputTokens, contextLength, contextLimit int, cost float64) Event

func ToolCall 

func ToolCall(toolCall tools.ToolCall, toolDefinition tools.Tool, agentName string) Event

func ToolCallConfirmation 

func ToolCallConfirmation(toolCall tools.ToolCall, toolDefinition tools.Tool, agentName string) Event

func ToolCallResponse 

func ToolCallResponse(toolCall tools.ToolCall, response, agentName string) Event

func UserMessage 

func UserMessage(message string) Event

type MaxIterationsReachedEvent added in v1.3.5 

type MaxIterationsReachedEvent struct {
	Type          string `json:"type"`
	MaxIterations int    `json:"max_iterations"`
	AgentContext
}

func (*MaxIterationsReachedEvent) GetAgentName added in v1.3.5 

func (e *MaxIterationsReachedEvent) GetAgentName() string

type Opt 

type Opt func(*runtime)

func WithCurrentAgent 

func WithCurrentAgent(agentName string) Opt

func WithManagedOAuth added in v1.5.10 

func WithManagedOAuth(managed bool) Opt

func WithModelStore added in v1.5.4 

func WithModelStore(store modelStore) Opt

func WithRootSessionID added in v1.6.1 

func WithRootSessionID(sessionID string) Opt

func WithSessionCompaction 

func WithSessionCompaction(sessionCompaction bool) Opt

func WithTracer 

func WithTracer(t trace.Tracer) Opt

WithTracer sets a custom OpenTelemetry tracer; if not provided, tracing is disabled (no-op).

type PartialToolCallEvent 

type PartialToolCallEvent struct {
	Type           string         `json:"type"`
	ToolCall       tools.ToolCall `json:"tool_call"`
	ToolDefinition tools.Tool     `json:"tool_definition"`
	AgentContext
}

PartialToolCallEvent is sent when a tool call is first received (partial/complete)

type RemoteRuntime added in v1.3.1 

type RemoteRuntime struct {
	// contains filtered or unexported fields
}

RemoteRuntime implements the Interface using a remote client

func NewRemoteRuntime added in v1.3.1 

func NewRemoteRuntime(client *Client, opts ...RemoteRuntimeOption) (*RemoteRuntime, error)

NewRemoteRuntime creates a new remote runtime that implements the Interface

func (*RemoteRuntime) CurrentAgent added in v1.3.1 

func (r *RemoteRuntime) CurrentAgent() *agent.Agent

CurrentAgent returns the currently active agent

func (*RemoteRuntime) Resume added in v1.3.1 

func (r *RemoteRuntime) Resume(ctx context.Context, confirmationType string)

Resume allows resuming execution after user confirmation

func (*RemoteRuntime) ResumeCodeReceived added in v1.3.1 

func (r *RemoteRuntime) ResumeCodeReceived(ctx context.Context, code, state string) error

Resume allows resuming execution after user confirmation

func (*RemoteRuntime) ResumeStartAuthorizationFlow added in v1.3.1 

func (r *RemoteRuntime) ResumeStartAuthorizationFlow(ctx context.Context, confirmationType bool)

Resume allows resuming execution after user confirmation

func (*RemoteRuntime) Run added in v1.3.1 

func (r *RemoteRuntime) Run(ctx context.Context, sess *session.Session) ([]session.Message, error)

Run starts the agent's interaction loop and returns the final messages

func (*RemoteRuntime) RunStream added in v1.3.1 

func (r *RemoteRuntime) RunStream(ctx context.Context, sess *session.Session) <-chan Event

RunStream starts the agent's interaction loop and returns a channel of events

func (*RemoteRuntime) Summarize added in v1.3.1 

func (r *RemoteRuntime) Summarize(ctx context.Context, sess *session.Session, events chan Event)

Summarize generates a summary for the session

type RemoteRuntimeOption added in v1.3.1 

type RemoteRuntimeOption func(*RemoteRuntime)

RemoteRuntimeOption is a function for configuring the RemoteRuntime

func WithRemoteAgentFilename added in v1.3.1 

func WithRemoteAgentFilename(filename string) RemoteRuntimeOption

WithRemoteAgentFilename sets the agent filename to use with the remote API

func WithRemoteCurrentAgent added in v1.3.1 

func WithRemoteCurrentAgent(agentName string) RemoteRuntimeOption

WithRemoteCurrentAgent sets the current agent name

type ResumeType 

type ResumeType string
const (
	ResumeTypeApprove        ResumeType = "approve"
	ResumeTypeApproveSession ResumeType = "approve-session"
	ResumeTypeReject         ResumeType = "reject"
)

type Runtime 

type Runtime interface {
	// CurrentAgent returns the currently active agent
	CurrentAgent() *agent.Agent
	// RunStream starts the agent's interaction loop and returns a channel of events
	RunStream(ctx context.Context, sess *session.Session) <-chan Event
	// Run starts the agent's interaction loop and returns the final messages
	Run(ctx context.Context, sess *session.Session) ([]session.Message, error)
	// Resume allows resuming execution after user confirmation
	Resume(ctx context.Context, confirmationType string)
	// Summarize generates a summary for the session
	Summarize(ctx context.Context, sess *session.Session, events chan Event)
	// ResumeStartAuthorizationFlow signals that user confirmation has been given to start the OAuth flow
	ResumeStartAuthorizationFlow(_ context.Context, confirmation bool)
	// ResumeCodeReceived sends the OAuth authorization code and state to the runtime after user has completed the OAuth flow in their browser
	ResumeCodeReceived(_ context.Context, code, state string) error
}

Runtime defines the contract for runtime execution

func New 

func New(agents *team.Team, opts ...Opt) (Runtime, error)

New creates a new runtime for an agent and its team

type SessionCompactionEvent 

type SessionCompactionEvent struct {
	Type      string `json:"type"`
	SessionID string `json:"session_id"`
	Status    string `json:"status"`
	AgentContext
}

type SessionSummaryEvent 

type SessionSummaryEvent struct {
	Type      string `json:"type"`
	SessionID string `json:"session_id"`
	Summary   string `json:"summary"`
	AgentContext
}

type SessionTitleEvent 

type SessionTitleEvent struct {
	Type      string `json:"type"`
	SessionID string `json:"session_id"`
	Title     string `json:"title"`
	AgentContext
}

type ShellOutputEvent added in v1.0.0 

type ShellOutputEvent struct {
	Type   string `json:"type"`
	Output string `json:"error"`
}

func (*ShellOutputEvent) GetAgentName added in v1.0.0 

func (e *ShellOutputEvent) GetAgentName() string

type StreamStartedEvent 

type StreamStartedEvent struct {
	Type      string `json:"type"`
	SessionID string `json:"session_id,omitempty"`
	AgentContext
}

func (*StreamStartedEvent) GetAgentName 

func (e *StreamStartedEvent) GetAgentName() string

type StreamStoppedEvent 

type StreamStoppedEvent struct {
	Type      string `json:"type"`
	SessionID string `json:"session_id,omitempty"`
	AgentContext
}

func (*StreamStoppedEvent) GetAgentName 

func (e *StreamStoppedEvent) GetAgentName() string

type TokenUsageEvent 

type TokenUsageEvent struct {
	Type  string `json:"type"`
	Usage *Usage `json:"usage"`
	AgentContext
}

type ToolCallConfirmationEvent 

type ToolCallConfirmationEvent struct {
	Type           string         `json:"type"`
	ToolCall       tools.ToolCall `json:"tool_call"`
	ToolDefinition tools.Tool     `json:"tool_definition"`
	AgentContext
}

type ToolCallEvent 

type ToolCallEvent struct {
	Type           string         `json:"type"`
	ToolCall       tools.ToolCall `json:"tool_call"`
	ToolDefinition tools.Tool     `json:"tool_definition"`
	AgentContext
}

ToolCallEvent is sent when a tool call is received

type ToolCallResponseEvent 

type ToolCallResponseEvent struct {
	Type     string         `json:"type"`
	ToolCall tools.ToolCall `json:"tool_call"`
	Response string         `json:"response"`
	AgentContext
}

type ToolHandler 

type ToolHandler func(ctx context.Context, sess *session.Session, toolCall tools.ToolCall, events chan Event) (*tools.ToolCallResult, error)

ToolHandler is a function type for handling tool calls

type Usage 

type Usage struct {
	InputTokens   int     `json:"input_tokens"`
	OutputTokens  int     `json:"output_tokens"`
	ContextLength int     `json:"context_length"`
	ContextLimit  int     `json:"context_limit"`
	Cost          float64 `json:"cost"`
}

type UserMessageEvent 

type UserMessageEvent struct {
	Type    string `json:"type"`
	Message string `json:"message"`
}

UserMessageEvent is sent when a user message is received

func (*UserMessageEvent) GetAgentName 

func (e *UserMessageEvent) GetAgentName() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.