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.
236 lines
8.2 KiB
Go
236 lines
8.2 KiB
Go
package agentcmd
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/aiclient"
|
|
"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/sse"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// agentInvokeFields enumerates fields surfaced for `--json` discovery on
|
|
// `agent invoke`. Matches invokeData below — the single-shot result
|
|
// object with the agent's final answer plus the trace (references,
|
|
// tool events).
|
|
var agentInvokeFields = []string{
|
|
"answer", "references", "tool_events", "thinking",
|
|
"session_id", "agent_id", "query",
|
|
}
|
|
|
|
// InvokeOptions captures `agent invoke` flag state.
|
|
type InvokeOptions struct {
|
|
AgentID string
|
|
Query string
|
|
SessionID string // --session: continue an existing session (skip auto-create)
|
|
NoStream bool // --no-stream: force accumulate-and-emit (TTY default streams)
|
|
}
|
|
|
|
// InvokeService is the narrow SDK surface this command depends on.
|
|
//
|
|
// CreateSession is called when --session is omitted — sessions are
|
|
// agent-agnostic at creation (verified against
|
|
// internal/handler/session/handler.go CreateSession, which only persists
|
|
// {title, description}). The agent ID is supplied per-request via
|
|
// AgentQARequest.AgentID, so the same session can be reused across
|
|
// agent / KB-chat invocations.
|
|
type InvokeService interface {
|
|
CreateSession(ctx context.Context, req *sdk.CreateSessionRequest) (*sdk.Session, error)
|
|
AgentQAStreamWithRequest(ctx context.Context, sessionID string, req *sdk.AgentQARequest, cb sdk.AgentEventCallback) error
|
|
}
|
|
|
|
// invokeData is the JSON payload emitted on the --json path.
|
|
type invokeData struct {
|
|
Answer string `json:"answer"`
|
|
References []*sdk.SearchResult `json:"references"`
|
|
ToolEvents []sse.AgentToolEvent `json:"tool_events,omitempty"`
|
|
Thinking string `json:"thinking,omitempty"`
|
|
SessionID string `json:"session_id"`
|
|
AgentID string `json:"agent_id"`
|
|
Query string `json:"query"`
|
|
}
|
|
|
|
// NewCmdInvoke builds `weknora agent invoke <agent-id> "<text>"`.
|
|
func NewCmdInvoke(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &InvokeOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: `invoke <agent-id> "<text>"`,
|
|
Short: "Run a query through a custom agent",
|
|
Long: `Sends a query to the agent's configured workflow (system prompt, allowed
|
|
tools, KB scope, retrieval thresholds) over SSE. By default a fresh session
|
|
is auto-created; pass --session to continue an existing conversation. The
|
|
agent picks the model, retrieval params, and tool surface from its own
|
|
config — agent invoke is the thin shim that streams the result.
|
|
|
|
Modes:
|
|
TTY (default): live answer streaming + tool-trace footer
|
|
Pipe / --no-stream / --json: buffered, single JSON object at completion`,
|
|
Example: ` weknora agent invoke ag_abc "Summarise the Q3 plan"
|
|
weknora agent invoke ag_abc "Continue?" --session sess_xyz
|
|
weknora agent invoke ag_abc "What did we ship?" --json`,
|
|
Args: cobra.ExactArgs(2),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
jopts, err := cmdutil.CheckJSONFlags(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
opts.AgentID = args[0]
|
|
opts.Query = strings.TrimSpace(args[1])
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runInvoke(c.Context(), opts, jopts, cli)
|
|
},
|
|
}
|
|
cmd.Flags().StringVar(&opts.SessionID, "session", "", "Continue an existing chat session (skip auto-create)")
|
|
cmd.Flags().BoolVar(&opts.NoStream, "no-stream", false, "Buffer the full answer before printing (forces accumulate mode)")
|
|
cmdutil.AddJSONFlags(cmd, agentInvokeFields)
|
|
aiclient.SetAgentHelp(cmd, "Streams an agent's answer over SSE. Pass --json (or run non-TTY) to receive a single completed {answer, references, tool_events, …} JSON object instead of partial chunks. Errors: resource.not_found (unknown agent_id) / server.session_create_failed (auto-create) / local.sse_stream_aborted (mid-stream).")
|
|
return cmd
|
|
}
|
|
|
|
func runInvoke(ctx context.Context, opts *InvokeOptions, jopts *cmdutil.JSONOptions, svc InvokeService) error {
|
|
if opts.Query == "" {
|
|
return cmdutil.NewError(cmdutil.CodeInputInvalidArgument, "query argument cannot be empty")
|
|
}
|
|
if opts.AgentID == "" {
|
|
return cmdutil.NewError(cmdutil.CodeInputInvalidArgument, "agent-id argument cannot be empty")
|
|
}
|
|
if svc == nil {
|
|
return cmdutil.NewError(cmdutil.CodeServerError, "agent invoke: no SDK client available")
|
|
}
|
|
|
|
jsonOut := jopts.Enabled()
|
|
|
|
sessionID := opts.SessionID
|
|
autoCreated := false
|
|
if sessionID == "" {
|
|
sess, err := svc.CreateSession(ctx, &sdk.CreateSessionRequest{Title: "weknora agent invoke"})
|
|
if err != nil {
|
|
code := cmdutil.ClassifyHTTPError(err)
|
|
if code == cmdutil.CodeNetworkError || code == cmdutil.CodeServerError {
|
|
code = cmdutil.CodeSessionCreateFailed
|
|
}
|
|
return cmdutil.Wrapf(code, err, "create chat session")
|
|
}
|
|
sessionID = sess.ID
|
|
autoCreated = true
|
|
}
|
|
|
|
// Streaming requires interactive stdout + no --no-stream + no --json.
|
|
// Matches chat.go's mode-selection contract so users get the same
|
|
// muscle memory across both commands.
|
|
streamMode := iostreams.IO.IsStdoutTTY() && !opts.NoStream && !jsonOut
|
|
|
|
// Surface auto-created session id up-front so a ^C mid-stream still
|
|
// leaves a recoverable pointer.
|
|
if autoCreated && !jsonOut {
|
|
fmt.Fprintf(iostreams.IO.Err, "session: %s (use --session to continue)\n", sessionID)
|
|
}
|
|
|
|
req := &sdk.AgentQARequest{
|
|
Query: opts.Query,
|
|
AgentEnabled: true,
|
|
AgentID: opts.AgentID,
|
|
Channel: "api",
|
|
}
|
|
|
|
acc := &sse.AgentAccumulator{}
|
|
cb := func(r *sdk.AgentStreamResponse) error {
|
|
if streamMode && r != nil && r.ResponseType == sdk.AgentResponseTypeAnswer && r.Content != "" {
|
|
_, _ = iostreams.IO.Out.Write([]byte(r.Content))
|
|
}
|
|
acc.Append(r)
|
|
return nil
|
|
}
|
|
|
|
streamErr := svc.AgentQAStreamWithRequest(ctx, sessionID, req, cb)
|
|
if streamErr != nil {
|
|
if autoCreated && !jsonOut {
|
|
fmt.Fprintf(iostreams.IO.Err, "session: %s (resume with --session %s)\n", sessionID, sessionID)
|
|
}
|
|
if errors.Is(streamErr, context.Canceled) || errors.Is(ctx.Err(), context.Canceled) {
|
|
return cmdutil.Wrapf(cmdutil.CodeUserAborted, streamErr, "agent invoke cancelled")
|
|
}
|
|
if acc.Answer() != "" && !acc.Done() {
|
|
return cmdutil.Wrapf(cmdutil.CodeSSEStreamAborted, streamErr, "stream aborted before completion")
|
|
}
|
|
return cmdutil.WrapHTTP(streamErr, "agent-chat stream")
|
|
}
|
|
|
|
// Server closed cleanly but never sent a Done event — treat as aborted
|
|
// so agents don't silently emit a truncated answer as ok=true.
|
|
if !acc.Done() {
|
|
return cmdutil.NewError(cmdutil.CodeSSEStreamAborted, "stream ended without a terminal event")
|
|
}
|
|
|
|
answer := acc.Answer()
|
|
if jsonOut {
|
|
data := invokeData{
|
|
Answer: answer,
|
|
References: acc.References,
|
|
ToolEvents: acc.ToolEvents,
|
|
Thinking: acc.Thinking(),
|
|
SessionID: sessionID,
|
|
AgentID: opts.AgentID,
|
|
Query: opts.Query,
|
|
}
|
|
return jopts.Emit(iostreams.IO.Out, data)
|
|
}
|
|
|
|
out := iostreams.IO.Out
|
|
if streamMode {
|
|
if !strings.HasSuffix(answer, "\n") {
|
|
fmt.Fprintln(out)
|
|
}
|
|
} else {
|
|
fmt.Fprint(out, answer)
|
|
if !strings.HasSuffix(answer, "\n") {
|
|
fmt.Fprintln(out)
|
|
}
|
|
}
|
|
renderToolTrace(out, acc.ToolEvents)
|
|
format.WriteReferences(out, acc.References)
|
|
return nil
|
|
}
|
|
|
|
// renderToolTrace prints a compact tool-event footer in human mode.
|
|
// Skipped when the agent emitted no tool events — silent beats an empty
|
|
// banner.
|
|
func renderToolTrace(w io.Writer, events []sse.AgentToolEvent) {
|
|
if len(events) == 0 {
|
|
return
|
|
}
|
|
fmt.Fprintln(w)
|
|
fmt.Fprintln(w, "──── Tool trace ────")
|
|
for i, e := range events {
|
|
fmt.Fprintf(w, "[%d] %s", i+1, e.Kind)
|
|
if e.Result != "" {
|
|
fmt.Fprintf(w, " %s", truncateInline(e.Result, 80))
|
|
}
|
|
fmt.Fprintln(w)
|
|
}
|
|
}
|
|
|
|
// truncateInline shrinks a multi-line result to a single line + ellipsis
|
|
// for the human tool-trace footer.
|
|
func truncateInline(s string, maxLen int) string {
|
|
s = strings.ReplaceAll(s, "\n", " ")
|
|
if len(s) <= maxLen {
|
|
return s
|
|
}
|
|
return s[:maxLen-1] + "…"
|
|
}
|
|
|
|
// compile-time check: production SDK client satisfies InvokeService.
|
|
var _ InvokeService = (*sdk.Client)(nil)
|