Skip to content

hotfix(embeddings): name the 3-series models, drop unneeded auth, dec… - #42

Merged
tristantelleb merged 4 commits into
mainfrom
hotfix/embeddings
May 22, 2026
Merged

hotfix(embeddings): name the 3-series models, drop unneeded auth, dec…#42
tristantelleb merged 4 commits into
mainfrom
hotfix/embeddings

Conversation

@tristantelleb

@tristantelleb tristantelleb commented May 5, 2026

Copy link
Copy Markdown
Member
  • 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.

Summary by CodeRabbit

  • Documentation

    • Updated embeddings API documentation with corrected code examples for model listing endpoint calls
    • Clarified dimensions field documentation with model-specific support details
  • Chores

    • Added numpy to test dependencies

…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.
@mintlify

mintlify Bot commented May 5, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
edenai 🟢 Ready View Preview May 5, 2026, 12:53 PM

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

@coderabbitai

coderabbitai Bot commented May 5, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@tristantelleb has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 58 minutes and 16 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: bf144f2a-c6a9-4389-8644-cd70c91b93f6

📥 Commits

Reviewing files that changed from the base of the PR and between 97970c0 and ef80291.

📒 Files selected for processing (1)
  • v3/llms/embeddings.mdx

Walkthrough

This PR adds numpy to test dependencies and updates the embeddings API documentation to remove authorization headers from model-listing requests while clarifying that dimension truncation support is model-dependent.

Changes

Test Dependencies

Layer / File(s) Summary
Dependency Addition
tests/requirements.txt
Adds numpy to the test dependencies list.

Embeddings API Documentation

Layer / File(s) Summary
API Examples
v3/llms/embeddings.mdx
Removes Authorization: Bearer header from GET /v3/embeddings/models requests in Python and cURL examples (List available models, Create embeddings runtime lookup, Semantic search initialization).
Field Documentation
v3/llms/embeddings.mdx
Updates dimensions field description to clarify truncation support is model-dependent and adds text-embedding-3-small/large examples; aligns "Choosing a model" bullet text accordingly.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

Possibly related PRs

  • edenai/docs#37: Both PRs modify v3/llms/embeddings.mdx; this PR refines existing API examples and documentation while that PR may be adding foundational content.

Poem

🐰 A hop through the docs, a header we shed,
Where models now list without auth, clearly read,
Dimensions speak truth of what each can do—
numpy joins tests, and the whole thing feels new! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title addresses the main changes: naming 3-series models explicitly, removing unneeded auth headers, and adding a dependency (numpy). It accurately summarizes the primary objectives of the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch hotfix/embeddings

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 85a2a09 and 97970c0.

📒 Files selected for processing (2)
  • tests/requirements.txt
  • v3/llms/embeddings.mdx

Comment thread v3/llms/embeddings.mdx Outdated
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>
@tristantelleb
tristantelleb merged commit 7a04b73 into main May 22, 2026
6 of 8 checks passed
@tristantelleb
tristantelleb deleted the hotfix/embeddings branch June 8, 2026 07:52
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.

1 participant