mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-06-04 13:30:32 +08:00
Three command renames consolidate the v0.7 verb table:
- `weknora agent invoke` → `weknora session ask --agent <id>`.
Server route POST /sessions/{session_id}/agent-qa is session-
anchored, so the verb moves with it. `weknora agent` subtree keeps
CRUD only (list / view / create / edit / delete / status / check).
SDK call (AgentQAStreamWithRequest) preserved verbatim; only the
command surface + flag layout move.
- `weknora doc upload` split into three commands:
- `weknora doc upload <file>` — local file (only).
- `weknora doc fetch <url>` — server-side remote fetch (was
`upload --from-url`). URL-only flags (--title / --file-type /
--tag-id) move with the verb.
- `weknora doc create --text` — direct text knowledge entry via
server CreateManualKnowledge.
- `weknora kb empty <id>` → `weknora doc delete --all --kb=<id>`.
Atomic server ClearKnowledgeBaseContents (no list-then-delete
race). Same exit-10 -y/--yes guard as other destructive verbs;
unified through the extended ConfirmDestructive helper.
Parent commands (agent, kb, doc, chunk, session, auth, profile,
search) lose their explicit Args:NoArgs + Run:cmd.Help so the
unknown-subcommand guard fires correctly — `weknora agent invoke
ag_x q` now emits the typed input.unknown_subcommand envelope with
detail.available[] instead of cobra's free-form exit-2 prose.
Spec: docs/superpowers/specs/2026-05-20-weknora-cli-v0.7-design.md §3.4 / §10.7
193 lines
7.6 KiB
Go
193 lines
7.6 KiB
Go
package doc
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
|
)
|
|
|
|
// docDeleteFields enumerates the fields surfaced for `--format json` discovery
|
|
// on `doc delete`. The result payload is a small {id, deleted} object.
|
|
var docDeleteFields = []string{"id", "deleted"}
|
|
|
|
type DeleteOptions struct {
|
|
Yes bool // sourced from the global -y/--yes persistent flag (see cli/cmd/root.go)
|
|
All bool // delete all docs in --kb
|
|
KB string // required when --all
|
|
}
|
|
|
|
// DeleteService is the narrow SDK surface this command depends on.
|
|
// *sdk.Client satisfies it.
|
|
type DeleteService interface {
|
|
DeleteKnowledge(ctx context.Context, id string) error
|
|
}
|
|
|
|
// AllService is the narrow SDK surface for --all mode.
|
|
// *sdk.Client satisfies it.
|
|
type AllService interface {
|
|
ClearKnowledgeBaseContents(ctx context.Context, kbID string) (*sdk.ClearKnowledgeBaseContentsResponse, error)
|
|
}
|
|
|
|
// deleteResult is the typed payload emitted under data on success (single-id).
|
|
type deleteResult struct {
|
|
ID string `json:"id"`
|
|
Deleted bool `json:"deleted"`
|
|
}
|
|
|
|
// NewCmdDelete builds `weknora doc delete`. Single-id keeps the simpler
|
|
// code path (one confirm prompt, exit 0/1); multi-id uses keep-going
|
|
// semantics (one -y confirms all, failures collected, exit 1 if any fail);
|
|
// --all --kb=<id> atomically clears every document in a knowledge base.
|
|
func NewCmdDelete(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &DeleteOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "delete <doc-id> [<doc-id>...] | --all --kb=<kb-id>",
|
|
Short: "Delete one or more documents from a knowledge base",
|
|
Long: `Permanently deletes one or more documents. Prompts for confirmation by
|
|
default when stdout is a TTY and JSON output is not set; pass -y/--yes
|
|
(global flag) to skip the prompt (required in agent / CI / piped contexts).
|
|
|
|
Single-id: one confirm prompt, exit 0/1.
|
|
Multi-id:
|
|
• Default keep-going: failed deletes do NOT stop the run; failures collected.
|
|
• One -y/--yes confirms all documents.
|
|
• TTY prompt shows total: "Delete N document(s)? This cannot be undone."
|
|
• Exit 0 if all succeed; exit 1 if any failed.
|
|
|
|
All-in-KB (--all --kb=<kb-id>):
|
|
• Atomically clears every document in the named knowledge base.
|
|
• The KB record itself (name, config) is preserved.
|
|
• Mutually exclusive with positional doc ids.
|
|
• Exit 0 on success; exit 10 without -y in non-interactive/JSON mode.
|
|
|
|
AI agents: This is a high-risk write. Without -y/--yes the CLI exits 10
|
|
and writes input.confirmation_required to stderr. NEVER auto-pass -y
|
|
without the user's explicit go-ahead.`,
|
|
Example: ` weknora doc delete doc_abc # interactive confirm
|
|
weknora doc delete doc_abc -y # no prompt
|
|
weknora doc delete doc_abc -y --format json # bare {id, deleted:true} JSON
|
|
weknora doc delete doc_a doc_b doc_c -y # delete 3, keep-going
|
|
weknora doc delete doc_a doc_b --format json # multi-id JSON output
|
|
weknora doc delete --all --kb=kb_x -y # clear all docs in kb_x
|
|
weknora doc delete --all --kb=kb_x -y --format json # agent-friendly`,
|
|
Args: cobra.ArbitraryArgs,
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
fopts, err := cmdutil.CheckFormatFlag(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fopts.ResolveDefault(iostreams.IO.IsStdoutTTY())
|
|
opts.Yes, _ = c.Flags().GetBool("yes")
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if opts.All {
|
|
if opts.KB == "" {
|
|
return cmdutil.NewError(cmdutil.CodeInputInvalidArgument, "--all requires --kb=<id>").
|
|
WithHint("specify --kb=<kb-id> to scope the delete-all operation").
|
|
WithRetryCommand("weknora doc delete --all --kb=<kb-id> -y")
|
|
}
|
|
if len(args) > 0 {
|
|
return cmdutil.NewFlagError(fmt.Errorf("--all is exclusive with positional doc ids"))
|
|
}
|
|
return runDeleteAll(c.Context(), opts, fopts, cli, f.Prompter())
|
|
}
|
|
if len(args) == 0 {
|
|
return cmdutil.NewFlagError(fmt.Errorf("doc id(s) required (or use --all --kb=<id>)"))
|
|
}
|
|
// Single-id uses the simpler code path (bare {id, deleted}).
|
|
if len(args) == 1 {
|
|
return runDelete(c.Context(), opts, fopts, cli, f.Prompter(), args[0])
|
|
}
|
|
if err := cmdutil.ConfirmDestructiveBatch(f.Prompter(), opts.Yes, fopts.WantsJSON(), "document", len(args), "doc.delete", "weknora doc delete "+strings.Join(args, " ")+" -y"); err != nil {
|
|
return err
|
|
}
|
|
outcomes, runErr := cmdutil.RunBatch(c.Context(), args, func(ctx context.Context, id string) error {
|
|
if err := cli.DeleteKnowledge(ctx, id); err != nil {
|
|
return cmdutil.WrapHTTP(err, "delete document %s", id)
|
|
}
|
|
return nil
|
|
})
|
|
// Only emit when the operation actually ran. Pre-flight errors
|
|
// (e.g. confirmation_required) must leave stdout empty per the
|
|
// wire contract in README.md.
|
|
if len(outcomes) > 0 {
|
|
if emitErr := cmdutil.EmitBatch(outcomes, fopts, iostreams.IO.Out, cmdutil.DeletedAtNow); emitErr != nil {
|
|
return emitErr
|
|
}
|
|
}
|
|
return runErr
|
|
},
|
|
}
|
|
cmd.Flags().BoolVar(&opts.All, "all", false, "delete all documents in the KB specified by --kb")
|
|
cmd.Flags().StringVar(&opts.KB, "kb", "", "knowledge base ID (required with --all)")
|
|
cmdutil.AddFormatFlag(cmd, docDeleteFields...)
|
|
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
|
UsedFor: "permanently delete one or more documents from a knowledge base",
|
|
RequiredFlags: []string{"<doc-id>... (positional) | --all --kb=<id>"},
|
|
Examples: []string{
|
|
"weknora doc delete doc_abc -y",
|
|
"weknora doc delete doc_a doc_b doc_c -y",
|
|
"weknora doc delete --all --kb=kb_x -y --format json",
|
|
},
|
|
Warnings: []string{
|
|
"doc delete is irreversible. --all --kb=<id> atomically clears every document in the KB; that is especially destructive. Never auto-add -y; surface the exit-10 prompt to the user and only retry after explicit approval.",
|
|
},
|
|
})
|
|
return cmd
|
|
}
|
|
|
|
func runDelete(ctx context.Context, opts *DeleteOptions, fopts *cmdutil.FormatOptions, svc DeleteService, p prompt.Prompter, id string) error {
|
|
if err := cmdutil.ConfirmDestructive(p, opts.Yes, fopts.WantsJSON(), "document", id, "doc.delete", "weknora doc delete "+id+" -y"); err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := svc.DeleteKnowledge(ctx, id); err != nil {
|
|
return cmdutil.WrapHTTP(err, "delete document %s", id)
|
|
}
|
|
|
|
if fopts.WantsJSON() {
|
|
return fopts.Emit(iostreams.IO.Out, deleteResult{ID: id, Deleted: true}, nil)
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Deleted document %s\n", id)
|
|
return nil
|
|
}
|
|
|
|
// runDeleteAll atomically clears every document in opts.KB via a single
|
|
// ClearKnowledgeBaseContents call. Non-TTY/JSON mode without -y returns
|
|
// CodeInputConfirmationRequired (exit 10) with risk metadata so agents can
|
|
// surface the risk to the user before re-invoking with -y.
|
|
func runDeleteAll(ctx context.Context, opts *DeleteOptions, fopts *cmdutil.FormatOptions, svc AllService, p prompt.Prompter) error {
|
|
if err := cmdutil.ConfirmDestructive(p, opts.Yes, fopts.WantsJSON(), "all docs in KB", opts.KB, "doc.delete_all", fmt.Sprintf("weknora doc delete --all --kb=%s -y", opts.KB)); err != nil {
|
|
return err
|
|
}
|
|
|
|
resp, err := svc.ClearKnowledgeBaseContents(ctx, opts.KB)
|
|
if err != nil {
|
|
return cmdutil.WrapHTTP(err, "clear KB %s", opts.KB)
|
|
}
|
|
deleted := 0
|
|
if resp != nil {
|
|
deleted = resp.DeletedCount
|
|
}
|
|
|
|
if !fopts.WantsJSON() {
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Deleted %d document(s) from KB %s\n", deleted, opts.KB)
|
|
return nil
|
|
}
|
|
return fopts.Emit(iostreams.IO.Out, map[string]any{
|
|
"kb_id": opts.KB,
|
|
"deleted_count": deleted,
|
|
}, nil)
|
|
}
|