Skip to content

Update Azure OpenAI integration docs with new model deployment names #292

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

Closed
wants to merge 4 commits into from

Conversation

hasit
Copy link
Contributor

@hasit hasit commented Apr 21, 2025

No description provided.

@hasit hasit self-assigned this Apr 21, 2025
Copy link
Contributor

coderabbitai bot commented Apr 21, 2025

Walkthrough

The documentation for self-hosted integrations with Azure OpenAI across Azure DevOps, Bitbucket, GitHub, and GitLab was updated. The recommended deployment names and corresponding environment variable names in the .env configuration sections were revised to reflect newer Azure OpenAI models, replacing previous references to gpt-4o-mini, o3-mini, and o1 with gpt-4.1-mini, o4-mini, o3, and optionally gpt-4.1. Optional alternative deployments and their environment variables were also introduced or updated for flexibility. No changes were made to code or exported entities.

Changes

Files Change Summary
docs/self-hosted/azure-devops.md
docs/self-hosted/bitbucket.md
docs/self-hosted/github.md
docs/self-hosted/gitlab.md
Updated recommended Azure OpenAI deployment names and related environment variable names in .env configuration documentation. Added or revised optional alternative deployment variables. No changes to code or exported/public entities.

Possibly related PRs

  • self-hosted: support o1 model #203: Clarifies and renames the AZURE_O1_DEPLOYMENT_NAME variable and related notes about the o1 model in Azure DevOps documentation, closely related to updating Azure OpenAI deployment naming conventions.

Poem

In the warren of docs, we burrowed anew,
Swapping our models for shinier crew.
From o-mini to four-point-one,
Our environment names now match the run.
Optional hop-paths, clear and bright—
Rabbits keep configs tidy and light!
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b2c31dc and 8a6baf7.

📒 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: Cloudflare Pages
🔇 Additional comments (4)
docs/self-hosted/gitlab.md (1)

65-75: Updated Azure OpenAI deployment environment variables

The .env snippet now recommends deploying gpt-4.1-mini, o4-mini, and o3, with an optional gpt-4.1, and includes bracketed legacy alternatives (gpt-4o-mini, o3-mini, o1) for backward compatibility. This aligns the GitLab guide with the other self-hosted provider docs.

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

67-77: Consistent Azure OpenAI deployment naming updates

The Azure DevOps guide has been aligned to recommend gpt-4.1-mini, o4-mini, o3, and optionally gpt-4.1, with bracketed fallback names (gpt-4o-mini, o3-mini, o1). This ensures uniformity across all self-hosted integration documents.

docs/self-hosted/bitbucket.md (1)

59-69: Harmonized Azure OpenAI environment variable examples

The Bitbucket Datacenter .env section now matches the new convention: primary deployments gpt-4.1-mini, o4-mini, o3 plus optional gpt-4.1, with legacy fallbacks (gpt-4o-mini, o3-mini, o1). This keeps the docs consistent.

docs/self-hosted/github.md (1)

70-80: Standardized Azure OpenAI deployment variables

The GitHub guide example has been updated to use AZURE_GPT41MINI_DEPLOYMENT_NAME, AZURE_O4MINI_DEPLOYMENT_NAME, AZURE_O3_DEPLOYMENT_NAME, and optional AZURE_GPT41_DEPLOYMENT_NAME, along with bracketed legacy alternatives. This mirrors changes in the other self-hosted docs.


🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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.

@coderabbitai coderabbitai bot changed the title @coderabbitai Update Azure OpenAI integration docs with new model deployment names Apr 21, 2025
@hasit hasit closed this Apr 21, 2025
@hasit hasit deleted the hasit/on-prem-models branch April 21, 2025 23:21
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