copilot

package module

Go to main page

Versions in this module

v0

v0.1.19

Jan 27, 2026

Changes in this version

type Attachment

+ FilePath *string

+ Selection *SelectionClass

+ Text *string

type AttachmentType

+ const Selection

type Client

+ func (c *Client) DeleteSession(sessionID string) error

+ func (c *Client) ListSessions() ([]SessionMetadata, error)

type Data

+ EventsRemoved *float64

+ MCPServerName *string

+ MCPToolName *string

+ UpToEventID *string

+ type DeleteSessionRequest struct

+ SessionID string

+ type DeleteSessionResponse struct

+ Error *string

+ Success bool

+ type End struct

+ Character float64

+ Line float64

+ type ListSessionsResponse struct

+ Sessions []SessionMetadata

type Result

+ DetailedContent *string

+ type SelectionClass struct

+ End End

+ Start Start

type SessionEventType

+ const SessionSnapshotRewind

+ type SessionMetadata struct

+ IsRemote bool

+ ModifiedTime string

+ SessionID string

+ StartTime string

+ Summary *string

+ type Start struct

+ Character float64

+ Line float64

v0.1.18

Jan 24, 2026

Changes in this version

+ func Float64(v float64) *float64

+ type InfiniteSessionConfig struct

+ BackgroundCompactionThreshold *float64

+ BufferExhaustionThreshold *float64

+ Enabled *bool

type Session

+ func (s *Session) WorkspacePath() string

type SessionConfig

+ InfiniteSessions *InfiniteSessionConfig

v0.1.17

Jan 23, 2026

v0.1.16

Jan 23, 2026

v0.1.16-preview.0

Jan 22, 2026

v0.1.15

Jan 22, 2026

Changes in this version

+ type AttachmentType string

+ const Directory

+ const File

type Client

+ func (c *Client) GetAuthStatus() (*GetAuthStatusResponse, error)

+ func (c *Client) GetStatus() (*GetStatusResponse, error)

+ func (c *Client) ListModels() ([]ModelInfo, error)

+ type CompactionTokensUsed struct

+ CachedInput float64

+ Input float64

+ Output float64

+ type ContextClass struct

+ Branch *string

+ Cwd string

+ GitRoot *string

+ Repository *string

+ type ContextUnion struct

+ ContextClass *ContextClass

+ String *string

+ func (x *ContextUnion) MarshalJSON() ([]byte, error)

+ func (x *ContextUnion) UnmarshalJSON(data []byte) error

+ type Data struct

+ APICallID *string

+ AgentDescription *string

+ AgentDisplayName *string

+ AgentName *string

+ Arguments interface{}

+ Attachments []Attachment

+ CacheReadTokens *float64

+ CacheWriteTokens *float64

+ CompactionTokensUsed *CompactionTokensUsed

+ Content *string

+ Context *ContextUnion

+ CopilotVersion *string

+ Cost *float64

+ CurrentTokens *float64

+ DeltaContent *string

+ Duration *float64

+ Error *ErrorUnion

+ ErrorType *string

+ EventCount *float64

+ HandoffTime *time.Time

+ HookInvocationID *string

+ HookType *string

+ InfoType *string

+ Initiator *string

+ Input interface{}

+ InputTokens *float64

+ Intent *string

+ IsUserRequested *bool

+ Message *string

+ MessageID *string

+ MessagesLength *float64

+ MessagesRemoved *float64

+ MessagesRemovedDuringTruncation *float64

+ Metadata *Metadata

+ Model *string

+ Name *string

+ NewModel *string

+ Output interface{}

+ OutputTokens *float64

+ ParentToolCallID *string

+ PartialOutput *string

+ PerformedBy *string

+ PostCompactionTokens *float64

+ PostTruncationMessagesLength *float64

+ PostTruncationTokensInMessages *float64

+ PreCompactionMessagesLength *float64

+ PreCompactionTokens *float64

+ PreTruncationMessagesLength *float64

+ PreTruncationTokensInMessages *float64

+ PreviousModel *string

+ Producer *string

+ ProgressMessage *string

+ ProviderCallID *string

+ QuotaSnapshots map[string]QuotaSnapshot

+ Reason *string

+ ReasoningID *string

+ RemoteSessionID *string

+ Repository *Repository

+ Result *Result

+ ResumeTime *time.Time

+ Role *Role

+ SelectedModel *string

+ SessionID *string

+ Source *string

+ SourceType *SourceType

+ Stack *string

+ StartTime *time.Time

+ Success *bool

+ Summary *string

+ SummaryContent *string

+ TokenLimit *float64

+ TokensRemoved *float64

+ TokensRemovedDuringTruncation *float64

+ ToolCallID *string

+ ToolName *string

+ ToolRequests []ToolRequest

+ ToolTelemetry map[string]interface{}

+ Tools []string

+ TotalResponseSizeBytes *float64

+ TransformedContent *string

+ TurnID *string

+ Version *float64

+ type ErrorClass struct

+ Code *string

+ Message string

+ Stack *string

