Skip to content

docs: add MockTextEmbedder and MockDocumentEmbedder pages - #11876

Merged
julian-risch merged 4 commits into
mainfrom
docs/v3-simple-doc-updates-4
Jul 8, 2026
Merged

docs: add MockTextEmbedder and MockDocumentEmbedder pages#11876
julian-risch merged 4 commits into
mainfrom
docs/v3-simple-doc-updates-4

Conversation

@julian-risch

@julian-risch julian-risch commented Jul 5, 2026

Copy link
Copy Markdown
Member

Related Issues

Proposed Changes:

Adds two new component pages:

  • MockTextEmbedder covers the three embedding modes (deterministic hash-based default, fixed embedding, embedding_fn), the dimension / model / meta / prefix / suffix parameters, and a full no-API-key retrieval pipeline example with InMemoryEmbeddingRetriever.
  • MockDocumentEmbedder has the same structure, plus the Document-Embedder-specific meta_fields_to_embed / embedding_separator / progress_bar parameters and an indexing pipeline example with DocumentWriter.

How did you test it?

  • All four code examples were executed against the v3 code

Notes for the reviewer

Draft PR targeting v3. Do not merge before v3 is on main.

Checklist

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Jul 8, 2026 3:45pm

Request Review

Clarified descriptions of embedding options and their behavior. Improved explanations regarding deterministic embeddings and their implications for retrieval.
Clarified descriptions of embedding options and their behaviors.
@sjrl
sjrl changed the base branch from v3 to main July 8, 2026 13:21
@julian-risch
julian-risch marked this pull request as ready for review July 8, 2026 15:42
@julian-risch
julian-risch requested a review from a team as a code owner July 8, 2026 15:43
@julian-risch
julian-risch requested review from anakin87 and removed request for a team July 8, 2026 15:43
@claude

claude Bot commented Jul 8, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

1 similar comment
@claude

claude Bot commented Jul 8, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@anakin87 anakin87 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good

@julian-risch
julian-risch merged commit 8296211 into main Jul 8, 2026
24 checks passed
@julian-risch
julian-risch deleted the docs/v3-simple-doc-updates-4 branch July 8, 2026 16:21
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.

2 participants