Skip to content

docs(guides): BYOK embeddings setup guide - #196

Open
EthanThatOneKid wants to merge 5 commits into
mainfrom
byok-embeddings-guide
Open

EthanThatOneKid wants to merge 5 commits into
mainfrom
byok-embeddings-guide

Conversation

@EthanThatOneKid

@EthanThatOneKid EthanThatOneKid commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Adds guides/byok-embeddings.mdx (nav entry included), written against the live API: Platform API /v1/users/me/embedding-providers (wazoo-api#125, on prod) and the worlds-api data plane (#142, #145, on prod). Updates worlds/search.mdx and console/reindex.mdx, which said the hosted beta has no embedding provider.

Verified: QA round-trip with OpenRouter text-embedding-3-small through the Platform API routes (store, reindex, hybrid after 63 s, semantic paraphrase, isolation, revoke). Prod routes respond 401 without a token; no key has been stored on prod.

Not verified: OpenAI models and OpenRouter -large have not been round-tripped; world-token (wzw_) use of PATCH/reindex was read from code, not exercised. pnpm run precommit passes.

🤖 Generated with Claude Code

EthanThatOneKid and others added 3 commits October 19, 2026 15:43
…sed API

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
… the API ships

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@EthanThatOneKid

Copy link
Copy Markdown
Contributor Author

Review fixes: search modes (hybrid/semantic/keyword/fallback), token scopes named (data:write for model change and reindex, data:read for search), query limit and large-model dimensions noted, OpenAI no longer called recommended (no OpenAI round-trip has run yet; only OpenRouter -small is proven live), nav entry removed so merging does not publish the page. When wazoo-api#123 ships, re-add guides/byok-embeddings to docs.json, drop the Warning, and correct worlds/search.mdx and console/reindex.mdx.

🤖 Generated with Claude Code

…index pages

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@EthanThatOneKid EthanThatOneKid changed the title docs(guides): BYOK embeddings setup guide (draft, blocked on wazoo-api#123) docs(guides): BYOK embeddings setup guide Oct 20, 2026
@EthanThatOneKid
EthanThatOneKid marked this pull request as ready for review October 20, 2026 21:02

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant