Files
libredesk/internal/ai/knowledgebase.go
Abhinav Raut 76db5aa851 fix help center bugs and share the embedding and article-content code
Review pass over the help center commit. Bug fixes:

- Image-only or video-only articles were rejected on save because the
  editor blanked the content when it had no text.
- An article could be moved into a collection in another help center.
  Slugs are only unique per help center, so two articles could end up
  on the same public URL.
- The article editor fired the "agent is typing" indicator into
  whatever conversation was last open, which the contact could see.
- Unsupported locales like /hc/x/zz-ZZ returned an empty 200 page with
  a canonical URL, so crawlers saw unlimited URLs. They 404 now.
- Article feedback was accepted for paused help centers.
- French pages announced lang="en".
- Editing a help center popped validation errors mid-keystroke.

Shared code that was duplicated:

- Help articles had their own copy of the snippet embedding lifecycle.
  The copy was missing the wait group, the concurrency cap and the
  generation gating, so article embeds were killed at shutdown, all hit
  the provider at once, and a slow embed could overwrite a newer edit or
  bring back a deleted article. Both content types now go through one
  embedSource lifecycle. Fingerprints are unchanged, so nothing
  re-embeds on deploy.
- Callout and collapsible CSS was written twice, once for the editor and
  once for the public page. They now share article-content.css, so the
  editor stays WYSIWYG.
- The excerpt was computed three ways. The page uses the stored one.

Less work at runtime:

- The admin tree no longer sends every article's HTML. The edit sheet
  loads the one article it needs. Publishing an article used to
  re-download the whole help center.
- Embedding reconcile no longer reads every article body every minute.
- The tree view fetched the help center twice on load.

Cleanups: one update-article route instead of two, media privacy comes
from the model type instead of a bool threaded through the handler, a
LinkListField component replaces three copies of the same repeater,
TreeNode renders the article row once, and 12 duplicate or dead i18n
keys are gone.
2026-07-25 15:50:47 +05:30

172 lines
6.2 KiB
Go

