config

package

v1.9.0 Latest Latest Go to latest Published: Feb 19, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mattermost/mattermost-plugin-ai

Links

Open Source Insights

Documentation ¶

Index ¶

func DeepCopyJSON[T any](src T) (T, error)
func OpenAIConfigFromServiceConfig(serviceConfig llm.ServiceConfig, botConfig llm.BotConfig) openai.Config
func OpenAIConfigFromServiceConfigWithOptions(serviceConfig llm.ServiceConfig, botConfig llm.BotConfig, ...) openai.Config
type Config
- func (c *Config) Clone() *Config
- func (c *Config) GetServiceByID(id string) (llm.ServiceConfig, bool)
type Container
type UpdateListener
type WebSearchBraveConfig
type WebSearchConfig
type WebSearchGoogleConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DeepCopyJSON ¶

func DeepCopyJSON[T any](src T) (T, error)

DeepCopyJSON creates a deep copy of JSON-serializable structs

func OpenAIConfigFromServiceConfig ¶

func OpenAIConfigFromServiceConfig(serviceConfig llm.ServiceConfig, botConfig llm.BotConfig) openai.Config

func OpenAIConfigFromServiceConfigWithOptions ¶ added in v1.7.0

func OpenAIConfigFromServiceConfigWithOptions(serviceConfig llm.ServiceConfig, botConfig llm.BotConfig, disableStreamOptions bool, useMaxTokens bool) openai.Config

OpenAIConfigFromServiceConfigWithOptions creates an OpenAI config with additional options for OpenAI-compatible APIs

Types ¶

type Config ¶

type Config struct {
	Services                        []llm.ServiceConfig              `json:"services"`
	Bots                            []llm.BotConfig                  `json:"bots"`
	DefaultBotName                  string                           `json:"defaultBotName"`
	TranscriptGenerator             string                           `json:"transcriptBackend"`
	EnableLLMTrace                  bool                             `json:"enableLLMTrace"`
	EnableTokenUsageLogging         bool                             `json:"enableTokenUsageLogging"`
	AllowedUpstreamHostnames        string                           `json:"allowedUpstreamHostnames"`
	AllowUnsafeLinks                bool                             `json:"allowUnsafeLinks"`
	EnableChannelMentionToolCalling bool                             `json:"enableChannelMentionToolCalling"`
	AllowNativeWebSearchInChannels  bool                             `json:"allowNativeWebSearchInChannels"`
	EmbeddingSearchConfig           embeddings.EmbeddingSearchConfig `json:"embeddingSearchConfig"`
	MCP                             mcp.Config                       `json:"mcp"`
	WebSearch                       WebSearchConfig                  `json:"webSearch"`
}

func (*Config) Clone ¶

func (c *Config) Clone() *Config

func (*Config) GetServiceByID ¶ added in v1.5.0

func (c *Config) GetServiceByID(id string) (llm.ServiceConfig, bool)

GetServiceByID returns the service configuration for the given ID

type Container ¶

type Container struct {
	// contains filtered or unexported fields
}

func (*Container) AllowNativeWebSearchInChannels ¶ added in v1.8.1

func (c *Container) AllowNativeWebSearchInChannels() bool

func (*Container) AllowUnsafeLinks ¶ added in v1.5.0

func (c *Container) AllowUnsafeLinks() bool

func (*Container) Config ¶

func (c *Container) Config() *Config

Config retruns the whole configuration readonly. Avoid using this method, prefer using config though interfaces.

func (*Container) EmbeddingSearchConfig ¶

func (c *Container) EmbeddingSearchConfig() embeddings.EmbeddingSearchConfig

func (*Container) EnableChannelMentionToolCalling ¶ added in v1.9.0

func (c *Container) EnableChannelMentionToolCalling() bool

func (*Container) EnableLLMLogging ¶

func (c *Container) EnableLLMLogging() bool

func (*Container) EnableTokenUsageLogging ¶ added in v1.4.0

func (c *Container) EnableTokenUsageLogging() bool

func (*Container) GetBots ¶

func (c *Container) GetBots() []llm.BotConfig

func (*Container) GetDefaultBotName ¶

func (c *Container) GetDefaultBotName() string

func (*Container) GetEnableLLMTrace ¶

func (c *Container) GetEnableLLMTrace() bool

func (*Container) GetServiceByID ¶ added in v1.5.0

func (c *Container) GetServiceByID(id string) (llm.ServiceConfig, bool)

GetServiceByID returns the service configuration for the given ID

func (*Container) GetTranscriptGenerator ¶

func (c *Container) GetTranscriptGenerator() string

func (*Container) MCP ¶

func (c *Container) MCP() mcp.Config

func (*Container) RegisterUpdateListener ¶

func (c *Container) RegisterUpdateListener(listener UpdateListener)

func (*Container) Update ¶

func (c *Container) Update(newConfig *Config)

Updates the current configuration The new configuration is deep-copied to ensure the new and old configurations are independent of each other.

type UpdateListener ¶

type UpdateListener func()

type WebSearchBraveConfig ¶ added in v1.8.0

type WebSearchBraveConfig struct {
	APIKey       string `json:"apiKey"`
	APIURL       string `json:"apiURL"`
	ResultLimit  int    `json:"resultLimit"`
	PollTimeout  int    `json:"pollTimeout"`
	PollInterval int    `json:"pollInterval"`
}

type WebSearchConfig ¶ added in v1.8.0

type WebSearchConfig struct {
	Enabled        bool                  `json:"enabled"`
	Provider       string                `json:"provider"`
	Google         WebSearchGoogleConfig `json:"google"`
	Brave          WebSearchBraveConfig  `json:"brave"`
	DomainDenylist []string              `json:"domainDenylist"`
}

type WebSearchGoogleConfig ¶ added in v1.8.0

type WebSearchGoogleConfig struct {
	APIKey         string `json:"apiKey"`
	SearchEngineID string `json:"searchEngineId"`
	ResultLimit    int    `json:"resultLimit"`
	APIURL         string `json:"apiURL"`
}

Source Files ¶

View all Source files

config.go

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