hotfix(embeddings): name the 3-series models, drop unneeded auth, dec… - #42
Conversation
…lare numpy - v3/llms/embeddings.mdx: replace "3-series" in the `dimensions` row and Choosing-a-model section with the explicit model ids `text-embedding-3-small` / `text-embedding-3-large`. The shorthand assumed OpenAI naming knowledge. - v3/llms/embeddings.mdx: remove `Authorization: Bearer` from the `GET /v3/embeddings/models` calls (Python + cURL list snippets and the worked-example lookup). Endpoint is public — confirmed returns 200 without auth — so showing the header was misleading. - tests/requirements.txt: add `numpy`. The semantic-search snippet imports numpy; it was only resolving via chromadb/langchain transitives, which would silently break the snippet test if those deps drop numpy.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThis PR adds ChangesTest Dependencies
Embeddings API Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~8 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@v3/llms/embeddings.mdx`:
- Line 154: Update the two places that list the embedding model IDs so they
include the provider prefix: replace `text-embedding-3-small` and
`text-embedding-3-large` with `openai/text-embedding-3-small` and
`openai/text-embedding-3-large` in the `dimensions` table row (the `dimensions`
entry) and in the "Dimensions" bullet point; ensure the examples match the
document's provider/model format and the API's returned model IDs.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 895dacc6-ac2f-418c-a94f-2380d7ae5490
📒 Files selected for processing (2)
tests/requirements.txtv3/llms/embeddings.mdx
Match the canonical model-string format used elsewhere in the docs (openai/text-embedding-3-small) instead of the prose "OpenAI's text-embedding-3-small" phrasing. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
dimensionsrow and Choosing-a-model section with the explicit model idstext-embedding-3-small/text-embedding-3-large. The shorthand assumed OpenAI naming knowledge.Authorization: Bearerfrom theGET /v3/embeddings/modelscalls (Python + cURL list snippets and the worked-example lookup). Endpoint is public confirmed returns 200 without auth so showing the header was misleading.numpy. The semantic-search snippet imports numpy; it was only resolving via chromadb/langchain transitives, which would silently break the snippet test if those deps drop numpy.Summary by CodeRabbit
Documentation
Chores