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

engine

package

Go to main page

Versions in this module

v0

v0.6.0

Sep 11, 2026

Changes in this version

type Engine

+ func (e *Engine) GenerateImage(ctx context.Context, req GenerateImageRequest) ([]GenerateImageResult, error)

+ func (e *Engine) Transcribe(ctx context.Context, req TranscribeRequest) (string, error)

+ type GenerateImageRequest struct

+ Model string

+ N int

+ Prompt string

+ Size string

+ type GenerateImageResult struct

+ Image []byte

+ ProviderURL string

+ type MediaOptions struct

+ APIKey string

+ BaseURL string

+ type TranscribeRequest struct

+ Audio []byte

+ FileName string

+ Language string

+ Model string

+ Prompt string

v0.2.2

Aug 3, 2026

Changes in this version

+ const CheckFail

+ const CheckOK

+ const CheckWarn

+ const ContractVersion

+ const EventContentDelta

+ const EventContinuation

+ const EventDone

+ const EventRetry

+ const EventRouteChanged

+ const EventRouteSelected

+ const EventTTFT

+ const EventThinkingDelta

+ const EventToolCallDelta

+ const EventToolCallDone

+ const EventToolCallStart

+ const EventUsage

+ const EventWarning

+ var DefaultStore = credentials.DefaultStore

+ var SetDefaultStore = credentials.SetDefaultStore

+ func AccountForEnv(envVar string) string

+ func CredentialGuidance(providerID, secret string) string

+ func DefaultThinkingDisabled(providerID string) bool

+ func FormatPreflight(report PreflightReport) string

+ func FormatSetupError(providerID string, err error) string

+ func HasSecret(ctx context.Context, envKey string) bool

+ func IsCatalogCacheRequired(err error) bool

+ func IsCode(err error, code ErrorCode) bool

+ func MigrateEnvFileCredentials(ctx context.Context) (int, error)

+ func NormalizeProviderID(providerID string) string

+ func RegisterCustomGateway(gateway CustomGateway) error

+ func RegisteredGatewayCount() int

+ func SecretStoreName() string

+ func SetSecretStoreServiceName(name string)

+ func ThinkingToggleSupported(providerID string) bool

+ type CatalogHealth = llm.CatalogHealth

+ type CatalogSnapshot = llm.CatalogSnapshot

+ type CheckStatus = llm.CheckStatus

+ type ContentPart = llm.ContentPart

+ type CredentialProvider = llm.CredentialProviderOption

+ type CredentialResolution = llm.CredentialResolution

+ type CredentialStatus = llm.CredentialStatus

+ type CredentialStorageReport struct

+ Detail string

+ Formatted string

+ PlatformStore string

+ Writable bool

+ func CredentialStorage(ctx context.Context) CredentialStorageReport

+ type CustomGateway struct

+ BaseURL string

+ Capabilities *CustomGatewayCapabilities

+ ChatPreference int

+ ContextWindow int

+ CredentialEnv string

+ DefaultModel string

+ DisplayName string

+ ID string

+ MaxTokensField string

+ SortOrder int

+ type CustomGatewayCapabilities struct

+ Reasoning bool

+ Streaming bool

+ StructuredJSON bool

+ Tools bool

+ Vision bool

+ type DeploymentSummary = llm.DeploymentSummary

+ type Engine struct

+ func New(opts Options) (*Engine, error)

+ func (e *Engine) ActiveSelection(ctx context.Context) Route

+ func (e *Engine) ApplyCredentials(ctx context.Context, providerID string) (CatalogSnapshot, error)

+ func (e *Engine) ApplyGatewayEnvironment(_ context.Context, providerID string)

+ func (e *Engine) CanonicalModel(ctx context.Context, modelID string) string

+ func (e *Engine) Catalog(ctx context.Context) (CatalogSnapshot, error)

+ func (e *Engine) CatalogHealth(ctx context.Context) CatalogHealth

+ func (e *Engine) ClearSelection(ctx context.Context) error

+ func (e *Engine) CompactNative(ctx context.Context, req NativeCompactionRequest) (string, error)

+ func (e *Engine) CredentialEnvKeys(providerID string) []string

+ func (e *Engine) CredentialProviders(context.Context) []CredentialProvider

+ func (e *Engine) CredentialStatus(ctx context.Context, providerID string) (CredentialStatus, error)

+ func (e *Engine) DefaultModel(ctx context.Context, provider, fallback string) string

+ func (e *Engine) DefaultProviderFilter(ctx context.Context) string

+ func (e *Engine) DefaultThinkingDisabled(providerID string) bool

+ func (e *Engine) DeploymentRoutingEnabled(override *bool) bool

+ func (e *Engine) DeploymentStatus(ctx context.Context, activeModel string) (string, error)

+ func (e *Engine) DeploymentSummary(ctx context.Context, activeModel string) (DeploymentSummary, error)

+ func (e *Engine) EffectiveSelection(ctx context.Context, opts SelectionOptions) Selection

+ func (e *Engine) GatewayDefinitions() []Gateway

+ func (e *Engine) GatewayForModel(ctx context.Context, modelID string) string

+ func (e *Engine) GatewayRegion(providerID string) (label string, required bool)

+ func (e *Engine) Gateways(ctx context.Context) []Gateway

+ func (e *Engine) Generate(ctx context.Context, req GenerateRequest) (*GenerateResponse, error)

+ func (e *Engine) HasCredentialEnv(ctx context.Context, envVar string) bool

+ func (e *Engine) ListLiveModels(ctx context.Context, providerID string) ([]Model, error)

+ func (e *Engine) ListModels(ctx context.Context, providerID string, refresh bool) ([]Model, error)

