Skip to content

fix: make azure api-version query param optional #9221

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.

Sign up for GitHub

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

Open
DOsinga wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: make azure api-version query param optional #9221

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 45 additions & 12 deletions crates/goose/src/providers/azure.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,15 @@ const AZURE_PROVIDER_NAME: &str = "azure_openai";
pub const AZURE_DEFAULT_MODEL: &str = "gpt-4o";
pub const AZURE_DOC_URL: &str =
"https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models";
pub const AZURE_DEFAULT_API_VERSION: &str = "2024-10-21";
const AZURE_DEFAULT_API_VERSION: &str = "2024-10-21";
pub const AZURE_OPENAI_KNOWN_MODELS: &[&str] = &["gpt-4o", "gpt-4o-mini", "gpt-4"];

/// New-style Azure AI endpoints use `/v1/` paths and reject the `api-version` query param.
fn is_v1_endpoint(endpoint: &str) -> bool {
let normalized = endpoint.trim_end_matches('/');
normalized.ends_with("/v1") || endpoint.contains("/v1/")
}

pub struct AzureProvider;

// Custom auth provider that wraps AzureAuth
Expand Down Expand Up @@ -57,13 +63,7 @@ impl ProviderDef for AzureProvider {
vec![
ConfigKey::new("AZURE_OPENAI_ENDPOINT", true, false, None, true),
ConfigKey::new("AZURE_OPENAI_DEPLOYMENT_NAME", true, false, None, true),
ConfigKey::new(
"AZURE_OPENAI_API_VERSION",
true,
false,
Some("2024-10-21"),
false,
),
ConfigKey::new("AZURE_OPENAI_API_VERSION", false, false, None, false),
ConfigKey::new("AZURE_OPENAI_API_KEY", false, true, Some(""), true),
],
)
Expand All @@ -77,9 +77,16 @@ impl ProviderDef for AzureProvider {
let config = crate::config::Config::global();
let endpoint: String = config.get_param("AZURE_OPENAI_ENDPOINT")?;
let deployment_name: String = config.get_param("AZURE_OPENAI_DEPLOYMENT_NAME")?;
let api_version: String = config
let api_version: Option<String> = config
.get_param("AZURE_OPENAI_API_VERSION")
.unwrap_or_else(|_| AZURE_DEFAULT_API_VERSION.to_string());
.ok()
.or_else(|| {
if is_v1_endpoint(&endpoint) {
None
} else {
Some(AZURE_DEFAULT_API_VERSION.to_string())
}
});

let api_key = config
.get_secret("AZURE_OPENAI_API_KEY")
Expand All @@ -92,8 +99,10 @@ impl ProviderDef for AzureProvider {

let auth_provider = AzureAuthProvider { auth };
let host = format!("{}/openai", endpoint.trim_end_matches('/'));
let api_client = ApiClient::new(host, AuthMethod::Custom(Box::new(auth_provider)))?
.with_query(vec![("api-version".to_string(), api_version)]);
let mut api_client = ApiClient::new(host, AuthMethod::Custom(Box::new(auth_provider)))?;
if let Some(version) = api_version {
api_client = api_client.with_query(vec![("api-version".to_string(), version)]);
}
Comment on lines +103 to +105
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot May 14, 2026

Choose a reason for hiding this comment

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

P1 Badge Preserve api-version for legacy Azure deployment paths

from_env now omits the api-version query parameter when AZURE_OPENAI_API_VERSION is unset, but this provider still targets the legacy .../openai/deployments/{deployment}/... route shape (not /openai/v1/...). For classic Azure OpenAI endpoints, requests on that route require an API version, so a newly configured Azure provider (where this key is now optional) can fail at runtime with 4xx errors even though setup succeeds. Please keep a fallback for non-v1 endpoints (or infer based on endpoint path) so legacy deployments remain functional without manual env overrides.

Useful? React with 👍 / 👎.


Ok(OpenAiCompatibleProvider::new(
AZURE_PROVIDER_NAME.to_string(),
Expand All @@ -104,3 +113,27 @@ impl ProviderDef for AzureProvider {
})
}
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn test_is_v1_endpoint() {
assert!(is_v1_endpoint(
"https://my-resource.services.ai.azure.com/api/projects/my-proj/openai/v1"
));
assert!(is_v1_endpoint(
"https://my-resource.services.ai.azure.com/api/projects/my-proj/openai/v1/"
));
assert!(is_v1_endpoint(
"https://my-resource.services.ai.azure.com/v1/some/path"
));

assert!(!is_v1_endpoint("https://my-resource.openai.azure.com"));
assert!(!is_v1_endpoint("https://my-resource.openai.azure.com/"));
assert!(!is_v1_endpoint(
"https://my-resource.openai.azure.com/openai"
));
}
}
Loading