-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Description
Problem
The OpenAI Java SDK (v4.8.0) cannot be used to call the OpenAI Responses API on Microsoft Foundry endpoints because it doesn't support adding custom query parameters to requests.
Why This Matters
Microsoft Foundry's OpenAI Responses API endpoints require the api-version parameter as a query parameter:
https://YOUR-RESOURCE.services.ai.azure.com/api/projects/YOUR-PROJECT/openai/responses?api-version=2025-11-15-preview
The OpenAI Java SDK doesn't provide a way to add custom query parameters to its API calls.
Current Workaround
We use OkHttp to make direct HTTP calls to the OpenAI Responses API:
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url(endpoint) // Endpoint includes ?api-version=2025-11-15-preview
.addHeader("Authorization", "Bearer " + token.getToken())
.addHeader("Content-Type", "application/json")
.post(RequestBody.create(jsonBody, MediaType.get("application/json")))
.build();What We Need
The OpenAI Java SDK should support something like the following: A method to add custom query parameters to requests:
OpenAIClient client = OpenAIClient.builder()
.baseUrl(baseUrl)
.addQueryParam("api-version", "2025-11-15-preview")
.build();Impact
Without this capability, Java developers cannot use the official OpenAI SDK with Microsoft Foundry and must resort to manual HTTP client implementations, losing the benefits of:
- Type safety
- Automatic request/response serialization
- Built-in error handling
- SDK updates and improvements
References
- Current implementation: ClaudeResponsesExample.java
- Microsoft Foundry documentation: https://learn.microsoft.com/azure/ai-foundry/foundry-models/how-to/use-foundry-models-claude
Metadata
Metadata
Assignees
Labels
No labels