e623e8208f
Removes the entire envelope machinery now that every success path
emits bare JSON:
- cli/internal/format/envelope.go (Envelope, Success, Failure,
SuccessWithRisk, WriteEnvelope, Meta, Notice, UpdateNotice,
VersionSkewNotice, Risk, RiskLevel, ErrorBody) + tests.
- cli/internal/format/filter.go envelope-specific helpers
(WriteEnvelopeFiltered, marshalEnvelope, applyFieldFilter,
filterDataPayload, filterObjectData); the reusable
filterArrayItems / filterObjectKeys / writeJQ stay for bare.go.
- cli/internal/cmdutil/exporter.go + tests (envelope-only).
- cli/internal/cmdutil/PrintErrorEnvelope + ToErrorBody +
operationRiskOf + Error.OperationRisk field + OperationRisk struct.
Error path: all errors now go to stderr via cmdutil.PrintError in
`code: message\nhint: ...` form, regardless of --json. Stdout stays
empty (or holds the partial-success the command already wrote) so
downstream `--json | jq` pipelines never have to filter error shapes
out of the success stream. Typed exit codes (3 auth.* / 4
resource.not_found / 5 input.* / 6 server.rate_limited / 7 server.*
+ network.* / 10 input.confirmation_required) carry the failure
class for agents that branch on it.
Acceptance contract:
- envelope_test.go → wire_test.go (TestEnvelopeGolden → TestWireGolden).
- testdata/envelopes/ → testdata/wire/.
- Error-path cases assert the typed code substring on stderr.
- Orphan whoami.*.json goldens deleted.
AGENTS.md + README.md rewritten for the bare-data contract:
- Drop envelope schema section + dry-run rule.
- Document bare JSON on stdout + `code: msg\nhint: …` on stderr.
- ADR-3 reframed around bare data and why error separation matters
for `--json | jq` pipelines.
WriteJSONFiltered short-circuits to WriteJSON when both filters are
empty (skip the marshal-buffer round-trip for the common case).
Final review pass:
- Fix wire-contract bug: `--json id,name` (space form) is broken by
pflag's NoOptDefVal; AGENTS.md / README.md / SetAgentHelp + the
field-discovery help text all switched to `--json=id,name`.
- Fix `weknora api --jq` silently ignored: api.go now routes through
WriteJSONFiltered with jopts.JQ.
- AGENTS.md: drop the false claim that `auth logout` honors `-y`
(logout is local-only with no ConfirmDestructive guard); list the
actual destructive commands instead.
- Rewrite cli/acceptance/e2e/e2e_test.go for the bare-data wire shape
(was still parsing `out["data"]` / `env["ok"]`).
- Add `JSONOptions.Emit(w, v)` helper; collapse ~33 repeated
`format.WriteJSONFiltered(iostreams.IO.Out, X, jopts.Fields,
jopts.JQ)` sites to `jopts.Emit(iostreams.IO.Out, X)` — drops the
format import from 22 cmd/* files.
- Delete single-caller `cmdutil.MustRequireFlag`; inline as
`_ = cmd.MarkFlagRequired(...)` everywhere.
- Add `_ = cmd.MarkFlagRequired("name")` to `kb create`; it was the
only write command relying on runtime --name validation while
`context add` already used the cobra-level mark.
- `context use`: register `--json` / `--jq` (was always emitting JSON
unconditionally with no human path and no flag — diverged from
every other write command); human mode now prints
`✓ Switched context to X (was Y)`.
- Replace per-package `confirmPrompter` / `scriptedConfirm` /
`errPrompter` test doubles with `testutil.ConfirmPrompter`.
- Rename `chatService` → `ChatService` (export to match siblings
`ListService` / `ViewService`); rename `printUploadSuccess` →
`renderUploadSuccess` (siblings use `render*`).
- `defaultHint(CodeResourceNotFound)`: drop the hardcoded
"list available with `weknora kb list`" — misleading on agent /
doc / session 404. Replaced with "verify the resource ID and try
again".
- Strip stale `v0.2/v0.3` / "envelope" / "v0.0/v0.1 supports only"
historical tags from production comments and a few test
descriptions.
149 lines
5.1 KiB
Go
149 lines
5.1 KiB
Go
package search
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"sort"
|
|
"strings"
|
|
"text/tabwriter"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/aiclient"
|
|
"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"
|
|
)
|
|
|
|
// 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
|
|
}
|
|
|
|
// 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", 30, "Maximum results to return")
|
|
cmdutil.AddJSONFlags(cmd, docsFields)
|
|
_ = cmd.MarkFlagRequired("kb")
|
|
aiclient.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 jopts.Emit(iostreams.IO.Out, matches)
|
|
}
|
|
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)
|
|
})
|
|
}
|