Skip to content
cccskills
FreePublished on GitHub

weknora-rag-search

Choose the right WeKnora command to answer questions from a knowledge base or retrieve source passages. Covers cited answers, custom agents, document searches, and continuing a conversation through the command-line tool.

OriginalShow the original description

Use when retrieving from or asking questions against a WeKnora knowledge base via the `weknora` CLI — and especially when unsure whether to use `chat`, `session ask`, or `search chunks` for a given goal.

See how to install

Good for

  • Ask questions with citations from a knowledge base
  • Retrieve source passages for further analysis
  • Find documents by title or filename
  • Continue a previous knowledge-base conversation

Files included (3)

  • SKILL.md4.0 KB
  • references/chat.md2.6 KB
  • references/search-chunks.md1.9 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

WeKnora — retrieval & RAG queries

REQUIRED BACKGROUND: read the weknora-shared skill first (auth, --kb resolution, the JSON envelope, exit codes, streaming/NDJSON output).

WeKnora gives you several ways to "ask about a knowledge base." Picking the wrong one wastes turns or returns the wrong shape. Use the decision table.

Pick the command by your goal

Your goalCommandLLM synthesis?Returns
Natural-language answer grounded in a KBchat "<q>" --kb <kb>yesbounded answer events; --reference adds citations; --verbose adds execution detail
Answer via a custom agent (its own KB scope, tools, web search)session ask --agent <id> "<q>"yes (+ tools)bounded answer events; --reference adds citations; --verbose adds execution detail
Raw context chunks to reason over yourself (no answer)search chunks "<q>" --kb <kb>noranked chunk list
Which documents match a keyword (title/filename)search docs "<q>" --kb <kb>nodocument list
Find a knowledge base by namesearch kb "<q>"noKB list
Find a past session by titlesearch sessions "<q>"nosession list

The three decisions that matter

  1. Answer vs raw context. Want a written answer → chat / session ask. Want chunks to feed into your own reasoning (e.g. you'll synthesize across sources) → search chunks. Don't call chat just to read source text.
  2. chat vs session ask. chat = plain KB RAG Q&A. session ask --agent <id> = invoke a configured custom agent (it may scope its own KBs, call tools, do web search). If the user set up an agent for this, prefer it (weknora agent list to find ids); otherwise chat.
  3. One-shot vs multi-turn. Both chat and session ask return a data.session_id in default JSON output. Pass --session <id> on the next call to continue the conversation. In NDJSON mode, read it from init.

Safety / Gotchas

  • chat, search chunks, search docs need a KB: pass --kb <id-or-name>, or set WEKNORA_KB_ID, or weknora link the directory (resolved in that order). If none resolves it's exit 1 (local.kb_id_required); a bad name is exit 1 (local.kb_not_found). Resolve names with weknora kb list / search kb. (search kb / search sessions are tenant-wide and take no --kb.)
  • chat / session ask return one buffered JSON envelope with answer events by default. Add --reference for indexed citations and --verbose for execution detail; use --format ndjson for raw events or --format text for the live human-readable projection.
  • A stalled stream is not stopped by Ctrl-C (that just drops your local connection; the server keeps generating + billing). Stop it server-side: weknora session stop <session-id> --message <message-id> (session_id from data.session_id, or from init under --format ndjson). Re-attach to a stream with weknora session resume <session-id> --message <message-id>.
  • search chunks --limit defaults to 8 (tuned for an LLM context window); the search docs/kb/sessions lists default to 30. Tune retrieval with --vector-threshold / --keyword-threshold, or --no-vector/--no-keyword to disable a channel. Details: references/search-chunks.md.

Quick examples

# raw retrieval to reason over
weknora search chunks "retry backoff policy" --kb engineering --limit 12

# grounded answer (human transcript)
weknora chat "How do we handle retries?" --kb engineering --format text

# continue the conversation (session id from data.session_id above)
weknora chat "And the max attempts?" --kb engineering --session sess_abc

# answer via a custom agent
weknora session ask --agent ag_123 "Summarize this quarter's incidents"

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

pdf-processing

FreeSummary

Extract text and tables from PDFs, fill form fields with supplied data, and merge documents. Includes a pdfplumber text extraction example and scripts for inspecting form fields and extracting text.

  • Extracting text from PDF pages
  • Retrieving tables from PDF documents
  • Filling PDF forms with supplied data
Tencent/WeKnora35KUpdated Oct 21, 2026

weknora-shared

FreeSummary

Use the weknora CLI to manage knowledge bases and documents, search stored material, and ask questions grounded in it. This shared guide covers authentication, structured JSON results, error handling, and previews of changes.

  • Setting up authentication for a WeKnora server
  • Managing knowledge bases and uploaded documents
  • Searching stored material and asking questions about it
Tencent/WeKnora35KUpdated Oct 21, 2026

See all skills by Tencent

Report a problem with this skill