Skip to content

DX-3073: update Vector embedding model docs to match the console - #878

Merged
CahidArda merged 4 commits into
mainfrom
DX-3073-vector-embedding-models
Sep 29, 2026
Merged

CahidArda merged 4 commits into
mainfrom
DX-3073-vector-embedding-models

Conversation

@CahidArda

Copy link
Copy Markdown
Contributor

Fixes #766.

Since DX-2310 (upstash-console-v2#1011, Dec 2025) the console's create-index wizard hides the BGE models. It now offers only openai/text-embedding-3-small for dense/hybrid indexes and BM25 for sparse/hybrid indexes. The docs still listed the BGE models and never mentioned text-embedding-3-small.

Changes

  • vector/features/embeddingmodels.mdx: the dense table now lists openai/text-embedding-3-small (1536 dims, 8191 tokens, MTEB 62.3) and the sparse table lists only BM25. Added a note that the BGE models are no longer available for new indexes. Removed the video guide, since it walks through the BGE models.
  • vector/features/sparseindexes.mdx: removed the "BGE-M3 Sparse Vectors" section, and the intro example now uses text-embedding-3-small.
  • vector/api/endpoints/info.mdx: the example response uses TEXT_EMBEDDING_3_SMALL / 1536.
  • img/vector/create_index_with_model.png: retook the screenshot from the current console, showing openai/text-embedding-3-small.

To confirm

  • Do existing BGE indexes keep embedding text? The new note only says the models are unavailable "for new indexes" and makes no claim about existing indexes.

https://claude.ai/code/session_01Vxm3XqQhCauGVEoLZxxNVM

The console only offers openai/text-embedding-3-small (dense) and BM25
(sparse) since DX-2310. Drop the BGE models from the model tables, the
BGE-M3 sparse section and the info example, and retake the create-index
screenshot.

Closes #766

Claude-Session: https://claude.ai/code/session_01Vxm3XqQhCauGVEoLZxxNVM
@mintlify

mintlify Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
upstash 🟢 Ready View Preview Sep 28, 2026, 1:45 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@context7

context7 Bot commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

Docs7 for upstash.com

Result Status Action
Deployment ✅ Ready Open preview
Content review ✅ Passed. No problems found. View findings

Commit c0fb62f · Updated 2026-09-28 13:51 UTC · View build details

@linear-code

linear-code Bot commented Sep 28, 2026

Copy link
Copy Markdown

DX-3073

@CahidArda
CahidArda requested a lite review from Copilot September 28, 2026 12:52
@context7
context7 Bot temporarily deployed to Docs7 Preview: DX-3073-vector-embedding-models September 28, 2026 12:54 Destroyed
Copilot stopped reviewing on behalf of CahidArda due to an error September 28, 2026 13:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

Copilot was unable to run its full agentic suite in this review.

Copilot review overview

Review effort: Lite
Findings: 3 Medium severity · 1 Low severity

Open (4)
What changed in this PR

Updates the Vector documentation/examples to reflect the currently hosted embedding options (OpenAI text-embedding-3-small for dense/hybrid and BM25 for sparse), removing older BGE-related references.

Changes:

  • Replace BGE-M3 references with text-embedding-3-small (1536 dims) in docs and API examples.
  • Remove BGE model listings/sections and add guidance that BGE models aren’t available for new indexes.
  • Update BM25 wording and mirror the doc updates into llms-full.txt.
File Description
vector/​features/​sparseindexes.mdx Updates sparse index docs to reference BM25 and uses text-embedding-3-small in the dense-vs-sparse example.
vector/​features/​embeddingmodels.mdx Updates hosted model lists, removes BGE options, and adds a note about deprecation for new indexes.
vector/​api/​endpoints/​info.mdx Updates the /info example response to reflect the new dense embedding model and dimension.
llms-full.txt Mirrors the same doc/example updates into the consolidated text artifact.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread vector/features/embeddingmodels.mdx
Comment thread vector/features/embeddingmodels.mdx
Comment thread vector/features/sparseindexes.mdx Outdated
Comment thread vector/features/embeddingmodels.mdx
@context7
context7 Bot temporarily deployed to Docs7 Preview: DX-3073-vector-embedding-models September 28, 2026 13:51 Destroyed
@CahidArda
CahidArda merged commit 8bcafe4 into main Sep 29, 2026
3 of 4 checks passed
@CahidArda
CahidArda deleted the DX-3073-vector-embedding-models branch September 29, 2026 14:36

This branch was successfully deployed

1 active deployment
Docs7 Preview: DX-3073-vector-embedding-models — c0fb62f0 Deployed Sep 28, 2026 by context7[bot]
staging — c0fb62f0 Deployed Sep 28, 2026 by mintlify[bot]
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.

Issue on docs

2 participants