typesafe

package module

Go to main page

Versions in this module

v0

v0.13.0

Oct 16, 2026

Changes in this version

+ const EncodingGzip

+ const EncodingZstd

+ const HeaderContentEncoding

+ const HeaderDangerZoneImages

+ const HeaderDangerZoneLongContext

+ const MaxImageSizeLimit

+ const MaxRequestBodyLimit

+ const MinCompressionBytes

+ const ModelJev113

+ const ModelJev114

+ const ModelJevLatest

+ const ModelJevPreview

+ const StatusPayloadTooLarge

+ const StatusUnsupportedMediaType

+ type Asset struct

+ DataBase64 string

+ Format string

+ Part string

+ Type string

+ type Assets map[string]Asset

+ func CollectAssets(images ...*Image) Assets

+ type BoxAnswer struct

+ Box BoxCoordinates

+ Confidence *float64

+ Type string

+ func (a *BoxAnswer) AnswerType() string

+ type BoxCoordinates struct

+ Bottom float64

+ Left float64

+ Right float64

+ Top float64

+ type BoxQuestion struct

+ Instructions any

+ Type string

+ func NewBox(instructions any, opts ...QuestionOption) *BoxQuestion

+ func (q *BoxQuestion) MarshalJSON() ([]byte, error)

+ func (q *BoxQuestion) QuestionType() string

+ func (q *BoxQuestion) Validate(string) error

type Config

+ Compression bool

+ Images bool

+ LongContext bool

+ type Image struct

+ Base64 string

+ Data []byte

+ Format string

+ Ref string

+ func NewImage(data []byte, format string) (*Image, error)

+ func NewImageFromBase64(ref, b64, format string) (*Image, error)

+ func NewImageFromFile(path string) (*Image, error)

+ func NewImageWithRef(ref string, data []byte, format string) (*Image, error)

+ func (img *Image) Asset() Asset

+ func (img *Image) MarshalJSON() ([]byte, error)

+ func (img *Image) String() string

type Option

+ func WithCompression(enabled bool) Option

+ func WithImages(enabled bool) Option

+ func WithLongContext(enabled bool) Option

+ type PayloadTooLargeError struct

+ func AsPayloadTooLargeError(err error) (*PayloadTooLargeError, bool)

+ func (e *PayloadTooLargeError) Unwrap() error

type RequestOption

+ func WithAssets(assets any) RequestOption

+ func WithCallCompression(enabled bool) RequestOption

+ func WithCallImages(enabled bool) RequestOption

+ func WithCallLongContext(enabled bool) RequestOption

type SystemOneResponse

+ func (r *SystemOneResponse) Boxes() map[string]*BoxAnswer

+ type UnsupportedMediaTypeError struct

+ func AsUnsupportedMediaTypeError(err error) (*UnsupportedMediaTypeError, bool)

+ func (e *UnsupportedMediaTypeError) Unwrap() error

v0.12.0

Sep 26, 2026

Changes in this version

type RetryPolicy

+ MaxRetryAfter time.Duration

v0.11.0

Sep 26, 2026

Changes in this version

type ScoreAnswer

+ func (a *ScoreAnswer) LegendFor(level int) (any, bool)

v0.10.1

Sep 20, 2026

Changes in this version

+ const StatusOverloaded

+ type OverloadedError struct

+ RetryAfterMS *float64

+ func AsOverloadedError(err error) (*OverloadedError, bool)

+ func (e *OverloadedError) RetryAfter() (time.Duration, bool)

+ func (e *OverloadedError) Unwrap() error

v0.10.0

Sep 20, 2026

v0.9.0

Sep 19, 2026

v0.8.0

Sep 19, 2026

v0.7.0

Sep 19, 2026

Changes in this version

+ const APIKeyEnv

+ const BaseURLEnv

+ const ContentTypeJSON

+ const DefaultBaseURL

+ const DefaultModel

+ const DefaultModelEnv

+ const DefaultRetryBudget

+ const DefaultTimeout

+ const HeaderAccept

+ const HeaderAuthorization

+ const HeaderContentType

+ const HeaderRequestID

+ const HeaderRetryAfter

+ const HeaderRetryAfterMs

+ const HeaderRetryCount

+ const HeaderRuntime

+ const HeaderSDK

+ const HeaderUserAgent

+ const LogLevelEnv

+ const MaxErrorBodyLength

+ const MaxResponseBodyLimit

+ const ModelsPath

+ const SDKName

+ const SDKVersion

+ const SystemOnePath

+ func DefaultRetryStatuses() map[int]bool

+ func NormalizeQuestions(questions any) (map[string]any, error)

+ func ParseLogLevel(level string) (slog.Level, bool)

+ func RuntimeString() string

+ func SystemOneAs[T any](ctx context.Context, client *Client, state any, questions any, ...) (*T, error)

+ type APIConnectionError struct

+ Cause error

+ Message string

+ func (e *APIConnectionError) Error() string

+ func (e *APIConnectionError) Unwrap() error

+ type APIError struct

+ Body any

+ Endpoint string

+ Headers http.Header

+ Message string

+ RawBody []byte

+ RequestID string

+ Status int

+ func AsAPIError(err error) (*APIError, bool)

+ func (e *APIError) Error() string

+ type APIResponseValidationError struct

+ FieldPath string

+ func AsValidationError(err error) (*APIResponseValidationError, bool)

+ func (e *APIResponseValidationError) Error() string

+ func (e *APIResponseValidationError) Unwrap() error

+ type APITimeoutError struct

+ Timeout time.Duration

+ func AsTimeoutError(err error) (*APITimeoutError, bool)

+ func (e *APITimeoutError) Error() string

+ type Answer interface

+ AnswerType func() string

+ type Answers map[string]Answer

+ func (a *Answers) UnmarshalJSON(data []byte) error

+ type AuthenticationError struct

+ func (e *AuthenticationError) Unwrap() error

+ type BadRequestError struct

+ func (e *BadRequestError) Unwrap() error

+ type ChoiceAnswer struct

+ Choice string

+ Confidence float64

+ Probabilities map[string]float64

+ Type string

+ func (a *ChoiceAnswer) AnswerType() string

+ type ChoiceQuestion struct

+ Criteria map[string]any

+ Instructions any

+ Type string

+ func NewChoice(criteria map[string]any, opts ...QuestionOption) *ChoiceQuestion

+ func (q *ChoiceQuestion) MarshalJSON() ([]byte, error)

+ func (q *ChoiceQuestion) QuestionType() string

+ func (q *ChoiceQuestion) Validate(name string) error

+ type Client struct

+ Models *ModelsService

+ func NewClient(opts ...Option) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) Config() *Config

+ func (c *Client) HTTPClient() *http.Client

+ func (c *Client) SystemOne(ctx context.Context, state any, questions any, opts ...RequestOption) (*SystemOneResponse, error)

+ type Config struct

+ APIKey string

+ BaseURL string

+ DefaultHeaders http.Header

+ DefaultModel string

+ HTTPClient *http.Client

+ Logger *slog.Logger

+ RetryPolicy *RetryPolicy

+ Timeout time.Duration

+ Transport http.RoundTripper

+ type InternalServerError struct

+ func (e *InternalServerError) Unwrap() error

+ type ListModelsResponse struct

+ Models []ModelMetadata

+ func (r *ListModelsResponse) MarshalJSON() ([]byte, error)

+ func (r *ListModelsResponse) RawBody() []byte

+ func (r *ListModelsResponse) RawHTTPResponse() (*http.Response, error)

+ func (r *ListModelsResponse) RawRequestID() string

+ func (r *ListModelsResponse) RequestID() (string, error)

+ type ModelMetadata struct

+ Description string

+ Name string

+ ReleaseDate string

+ type ModelsService struct

+ func (s *ModelsService) List(ctx context.Context, opts ...RequestOption) (*ListModelsResponse, error)

+ type NotFoundError struct

+ func (e *NotFoundError) Unwrap() error

+ type NoulAnswer struct

+ Noul float64

+ Type string

+ func (a *NoulAnswer) AnswerType() string

+ type NoulCriteria struct

+ False any

+ True any

+ type NoulQuestion struct

+ Criteria *NoulCriteria

+ Instructions any

+ Type string

+ func NewNoul(instructions any, opts ...QuestionOption) *NoulQuestion

+ func (q *NoulQuestion) MarshalJSON() ([]byte, error)

+ func (q *NoulQuestion) QuestionType() string

+ func (q *NoulQuestion) Validate(string) error

+ type Option func(*configOptions)

+ func WithAPIKey(apiKey string) Option

+ func WithBaseURL(baseURL string) Option

+ func WithDefaultModel(model string) Option

+ func WithHTTPClient(client *http.Client) Option

+ func WithHeader(key, value string) Option

+ func WithHeaders(headers map[string]string) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithRetryPolicy(policy *RetryPolicy) Option

+ func WithTimeout(timeout time.Duration) Option

+ func WithTransport(transport http.RoundTripper) Option

+ type PermissionDeniedError struct

+ func (e *PermissionDeniedError) Unwrap() error

+ type Question interface

+ QuestionType func() string

+ Validate func(name string) error

+ type QuestionOption func(*questionOptions)

+ func WithInstructions(instructions any) QuestionOption

+ func WithNoulCriteria(criteria NoulCriteria) QuestionOption

+ func WithQuestionField(key string, value any) QuestionOption

+ type Questions map[string]any

+ type RateLimitError struct

+ RetryAfterMS *float64

+ func AsRateLimitError(err error) (*RateLimitError, bool)

+ func (e *RateLimitError) RetryAfter() (time.Duration, bool)

+ func (e *RateLimitError) Unwrap() error

+ type RawQuestion map[string]any

+ func (q RawQuestion) QuestionType() string

+ func (q RawQuestion) Validate(name string) error

+ type RedactingHandler struct

+ func NewRedactingHandler(handler slog.Handler) *RedactingHandler

+ func (r *RedactingHandler) Enabled(ctx context.Context, level slog.Level) bool

+ func (r *RedactingHandler) Handle(ctx context.Context, record slog.Record) error

+ func (r *RedactingHandler) WithAttrs(attrs []slog.Attr) slog.Handler

+ func (r *RedactingHandler) WithGroup(name string) slog.Handler

+ type RequestOption func(*requestOptions)

+ func WithCallHeader(key, value string) RequestOption

+ func WithCallHeaders(headers map[string]string) RequestOption

+ func WithCallRetry(policy *RetryPolicy) RequestOption

+ func WithCallTimeout(timeout time.Duration) RequestOption

+ func WithExtraBody(extra map[string]any) RequestOption

+ func WithModel(model string) RequestOption

+ type RetryPolicy struct

+ APIConnectionError bool

+ APITimeoutError bool

+ BackoffInitial time.Duration

+ BackoffJitter float64

+ BackoffMax time.Duration

+ HTTPStatuses map[int]bool

+ MaxRetries int

+ Predicate func(error) bool

+ RandFloat func() float64

+ RespectRetryAfter bool

+ RetryErrors []error

+ Sleep func(ctx context.Context, delay time.Duration) error

+ Timeout *time.Duration

+ func DefaultRetryPolicy() *RetryPolicy

+ func (p *RetryPolicy) Clone() *RetryPolicy

+ func (p *RetryPolicy) Execute(ctx context.Context, fn func(attempt int) error) error

+ func (p *RetryPolicy) Validate() error

+ type SDKError struct

+ Cause error

+ Message string

+ func (e *SDKError) Error() string

+ func (e *SDKError) Unwrap() error

+ type ScoreAnswer struct

+ Confidence float64

+ Legend map[int]any

+ Probabilities map[int]float64

+ Score float64

+ Type string

+ func (a *ScoreAnswer) AnswerType() string

+ func (a *ScoreAnswer) MarshalJSON() ([]byte, error)

+ type ScoreError struct

+ Name string

+ func (e *ScoreError) Error() string

+ type ScoreQuestion struct

+ Criteria []any

+ Instructions any

+ Type string

+ func NewScore(criteria []any, opts ...QuestionOption) *ScoreQuestion

+ func (q *ScoreQuestion) MarshalJSON() ([]byte, error)

+ func (q *ScoreQuestion) QuestionType() string

+ func (q *ScoreQuestion) Validate(name string) error

+ type SystemOneResponse struct

+ Answers map[string]Answer

+ Model string

+ Usage Usage

+ func (r *SystemOneResponse) Choices() map[string]*ChoiceAnswer

+ func (r *SystemOneResponse) MarshalJSON() ([]byte, error)

+ func (r *SystemOneResponse) Nouls() map[string]*NoulAnswer

+ func (r *SystemOneResponse) RawBody() []byte

+ func (r *SystemOneResponse) RawHTTPResponse() (*http.Response, error)

+ func (r *SystemOneResponse) RawRequestID() string

+ func (r *SystemOneResponse) RequestID() (string, error)

+ func (r *SystemOneResponse) Scores() map[string]*ScoreAnswer

+ func (r *SystemOneResponse) String() string

+ type TypeSafeError interface

+ type UnprocessableEntityError struct

+ func (e *UnprocessableEntityError) Unwrap() error

+ type Usage struct

+ InputTokens *int

+ OutputTokens *int

+ func (u Usage) String() string

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