+ func (e *Engine) ListPublicModels(ctx context.Context, providerID string) ([]Model, error)

+ func (e *Engine) MigrateProviderSecrets() error

+ func (e *Engine) MigrateProviderSecretsContext(ctx context.Context) error

+ func (e *Engine) ModelClassOf(ctx context.Context, modelID string) ModelClass

+ func (e *Engine) ModelInfo(ctx context.Context, modelID string) (Model, bool, error)

+ func (e *Engine) ModelNames(ctx context.Context) []string

+ func (e *Engine) ModelProviders(ctx context.Context) ([]string, error)

+ func (e *Engine) PreferredModel(ctx context.Context, provider string, class ModelClass, fallback string) string

+ func (e *Engine) PreferredModels(ctx context.Context, primaryProvider string, class ModelClass, limit int) []string

+ func (e *Engine) Preflight(ctx context.Context) PreflightReport

+ func (e *Engine) PreflightWithOptions(ctx context.Context, opts PreflightOptions) PreflightReport

+ func (e *Engine) PrimaryModel(ctx context.Context) string

+ func (e *Engine) ProviderForModel(ctx context.Context, modelID string) string

+ func (e *Engine) ProviderStateSecurityStatus() ProviderStateSecurity

+ func (e *Engine) RefreshCatalog(ctx context.Context, providerID string) (CatalogSnapshot, error)

+ func (e *Engine) RemoveCredential(ctx context.Context, providerID string) error

+ func (e *Engine) Resolve(ctx context.Context, req SelectionRequest) (Route, error)

+ func (e *Engine) ResolveCredential(ctx context.Context, secret string) CredentialResolution

+ func (e *Engine) RoutingPreview(ctx context.Context, modelID string) (string, error)

+ func (e *Engine) SaveCredential(ctx context.Context, providerID, secret string) (CredentialStatus, error)

+ func (e *Engine) SaveCredentialEnv(ctx context.Context, envVar, secret string) error

+ func (e *Engine) SetActiveModel(ctx context.Context, modelID string) error

+ func (e *Engine) SetActiveProvider(ctx context.Context, providerID string) error

+ func (e *Engine) SetGatewayRegion(ctx context.Context, providerID, value string) error

+ func (e *Engine) SetSelection(ctx context.Context, providerID, modelID string) error

+ func (e *Engine) StatePaths() StatePaths

+ func (e *Engine) Stream(ctx context.Context, req GenerateRequest) (EventStreamer, error)

+ func (e *Engine) SupportsNativeCompaction(ctx context.Context, provider, model string) bool

+ func (e *Engine) ThinkingToggleSupported(providerID string) bool

+ type Error struct

+ Cause error

+ Code ErrorCode

+ Message string

+ Model string

+ Operation string

+ Provider string

+ Retryable bool

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type ErrorCode string

+ const ErrorAuthentication

+ const ErrorBudgetExceeded

+ const ErrorCancelled

+ const ErrorCapabilityMismatch

+ const ErrorCatalogUnavailable

+ const ErrorContextExceeded

+ const ErrorCredentialMissing

+ const ErrorInternal

+ const ErrorInvalidRequest

+ const ErrorModelUnavailable

+ const ErrorProviderUnavailable

+ const ErrorRateLimited

+ type Event = llm.EyrieStreamEvent

+ type EventStreamer = llm.EventStreamer

+ type Gateway = llm.Gateway

+ type GenerateRequest = llm.GenerateRequest

+ type GenerateResponse = llm.EyrieResponse

+ type GenerationOptions = llm.GenerationOptions

+ type Intent = llm.Intent

+ type Limits = llm.Limits

+ type MapStore = credentials.MapStore

+ type Message = llm.EyrieMessage

+ type Metadata = llm.Metadata

+ type Model = llm.Model

+ type ModelClass = llm.ModelClass

+ type NativeCompactionRequest = llm.NativeCompactionRequest

+ type OperationsGraphExport = operationsgraph.Export

+ func BuildOperationsGraph(input OperationsGraphInput) (*OperationsGraphExport, error)

+ type OperationsGraphInput = operationsgraph.Input

+ type Options struct

+ CacheConfig client.CacheConfig

+ CatalogPath string

+ CustomGateways []CustomGateway

+ EnableCaching bool

+ EnableRateLimiting bool

+ ProviderConfigPath string

+ RateLimitConfig client.AdaptiveRateLimitConfig

+ RemoteCatalogURL string

+ SecretStore credentials.Store

+ StateDir string

+ UseRegisteredCustomGateways bool

+ type Preference = llm.Preference

+ type PreflightCheck = llm.PreflightCheck

+ type PreflightOptions = llm.PreflightOptions

+ type PreflightReport = llm.PreflightReport

+ type Provider = llm.Provider

+ type ProviderStateSecurity = llm.ProviderStateSecurity

+ type Requirements = llm.Requirements

+ type Route = llm.ResolvedRoute

+ type Selection = llm.Selection

+ type SelectionOptions = llm.SelectionOptions

+ type SelectionRequest struct

+ Preference Preference

+ Requirements Requirements

+ type StatePaths = llm.StatePaths

+ type Stream struct

+ func (s *Stream) Close() error

+ func (s *Stream) Err() error

+ func (s *Stream) Event() Event

+ func (s *Stream) Next() bool

+ type Tool = llm.EyrieTool

+ type ToolCall = llm.ToolCall

+ func ParseInlineToolCalls(content string) (string, []ToolCall)

+ type ToolChoice = llm.ToolChoiceOption

+ type ToolResult = llm.ToolResult

+ type Usage = llm.EyrieUsage