Content-Length: 310203 | pFad | http://github.com/coderabbitai/coderabbit-docs/pull/390

6B 📝 add Azure text-embedding-3-large deployment configuration by bar0meter · Pull Request #390 · coderabbitai/coderabbit-docs · GitHub
Skip to content

📝 add Azure text-embedding-3-large deployment configuration #390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 9, 2025

Conversation

bar0meter
Copy link
Contributor

Add AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME environment variable
to all self-hosted platform documentation and update deployment
recommendations to include text-embedding-3-large model

Add AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME environment variable
to all self-hosted platform documentation and update deployment
recommendations to include text-embedding-3-large model
Copy link
Contributor

coderabbitai bot commented Jun 9, 2025

Walkthrough

The documentation for self-hosted setups across Azure DevOps, Bitbucket, GitHub, and GitLab was updated to recommend deploying the text-embedding-3-large Azure OpenAI model. Each guide now includes a new environment variable, AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME, in the .env configuration examples.

Changes

File(s) Change Summary
docs/self-hosted/azure-devops.md Added text-embedding-3-large to recommended deployments and introduced related environment variable.
docs/self-hosted/bitbucket.md Updated recommended deployments to include text-embedding-3-large and added corresponding env var.
docs/self-hosted/github.md Included text-embedding-3-large in deployment recommendations and added new env variable.
docs/self-hosted/gitlab.md Expanded recommended deployments with text-embedding-3-large and introduced new env variable.

Poem

In docs we hop, from cloud to cloud,
A new model joins, we’re extra proud!
text-embedding-3-large now takes its place,
With env vars set, you’re off to the race.
🐇✨ Configs grow tall,
For every self-hosted hall!

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch updated-list-azure-openai-deployments
  • Post Copyable Unit Tests in Comment

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@bar0meter bar0meter enabled auto-merge (squash) June 9, 2025 06:29
@bar0meter bar0meter requested a review from hasit June 9, 2025 06:30
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

♻️ Duplicate comments (3)
docs/self-hosted/github.md (1)

70-71: Duplicate: clarify optional placeholder formatting.
Same recommendation as in gitlab.md—wrap the placeholder in [] to mark it optional per this document’s convention.

docs/self-hosted/azure-devops.md (1)

67-68: Duplicate: clarify optional placeholder formatting.
As above, align with the optional-value convention by wrapping the new placeholder in []:

- AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=<text-embedding-3-large-deployment-name>
+ AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=[<text-embedding-3-large-deployment-name>]
docs/self-hosted/bitbucket.md (1)

59-60: Duplicate: clarify optional placeholder formatting.
Mirror the fix from gitlab.md to indicate this deployment is optional:

- AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=<text-embedding-3-large-deployment-name>
+ AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=[<text-embedding-3-large-deployment-name>]
🧹 Nitpick comments (1)
docs/self-hosted/gitlab.md (1)

65-66: Clarify optional placeholder formatting for the new env var.
The comment flags text-embedding-3-large as optional, but the placeholder isn’t wrapped in [] (our convention for optional values). To avoid confusion, consider:

- AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=<text-embedding-3-large-deployment-name>
+ AZURE_TEXT_EMBEDDING_3_LARGE_DEPLOYMENT_NAME=[<text-embedding-3-large-deployment-name>]
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fb9c056 and 8aa5b01.

📒 Files selected for processing (4)
  • docs/self-hosted/azure-devops.md (1 hunks)
  • docs/self-hosted/bitbucket.md (1 hunks)
  • docs/self-hosted/github.md (1 hunks)
  • docs/self-hosted/gitlab.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test

Copy link

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8aa5b01
Status: ✅  Deploy successful!
Preview URL: https://e101b1c9.coderabbit-docs.pages.dev
Branch Preview URL: https://updated-list-azure-openai-de.coderabbit-docs.pages.dev

View logs

@bar0meter bar0meter merged commit 33d5fd3 into main Jun 9, 2025
4 checks passed
@bar0meter bar0meter deleted the updated-list-azure-openai-deployments branch June 9, 2025 06:31
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.

3 participants








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/coderabbitai/coderabbit-docs/pull/390

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy