Skip to content

docs: document <prepend> config for OpenAI embedder#4675

Merged
bjorncs merged 1 commit intomasterfrom
bjorncs/openai-embedder-prepend-docs
Apr 28, 2026
Merged

docs: document <prepend> config for OpenAI embedder#4675
bjorncs merged 1 commit intomasterfrom
bjorncs/openai-embedder-prepend-docs

Conversation

@bjorncs
Copy link
Copy Markdown
Member

@bjorncs bjorncs commented Apr 28, 2026

Summary

  • Documents the new <prepend> element for the OpenAI embedder in en/reference/rag/embedding.html (reference table row with example).
  • Adds a cross-reference from the "Adding a fixed string to a query text" section in en/rag/embedding.html so users searching for prepend find that it also works for the OpenAI embedder.
  • Pairs with the implementation PR: feat: add <prepend> config to OpenAI embedder vespa#36580.

Adds reference documentation for the new <prepend> element on the
OpenAI embedder, and a cross-reference from the embedding guide's
"Adding a fixed string to a query text" section so users searching
for prepend find that it works for OpenAI-compatible models too.
@bjorncs bjorncs force-pushed the bjorncs/openai-embedder-prepend-docs branch from 12d0e55 to ab36064 Compare April 28, 2026 11:24
@bjorncs bjorncs requested a review from Copilot April 28, 2026 11:32
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Documents the new <prepend> configuration element for the OpenAI embedder and cross-links it from the general “Adding a fixed string to a query text” section so users discover that the same mechanism applies to OpenAI-compatible embedding backends.

Changes:

  • Adds a new prepend row (with example) to the OpenAI embedder reference config table.
  • Adds a cross-reference note in the general embedding guide pointing to the OpenAI embedder documentation.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
en/reference/rag/embedding.html Adds OpenAI embedder reference-table documentation for <prepend> including <query>/<document> and an XML example.
en/rag/embedding.html Adds a short paragraph cross-referencing that <prepend> is supported by the OpenAI embedder.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bjorncs bjorncs merged commit 8f29a41 into master Apr 28, 2026
4 checks passed
@bjorncs bjorncs deleted the bjorncs/openai-embedder-prepend-docs branch April 28, 2026 12:12
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.

4 participants