bots

package
v2.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 2, 2026 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrUsageRestriction = errors.New("usage restriction")

Functions

func UsageRestrictionsForUserConfig 

func UsageRestrictionsForUserConfig(client *pluginapi.Client, cfg llm.BotConfig, requestingUserID string) error

UsageRestrictionsForUserConfig returns nil if userID is allowed by cfg's UserAccessLevel / UserIDs / TeamIDs, otherwise an error wrapping ErrUsageRestriction. Callers without an MMBots instance (e.g. API code when bots may be nil) should use this with the plugin client; MMBots.CheckUsageRestrictionsForUserConfig delegates here.

Types

type AgentStore 

type AgentStore interface {
	ListAgents() ([]*llm.BotConfig, error)
}

AgentStore provides read access to user-created agents from the database. This is a subset of the full store.AgentStore — only read methods needed here.

type Bot 

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

Bot represents an AI bot instance with its configuration and dependencies.

Source of truth for bot fields:

  • cfg: The bot's configuration (name, display name, permissions, etc.)
  • service: The RESOLVED service configuration (use GetService() to access). DO NOT use cfg.Service or cfg.ServiceID directly - those are internal references.
  • mmBot: The Mattermost bot user
  • llm: The initialized language model instance
  • providerServices: resolved from the concrete client before wrapping (see llm.ProviderServices)

Bot instances should be created via EnsureBots() which properly resolves service references and initializes all fields.

func NewBot 

func NewBot(cfg llm.BotConfig, service llm.ServiceConfig, mmBot *model.Bot, llmInstance llm.LanguageModel) *Bot

NewBot has no provider services. Use EnsureBots for a wired bot, or WithConfig to derive one.

func (*Bot) BotUserID added in v2.7.0 

func (b *Bot) BotUserID() string

BotUserID returns the Mattermost user ID of the bot's user account, or "" when no bot user exists.

func (*Bot) GetConfig 

func (b *Bot) GetConfig() llm.BotConfig

func (*Bot) GetMMBot 

func (b *Bot) GetMMBot() *model.Bot

func (*Bot) GetService 

func (b *Bot) GetService() llm.ServiceConfig

func (*Bot) HasNativeCodeExecutionEnabled added in v2.7.0 

func (b *Bot) HasNativeCodeExecutionEnabled() bool

HasNativeCodeExecutionEnabled is independent of file retrieval. OpenAI can run the sandbox but cannot serve its files; use SandboxFileAttachmentAvailable for attach/prompt gating.

func (*Bot) HasNativeWebSearchEnabled 

func (b *Bot) HasNativeWebSearchEnabled() bool

HasNativeWebSearchEnabled is used to suppress Mattermost's built-in web search fallback.

func (*Bot) LLM 

func (b *Bot) LLM() llm.LanguageModel

func (*Bot) ProviderServices added in v2.7.0 

func (b *Bot) ProviderServices() *llm.ProviderServices

ProviderServices is nil-safe; callers must tolerate nil (bots built outside EnsureBots).

func (*Bot) SandboxFileAttachmentAvailable added in v2.7.0 

func (b *Bot) SandboxFileAttachmentAvailable() bool

SandboxFileAttachmentAvailable requires both the sandbox and a retrievable file API. Prompt text and the attach path must use this so they cannot disagree.

func (*Bot) SetLLMForTest 

func (b *Bot) SetLLMForTest(llm llm.LanguageModel)

func (*Bot) SetProviderServicesForTest added in v2.7.0 

func (b *Bot) SetProviderServicesForTest(services *llm.ProviderServices)

func (*Bot) SetServiceForTest 

func (b *Bot) SetServiceForTest(service llm.ServiceConfig)

func (*Bot) WithConfig added in v2.7.0 

func (b *Bot) WithConfig(cfg llm.BotConfig) *Bot

WithConfig copies the bot with a new config. Use this instead of NewBot so resolved LLM and provider services are not silently dropped.

type Config 

type Config interface {
	GetBots() []llm.BotConfig
	GetServiceByID(id string) (llm.ServiceConfig, bool)
	GetDefaultBotName() string
	EnableTokenUsageLogging() bool
	EnableTokenUsageLogToPlugin() bool
	EnableTokenUsageLogToFile() bool
	GetTranscriptGenerator() string
}

type MMBots 

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

func New 

