Skip to content

Open-source LLM knowledge platform: turn raw documents into a queryable RAG, an autonomous reasoning agent, and a self-maintaining Wiki.

4.3 KB
Raw Blame
package kb

import (
	"context"
	"fmt"

	"github.com/spf13/cobra"

	"github.com/Tencent/WeKnora/cli/internal/cmdutil"
	"github.com/Tencent/WeKnora/cli/internal/iostreams"
	"github.com/Tencent/WeKnora/cli/internal/text"
	sdk "github.com/Tencent/WeKnora/client"
)

// kbViewFields enumerates the fields surfaced for `--format json` discovery on
// `kb view`. Lists the KnowledgeBase top-level json tags; nested config
// structs are omitted (use --jq for those).
var kbViewFields = []string{
	"id", "name", "type", "description",
	"is_temporary", "is_pinned",
	"embedding_model_id", "summary_model_id",
	"knowledge_count", "chunk_count",
	"is_processing", "processing_count",
	"created_at", "updated_at",
}

type ViewOptions struct{}

// ViewService is the narrow SDK surface this command depends on.
// ListKnowledgeBases is used only to enrich is_pinned (the single-KB GET
// doesn't carry per-user pin state — pin is a per-user list concept).
type ViewService interface {
	GetKnowledgeBase(ctx context.Context, id string) (*sdk.KnowledgeBase, error)
	ListKnowledgeBases(ctx context.Context) ([]sdk.KnowledgeBase, error)
}

// NewCmdView builds `weknora kb view <id>`.
func NewCmdView(f *cmdutil.Factory) *cobra.Command {
	opts := &ViewOptions{}
	cmd := &cobra.Command{
		Use:   "view <kb-id>",
		Short: "Show a knowledge base by ID",
		Long:  `Fetch a knowledge base's full configuration: chunking settings, embedding / summary model IDs, knowledge_count, chunk_count.`,
		Args:  cobra.ExactArgs(1),
		RunE: func(c *cobra.Command, args []string) error {
			fopts, err := cmdutil.CheckFormatFlag(c)
			if err != nil {
				return err
			}
			fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
			cli, err := f.Client()
			if err != nil {
				return err
			}
			return runView(c.Context(), opts, fopts, cli, args[0])
		},
	}
	cmdutil.AddFormatFlag(cmd, kbViewFields...)
	cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
		UsedFor:       "fetch one knowledge base's full configuration by id",
		RequiredFlags: []string{"<kb-id> (positional)"},
		Examples: []string{
			"weknora kb view kb_abc",
			"weknora kb view kb_abc --jq .data.embedding_model_id",
		},
		Output: "envelope.data is the KnowledgeBase object (id, name, type, embedding/summary model ids, chunk_count, ...)",
	})
	return cmd
}

func runView(ctx context.Context, opts *ViewOptions, fopts *cmdutil.FormatOptions, svc ViewService, id string) error {
	kb, err := svc.GetKnowledgeBase(ctx, id)
	if err != nil {
		return cmdutil.WrapHTTP(err, "get knowledge base %q", id)
	}
	// The single-KB GET doesn't stamp per-user pin state, so is_pinned would
	// always read false here. Enrich it from the list (the canonical pin
	// source) so the field is accurate. Best-effort: a list error leaves the
	// (unstamped) value rather than failing the view.
	if kbs, lerr := svc.ListKnowledgeBases(ctx); lerr == nil {
		for i := range kbs {
			if kbs[i].ID == id {
				kb.IsPinned = kbs[i].IsPinned
				break
			}
		}
	}
	if fopts.WantsJSON() {
		return fopts.Emit(iostreams.IO.Out, kb, nil)
	}
	// Text mode: KEY: VALUE. Nested config structs (chunking_config,
	// vlm_config, etc.) are intentionally omitted from the text render —
	// those are for `--format json | jq '.chunking_config'` workflows.
	w := iostreams.IO.Out
	fmt.Fprintf(w, "ID:        %s\n", kb.ID)
	fmt.Fprintf(w, "NAME:      %s\n", kb.Name)
	if kb.Type != "" {
		fmt.Fprintf(w, "TYPE:      %s\n", kb.Type)
	}
	if kb.Description != "" {
		fmt.Fprintf(w, "DESC:      %s\n", kb.Description)
	}
	if kb.IsPinned {
		fmt.Fprintf(w, "PINNED:    yes\n")
	}
	if kb.IsTemporary {
		fmt.Fprintf(w, "TEMPORARY: yes\n")
	}
	fmt.Fprintf(w, "DOCS:      %s\n", text.Pluralize(int(kb.KnowledgeCount), "doc"))
	fmt.Fprintf(w, "CHUNKS:    %s\n", text.Pluralize(int(kb.ChunkCount), "chunk"))
	if kb.IsProcessing {
		fmt.Fprintf(w, "PROCESSING: %s\n", text.Pluralize(int(kb.ProcessingCount), "doc"))
	}
	if kb.EmbeddingModelID != "" {
		fmt.Fprintf(w, "EMBEDDING: %s\n", kb.EmbeddingModelID)
	}
	if kb.SummaryModelID != "" {
		fmt.Fprintf(w, "SUMMARY MODEL: %s\n", kb.SummaryModelID)
	}
	if !kb.CreatedAt.IsZero() {
		fmt.Fprintf(w, "CREATED:   %s\n", kb.CreatedAt.Format("2006-01-02 15:04:05"))
	}
	if !kb.UpdatedAt.IsZero() {
		// Detail page favors absolute time; FuzzyAgo is reserved for list views.
		fmt.Fprintf(w, "UPDATED:   %s\n", kb.UpdatedAt.Format("2006-01-02 15:04:05"))
	}
	return nil
}