search

package

v1.14.2 Latest Latest Go to latest Published: May 25, 2026 License: Apache-2.0 Imports: 16 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 ¶

Constants
func InitEmbeddingsSearch(db *sqlx.DB, httpClient *http.Client, cfg embeddings.EmbeddingSearchConfig, ...) (embeddings.EmbeddingSearch, error)
type Options
type RAGResult
type Request
type Response
type Search
- func New(getSearch func() embeddings.EmbeddingSearch, mmclient mmapi.Client, ...) *Search

Constants ¶

View Source

const (
	SearchResultsProp = "search_results"
	SearchQueryProp   = "search_query"
)

Variables ¶

This section is empty.

Functions ¶

func InitEmbeddingsSearch ¶

func InitEmbeddingsSearch(db *sqlx.DB, httpClient *http.Client, cfg embeddings.EmbeddingSearchConfig, licenseChecker *enterprise.LicenseChecker) (embeddings.EmbeddingSearch, error)

InitEmbeddingsSearch creates and initializes the embedding search system

Types ¶

type Options ¶ added in v1.14.0

type Options struct {
	Limit     int
	Offset    int
	TeamID    string
	ChannelID string
	UserID    string
}

Options configures a search operation

type RAGResult ¶

type RAGResult struct {
	Index       int     `json:"index"` // 1-based index for citation mapping
	PostID      string  `json:"postId"`
	ChannelID   string  `json:"channelId"`
	ChannelName string  `json:"channelName"`
	TeamName    string  `json:"teamName"`
	UserID      string  `json:"userId"`
	Username    string  `json:"username"`
	Content     string  `json:"content"`
	Score       float32 `json:"score"`
}

RAGResult represents an enriched search result with metadata

type Request ¶

type Request struct {
	Query      string `json:"query"`
	TeamID     string `json:"teamId"`
	ChannelID  string `json:"channelId"`
	MaxResults int    `json:"maxResults"`
}

Request represents a search query request

type Response ¶

type Response struct {
	Answer    string      `json:"answer"`
	Results   []RAGResult `json:"results"`
	PostID    string      `json:"postid,omitempty"`
	ChannelID string      `json:"channelid,omitempty"`
}

Response represents a response to a search query

type Search ¶

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

func New ¶

func New(
	getSearch func() embeddings.EmbeddingSearch,
	mmclient mmapi.Client,
	prompts *llm.Prompts,
	streamingService streaming.Service,
	licenseChecker *enterprise.LicenseChecker,
) *Search

func (*Search) Enabled ¶ added in v1.2.2

func (s *Search) Enabled() bool

Enabled returns true if the search service is enabled and functional

func (*Search) RunSearch ¶

func (s *Search) RunSearch(ctx context.Context, userID string, bot *bots.Bot, query, teamID, channelID string, maxResults int) (map[string]string, error)

RunSearch initiates a search and sends results to a DM

func (*Search) Search ¶ added in v1.14.0

func (s *Search) Search(ctx context.Context, query string, opts Options) ([]RAGResult, error)

Search performs a semantic search and returns enriched results with channel/user metadata.

func (*Search) SearchQuery ¶

func (s *Search) SearchQuery(ctx context.Context, userID string, bot *bots.Bot, query, teamID, channelID string, maxResults int) (Response, error)

SearchQuery performs a search and returns results immediately

Source Files ¶

View all Source files

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