func New(mutexPluginAPI cluster.MutexPluginAPI, pluginAPI *pluginapi.Client, licenseChecker *enterprise.LicenseChecker, config Config, agentStore AgentStore, llmUpstreamHTTPClient *http.Client, metrics llm.MetricsObserver) *MMBots

func (*MMBots) CheckUsageRestrictions 

func (m *MMBots) CheckUsageRestrictions(requestingUserID string, bot *Bot, channel *model.Channel) error

func (*MMBots) CheckUsageRestrictionsForChannel added in v2.6.0 

func (m *MMBots) CheckUsageRestrictionsForChannel(bot *Bot, channel *model.Channel) error

CheckUsageRestrictionsForChannel returns nil when the bot's ChannelAccessLevel configuration allows use in the given channel, otherwise an error wrapping ErrUsageRestriction. Unlike CheckUsageRestrictions it does not consider user-scope restrictions, so callers can validate channel-level settings (e.g. auto-reply) independent of any requesting user.

func (*MMBots) CheckUsageRestrictionsForUser 

func (m *MMBots) CheckUsageRestrictionsForUser(bot *Bot, requestingUserID string) error

func (*MMBots) CheckUsageRestrictionsForUserConfig 

func (m *MMBots) CheckUsageRestrictionsForUserConfig(cfg llm.BotConfig, requestingUserID string) error

CheckUsageRestrictionsForUserConfig returns nil if userID is allowed by cfg's UserAccessLevel / UserIDs / TeamIDs, otherwise an error wrapping ErrUsageRestriction. This is the shared source of truth for user-scope access checks; both config-bot Bot-based callers (CheckUsageRestrictionsForUser) and DB-agent BotConfig-based callers (api.canUserAccessAgent) use it.

func (*MMBots) EnsureBots 

func (b *MMBots) EnsureBots() error

func (*MMBots) ForceRefreshOnNextEnsure 

func (b *MMBots) ForceRefreshOnNextEnsure()

ForceRefreshOnNextEnsure clears the optimistic ensure snapshot and sets forceRefresh so the next EnsureBots() cannot take the fast path. DB-backed agents are not part of the config-file bot slice used for botConfigsEqual, so we must invalidate when agents change.

func (*MMBots) GetAllBotUserIDs 

func (b *MMBots) GetAllBotUserIDs() []string

GetAllBotUserIDs returns a list of all bot user IDs

func (*MMBots) GetAllBots 

func (b *MMBots) GetAllBots() []*Bot

GetAllBots returns all bots

func (*MMBots) GetBotByID 

func (b *MMBots) GetBotByID(botID string) *Bot

GetBotByID retrieves the bot associated with the given bot ID

func (*MMBots) GetBotByUsername 

func (b *MMBots) GetBotByUsername(botUsername string) *Bot

GetBotByUsername retrieves the bot associated with the given bot username

func (*MMBots) GetBotByUsernameOrFirst 

func (b *MMBots) GetBotByUsernameOrFirst(botUsername string) *Bot

GetBotByUsernameOrFirst retrieves the bot associated with the given bot username or the first bot if not found

func (*MMBots) GetBotConfig 

func (b *MMBots) GetBotConfig(botUsername string) (llm.BotConfig, error)

func (*MMBots) GetBotConfigByID 

func (b *MMBots) GetBotConfigByID(botID string) (bool, int64, bool)

GetBotConfigByID returns the bot's EnableVision and MaxFileSize. ok is false when botID is unknown.

func (*MMBots) GetBotForDMChannel 

func (b *MMBots) GetBotForDMChannel(channel *model.Channel) *Bot

GetBotForDMChannel returns the bot for the given DM channel.

func (*MMBots) GetBotMentioned 

func (b *MMBots) GetBotMentioned(text string) *Bot

GetBotMentioned returns the bot mentioned in the text, if any.

func (*MMBots) GetTranscribe 

func (b *MMBots) GetTranscribe() Transcriber

TODO: This really doesn't belong here. Figure out where to put this.

func (*MMBots) IsAnyBot 

func (b *MMBots) IsAnyBot(userID string) bool

IsAnyBot returns true if the given user is an AI bot.

func (*MMBots) SetBotsForTesting 

func (b *MMBots) SetBotsForTesting(bots []*Bot)

SetBotsForTesting sets bots directly for testing purposes only

type Transcriber 

type Transcriber interface {
	Transcribe(file io.Reader) (*subtitles.Subtitles, error)
}

Transcriber interface defines the contract for transcription services

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.