Added an option to specify "api-version" query parameter for Azure OpenAI.

Author: deep-learning-dynamo

src/main/java/dev/ai4j/openai4j/OpenAiApi.java

@@ -12,22 +12,23 @@
 import retrofit2.http.Body;
 import retrofit2.http.Headers;
 import retrofit2.http.POST;
+import retrofit2.http.Query;
 
 interface OpenAiApi {
 
  @POST("completions")
  @Headers("Content-Type: application/json")
- Call<CompletionResponse> completions(@Body CompletionRequest request);
+ Call<CompletionResponse> completions(@Body CompletionRequest request, @Query("api-version") String apiVersion);
 
  @POST("chat/completions")
  @Headers("Content-Type: application/json")
- Call<ChatCompletionResponse> chatCompletions(@Body ChatCompletionRequest request);
+ Call<ChatCompletionResponse> chatCompletions(@Body ChatCompletionRequest request, @Query("api-version") String apiVersion);
 
  @POST("embeddings")
  @Headers("Content-Type: application/json")
- Call<EmbeddingResponse> embeddings(@Body EmbeddingRequest request);
+ Call<EmbeddingResponse> embeddings(@Body EmbeddingRequest request, @Query("api-version") String apiVersion);
 
  @POST("moderations")
  @Headers("Content-Type: application/json")
- Call<ModerationResponse> moderations(@Body ModerationRequest request);
+ Call<ModerationResponse> moderations(@Body ModerationRequest request, @Query("api-version") String apiVersion);
 }

src/main/java/dev/ai4j/openai4j/OpenAiClient.java

