Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

skyl

package module

Go to main page

Versions in this module

v1

v1.0.0

Sep 6, 2026

v0

v0.1.0

Aug 5, 2026

Changes in this version

+ const OpComplete

+ const OpModels

+ const OpStream

+ const OpStreamEnd

+ var ErrAuth = errors.New("skyl: authentication failed")

+ var ErrBadRequest = errors.New("skyl: invalid request")

+ var ErrNotFound = errors.New("skyl: not found")

+ var ErrRateLimit = errors.New("skyl: rate limited")

+ var ErrRefusal = errors.New("skyl: model declined the request")

+ var ErrServer = errors.New("skyl: provider server error")

+ var ErrStreamClosed = errors.New("skyl: stream is closed")

+ var ErrUnsupported = errors.New("skyl: unsupported by this provider")

+ func ClassifyStatus(status int) error

+ func ParseRetryAfter(v string) time.Duration

+ func Unsupportedf(provider, format string, args ...any) error

+ type Client struct

+ func New(p Provider, opts ...Option) *Client

+ func (c *Client) Complete(ctx context.Context, req *Request) (*Response, error)

+ func (c *Client) Models(ctx context.Context) ([]ModelInfo, error)

+ func (c *Client) Provider() Provider

+ func (c *Client) Stream(ctx context.Context, req *Request) (Stream, error)

+ type Effort string

+ const EffortHigh

+ const EffortLow

+ const EffortMax

+ const EffortMedium

+ type Error struct

+ Body string

+ Kind error

+ Message string

+ Provider string

+ RetryAfter time.Duration

+ StatusCode int

+ func NewError(provider string, status int, kind error, message string, body []byte) *Error

+ func (e *Error) Cause() error

+ func (e *Error) Error() string

+ func (e *Error) Retryable() bool

+ func (e *Error) Unwrap() []error

+ func (e *Error) WithCause(err error) *Error

+ type EventType string

+ const EventDone

+ const EventTextDelta

+ const EventThinkingDelta

+ const EventToolCall

+ type Hook func(ctx context.Context, ev HookEvent)

+ type HookEvent struct

+ Attempt int

+ Completed bool

+ Duration time.Duration

+ Err error

+ Model string

+ Operation string

+ Provider string

+ Request *Request

+ ResponseID string

+ ResponseModel string

+ StopReason StopReason

+ Usage Usage

+ type Image struct

+ Data []byte

+ MediaType string

+ URL string

+ type Message struct

+ Parts []Part

+ Role Role

+ func AssistantText(text string) Message

+ func ToolErrorMessage(callID, content string) Message

+ func ToolResultMessage(callID, content string) Message

+ func UserImage(mediaType string, data []byte, caption string) Message

+ func UserText(text string) Message

+ func (m Message) Text() string

+ func (m Message) ToolCalls() []ToolCall

+ type ModelInfo struct

+ ContextWindow int

+ DisplayName string

+ ID string

+ MaxOutputTokens int

+ Provider string

+ Raw json.RawMessage

+ type Option func(*Client)

+ func WithHook(h Hook) Option

+ func WithMaxRetries(n int) Option

+ func WithRetryAfterCap(d time.Duration) Option

+ func WithRetryDelay(base, max time.Duration) Option

+ func WithTimeout(d time.Duration) Option

+ type Part interface

+ type Provider interface

+ Complete func(ctx context.Context, req *Request) (*Response, error)

+ Models func(ctx context.Context) ([]ModelInfo, error)

+ Name func() string

+ Stream func(ctx context.Context, req *Request) (Stream, error)

+ type Request struct

+ MaxTokens int

+ Messages []Message

+ Model string

+ ProviderOptions map[string]any

+ ResponseFormat *ResponseFormat

+ Stop []string

+ System string

+ Temperature *float64

+ Thinking *Thinking

+ ToolChoice *ToolChoice

+ Tools []Tool

+ TopP *float64

+ func (r *Request) Validate() error

+ type Response struct

+ ID string

+ Message Message

+ Model string

+ Provider string

+ Raw json.RawMessage

+ StopReason StopReason

+ Usage Usage

+ func CollectStream(s Stream, provider, model string) (*Response, error)

+ func (r *Response) Text() string

+ func (r *Response) ToolCalls() []ToolCall

+ type ResponseFormat struct

+ Name string

+ Schema map[string]any

+ type Role string

+ const RoleAssistant

+ const RoleTool

+ const RoleUser

+ func (r Role) Valid() bool

+ type StopReason string

+ const StopEndTurn

+ const StopMaxTokens

+ const StopRefusal

+ const StopStopSequence

+ const StopToolUse

+ const StopUnknown

+ type Stream interface

+ Close func() error

+ Err func() error

+ Event func() StreamEvent

+ Next func() bool

+ type StreamEvent struct

+ Raw json.RawMessage

+ StopReason StopReason

+ Text string

+ ToolCall *ToolCall

+ Type EventType

+ Usage *Usage

+ type Text struct

+ Text string

+ type Thinking struct

+ Effort Effort

+ Enabled bool

+ type Tool struct

+ Description string

+ Name string

+ Parameters map[string]any

+ type ToolCall struct

+ Arguments json.RawMessage

+ ID string

+ Name string

+ type ToolChoice struct

+ Mode ToolChoiceMode

+ Name string

+ type ToolChoiceMode string

+ const ToolChoiceAuto

+ const ToolChoiceNone

+ const ToolChoiceRequired

+ const ToolChoiceSpecific

+ type ToolResult struct

+ CallID string

+ Content string

+ IsError bool

+ type Usage struct

+ CacheReadTokens int

+ CacheWriteTokens int

+ InputTokens int

+ OutputTokens int

+ func (u Usage) Add(other Usage) Usage

+ func (u Usage) TotalTokens() int