ai

package module

Go to main page

Versions in this module

v1

v1.2.0

Aug 15, 2026

Changes in this version

+ func SupportsImages(c Client) bool

type Capabilities

+ Images bool

v1.1.1

Aug 11, 2026

v1.1.0

Aug 11, 2026

Changes in this version

+ var ErrBadStrictSchema = errors.New("ai: strict schema is not provider-compatible")

+ func SupportsHosted(c Client, h Hosted) bool

+ func ValidateStrictSchema(schema json.RawMessage) error

+ type Capabilities struct

+ Format FormatCapability

+ Hosted map[HostedKind]HostedCapability

+ func CapabilitiesOf(c Client) Capabilities

+ type Capable interface

+ Capabilities func() Capabilities

+ type FormatCapability struct

+ JSON FormatMode

+ JSONSchema FormatMode

+ Strict FormatMode

+ type HostedCapability struct

+ Policy HostedPolicyCapability

+ Web *HostedWebCapability

+ WithFormat FormatCapability

+ func HostedCapabilityOf(c Client, k HostedKind) (HostedCapability, bool)

+ type HostedPolicyCapability struct

+ Required bool

+ type HostedWebCapability struct

+ AllowDomains bool

+ BlockDomains bool

+ BothDomainLists bool

+ MaxUses bool

+ Region bool

v1.0.0

Aug 11, 2026

Changes in this version

+ var ErrBadHosted = errors.New("ai: unknown hosted capability")

+ var ErrBadHostedPolicy = errors.New("ai: unknown hosted policy")

+ var ErrDupHosted = errors.New("ai: hosted capability requested twice")

+ var ErrFormatWithHosted = errors.New("ai: provider cannot combine the requested format with a hosted capability")

+ var ErrHostedRequired = errors.New("ai: required hosted capability was not used")

+ var ErrNoHosted = errors.New("ai: provider cannot run the requested hosted capability")

type Chunk

+ Citations []Citation

+ Hosted []HostedReport

+ type Citation struct

+ CitedText string

+ EndByte int

+ StartByte int

+ Title string

+ URL string

+ type Hosted struct

+ Kind HostedKind

+ Policy HostedPolicy

+ Web *HostedWeb

+ func (h Hosted) Validate() error

+ type HostedKind int

+ const HostedWebSearch

+ func (k HostedKind) String() string

+ type HostedMode int

+ const HostedNative

+ const HostedNone

+ const HostedSkipped

+ func (m HostedMode) String() string

+ type HostedPolicy int

+ const HostedAuto

+ const HostedRequired

+ func (p HostedPolicy) String() string

+ type HostedReport struct

+ Calls int

+ Kind HostedKind

+ Mode HostedMode

+ type HostedWeb struct

+ AllowDomains []string

+ BlockDomains []string

+ MaxUses int

+ Region string

type Request

+ Hosted []Hosted

+ func (r *Request) HostedByKind(k HostedKind) (Hosted, bool)

+ func (r *Request) HostedReports(calls map[HostedKind]int) ([]HostedReport, error)

type Response

+ Hosted []HostedReport

+ func (r *Response) Citations() []Citation

type Text

+ Citations []Citation

v0

v0.4.1

Aug 5, 2026

v0.4.0

Aug 5, 2026

Changes in this version

+ const DefaultSchemaName

+ var ErrBadFormat = errors.New("ai: unknown format type")

+ var ErrBadSchema = errors.New("ai: format schema must be a JSON Schema object")

+ var ErrNoFormat = errors.New("ai: provider cannot produce the requested format")

+ var ErrNoSchema = errors.New("ai: FormatJSONSchema requires a schema")

+ var ErrNoText = errors.New("ai: response has no text")

+ type Format struct

+ Name string

+ Schema json.RawMessage

+ Strict bool

+ Type FormatType

+ func (f *Format) AppendInstruction(system string) string