@@ -29,6 +29,7 @@ public class OpenAiClient {
  private static final Logger log = LoggerFactory.getLogger(OpenAiClient.class);
 
  private final String baseUrl;
+ private final String apiVersion;
  private final OkHttpClient okHttpClient;
  private final OpenAiApi openAiApi;
  private final boolean logStreamingResponses;
@@ -40,6 +41,7 @@ public OpenAiClient(String apiKey) {
  private OpenAiClient(Builder serviceBuilder) {
 
  this.baseUrl = serviceBuilder.baseUrl;
+ this.apiVersion = serviceBuilder.apiVersion;
 
  OkHttpClient.Builder okHttpClientBuilder = new OkHttpClient.Builder()
  .addInterceptor(new ApiKeyInsertingInterceptor(serviceBuilder.apiKey))
@@ -94,6 +96,7 @@ public static Builder builder() {
  public static class Builder {
 
  private String baseUrl = "https://api.openai.com/v1/";
+ private String apiVersion;
  private String apiKey;
  private Duration callTimeout = Duration.ofSeconds(60);
  private Duration connectTimeout = Duration.ofSeconds(60);
@@ -107,6 +110,12 @@ public static class Builder {
  private Builder() {
  }
 
+ /**
+ * @param baseUrl Base URL of OpenAI API.
+ * For OpenAI (default): "https://api.openai.com/v1/"
+ * For Azure OpenAI: "https://{resource-name}.openai.azure.com/openai/deployments/{deployment-id}/"
+ * @return builder
+ */
  public Builder baseUrl(String baseUrl) {
  if (baseUrl == null || baseUrl.trim().isEmpty()) {
  throw new IllegalArgumentException("baseUrl cannot be null or empty");
@@ -115,6 +124,15 @@ public Builder baseUrl(String baseUrl) {
  return this;
  }
 
+ /**
+ * @param apiVersion Version of the API in the YYYY-MM-DD format. Applicable only for Azure OpenAI.
+ * @return builder
+ */
+ public Builder apiVersion(String apiVersion) {
+ this.apiVersion = apiVersion;
+ return this;
+ }
+
  public Builder apiKey(String apiKey) {
  if (apiKey == null || apiKey.trim().isEmpty()) {
  throw new IllegalArgumentException("API key cannot be null or empty. API keys can be generated here: https://platform.openai.com/account/api-keys");
@@ -208,11 +226,16 @@ public OpenAiClient build() {
 
  public SyncOrAsyncOrStreaming<CompletionResponse> completion(CompletionRequest request) {
 
+ CompletionRequest syncRequest = CompletionRequest.builder()
+ .from(request)
+ .stream(null)
+ .build();
+
  return new RequestExecutor<>(
- openAiApi.completions(CompletionRequest.builder().from(request).stream(null).build()),
+ openAiApi.completions(syncRequest, apiVersion),
  (r) -> r,
  okHttpClient,
- baseUrl + "completions",
+ formatUrl("completions"),
  () -> CompletionRequest.builder().from(request).stream(true).build(),
  CompletionResponse.class,
  (r) -> r,
@@ -227,11 +250,16 @@ public SyncOrAsyncOrStreaming<String> completion(String prompt) {
  .prompt(prompt)
  .build();
 
+ CompletionRequest syncRequest = CompletionRequest.builder()
+ .from(request)
+ .stream(null)
+ .build();
+
  return new RequestExecutor<>(
- openAiApi.completions(CompletionRequest.builder().from(request).stream(null).build()),
+ openAiApi.completions(syncRequest, apiVersion),
  CompletionResponse::text,
  okHttpClient,
- baseUrl + "completions",
+ formatUrl("completions"),
  () -> CompletionRequest.builder().from(request).stream(true).build(),
  CompletionResponse.class,
  CompletionResponse::text,
@@ -241,11 +269,16 @@ public SyncOrAsyncOrStreaming<String> completion(String prompt) {
 
  public SyncOrAsyncOrStreaming<ChatCompletionResponse> chatCompletion(ChatCompletionRequest request) {
 
+ ChatCompletionRequest syncRequest = ChatCompletionRequest.builder()
+ .from(request)
+ .stream(null)
+ .build();
+
  return new RequestExecutor<>(
- openAiApi.chatCompletions(ChatCompletionRequest.builder().from(request).stream(null).build()),
+ openAiApi.chatCompletions(syncRequest, apiVersion),
  (r) -> r,
  okHttpClient,
- baseUrl + "chat/completions",
+ formatUrl("chat/completions"),
  () -> ChatCompletionRequest.builder().from(request).stream(true).build(),
  ChatCompletionResponse.class,
  (r) -> r,
@@ -260,11 +293,16 @@ public SyncOrAsyncOrStreaming<String> chatCompletion(String userMessage) {
  .addUserMessage(userMessage)
  .build();
 
+ ChatCompletionRequest syncRequest = ChatCompletionRequest.builder()
+ .from(request)
+ .stream(null)
+ .build();
+
  return new RequestExecutor<>(
- openAiApi.chatCompletions(ChatCompletionRequest.builder().from(request).stream(null).build()),
+ openAiApi.chatCompletions(syncRequest, apiVersion),
  ChatCompletionResponse::content,
  okHttpClient,
- baseUrl + "chat/completions",
+ formatUrl("chat/completions"),
  () -> ChatCompletionRequest.builder().from(request).stream(true).build(),
  ChatCompletionResponse.class,
  (r) -> r.choices().get(0).delta().content(),
@@ -274,7 +312,7 @@ public SyncOrAsyncOrStreaming<String> chatCompletion(String userMessage) {
 
  public SyncOrAsync<EmbeddingResponse> embedding(EmbeddingRequest request) {
 
- return new RequestExecutor<>(openAiApi.embeddings(request), (r) -> r);
+ return new RequestExecutor<>(openAiApi.embeddings(request, apiVersion), (r) -> r);
  }
 
  @Experimental
@@ -284,12 +322,12 @@ public SyncOrAsync<List<Float>> embedding(String input) {
  .input(input)
  .build();
 
- return new RequestExecutor<>(openAiApi.embeddings(request), EmbeddingResponse::embedding);
+ return new RequestExecutor<>(openAiApi.embeddings(request, apiVersion), EmbeddingResponse::embedding);
  }
 
  public SyncOrAsync<ModerationResponse> moderation(ModerationRequest request) {
 
- return new RequestExecutor<>(openAiApi.moderations(request), (r) -> r);
+ return new RequestExecutor<>(openAiApi.moderations(request, apiVersion), (r) -> r);
  }
 
  @Experimental
@@ -299,6 +337,17 @@ public SyncOrAsync<ModerationResult> moderation(String input) {
  .input(input)
  .build();
 
- return new RequestExecutor<>(openAiApi.moderations(request), (r) -> r.results().get(0));
+ return new RequestExecutor<>(openAiApi.moderations(request, apiVersion), (r) -> r.results().get(0));
+ }
+
+ private String formatUrl(String endpoint) {
+ return baseUrl + endpoint + apiVersionQueryParam();
+ }
+
+ private String apiVersionQueryParam() {
+ if (apiVersion == null || apiVersion.trim().isEmpty()) {
+ return "";
+ }
+ return "?api-version=" + apiVersion;
  }
 }

src/test/java/dev/ai4j/openai4j/Test.java

@@ -12,6 +12,8 @@ public static void main(String[] args) {
  String apiKey = System.getenv("OPENAI_API_KEY");
 
  OpenAiClient client = OpenAiClient.builder()
+ .baseUrl("https://my-resource.openai.azure.com/openai/deployments/my-deployment/")
+ .apiVersion("2023-06-13")
  .apiKey(apiKey)
  .callTimeout(ofSeconds(60))
  .connectTimeout(ofSeconds(60))