gains

package module

Go to main page

Versions in this module

v0

v0.2.11

Dec 23, 2025

Changes in this version

+ type ImageAspectRatio string

+ const ImageAspectRatio16x9

+ const ImageAspectRatio1x1

+ const ImageAspectRatio21x9

+ const ImageAspectRatio2x3

+ const ImageAspectRatio3x2

+ const ImageAspectRatio3x4

+ const ImageAspectRatio4x3

+ const ImageAspectRatio9x16

+ type ImageOutputSize string

+ const ImageOutputSize1K

+ const ImageOutputSize2K

+ const ImageOutputSize4K

type Option

+ func WithImageAspectRatio(ratio ImageAspectRatio) Option

+ func WithImageOutputSize(size ImageOutputSize) Option

type Options

+ ImageAspectRatio ImageAspectRatio

+ ImageOutputSize ImageOutputSize

v0.2.10

Dec 21, 2025

Changes in this version

+ func ModelSupportsImageOutput(m Model) bool

+ type ImageOutputCapable interface

+ SupportsImageOutput func() bool

type Option

+ func WithImageOutput() Option

type Options

+ ImageOutput bool

type Response

+ Parts []ContentPart

+ func (r Response) HasParts() bool

v0.2.9

Dec 20, 2025

Changes in this version

type Provider

+ const ProviderVertex

v0.2.8

Dec 19, 2025

Changes in this version

type EmbeddingOption

+ func WithEmbeddingRetry(cfg RetryConfig) EmbeddingOption

+ func WithEmbeddingRetryDisabled() EmbeddingOption

type EmbeddingOptions

+ RetryConfig *RetryConfig

type ImageOption

+ func WithImageRetry(cfg RetryConfig) ImageOption

+ func WithImageRetryDisabled() ImageOption

type ImageOptions

+ RetryConfig *RetryConfig

type Option

+ func WithRetry(cfg RetryConfig) Option

+ func WithRetryDisabled() Option

type Options

+ RetryConfig *RetryConfig

+ type RetryConfig struct

+ InitialDelay time.Duration

+ Jitter float64

+ MaxAttempts int

+ MaxDelay time.Duration

+ Multiplier float64

+ func DefaultRetryConfig() RetryConfig

+ func DisabledRetryConfig() RetryConfig

+ func NewRetryConfig(maxAttempts int, initialDelay, maxDelay time.Duration, ...) RetryConfig

v0.2.7

Dec 19, 2025

v0.2.6

Dec 19, 2025

Changes in this version

+ type UnmarshalError struct

+ Content string

+ Context string

+ Err error

+ TargetType string

+ func (e *UnmarshalError) Error() string

+ func (e *UnmarshalError) Unwrap() error

v0.2.5

Dec 19, 2025

v0.2.4

Dec 18, 2025

Changes in this version

+ func GenerateMessageID() string

+ func IsPermanent(err error) bool

+ func IsTransient(err error) bool

+ func IsUserInput(err error) bool

+ func MustSchemaFor[T any]() json.RawMessage

+ func RetryAfterOf(err error) time.Duration

+ func SchemaFor[T any]() (json.RawMessage, error)

+ func StatusCodeOf(err error) int

+ type CategorizedError interface

+ Category func() ErrorCategory

+ RetryAfter func() time.Duration

+ Retryable func() bool

+ StatusCode func() int

+ type Error struct

+ Cat ErrorCategory

+ Cause error

+ Code int

+ Msg string

+ RetryDelay time.Duration

+ func NewPermanentError(msg string, statusCode int, cause error) *Error

+ func NewTransientError(msg string, statusCode int, cause error) *Error

+ func NewTransientErrorWithRetry(msg string, statusCode int, retryAfter time.Duration, cause error) *Error

+ func NewUserInputError(msg string, statusCode int, cause error) *Error

+ func (e *Error) Category() ErrorCategory

+ func (e *Error) Error() string

+ func (e *Error) RetryAfter() time.Duration

+ func (e *Error) Retryable() bool

+ func (e *Error) StatusCode() int

+ func (e *Error) Unwrap() error

+ type ErrorCategory string

+ const ErrorPermanent

+ const ErrorTransient

+ const ErrorUserInput

type Message

+ ID string

v0.2.3

Dec 16, 2025

v0.2.1

Dec 16, 2025

v0.2.0

Dec 16, 2025

v0.1.0

Dec 16, 2025

Changes in this version

+ var ErrEmptyInput = errors.New("empty input")

+ type ChatProvider interface

+ Chat func(ctx context.Context, messages []Message, opts ...Option) (*Response, error)

+ ChatStream func(ctx context.Context, messages []Message, opts ...Option) (<-chan StreamEvent, error)

+ type ContentPart struct

+ Base64 string

+ ImageURL string

+ MimeType string

+ Text string

+ Type ContentPartType

+ func NewImageBase64Part(base64Data, mimeType string) ContentPart

+ func NewImageURLPart(url string) ContentPart

+ func NewTextPart(text string) ContentPart

+ type ContentPartType string

+ const ContentPartTypeImage

+ const ContentPartTypeText

