1b20b06f5e
Output ergonomics:
- `--json` accepts a comma-separated field list (gh-parity); selects
named keys from the per-command payload. Bare `--json` keeps the
full shape.
- `--jq <expr>` evaluates a gojq expression over the JSON; pairs with
`--json field-list` so projection runs before jq.
- `--version` is a global cobra flag in addition to the `version`
subcommand; both render the same line.
- Per-command `--help` now renders the available JSON field list under
"JSON fields available via `--json id,name,...`" (field-discovery
parity with gh / kubectl `-o jsonpath`).
New commands:
- `auth token` — print the active context's credential to stdout for
shell command substitution (`WEKNORA_TOKEN=$(weknora auth token)`).
Default: raw secret, no trailing newline. `--json` emits
`{token, mode, context}`.
- `doc upload --from-url <URL>` — ingest a remote URL via the SDK
`CreateKnowledgeFromURL`. `--name` forwarded as `FileName` so the
server's known-extension heuristic upgrades crawl-mode to
file-download-mode where appropriate.
Includes the simplify post-review polish pass (field-filter unit
tests, --json/--jq compose check, agent_help copy fixes).
159 lines
5.4 KiB
Go
159 lines
5.4 KiB
Go
package search
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"sort"
|
|
"strings"
|
|
"text/tabwriter"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/agent"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/format"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/text"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// docsPageSize is how many entries we pull per ListKnowledge round-trip
|
|
// when paging through a KB to filter client-side. Server caps page_size at
|
|
// 1000 (per the doc/list bound this branch already added).
|
|
const docsPageSize = 200
|
|
|
|
// docsFields enumerates the fields surfaced for `--json` discovery on
|
|
// `search docs`. Mirrors sdk.Knowledge json tags.
|
|
var docsFields = []string{
|
|
"id", "tenant_id", "knowledge_base_id", "tag_id", "type", "title",
|
|
"description", "source", "channel", "parse_status", "summary_status",
|
|
"enable_status", "embedding_model_id", "file_name", "file_type",
|
|
"file_size", "file_hash", "file_path", "storage_size", "metadata",
|
|
"created_at", "updated_at", "processed_at", "error_message",
|
|
}
|
|
|
|
type DocsSearchOptions struct {
|
|
Query string
|
|
KB string // raw --kb (UUID or name)
|
|
KBID string // resolved id; populated before listing
|
|
Limit int
|
|
}
|
|
|
|
// docsResult is the typed payload emitted under data.items.
|
|
type docsResult struct {
|
|
Items []sdk.Knowledge `json:"items"`
|
|
}
|
|
|
|
// DocsSearchService is the narrow SDK surface this command depends on.
|
|
// Server has no fuzzy-document-name endpoint, so the CLI pages through
|
|
// ListKnowledge and filters by Title / FileName client-side.
|
|
type DocsSearchService interface {
|
|
ListKnowledge(ctx context.Context, kbID string, page, pageSize int, tagID string) ([]sdk.Knowledge, int64, error)
|
|
}
|
|
|
|
// NewCmdDocs builds `weknora search docs "<query>" --kb <id-or-name>`.
|
|
// Pages through the KB's documents and surfaces every entry whose title
|
|
// or filename contains the query (case-insensitive). Useful for finding
|
|
// a specific upload to download or delete.
|
|
func NewCmdDocs(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &DocsSearchOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: `docs "<query>"`,
|
|
Short: "Find documents in a knowledge base by name (client-side substring match)",
|
|
Example: ` weknora search docs "Q3 forecast" --kb finance
|
|
weknora search docs "spec" --kb engineering --limit 5`,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
opts.Query = strings.TrimSpace(args[0])
|
|
if opts.Query == "" {
|
|
return cmdutil.NewError(cmdutil.CodeInputInvalidArgument, "query argument cannot be empty")
|
|
}
|
|
if opts.Limit < 1 || opts.Limit > 1000 {
|
|
return cmdutil.NewError(cmdutil.CodeInputInvalidArgument, "--limit must be between 1 and 1000")
|
|
}
|
|
jopts, err := cmdutil.CheckJSONFlags(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
kbID, err := cmdutil.ResolveKBFlag(c.Context(), cli, opts.KB)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
opts.KBID = kbID
|
|
return runDocsSearch(c.Context(), opts, jopts, cli)
|
|
},
|
|
}
|
|
cmd.Flags().StringVar(&opts.KB, "kb", "", "Knowledge base UUID or name (required)")
|
|
cmd.Flags().IntVarP(&opts.Limit, "limit", "L", 20, "Maximum results to return")
|
|
cmdutil.AddJSONFlags(cmd, docsFields)
|
|
_ = cmd.MarkFlagRequired("kb")
|
|
agent.SetAgentHelp(cmd, "Lists documents in --kb whose title or file_name contains the query. Pages through the KB sequentially; stops once limit hits found. Returns the full Knowledge object so agents can derive id / file_size / processed_at without a second call.")
|
|
return cmd
|
|
}
|
|
|
|
func runDocsSearch(ctx context.Context, opts *DocsSearchOptions, jopts *cmdutil.JSONOptions, svc DocsSearchService) error {
|
|
needle := strings.ToLower(opts.Query)
|
|
var matches []sdk.Knowledge
|
|
|
|
// Page through the KB until limit matches found or pagination exhausted.
|
|
// The server returns total; stop when (page-1)*pageSize >= total.
|
|
for page := 1; ; page++ {
|
|
items, total, err := svc.ListKnowledge(ctx, opts.KBID, page, docsPageSize, "")
|
|
if err != nil {
|
|
return cmdutil.WrapHTTP(err, "list documents")
|
|
}
|
|
for _, k := range items {
|
|
if matchKnowledge(k, needle) {
|
|
matches = append(matches, k)
|
|
if opts.Limit > 0 && len(matches) >= opts.Limit {
|
|
goto done
|
|
}
|
|
}
|
|
}
|
|
if int64(page*docsPageSize) >= total || len(items) == 0 {
|
|
break
|
|
}
|
|
}
|
|
done:
|
|
sortKnowledgeByRecency(matches)
|
|
|
|
if jopts.Enabled() {
|
|
if matches == nil {
|
|
matches = []sdk.Knowledge{}
|
|
}
|
|
return format.WriteEnvelopeFiltered(
|
|
iostreams.IO.Out,
|
|
format.Success(docsResult{Items: matches}, &format.Meta{KBID: opts.KBID}),
|
|
jopts.Fields, jopts.JQ,
|
|
)
|
|
}
|
|
if len(matches) == 0 {
|
|
fmt.Fprintln(iostreams.IO.Out, "(no matches)")
|
|
return nil
|
|
}
|
|
tw := tabwriter.NewWriter(iostreams.IO.Out, 0, 0, 2, ' ', 0)
|
|
fmt.Fprintln(tw, "ID\tFILE\tTYPE\tUPDATED")
|
|
for _, k := range matches {
|
|
name := text.Truncate(50, text.KnowledgeDisplayName(k.FileName, k.Title, k.ID))
|
|
fmt.Fprintf(tw, "%s\t%s\t%s\t%s\n", k.ID, name, k.FileType, k.UpdatedAt.Format("2006-01-02"))
|
|
}
|
|
return tw.Flush()
|
|
}
|
|
|
|
// matchKnowledge reports whether title or filename contains needle (already
|
|
// lowercased by caller).
|
|
func matchKnowledge(k sdk.Knowledge, needle string) bool {
|
|
return text.ContainsFold(needle, k.Title, k.FileName)
|
|
}
|
|
|
|
// sortKnowledgeByRecency sorts in place by UpdatedAt desc.
|
|
func sortKnowledgeByRecency(items []sdk.Knowledge) {
|
|
sort.Slice(items, func(i, j int) bool {
|
|
return items[i].UpdatedAt.After(items[j].UpdatedAt)
|
|
})
|
|
}
|