+ type ErrorUnion struct

+ ErrorClass *ErrorClass

+ String *string

+ func (x *ErrorUnion) MarshalJSON() ([]byte, error)

+ func (x *ErrorUnion) UnmarshalJSON(data []byte) error

+ type GetAuthStatusResponse struct

+ AuthType *string

+ Host *string

+ IsAuthenticated bool

+ Login *string

+ StatusMessage *string

+ type GetModelsResponse struct

+ Models []ModelInfo

+ type GetStatusResponse struct

+ ProtocolVersion int

+ Version string

+ type Metadata struct

+ PromptVersion *string

+ Variables map[string]interface{}

+ type ModelBilling struct

+ Multiplier float64

+ type ModelCapabilities struct

+ Limits ModelLimits

+ Supports ModelSupports

+ type ModelInfo struct

+ Billing *ModelBilling

+ Capabilities ModelCapabilities

+ ID string

+ Name string

+ Policy *ModelPolicy

+ type ModelLimits struct

+ MaxContextWindowTokens int

+ MaxPromptTokens *int

+ Vision *ModelVisionLimits

+ type ModelPolicy struct

+ State string

+ Terms string

+ type ModelSupports struct

+ Vision bool

+ type ModelVisionLimits struct

+ MaxPromptImageSize int

+ MaxPromptImages int

+ SupportedMediaTypes []string

+ type QuotaSnapshot struct

+ EntitlementRequests float64

+ IsUnlimitedEntitlement bool

+ Overage float64

+ OverageAllowedWithExhaustedQuota bool

+ RemainingPercentage float64

+ ResetDate *time.Time

+ UsageAllowedWithExhaustedQuota bool

+ UsedRequests float64

+ type Repository struct

+ Branch *string

+ Name string

+ Owner string

+ type Result struct

+ Content string

type ResumeSessionConfig

+ DisabledSkills []string

+ SkillDirectories []string

+ type Role string

+ const Developer

+ const System

type SessionConfig

+ ConfigDir string

+ DisabledSkills []string

+ SkillDirectories []string

type SessionEvent

+ Data Data

+ Ephemeral *bool

+ ID string

+ ParentID *string

+ Timestamp time.Time

+ Type SessionEventType

+ func UnmarshalSessionEvent(data []byte) (SessionEvent, error)

+ func (r *SessionEvent) Marshal() ([]byte, error)

+ type SessionEventType string

+ const Abort

+ const AssistantIntent

+ const AssistantMessage

+ const AssistantMessageDelta

+ const AssistantReasoning

+ const AssistantReasoningDelta

+ const AssistantTurnEnd

+ const AssistantTurnStart

+ const AssistantUsage

+ const HookEnd

+ const HookStart

+ const PendingMessagesModified

+ const SessionCompactionComplete

+ const SessionCompactionStart

+ const SessionError

+ const SessionHandoff

+ const SessionIdle

+ const SessionInfo

+ const SessionModelChange

+ const SessionResume

+ const SessionStart

+ const SessionTruncation

+ const SessionUsageInfo

+ const SubagentCompleted

+ const SubagentFailed

+ const SubagentSelected

+ const SubagentStarted

+ const SystemMessage

+ const ToolExecutionComplete

+ const ToolExecutionPartialResult

+ const ToolExecutionProgress

+ const ToolExecutionStart

+ const ToolUserRequested

+ const UserMessage

+ type SourceType string

+ const Local

+ const Remote

+ type ToolRequest struct

+ Arguments interface{}

+ Name string

+ ToolCallID string

+ Type *ToolRequestType

+ type ToolRequestType string

+ const Custom

+ const Function

v0.1.15-preview.0

Jan 20, 2026

v0.1.14

Jan 19, 2026

Changes in this version

+ const SdkProtocolVersion

+ func Bool(v bool) *bool

+ func GetSdkProtocolVersion() int

+ type Attachment struct

+ DisplayName string

+ Path string

+ Type string

+ type AzureProviderOptions struct

+ APIVersion string

+ type Client struct

+ func NewClient(options *ClientOptions) *Client

+ func (c *Client) CreateSession(config *SessionConfig) (*Session, error)

+ func (c *Client) ForceStop()

+ func (c *Client) GetState() ConnectionState

+ func (c *Client) Ping(message string) (*PingResponse, error)

+ func (c *Client) ResumeSession(sessionID string) (*Session, error)

+ func (c *Client) ResumeSessionWithOptions(sessionID string, config *ResumeSessionConfig) (*Session, error)

+ func (c *Client) Start() error

+ func (c *Client) Stop() []error

+ type ClientOptions struct

+ AutoRestart *bool

+ AutoStart *bool

+ CLIPath string

+ CLIUrl string

+ Cwd string

+ Env []string

+ LogLevel string

+ Port int

+ UseStdio bool

+ type ConnectionState string

+ const StateConnected

+ const StateConnecting

+ const StateDisconnected

+ const StateError

+ type CustomAgentConfig struct

+ Description string

+ DisplayName string

+ Infer *bool

