Repository navigation
Document OpenAI embedding task prefixes for v5.4 - #748
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to support the new configurable embedding task prefixes feature introduced in v5.4.0. This feature allows OpenAI embedding entries to prepend specific task instructions (such as Nomic retrieval prefixes) when an inputType is provided. The updates span the API reference, backend configuration, local development guidelines, overview, and release notes. The review feedback recommends standardizing the inline version references across the documentation to use the format (v5.4.0) for consistency.
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-748 This preview will update automatically when you push new commits. |
bcd685e to
cff0028
Compare
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-748 This preview will update automatically when you push new commits. |
cff0028 to
9e06a33
Compare
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-748 This preview will update automatically when you push new commits. |
Companion to HarperFast/harper#3450. Dispatch-Task: harper-openai-embed-inputtype-prefixes Co-Authored-By: GPT-5 Codex <noreply@openai.com>
Address the authorized documentation review findings without another review round. Dispatch-Task: harper-openai-embed-inputtype-prefixes Dispatch-Task: pr-maint-1833edca00ecdcd301860825953253c6 Co-Authored-By: GPT-5 Codex <noreply@openai.com> Co-Authored-By: Gemini <noreply@google.com>
9e06a33 to
248a683
Compare
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-748 This preview will update automatically when you push new commits. |
🧹 Preview CleanupThe preview deployment for this PR has been removed. |
📝 Summary
Document the opt-in OpenAI embedding
inputPrefixesadded by harper#3450, with the v5.4 version badge CONTRIBUTING.md requires. The reference gives the exact Nomic v1/v1.5 document and query prefixes, with their trailing spaces. It explains where prefixes stop:inputType, the gateway and stored vectors.The backend example and migration guidance cover empty or absent values, live reload and avoiding double-prefixing. Related API, environment-variable and local-development guidance now agree with the new option, and the v5.4 release notes link to it.
🔧 Changes
The backend reference defines exact input bytes and the configuration table links to it. The API reference adds the document batch inputType and configuration prerequisite. The overview explains unresolved prefix variables. The local-development guide covers Nomic prefix parity across backends. The v5.4 release note announces the option.
✅ Verification
npm run format:writeandnpm run format:checkpassed across the full docs worktree.npm run buildpassed; built HTML preserves the v5.4 badge, both quoted trailing spaces and the gateway guidance.32fcded2c6f2ecc8ad627493ac212124f18f2a9f: 127 focused regression/migration checks and 3 checks using the actual formatted documentation YAML passed. The gateway omitsinputType; reload does not re-embed stored documents, while rewriting the same source sends the changed prefix.Review notes
The rebase onto
mainat4aea8b1fffc5integrates the mergedtruncatedocumentation (#771) inreference/models/api.md,reference/models/backends.md, andrelease-notes/v5-lincoln/5.4.mdwhile preserving the existinginputPrefixesdocumentation wording. Review still flags the API phrase "require configured" as potentially implying validation; the backend section explicitly says calls without prefixes succeed unchanged.Depends-on: HarperFast/harper#3450
🤖 Generated by OpenAI Codex; posted via @kriszyp.
Release target: v5.4 — companion guidance for the new core configuration.
Related PRs: #771 overlaps
Complexity: easy
Deferred findings
bcb5eda4de862d8bnit documentation —reference/models/backends.md— Gateway exception lacks a documented gateway surface — NOT FILED5ece319d8865291anit documentation —reference/models/backends.md— Ollama blurb says 'nomic-embed-text' exact while line 144 says substring match — NOT FILEDReview-Coverage: authored=gemini; ran=claude,cursor-composer; adjudicated=domain; blocked=muse(failed); declined=cursor-grok; rounds=4; full=1 @ 248a683
Review-Attention: skim ~2m (decisions: inputprefixes-openai-only, reembed-by-rewriting-source) @ 248a683