Versions in this module Expand all Collapse all v1 v1.64.0 May 21, 2026 v1.63.0 May 21, 2026 v1.62.0 May 21, 2026 v1.61.0 May 18, 2026 v1.60.0 May 18, 2026 v1.59.0 May 13, 2026 v1.58.0 May 11, 2026 v1.57.0 May 7, 2026 v1.56.0 May 7, 2026 Changes in this version + const AuthTypeWorkloadIdentityFederation + const LifecycleProfileBestEffort + const LifecycleProfileResilient + const LifecycleProfileStrict + const SkillSourceLocal + const Version + func EffectiveProviderType(m ModelConfig, providers map[string]ProviderConfig) string + func Register(parsers map[string]func([]byte) (any, error), ...) + type APIToolConfig struct + Args map[string]any + Endpoint string + Headers map[string]string + Instruction string + Method string + Name string + OutputSchema map[string]any + Required []string + type AgentConfig struct + AddDate bool + AddDescriptionParameter bool + AddEnvironmentInfo bool + AddPromptFiles []string + Cache *CacheConfig + CodeModeTools bool + Commands types.Commands + Description string + Fallback *FallbackConfig + Handoffs []string + Hooks *HooksConfig + Instruction string + MaxConsecutiveToolCalls int + MaxIterations int + MaxOldToolCallTokens int + Model string + Name string + NumHistoryItems int + RedactSecrets bool + Skills SkillsConfig + StructuredOutput *StructuredOutput + SubAgents []string + Toolsets []Toolset + WelcomeMessage string + func (a *AgentConfig) GetFallbackCooldown() time.Duration + func (a *AgentConfig) GetFallbackModels() []string + func (a *AgentConfig) GetFallbackRetries() int + type Agents []AgentConfig + func (c *Agents) First() AgentConfig + func (c *Agents) Lookup(name string) (AgentConfig, bool) + func (c *Agents) UnmarshalYAML(unmarshal func(any) error) error + func (c *Agents) Update(name string, update func(a *AgentConfig)) bool + func (c Agents) MarshalYAML() (any, error) + type AuthConfig struct + Federation *FederationAuthConfig + Type string + func EffectiveAuth(m ModelConfig, providers map[string]ProviderConfig) *AuthConfig + func (a *AuthConfig) EnvVars() []string + type BackoffConfig struct + Initial Duration + Jitter float64 + Max Duration + Multiplier float64 + type CacheConfig struct + CaseSensitive bool + Enabled bool + Path string + TrimSpaces bool + type Config struct + Agents Agents + MCPs map[string]MCPToolset + Metadata Metadata + Models map[string]ModelConfig + Permissions *PermissionsConfig + Providers map[string]ProviderConfig + RAG map[string]RAGToolset + Version string + func (t *Config) UnmarshalYAML(unmarshal func(any) error) error + type DeferConfig struct + DeferAll bool + Tools []string + func (d *DeferConfig) UnmarshalYAML(unmarshal func(any) error) error + func (d DeferConfig) IsEmpty() bool + func (d DeferConfig) MarshalYAML() (any, error) + type Duration struct + func (d *Duration) UnmarshalJSON(data []byte) error + func (d *Duration) UnmarshalYAML(unmarshal func(any) error) error + func (d Duration) MarshalJSON() ([]byte, error) + func (d Duration) MarshalYAML() (any, error) + type FallbackConfig struct + Cooldown Duration + Models []string + Retries int + type FederationAuthConfig struct + FederationRuleID string + IdentityToken *IdentityTokenSourceConfig + OrganizationID string + ServiceAccountID string + type FlexibleModelConfig struct + func (f *FlexibleModelConfig) UnmarshalYAML(unmarshal func(any) error) error + func (f FlexibleModelConfig) MarshalYAML() (any, error) + type HookDefinition struct + Args []string + Command string + Env map[string]string + Model string + Name string + OnError string + Prompt string + Schema string + Timeout int + Type string + WorkingDir string + func (h *HookDefinition) DisplayName() string + func (h *HookDefinition) GetTimeout() time.Duration + type HookMatcherConfig struct + Hooks []HookDefinition + Matcher string + type HooksConfig struct + AfterCompaction []HookDefinition + AfterLLMCall []HookDefinition + BeforeCompaction []HookDefinition + BeforeLLMCall []HookDefinition + Notification []HookDefinition + OnAgentSwitch []HookDefinition + OnError []HookDefinition + OnMaxIterations []HookDefinition + OnSessionResume []HookDefinition + OnToolApprovalDecision []HookDefinition + OnUserInput []HookDefinition + PermissionRequest []HookMatcherConfig + PostToolUse []HookMatcherConfig + PreCompact []HookDefinition + PreToolUse []HookMatcherConfig + SessionEnd []HookDefinition + SessionStart []HookDefinition + Stop []HookDefinition + SubagentStop []HookDefinition + ToolResponseTransform []HookMatcherConfig + TurnEnd []HookDefinition + TurnStart []HookDefinition + UserPromptSubmit []HookDefinition + func (h *HooksConfig) IsEmpty() bool + type IdentityTokenSourceConfig struct + Command []string + Env string + File string + Headers map[string]string + ResponseField string + URL string + type LifecycleConfig struct + Backoff *BackoffConfig + CallTimeout Duration + MaxRestarts int + Profile string + Required *bool + Restart string + StartupTimeout Duration + func (l *LifecycleConfig) EffectiveStartupTimeout() time.Duration + func (l *LifecycleConfig) IsRequired() bool + type MCPToolset struct + func (m *MCPToolset) UnmarshalYAML(unmarshal func(any) error) error + type Metadata struct + Author string + Description string + License string + Readme string + Version string + type ModelConfig struct + Auth *AuthConfig + BaseURL string + DisplayModel string + FrequencyPenalty *float64 + MaxTokens *int64 + Model string + Name string + ParallelToolCalls *bool + PresencePenalty *float64 + Provider string + ProviderOpts map[string]any + Routing []RoutingRule + TaskBudget *TaskBudget + Temperature *float64 + ThinkingBudget *ThinkingBudget + TokenKey string + TopP *float64 + TrackUsage *bool + func ParseModelRef(ref string) (ModelConfig, error) + func (m *ModelConfig) Clone() *ModelConfig + func (m *ModelConfig) DisplayOrModel() string + type PermissionsConfig struct + Allow []string + Ask []string + Deny []string + type PostEditConfig struct + Cmd string + Path string + type ProviderConfig struct + APIType string + Auth *AuthConfig + BaseURL string + FrequencyPenalty *float64 + MaxTokens *int64 + ParallelToolCalls *bool + PresencePenalty *float64 + Provider string + ProviderOpts map[string]any + TaskBudget *TaskBudget + Temperature *float64 + ThinkingBudget *ThinkingBudget + TokenKey string + TopP *float64 + TrackUsage *bool + type RAGChunkingConfig struct + CodeAware bool + Overlap int + RespectWordBoundaries bool + Size int + func (c *RAGChunkingConfig) UnmarshalYAML(unmarshal func(any) error) error + type RAGConfig struct + Docs []string + RespectVCS *bool + Results RAGResultsConfig + Strategies []RAGStrategyConfig + Tool RAGToolConfig + func (c *RAGConfig) GetRespectVCS() bool + func (c *RAGConfig) UnmarshalYAML(unmarshal func(any) error) error + type RAGDatabaseConfig struct + func (d *RAGDatabaseConfig) AsString() (string, error) + func (d *RAGDatabaseConfig) IsEmpty() bool + func (d *RAGDatabaseConfig) UnmarshalYAML(unmarshal func(any) error) error + type RAGFusionConfig struct + K int + Strategy string + Weights map[string]float64 + type RAGRerankingConfig struct + Criteria string + Model string + Threshold float64 + TopK int + func (r *RAGRerankingConfig) UnmarshalYAML(unmarshal func(any) error) error + type RAGResultsConfig struct + Deduplicate bool + Fusion *RAGFusionConfig + IncludeScore bool + Limit int + Reranking *RAGRerankingConfig + ReturnFullContent bool + func (r *RAGResultsConfig) UnmarshalYAML(unmarshal func(any) error) error + type RAGStrategyConfig struct + Chunking RAGChunkingConfig + Database RAGDatabaseConfig + Docs []string + Limit int + Params map[string]any + Type string + func (s *RAGStrategyConfig) UnmarshalJSON(data []byte) error + func (s *RAGStrategyConfig) UnmarshalYAML(unmarshal func(any) error) error + func (s RAGStrategyConfig) MarshalJSON() ([]byte, error) + func (s RAGStrategyConfig) MarshalYAML() (any, error) + type RAGToolConfig struct + Description string + Instruction string + Name string + type RAGToolset struct + func (r *RAGToolset) UnmarshalYAML(unmarshal func(any) error) error + func (r RAGToolset) MarshalYAML() (any, error) + type Remote struct + Headers map[string]string + OAuth *RemoteOAuthConfig + TransportType string + URL string + type RemoteOAuthConfig struct + CallbackPort int + CallbackRedirectURL string + ClientID string + ClientSecret string + Scopes []string + type RoutingRule struct + Examples []string + Model string + type ScriptShellToolConfig struct + Args map[string]any + Cmd string + Description string + Env map[string]string + Required []string + WorkingDir string + type SkillsConfig struct + Include []string + Sources []string + func (s *SkillsConfig) UnmarshalJSON(data []byte) error + func (s *SkillsConfig) UnmarshalYAML(unmarshal func(any) error) error + func (s SkillsConfig) Enabled() bool + func (s SkillsConfig) HasLocal() bool + func (s SkillsConfig) MarshalJSON() ([]byte, error) + func (s SkillsConfig) MarshalYAML() (any, error) + func (s SkillsConfig) RemoteURLs() []string + type StructuredOutput struct + Description string + Name string + Schema map[string]any + Strict bool + type TaskBudget struct + Total int + Type string + func (t *TaskBudget) AsMap() map[string]any + func (t *TaskBudget) IsZero() bool + func (t *TaskBudget) UnmarshalJSON(data []byte) error + func (t *TaskBudget) UnmarshalYAML(unmarshal func(any) error) error + func (t TaskBudget) MarshalJSON() ([]byte, error) + func (t TaskBudget) MarshalYAML() (any, error) + type ThinkingBudget struct + Effort string + Tokens int + func (t *ThinkingBudget) AdaptiveEffort() (string, bool) + func (t *ThinkingBudget) EffortLevel() (effort.Level, bool) + func (t *ThinkingBudget) EffortTokens() (int, bool) + func (t *ThinkingBudget) IsAdaptive() bool + func (t *ThinkingBudget) IsDisabled() bool + func (t *ThinkingBudget) UnmarshalJSON(data []byte) error + func (t *ThinkingBudget) UnmarshalYAML(unmarshal func(any) error) error + func (t ThinkingBudget) MarshalJSON() ([]byte, error) + func (t ThinkingBudget) MarshalYAML() (any, error) + type Toolset struct + APIConfig APIToolConfig + AllowList []string + AllowPrivateIPs bool + AllowedDomains []string + Args []string + BlockedDomains []string + Command string + Config any + Defer DeferConfig + DenyList []string + Env map[string]string + FileTypes []string + Headers map[string]string + IgnoreVCS *bool + Instruction string + Lifecycle *LifecycleConfig + Model string + Models []string + Name string + Path string + PostEdit []PostEditConfig + RAGConfig *RAGConfig + Ref string + Remote Remote + Shared bool + Shell map[string]ScriptShellToolConfig + Timeout int + Tools []string + Toon string + Type string + URL string + Version string + WorkingDir string + func (t *Toolset) UnmarshalYAML(unmarshal func(any) error) error