bots

package

v1.7.2 Latest Latest Go to latest Published: Dec 12, 2025 License: Apache-2.0 Imports: 22 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 ¶

Variables
type Bot
- func NewBot(cfg llm.BotConfig, service llm.ServiceConfig, mmBot *model.Bot, ...) *Bot
type Config
type MMBots
- func New(mutexPluginAPI cluster.MutexPluginAPI, pluginAPI *pluginapi.Client, ...) *MMBots
type Transcriber

Constants ¶

This section is empty.

Variables ¶

View Source

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

Functions ¶

This section is empty.

Types ¶

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

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 creates a new Bot instance with all fields initialized.

func (*Bot) GetConfig ¶

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

func (*Bot) GetMMBot ¶

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

func (*Bot) GetService ¶ added in v1.5.0

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

func (*Bot) LLM ¶

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

func (*Bot) SetLLMForTest ¶

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

func (*Bot) SetServiceForTest ¶ added in v1.5.0

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

type Config ¶

type Config interface {
	GetBots() []llm.BotConfig
	GetServiceByID(id string) (llm.ServiceConfig, bool)
	GetDefaultBotName() string
	EnableLLMLogging() bool
	EnableTokenUsageLogging() 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, llmUpstreamHTTPClient *http.Client, tokenLogger *mlog.Logger, metrics llm.MetricsObserver) *MMBots

func (*MMBots) CheckUsageRestrictions ¶

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

func (*MMBots) CheckUsageRestrictionsForUser ¶

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

func (*MMBots) EnsureBots ¶

func (b *MMBots) EnsureBots() error

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) 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

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