jaz-clio 5.13.2 → 5.13.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -0
- package/assets/skills/api/SKILL.md +1 -1
- package/assets/skills/api/help-center-mirror/help-center-embeddings.json +1 -1
- package/assets/skills/api/help-center-mirror/help-center-index.json +1 -1
- package/assets/skills/api/help-center-mirror/index.md +1 -1
- package/assets/skills/cli/SKILL.md +1 -1
- package/assets/skills/conversion/SKILL.md +1 -1
- package/assets/skills/jaz-pseudo-sql/SKILL.md +1 -1
- package/assets/skills/jobs/SKILL.md +1 -1
- package/assets/skills/practice/SKILL.md +1 -1
- package/assets/skills/transaction-recipes/SKILL.md +1 -1
- package/cli.mjs +451 -450
- package/help-center-mirror/help-center-embeddings.json +1 -1
- package/help-center-mirror/help-center-index.json +1 -1
- package/help-center-mirror/index.md +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,6 +22,7 @@ Requires **Node.js 18+** ([nodejs.org](https://nodejs.org)). Also fully compatib
|
|
|
22
22
|
- [MCP Server](#mcp-server) — 301 tools for AI agents
|
|
23
23
|
- [Skills](#skills) — Teach any AI the Jaz API
|
|
24
24
|
- [Setup](#setup) — Auth, multi-org, automation
|
|
25
|
+
- [Semantic help-center search](#help-center-semantic-search-optional) — Optional OpenAI-backed retrieval
|
|
25
26
|
|
|
26
27
|
## Three Ways In
|
|
27
28
|
|
|
@@ -106,6 +107,16 @@ clio auth whoami # Verify
|
|
|
106
107
|
|
|
107
108
|
**Automation:** Every CLI command supports `--json` for structured output. Set `JAZ_API_KEY` as an env var for scripts and CI pipelines.
|
|
108
109
|
|
|
110
|
+
## Help-center semantic search (optional)
|
|
111
|
+
|
|
112
|
+
`search_help_center` ships with built-in BM25 lexical search over the bundled help-center corpus and a precomputed embedding index. Set `CLIO_HELP_CENTER_OPENAI_API_KEY` to enable hybrid retrieval (semantic + BM25 via RRF) — strict opt-in, no fallback to other OpenAI env vars.
|
|
113
|
+
|
|
114
|
+
When set, the CLI sends embedding requests for **only the user's query** to `https://api.openai.com/v1/embeddings` and nowhere else. The precomputed article vectors are locked to `text-embedding-3-small`; keys for other embedding models will be silently unused since cosine similarity requires the same model on both sides.
|
|
115
|
+
|
|
116
|
+
Recommended posture: create a project-scoped OpenAI key restricted to embedding models with a low monthly cap. On auth failure (401/403) the CLI prints a single warning to stderr and falls back to BM25 — subsequent failures stay silent.
|
|
117
|
+
|
|
118
|
+
**CLI-only.** The MCPB bundle ships without the embedding index (~2.6 MB skipped for bundle weight), so `CLIO_HELP_CENTER_OPENAI_API_KEY` has no effect for MCPB installs — those continue to use BM25 only regardless of whether the env var is set.
|
|
119
|
+
|
|
109
120
|
## Privacy
|
|
110
121
|
|
|
111
122
|
Runs on your machine. Calls go to the Jaz API over HTTPS. No telemetry. No data collection.
|