mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-08-29 02:04:30 +08:00
d3c03b2f34
A hardening + finalization pass over the agent-first CLI: correctness fixes,
richer machine-readable signals, flag/naming consistency, and a symmetric
config surface. Pre-1.0, so it includes breaking renames.
Correctness:
- agent update: resolve/validate --model/--rerank-model (was storing a bogus
name verbatim, corrupting config.model_id).
- doctor: honor WEKNORA_HOST / WEKNORA_API_KEY (headless path no longer reports
"no host configured").
- session ask / MCP session_ask: text answer was empty on non-TTY — the agent
stream sets Done=true on an intermediate agent_query frame before the answer,
and AgentAccumulator treated the first Done as terminal. Terminate on the
`complete` event (new sdk.AgentResponseTypeComplete), not a per-frame Done.
- batch exit codes: any per-item failure collapses to operation.failed (exit 1),
including `doc upload --recursive` partial failures — a permanent per-file
failure (e.g. a duplicate) no longer surfaces as a retryable exit 7 an agent
would loop on; per-item typed errors stay in the envelope.
Agent-first signals & discovery:
- error.exit_code in the envelope (type + exit_code disambiguate the
input.invalid_argument exit-2-vs-5 split in one JSON read).
- meta.hint on empty content search and on draft doc create; doc wait fails fast
on a never-parsing draft instead of hanging to --timeout.
- retrieval-readiness is visible in the natural flow: kb status / kb check emit
retrieval_ready, and kb create hints the fix when no embedding model is bound
— an unconfigured KB no longer looks silently healthy.
- schema contract completeness: every leaf declares output + >=1 example
(drift-guarded); output strings match the meta actually emitted; chunk list
and search docs now emit meta.total_count (both previously dropped it).
- schema tolerates a quoted multi-word command label; zero-state auth — and
`link` with no profile — point at profile setup / the headless WEKNORA_KB_ID
path instead of looping on `auth login`.
- id-addressed reads tolerate a redundant --kb (doc view/wait, chunk list/view
accept and ignore it, declared in schema) so a carried-over --kb doesn't
exit 2; streaming commands warn that --jq does not apply to an NDJSON stream.
- keep JSON-always as the default; --jq hints spell out the .data path.
Consistency & gating:
- doc create: drop the deprecated --name alias (--title only; pre-1.0 break).
- chunk list --limit aligned to 1..10000; model list --limit/-L with
has_more/total_count; api write-gates -X PUT/PATCH (exit 10); skills install
expands a leading ~.
- docs corrected: search docs / doc list --keyword help is case-insensitive
(server does LOWER LIKE); AGENTS.md risk-action list (no phantom kb.init; add
model.update / kb.config.set) and batch example (failed item carries `error`);
session resume --message id comes from `message list`, not the stream.
- auth/profile ergonomics: env credentials are now first-class — `auth token`
prints the active WEKNORA_API_KEY / WEKNORA_TOKEN, and auth login/logout/refresh
give an env-aware message instead of looping on "run auth login". `auth logout`
clears credentials but keeps the profile registered (host preserved for
re-login); deleting a profile is `profile remove`'s job (clean logout/remove
separation, matching gh / lark).
Config surface (symmetric read/write, in-place model edits):
- kb config now returns a secret-free KBModelConfigView (was {}); `kb config`
reads, new `kb config set` writes; `kb init` removed (misnomer).
- kb create --chat-model: retrieval-ready in one step.
- model update: edit a model in place (id preserved, references survive) —
rotate --api-key-stdin, change base-url / display-name / etc.
- session continue-stream renamed to session resume.
Docs: AGENTS.md is the single wire-contract source; CHANGELOG slimmed; stale
kb-init / continue-stream references removed; skill wire-vocab guard extended.
AGENTS.md / weknora-shared SKILL document retrieval_ready (a KB needs an
embedding model to be searchable), that --jq does not apply to NDJSON
streams, and the env-credential-first auth path; the KB quickstart example
now creates a retrieval-ready KB.
161 lines
6.6 KiB
Go
161 lines
6.6 KiB
Go
package chunkcmd
|
|
|
|
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/prompt"
|
|
)
|
|
|
|
// chunkDeleteFields enumerates the JSON discovery fields for `chunk delete`.
|
|
// Tracks the single-id result struct; multi-id mode emits batch envelope.
|
|
var chunkDeleteFields = []string{"id", "deleted"}
|
|
|
|
type DeleteOptions struct {
|
|
ChunkID string // single-id path
|
|
DocID string // required: SDK DeleteChunk takes both ids in the route
|
|
Yes bool // sourced from the global -y/--yes persistent flag
|
|
DryRun bool
|
|
}
|
|
|
|
// DeleteService is the narrow SDK surface this command depends on.
|
|
type DeleteService interface {
|
|
DeleteChunk(ctx context.Context, docID, chunkID string) error
|
|
}
|
|
|
|
// deleteResult is the typed payload emitted on single-id success in JSON mode.
|
|
type deleteResult struct {
|
|
ID string `json:"id"`
|
|
Deleted bool `json:"deleted"`
|
|
}
|
|
|
|
const chunkDeleteLong = `Permanently delete one or more chunks from a document.
|
|
|
|
Requires both the chunk id(s) (positional, repeatable) and the parent
|
|
document id (--doc) because the server route encodes both:
|
|
DELETE /chunks/{doc}/{id}. All chunks in a multi-id call must share the
|
|
same --doc. The CLI does not auto-resolve doc id from chunk id because
|
|
that would add a round-trip and open a race with the ingest pipeline
|
|
(a chunk could move between documents between resolve and delete).
|
|
|
|
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 chunks.
|
|
• Exit 0 if all succeed; exit 1 if any failed.
|
|
|
|
Prompts for confirmation by default when stdout is a TTY and JSON output
|
|
is not set. Pass -y/--yes (the global flag) to skip the prompt (required
|
|
in agent / CI / piped contexts).
|
|
|
|
Typed exit codes:
|
|
resource.not_found no chunk with the given id under that doc (exit 4)
|
|
auth.forbidden caller lacks delete permission on the chunk (exit 3)
|
|
input.confirmation_required destructive op without -y on a TTY (exit 10)
|
|
|
|
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 — the exit-10 protocol exists
|
|
exactly to guard against unintended deletes.`
|
|
|
|
const chunkDeleteExample = ` weknora chunk delete chunk_abc --doc doc_xyz # interactive confirm
|
|
weknora chunk delete chunk_abc --doc doc_xyz -y # no prompt
|
|
weknora chunk delete chunk_abc --doc doc_xyz -y --format json # bare {id, deleted:true} JSON
|
|
weknora chunk delete c1 c2 c3 --doc doc_xyz -y # delete 3 chunks under same doc, keep-going`
|
|
|
|
// NewCmdDelete builds `weknora chunk delete <chunk-id> [<chunk-id>...] --doc <doc-id>`.
|
|
func NewCmdDelete(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &DeleteOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "delete <chunk-id> [<chunk-id>...] --doc <doc-id>",
|
|
Short: "Delete one or more chunks from a document (scoped)",
|
|
Long: chunkDeleteLong,
|
|
Example: chunkDeleteExample,
|
|
Args: cobra.MinimumNArgs(1),
|
|
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")
|
|
if handled, err := cmdutil.HandleDryRun(c, opts.DryRun, cmdutil.DryRunPlan{
|
|
Action: "chunk.delete",
|
|
Args: map[string]any{
|
|
"chunk_ids": args,
|
|
"doc": opts.DocID,
|
|
},
|
|
}); handled {
|
|
return err
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if len(args) == 1 {
|
|
opts.ChunkID = args[0]
|
|
return runDelete(c.Context(), opts, fopts, cli, f.Prompter())
|
|
}
|
|
batchRetry := append([]string{"weknora", "chunk", "delete"}, args...)
|
|
batchRetry = append(batchRetry, "--doc", opts.DocID, "-y")
|
|
if err := cmdutil.ConfirmDestructiveBatch(f.Prompter(), opts.Yes, fopts.WantsJSON(), "delete", "chunk", len(args), "chunk.delete", batchRetry); err != nil {
|
|
return err
|
|
}
|
|
outcomes, runErr := cmdutil.RunBatch(c.Context(), args, func(ctx context.Context, id string) error {
|
|
if err := cli.DeleteChunk(ctx, opts.DocID, id); err != nil {
|
|
return cmdutil.WrapHTTP(err, "delete chunk %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().StringVar(&opts.DocID, "doc", "", "Parent document id (SDK knowledge_id) the chunks live under")
|
|
_ = cmd.MarkFlagRequired("doc")
|
|
cmdutil.AddIgnoredKBFlag(cmd)
|
|
cmdutil.AddFormatFlag(cmd, chunkDeleteFields...)
|
|
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
|
cmdutil.SetRisk(cmd, "chunk.delete")
|
|
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
|
UsedFor: "permanently delete one or more chunks from a document",
|
|
RequiredFlags: []string{"<chunk-id>... (positional, at least one)", "--doc <doc-id>"},
|
|
Examples: []string{
|
|
"weknora chunk delete chunk_abc --doc doc_xyz -y",
|
|
"weknora chunk delete c1 c2 c3 --doc doc_xyz -y",
|
|
"weknora chunk delete chunk_abc --doc doc_xyz -y --format json",
|
|
},
|
|
Output: "envelope.data shape depends on the form: a single chunk id -> {id, deleted:true}; multiple ids -> batch envelope (top-level status success|partial|error, ok=(failures==0), data per-item [{id, ok, error?}], meta.successes/failures — read data[].ok per id).",
|
|
Warnings: []string{
|
|
"Requires explicit user approval (exit 10 / input.confirmation_required); never auto-add -y.",
|
|
"chunk delete is irreversible; loses the chunk + breaks RAG retrieval coherence for downstream queries.",
|
|
},
|
|
})
|
|
return cmd
|
|
}
|
|
|
|
func runDelete(ctx context.Context, opts *DeleteOptions, fopts *cmdutil.FormatOptions, svc DeleteService, p prompt.Prompter) error {
|
|
if err := cmdutil.ConfirmDestructive(p, opts.Yes, fopts.WantsJSON(), "delete", "chunk", opts.ChunkID, "chunk.delete", []string{"weknora", "chunk", "delete", opts.ChunkID, "--doc", opts.DocID, "-y"}); err != nil {
|
|
return err
|
|
}
|
|
if err := svc.DeleteChunk(ctx, opts.DocID, opts.ChunkID); err != nil {
|
|
return cmdutil.WrapHTTP(err, "delete chunk %s", opts.ChunkID)
|
|
}
|
|
if fopts.WantsJSON() {
|
|
return fopts.Emit(iostreams.IO.Out, deleteResult{ID: opts.ChunkID, Deleted: true}, nil)
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Deleted chunk %s\n", opts.ChunkID)
|
|
return nil
|
|
}
|