+ MCPServers map[string]MCPServerConfig

+ Name string

+ Prompt string

+ Tools []string

+ type JSONRPCClient struct

+ func NewJSONRPCClient(stdin io.WriteCloser, stdout io.ReadCloser) *JSONRPCClient

+ func (c *JSONRPCClient) Notify(method string, params map[string]interface{}) error

+ func (c *JSONRPCClient) Request(method string, params map[string]interface{}) (map[string]interface{}, error)

+ func (c *JSONRPCClient) SetNotificationHandler(handler NotificationHandler)

+ func (c *JSONRPCClient) SetRequestHandler(method string, handler RequestHandler)

+ func (c *JSONRPCClient) Start()

+ func (c *JSONRPCClient) Stop()

+ type JSONRPCError struct

+ Code int

+ Data map[string]interface{}

+ Message string

+ func (e *JSONRPCError) Error() string

+ type JSONRPCNotification struct

+ JSONRPC string

+ Method string

+ Params map[string]interface{}

+ type JSONRPCRequest struct

+ ID json.RawMessage

+ JSONRPC string

+ Method string

+ Params map[string]interface{}

+ type JSONRPCResponse struct

+ Error *JSONRPCError

+ ID json.RawMessage

+ JSONRPC string

+ Result map[string]interface{}

+ type MCPLocalServerConfig struct

+ Args []string

+ Command string

+ Cwd string

+ Env map[string]string

+ Timeout int

+ Tools []string

+ Type string

+ type MCPRemoteServerConfig struct

+ Headers map[string]string

+ Timeout int

+ Tools []string

+ Type string

+ URL string

+ type MCPServerConfig map[string]interface

+ type MessageOptions struct

+ Attachments []Attachment

+ Mode string

+ Prompt string

+ type NotificationHandler func(method string, params map[string]interface{})

+ type PermissionHandler func(request PermissionRequest, invocation PermissionInvocation) (PermissionRequestResult, error)

+ type PermissionInvocation struct

+ SessionID string

+ type PermissionRequest struct

+ Extra map[string]interface{}

+ Kind string

+ ToolCallID string

+ type PermissionRequestResult struct

+ Kind string

+ Rules []interface{}

+ type PingResponse struct

+ Message string

+ ProtocolVersion *int

+ Timestamp int64

+ type ProviderConfig struct

+ APIKey string

+ Azure *AzureProviderOptions

+ BaseURL string

+ BearerToken string

+ Type string

+ WireApi string

+ type RequestHandler func(params map[string]interface{}) (map[string]interface{}, *JSONRPCError)

+ type ResumeSessionConfig struct

+ CustomAgents []CustomAgentConfig

+ MCPServers map[string]MCPServerConfig

+ OnPermissionRequest PermissionHandler

+ Provider *ProviderConfig

+ Streaming bool

+ Tools []Tool

+ type Session struct

+ SessionID string

+ func NewSession(sessionID string, client *JSONRPCClient) *Session

+ func (s *Session) Abort() error

+ func (s *Session) Destroy() error

+ func (s *Session) GetMessages() ([]SessionEvent, error)

+ func (s *Session) On(handler SessionEventHandler) func()

+ func (s *Session) Send(options MessageOptions) (string, error)

+ func (s *Session) SendAndWait(options MessageOptions, timeout time.Duration) (*SessionEvent, error)

+ type SessionConfig struct

+ AvailableTools []string

+ CustomAgents []CustomAgentConfig

+ ExcludedTools []string

+ MCPServers map[string]MCPServerConfig

+ Model string

+ OnPermissionRequest PermissionHandler

+ Provider *ProviderConfig

+ SessionID string

+ Streaming bool

+ SystemMessage *SystemMessageConfig

+ Tools []Tool

+ type SessionCreateResponse struct

+ SessionID string

+ type SessionEvent = generated.SessionEvent

+ type SessionEventHandler func(event SessionEvent)

+ type SessionGetMessagesResponse struct

+ Events []SessionEvent

+ type SessionSendResponse struct

+ MessageID string

+ type SystemMessageAppendConfig struct

+ Content string

+ Mode string

+ type SystemMessageConfig struct

+ Content string

+ Mode string

+ type SystemMessageReplaceConfig struct

+ Content string

+ Mode string

+ type Tool struct

+ Description string

+ Handler ToolHandler

+ Name string

+ Parameters map[string]interface{}

+ func DefineTool[T any, U any](name, description string, handler func(T, ToolInvocation) (U, error)) Tool

+ type ToolBinaryResult struct

+ Data string

+ Description string

+ MimeType string

+ Type string

+ type ToolHandler func(invocation ToolInvocation) (ToolResult, error)

+ type ToolInvocation struct

+ Arguments interface{}

+ SessionID string

+ ToolCallID string

+ ToolName string

+ type ToolResult struct

+ BinaryResultsForLLM []ToolBinaryResult

+ Error string

+ ResultType string

+ SessionLog string

+ TextResultForLLM string

+ ToolTelemetry map[string]interface{}

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