+ func (f *Format) Instruction() string

+ func (f *Format) SchemaName() string

+ func (f *Format) Validate() error

+ type FormatMode int

+ const FormatEmulated

+ const FormatNative

+ const FormatNone

+ func (m FormatMode) String() string

+ type FormatType int

+ const FormatJSON

+ const FormatJSONSchema

+ const FormatText

+ func (t FormatType) String() string

type Request

+ Format *Format

type Response

+ Format FormatMode

+ func (r *Response) JSON(v any) error

v0.3.0

Jul 11, 2026

Changes in this version

+ var ErrNoRequest = errors.New("ai: request is nil")

type Message

+ func (m *Message) UnmarshalJSON(data []byte) error

+ func (m Message) MarshalJSON() ([]byte, error)

type Options

+ func (o Options) GoString() string

+ func (o Options) String() string

type Response

+ func (r *Response) UnmarshalJSON(data []byte) error

+ func (r Response) MarshalJSON() ([]byte, error)

v0.2.1

Jul 10, 2026

v0.2.0

Jul 10, 2026

v0.1.1

Jul 9, 2026

Changes in this version

type Message

+ func SystemText(s string) Message

type Response

+ func (r *Response) ToolCall(name string) (ToolUse, bool)

v0.1.0

Jul 8, 2026

Changes in this version

+ var ErrNoAPIKey = errors.New("ai: API key is required")

+ var ErrNoMessages = errors.New("ai: at least one message is required")

+ var ErrNoModel = errors.New("ai: model is required")

+ func SSEEvents(r io.Reader) iter.Seq2[string, error]

+ type APIError struct

+ Code string

+ Message string

+ Raw json.RawMessage

+ Status int

+ Type string

+ func (e *APIError) Error() string

+ type Chunk struct

+ Done bool

+ Raw json.RawMessage

+ Text string

+ ToolCall *ToolUse

+ Usage *Usage

+ type Client interface

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

+ Stream func(ctx context.Context, req *Request) iter.Seq2[Chunk, error]

+ type Image struct

+ Data []byte

+ MIME string

+ URL string

+ type Message struct

+ Parts []Part

+ Role Role

+ func AssistantText(s string) Message

+ func UserText(s string) Message

+ type Option func(*Options)

+ func WithBaseURL(u string) Option

+ func WithHTTPClient(c *http.Client) Option

+ func WithHeader(key, value string) Option

+ func WithMaxRetries(n int) Option

+ func WithTimeout(d time.Duration) Option

+ type Options struct

+ APIKey string

+ BaseURL string

+ HTTPClient *http.Client

+ Headers http.Header

+ MaxRetries int

+ Timeout time.Duration

+ func NewOptions(apiKey string, opts ...Option) Options

+ func (o Options) Do(ctx context.Context, method, url string, body []byte, headers http.Header) (*http.Response, error)

+ type Part interface

+ type Request struct

+ MaxTokens int

+ Messages []Message

+ Model string

+ Stop []string

+ System string

+ Temperature *float64

+ ToolChoice ToolChoice

+ Tools []Tool

+ TopP *float64

+ func (r *Request) Validate() error

+ type Response struct

+ Model string

+ Parts []Part

+ Raw json.RawMessage

+ StopReason string

+ Usage Usage

+ func (r *Response) Text() string

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

+ type Role string

+ const RoleAssistant

+ const RoleSystem

+ const RoleTool

+ const RoleUser

+ type Text struct

+ Text string

+ type Tool struct

+ Description string

+ Name string

+ Schema json.RawMessage

+ type ToolChoice int

+ const ToolAuto

+ const ToolNone

+ const ToolRequired

+ type ToolResult struct

+ Content string

+ ID string

+ IsError bool

+ type ToolUse struct

+ ID string

+ Input json.RawMessage

+ Name string

+ type Usage struct

+ InputTokens int

+ OutputTokens int

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