mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-01 20:52:50 +08:00
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.
97 lines
3.2 KiB
Go
97 lines
3.2 KiB
Go
package doc
|
|
|
|
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"
|
|
)
|
|
|
|
// docReparseFields enumerates the fields surfaced for `--format json` discovery
|
|
// on `doc reparse`. The result is the Knowledge object; the caller mainly wants
|
|
// the id and the reset parse_status.
|
|
var docReparseFields = []string{"id", "parse_status", "file_name", "title"}
|
|
|
|
// ReparseOptions captures `doc reparse` flag state.
|
|
type ReparseOptions struct {
|
|
DryRun bool
|
|
}
|
|
|
|
// ReparseService is the narrow SDK surface this command depends on.
|
|
type ReparseService interface {
|
|
ReparseKnowledge(ctx context.Context, id string) (*sdk.Knowledge, error)
|
|
}
|
|
|
|
// NewCmdReparse builds `weknora doc reparse <doc-id>`.
|
|
func NewCmdReparse(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &ReparseOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "reparse <doc-id>",
|
|
Short: "Re-run parsing on a document",
|
|
Long: `Re-trigger server-side parsing of a document — the recovery path when a
|
|
document's parse_status is failed, or after its source changed. The document
|
|
keeps its id; parsing restarts asynchronously, so follow with
|
|
'weknora doc wait <doc-id>' to block until it reaches a terminal status.`,
|
|
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())
|
|
if handled, err := cmdutil.HandleDryRun(c, opts.DryRun, cmdutil.DryRunPlan{
|
|
Action: "doc.reparse",
|
|
Args: map[string]any{"doc": args[0]},
|
|
}); handled {
|
|
return err
|
|
}
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runReparse(c.Context(), opts, fopts, cli, args[0])
|
|
},
|
|
}
|
|
cmdutil.AddIgnoredKBFlag(cmd)
|
|
cmdutil.AddFormatFlag(cmd, docReparseFields...)
|
|
cmdutil.AddDryRunFlag(cmd, &opts.DryRun)
|
|
cmdutil.SetAgentHelp(cmd, cmdutil.AgentHelp{
|
|
UsedFor: "re-run parsing on a document (recovery after parse_status=failed, or a changed source)",
|
|
RequiredFlags: []string{"<doc-id> (positional)"},
|
|
Examples: []string{
|
|
"weknora doc reparse doc_abc",
|
|
"weknora doc reparse doc_abc --format json",
|
|
},
|
|
Output: "envelope.data is the Knowledge object with parse_status reset to the re-processing state; poll `weknora doc wait <doc-id>` for completion",
|
|
})
|
|
return cmd
|
|
}
|
|
|
|
func runReparse(ctx context.Context, opts *ReparseOptions, fopts *cmdutil.FormatOptions, svc ReparseService, id string) error {
|
|
k, err := svc.ReparseKnowledge(ctx, id)
|
|
if err != nil {
|
|
return cmdutil.WrapHTTP(err, "reparse document %s", id)
|
|
}
|
|
if fopts.WantsJSON() {
|
|
return fopts.Emit(iostreams.IO.Out, k, nil)
|
|
}
|
|
// fileName → title, with no id fallback (empty means "skip the suffix").
|
|
name := text.KnowledgeDisplayName(k.FileName, k.Title, "")
|
|
w := iostreams.IO.Out
|
|
fmt.Fprintf(w, "✓ reparse triggered for %s", id)
|
|
if name != "" {
|
|
fmt.Fprintf(w, " (%s)", name)
|
|
}
|
|
fmt.Fprintln(w)
|
|
if k.ParseStatus != "" {
|
|
fmt.Fprintf(w, " parse_status: %s\n", k.ParseStatus)
|
|
}
|
|
fmt.Fprintf(w, " next: weknora doc wait %s\n", id)
|
|
return nil
|
|
}
|