+ type EmbeddingOption func(*EmbeddingOptions)

+ func WithEmbeddingDimensions(dims int) EmbeddingOption

+ func WithEmbeddingModel(model Model) EmbeddingOption

+ func WithEmbeddingTaskType(taskType EmbeddingTaskType) EmbeddingOption

+ type EmbeddingOptions struct

+ Dimensions int

+ Model Model

+ TaskType EmbeddingTaskType

+ func ApplyEmbeddingOptions(opts ...EmbeddingOption) *EmbeddingOptions

+ type EmbeddingProvider interface

+ Embed func(ctx context.Context, texts []string, opts ...EmbeddingOption) (*EmbeddingResponse, error)

+ type EmbeddingResponse struct

+ Embeddings [][]float64

+ Usage Usage

+ type EmbeddingTaskType string

+ const EmbeddingTaskTypeClassification

+ const EmbeddingTaskTypeClustering

+ const EmbeddingTaskTypeRetrievalDocument

+ const EmbeddingTaskTypeRetrievalQuery

+ const EmbeddingTaskTypeSemanticSimilarity

+ type GeneratedImage struct

+ Base64 string

+ RevisedPrompt string

+ URL string

+ type ImageError struct

+ Err error

+ Op string

+ URL string

+ func (e *ImageError) Error() string

+ func (e *ImageError) Unwrap() error

+ type ImageFormat string

+ const ImageFormatBase64

+ const ImageFormatURL

+ type ImageOption func(*ImageOptions)

+ func WithImageCount(n int) ImageOption

+ func WithImageFormat(f ImageFormat) ImageOption

+ func WithImageModel(model Model) ImageOption

+ func WithImageQuality(q ImageQuality) ImageOption

+ func WithImageSize(size ImageSize) ImageOption

+ func WithImageStyle(s ImageStyle) ImageOption

+ type ImageOptions struct

+ Count int

+ Format ImageFormat

+ Model Model

+ Quality ImageQuality

+ Size ImageSize

+ Style ImageStyle

+ func ApplyImageOptions(opts ...ImageOption) *ImageOptions

+ type ImageProvider interface

+ GenerateImage func(ctx context.Context, prompt string, opts ...ImageOption) (*ImageResponse, error)

+ type ImageQuality string

+ const ImageQualityHD

+ const ImageQualityStandard

+ type ImageResponse struct

+ Images []GeneratedImage

+ type ImageSize string

+ const ImageSize1024x1024

+ const ImageSize1024x1792

+ const ImageSize1792x1024

+ type ImageStyle string

+ const ImageStyleNatural

+ const ImageStyleVivid

+ type Message struct

+ Content string

+ Parts []ContentPart

+ Role Role

+ ToolCalls []ToolCall

+ ToolResults []ToolResult

+ func NewToolResultMessage(results ...ToolResult) Message

+ func (m Message) HasParts() bool

+ type Model interface

+ Provider func() Provider

+ String func() string

+ type Option func(*Options)

+ func WithJSONMode() Option

+ func WithMaxTokens(n int) Option

+ func WithModel(model Model) Option

+ func WithResponseSchema(schema ResponseSchema) Option

+ func WithTemperature(t float64) Option

+ func WithToolChoice(choice ToolChoice) Option

+ func WithTools(tools []Tool) Option

+ type Options struct

+ MaxTokens int

+ Model Model

+ ResponseFormat ResponseFormat

+ ResponseSchema *ResponseSchema

+ Temperature *float64

+ ToolChoice ToolChoice

+ Tools []Tool

+ func ApplyOptions(opts ...Option) *Options

+ type Provider string

+ const ProviderAnthropic

+ const ProviderGoogle

+ const ProviderOpenAI

+ func (p Provider) String() string

+ type Response struct

+ Content string

+ FinishReason string

+ ToolCalls []ToolCall

+ Usage Usage

+ type ResponseFormat string

+ const ResponseFormatJSON

+ const ResponseFormatText

+ type ResponseSchema struct

+ Description string

+ Name string

+ Schema json.RawMessage

+ Strict bool

+ type Role string

+ const RoleAssistant

+ const RoleSystem

+ const RoleTool

+ const RoleUser

+ type SchemaBuilder struct

+ func SchemaFrom[T any]() *SchemaBuilder

+ func (s *SchemaBuilder) Build() json.RawMessage

+ func (s *SchemaBuilder) Desc(field, description string) *SchemaBuilder

+ func (s *SchemaBuilder) Enum(field string, values ...string) *SchemaBuilder

+ func (s *SchemaBuilder) Required(fields ...string) *SchemaBuilder

+ type StreamEvent struct

+ Delta string

+ Done bool

+ Err error

+ Response *Response

+ type Tool struct

+ Description string

+ Name string

+ Parameters json.RawMessage

+ type ToolCall struct

+ Arguments string

+ ID string

+ Name string

+ type ToolChoice string

+ const ToolChoiceAuto

+ const ToolChoiceNone

+ const ToolChoiceRequired

+ type ToolResult struct

+ Content string

+ IsError bool

+ ToolCallID string

+ type Usage struct

+ InputTokens int

+ OutputTokens int

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