Documentation
¶
Index ¶
- Variables
- func CodexErrorCode(err error) string
- type Capabilities
- type ConfigRequirements
- type Event
- type EventTransport
- type FileChange
- type ForkThreadRequest
- type InterruptTurnRequest
- type Item
- type ListThreadsRequest
- type Manager
- func (m *Manager) ArchiveThread(ctx context.Context, threadID string) error
- func (m *Manager) Close() error
- func (m *Manager) ForkThread(ctx context.Context, req ForkThreadRequest) (*ThreadDetail, error)
- func (m *Manager) InterruptTurn(ctx context.Context, req InterruptTurnRequest) error
- func (m *Manager) ListThreads(ctx context.Context, req ListThreadsRequest) ([]Thread, error)
- func (m *Manager) ReadCapabilities(ctx context.Context, cwd string) (*Capabilities, error)
- func (m *Manager) ReadThread(ctx context.Context, threadID string) (*ThreadDetail, error)
- func (m *Manager) RespondToRequest(ctx context.Context, threadID string, requestID string, ...) error
- func (m *Manager) StartReview(ctx context.Context, req StartReviewRequest) (*ThreadDetail, error)
- func (m *Manager) StartThread(ctx context.Context, req StartThreadRequest) (*ThreadDetail, error)
- func (m *Manager) StartTurn(ctx context.Context, req StartTurnRequest) (*Turn, error)
- func (m *Manager) Status(_ context.Context) Status
- func (m *Manager) SteerTurn(ctx context.Context, req SteerTurnRequest) (*Turn, error)
- func (m *Manager) SubscribeThreadEvents(ctx context.Context, threadID string, afterSeq int64) ([]Event, <-chan Event, error)
- func (m *Manager) UnarchiveThread(ctx context.Context, threadID string) error
- type ModelOption
- type OperationName
- type Options
- type PendingRequest
- type PendingRequestResponse
- type PermissionProfile
- type StartReviewRequest
- type StartThreadRequest
- type StartTurnRequest
- type Status
- type SteerTurnRequest
- type TextElement
- type Thread
- type ThreadDetail
- type ThreadRuntimeConfig
- type ThreadStreamState
- type ThreadTokenUsage
- type TokenUsageBreakdown
- type Turn
- type TurnError
- type UserInputEntry
- type UserInputOption
- type UserInputQuestion
- type WebSearchAction
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func CodexErrorCode ¶
Types ¶
type Capabilities ¶
type Capabilities struct {
Models []ModelOption `json:"models,omitempty"`
EffectiveConfig ThreadRuntimeConfig `json:"effective_config"`
Requirements *ConfigRequirements `json:"requirements,omitempty"`
Operations []OperationName `json:"operations,omitempty"`
}
type ConfigRequirements ¶
type Event ¶
type Event struct {
Seq int64 `json:"seq"`
Type string `json:"type"`
ThreadID string `json:"thread_id"`
TurnID string `json:"turn_id,omitempty"`
ItemID string `json:"item_id,omitempty"`
RequestID string `json:"request_id,omitempty"`
Thread *Thread `json:"thread,omitempty"`
Turn *Turn `json:"turn,omitempty"`
Item *Item `json:"item,omitempty"`
Request *PendingRequest `json:"request,omitempty"`
TokenUsage *ThreadTokenUsage `json:"token_usage,omitempty"`
Stream *ThreadStreamState `json:"stream,omitempty"`
Transport *EventTransport `json:"transport,omitempty"`
Delta string `json:"delta,omitempty"`
Status string `json:"status,omitempty"`
Flags []string `json:"flags,omitempty"`
ThreadName string `json:"thread_name,omitempty"`
SummaryIndex *int64 `json:"summary_index,omitempty"`
ContentIndex *int64 `json:"content_index,omitempty"`
Error string `json:"error,omitempty"`
TurnError *TurnError `json:"turn_error,omitempty"`
WillRetry bool `json:"will_retry,omitempty"`
}
type EventTransport ¶
type FileChange ¶
type ForkThreadRequest ¶
type InterruptTurnRequest ¶
type Item ¶
type Item struct {
ID string `json:"id"`
Type string `json:"type"`
TurnID string `json:"turn_id,omitempty"`
Text string `json:"text,omitempty"`
Phase string `json:"phase,omitempty"`
Summary []string `json:"summary,omitempty"`
Content []string `json:"content,omitempty"`
Command string `json:"command,omitempty"`
CWD string `json:"cwd,omitempty"`
Status string `json:"status,omitempty"`
AggregatedOutput string `json:"aggregated_output,omitempty"`
ExitCode *int `json:"exit_code,omitempty"`
DurationMs *int64 `json:"duration_ms,omitempty"`
Changes []FileChange `json:"changes,omitempty"`
Query string `json:"query,omitempty"`
Action *WebSearchAction `json:"action,omitempty"`
Inputs []UserInputEntry `json:"inputs,omitempty"`
}
type ListThreadsRequest ¶
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
func NewManager ¶
func (*Manager) ArchiveThread ¶
func (*Manager) ForkThread ¶
func (m *Manager) ForkThread(ctx context.Context, req ForkThreadRequest) (*ThreadDetail, error)
func (*Manager) InterruptTurn ¶
func (m *Manager) InterruptTurn(ctx context.Context, req InterruptTurnRequest) error
func (*Manager) ListThreads ¶
func (*Manager) ReadCapabilities ¶
func (*Manager) ReadThread ¶
func (*Manager) RespondToRequest ¶
func (*Manager) StartReview ¶
func (m *Manager) StartReview(ctx context.Context, req StartReviewRequest) (*ThreadDetail, error)
func (*Manager) StartThread ¶
func (m *Manager) StartThread(ctx context.Context, req StartThreadRequest) (*ThreadDetail, error)
func (*Manager) SubscribeThreadEvents ¶
type ModelOption ¶
type ModelOption struct {
ID string `json:"id"`
DisplayName string `json:"display_name"`
Description string `json:"description,omitempty"`
IsDefault bool `json:"is_default,omitempty"`
SupportsImageInput bool `json:"supports_image_input,omitempty"`
DefaultReasoningEffort string `json:"default_reasoning_effort,omitempty"`
SupportedReasoningEfforts []string `json:"supported_reasoning_efforts,omitempty"`
}
type OperationName ¶
type OperationName string
const ( OperationThreadArchive OperationName = "thread_archive" OperationThreadUnarchive OperationName = "thread_unarchive" OperationThreadFork OperationName = "thread_fork" OperationThreadListArchived OperationName = "thread_list_archived" OperationTurnSteer OperationName = "turn_steer" OperationTurnInterrupt OperationName = "turn_interrupt" OperationReviewStart OperationName = "review_start" )
type PendingRequest ¶
type PendingRequest struct {
ID string `json:"id"`
Type string `json:"type"`
ThreadID string `json:"thread_id"`
TurnID string `json:"turn_id"`
ItemID string `json:"item_id"`
Reason string `json:"reason,omitempty"`
Command string `json:"command,omitempty"`
CWD string `json:"cwd,omitempty"`
GrantRoot string `json:"grant_root,omitempty"`
AvailableDecisions []string `json:"available_decisions,omitempty"`
Questions []UserInputQuestion `json:"questions,omitempty"`
Permissions *PermissionProfile `json:"permissions,omitempty"`
AdditionalPermissions *PermissionProfile `json:"additional_permissions,omitempty"`
}
type PendingRequestResponse ¶
type PermissionProfile ¶
type StartReviewRequest ¶
type StartThreadRequest ¶
type StartTurnRequest ¶
type StartTurnRequest struct {
ThreadID string `json:"thread_id"`
InputText string `json:"input_text,omitempty"`
Inputs []UserInputEntry `json:"inputs,omitempty"`
CWD string `json:"cwd,omitempty"`
Model string `json:"model,omitempty"`
Effort string `json:"effort,omitempty"`
ApprovalPolicy string `json:"approval_policy,omitempty"`
SandboxMode string `json:"sandbox_mode,omitempty"`
ApprovalsReviewer string `json:"approvals_reviewer,omitempty"`
}
type Status ¶
type Status struct {
Available bool `json:"available"`
Ready bool `json:"ready"`
BinaryPath string `json:"binary_path,omitempty"`
AgentHomeDir string `json:"agent_home_dir,omitempty"`
CodexHome string `json:"codex_home,omitempty"`
UserAgent string `json:"user_agent,omitempty"`
PlatformFamily string `json:"platform_family,omitempty"`
PlatformOS string `json:"platform_os,omitempty"`
LastStderr string `json:"last_stderr,omitempty"`
RuntimePATH string `json:"runtime_path,omitempty"`
Error string `json:"error,omitempty"`
}
type SteerTurnRequest ¶
type SteerTurnRequest struct {
ThreadID string `json:"thread_id"`
ExpectedTurnID string `json:"expected_turn_id"`
Inputs []UserInputEntry `json:"inputs,omitempty"`
}
type TextElement ¶
type Thread ¶
type Thread struct {
ID string `json:"id"`
Preview string `json:"preview"`
Ephemeral bool `json:"ephemeral"`
ModelProvider string `json:"model_provider"`
CreatedAtUnixS int64 `json:"created_at_unix_s"`
UpdatedAtUnixS int64 `json:"updated_at_unix_s"`
Status string `json:"status"`
ActiveFlags []string `json:"active_flags,omitempty"`
Path string `json:"path,omitempty"`
CWD string `json:"cwd"`
CLIVersion string `json:"cli_version,omitempty"`
Source string `json:"source,omitempty"`
AgentNickname string `json:"agent_nickname,omitempty"`
AgentRole string `json:"agent_role,omitempty"`
Name string `json:"name,omitempty"`
Turns []Turn `json:"turns,omitempty"`
}
type ThreadDetail ¶
type ThreadDetail struct {
Thread Thread `json:"thread"`
RuntimeConfig ThreadRuntimeConfig `json:"runtime_config,omitempty"`
PendingRequests []PendingRequest `json:"pending_requests,omitempty"`
TokenUsage *ThreadTokenUsage `json:"token_usage,omitempty"`
LastAppliedSeq int64 `json:"last_applied_seq"`
Stream ThreadStreamState `json:"stream"`
ActiveStatus string `json:"active_status,omitempty"`
ActiveStatusFlags []string `json:"active_status_flags,omitempty"`
}
type ThreadRuntimeConfig ¶
type ThreadRuntimeConfig struct {
Model string `json:"model,omitempty"`
ModelProvider string `json:"model_provider,omitempty"`
CWD string `json:"cwd,omitempty"`
ApprovalPolicy string `json:"approval_policy,omitempty"`
ApprovalsReviewer string `json:"approvals_reviewer,omitempty"`
SandboxMode string `json:"sandbox_mode,omitempty"`
ReasoningEffort string `json:"reasoning_effort,omitempty"`
}
type ThreadStreamState ¶
type ThreadTokenUsage ¶
type ThreadTokenUsage struct {
Total TokenUsageBreakdown `json:"total"`
Last TokenUsageBreakdown `json:"last"`
ModelContextWindow *int64 `json:"model_context_window,omitempty"`
}
type TokenUsageBreakdown ¶
type TurnError ¶
type TurnError struct {
Message string `json:"message"`
AdditionalDetails string `json:"additional_details,omitempty"`
CodexErrorCode string `json:"codex_error_code,omitempty"`
}
func TurnErrorFromError ¶ added in v0.6.8
type UserInputEntry ¶
type UserInputOption ¶
type UserInputQuestion ¶
Click to show internal directories.
Click to hide internal directories.