package ai
import (
"context"
"database/sql"
"strings"
"github.com/abhinavxd/libredesk/internal/ai/models"
"github.com/abhinavxd/libredesk/internal/envelope"
)
// snippetSource indexes enabled knowledge base snippets.
type snippetSource struct {
m *Manager
}
func (s snippetSource) sourceType() string {
return models.SourceSnippet
}
func (s snippetSource) list() ([]embedItem, error) {
rows, err := s.m.GetKnowledgeBaseItems()
if err != nil {
return nil, err
}
items := make([]embedItem, 0, len(rows))
for _, row := range rows {
items = append(items, snippetItem(row))
}
return items, nil
}
func (s snippetSource) get(id int) (embedItem, error) {
row, err := s.m.GetKnowledgeBaseItem(id)
if err != nil {
return embedItem{}, err
}
return snippetItem(row), nil
}
func (s snippetSource) exists(id int) (bool, error) {
var exists bool
if err := s.m.q.KnowledgeBaseItemExists.Get(&exists, id); err != nil {
return false, err
}
return exists, nil
}
func (s snippetSource) setFingerprint(id int, fingerprint string) {
if _, err := s.m.q.SetKnowledgeBaseFingerprint.Exec(id, fingerprint); err != nil {
s.m.lo.Error("error setting snippet embedded fingerprint", "error", err, "id", id)
}
}
// deleteOrphans is a no-op: snippet rows and their vectors are deleted in one transaction.
func (s snippetSource) deleteOrphans() ([]int, error) {
return nil, nil
}
// GetKnowledgeBaseItems returns all snippet knowledge base items.
func (m *Manager) GetKnowledgeBaseItems() ([]models.KnowledgeBaseItem, error) {
items := make([]models.KnowledgeBaseItem, 0)
if err := m.q.GetKnowledgeBaseItems.Select(&items); err != nil {
m.lo.Error("error fetching knowledge base items", "error", err)
return nil, envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
return items, nil
}
func (m *Manager) GetKnowledgeBaseItem(id int) (models.KnowledgeBaseItem, error) {
var item models.KnowledgeBaseItem
if err := m.q.GetKnowledgeBaseItem.Get(&item, id); err != nil {
if err == sql.ErrNoRows {
return item, envelope.NewError(envelope.NotFoundError, m.i18n.T("globals.messages.notFound"), nil)
}
m.lo.Error("error fetching knowledge base item", "error", err)
return item, envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
return item, nil
}
func (m *Manager) CreateKnowledgeBaseItem(title, content, source, sourceURL string, enabled bool) (models.KnowledgeBaseItem, error) {
if strings.TrimSpace(title) == "" {
return models.KnowledgeBaseItem{}, envelope.NewError(envelope.InputError, m.i18n.Ts("globals.messages.empty", "name", m.i18n.T("globals.terms.title")), nil)
}
if strings.TrimSpace(content) == "" {
return models.KnowledgeBaseItem{}, envelope.NewError(envelope.InputError, m.i18n.Ts("globals.messages.empty", "name", m.i18n.T("globals.terms.content")), nil)
}
if source == "" {
source = models.KnowledgeSourceManual
}
var item models.KnowledgeBaseItem
if err := m.q.InsertKnowledgeBaseItem.Get(&item, models.KnowledgeTypeSnippet, title, content, enabled, source, sourceURL); err != nil {
m.lo.Error("error creating knowledge base item", "error", err)
return item, envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
m.reindexItem(snippetSource{m}, snippetItem(item))
return item, nil
}
func (m *Manager) UpdateKnowledgeBaseItem(id int, title, content string, enabled bool) (models.KnowledgeBaseItem, error) {
if strings.TrimSpace(title) == "" {
return models.KnowledgeBaseItem{}, envelope.NewError(envelope.InputError, m.i18n.Ts("globals.messages.empty", "name", m.i18n.T("globals.terms.title")), nil)
}
if strings.TrimSpace(content) == "" {
return models.KnowledgeBaseItem{}, envelope.NewError(envelope.InputError, m.i18n.Ts("globals.messages.empty", "name", m.i18n.T("globals.terms.content")), nil)
}
var item models.KnowledgeBaseItem
if err := m.q.UpdateKnowledgeBaseItem.Get(&item, id, title, content, enabled); err != nil {
if err == sql.ErrNoRows {
return item, envelope.NewError(envelope.NotFoundError, m.i18n.T("globals.messages.notFound"), nil)
}
m.lo.Error("error updating knowledge base item", "error", err)
return item, envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
m.reindexItem(snippetSource{m}, snippetItem(item))
return item, nil
}
// DeleteKnowledgeBaseItem removes the snippet and its embeddings in one transaction.
func (m *Manager) DeleteKnowledgeBaseItem(id int) error {
m.reindexMu.Lock()
defer m.reindexMu.Unlock()
// Supersede any in-flight reindex for this snippet so a slower embed can't re-insert its vectors
// after the delete commits.
m.dropGen(models.SourceSnippet, id)
tx, err := m.db.BeginTxx(context.Background(), &sql.TxOptions{})
if err != nil {
m.lo.Error("error beginning knowledge base delete transaction", "error", err)
return envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
defer func() {
_ = tx.Rollback()
}()
if _, err := tx.Stmtx(m.q.DeleteKnowledgeBaseItem).Exec(id); err != nil {
m.lo.Error("error deleting knowledge base item", "error", err)
return envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
if _, err := tx.Stmtx(m.q.DeleteEmbeddingsBySource).Exec(models.SourceSnippet, id); err != nil {
m.lo.Error("error deleting snippet embeddings", "error", err)
return envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
if err := tx.Commit(); err != nil {
m.lo.Error("error committing knowledge base delete transaction", "error", err)
return envelope.NewError(envelope.GeneralError, m.i18n.T("globals.messages.somethingWentWrong"), nil)
}
m.index.removeSource(models.SourceSnippet, id)
return nil
}
// ReindexAll triggers a reconcile so snippets are re-embedded against the current model, e.g. after the embedding model changed.
func (m *Manager) ReindexAll() {
m.wg.Add(1)
go func() {
defer m.wg.Done()
m.reconcile(m.ctx)
}()
}
func snippetItem(row models.KnowledgeBaseItem) embedItem {
return embedItem{
ID: row.ID,
Title: row.Title,
Content: row.Content,
Fingerprint: row.EmbeddedFingerprint,
Eligible: row.Enabled,
}
}