Merge branch 'main' into add-organizationId

Author: edeandrea

.prettierrc

@@ -0,0 +1,4 @@
+{
+ "tabWidth": 4,
+ "printWidth": 120
+}

README.md

@@ -332,10 +332,60 @@ client.moderation(request)
 .execute();
 ```
 
+## Images Generations with DALL·E
+
+Simple way:
+
+```
+ OpenAiClient client = OpenAiClient
+ .builder()
+ .openAiApiKey(System.getenv("OPENAI_API_KEY"))
+ .build();
+
+ ImageRequest request = ImageRequest
+ .builder()
+ .prompt("Beautiful house on country side")
+ .build();
+
+ ImageResponse response = client.imagesGenerations(request).execute();
+
+ // remote image generated with model DALL·E 3 and resolution 1024x1024
+ String remoteImage = response.data().get(0).url();
+```
+
+Customizable way:
+
+```
+ OpenAiClient client = OpenAiClient
+ .builder()
+ .openAiApiKey(System.getenv("OPENAI_API_KEY"))
+ .logRequests()
+ .logResponses()
+ .withPersisting()
+ .build();
+
+ ImageRequest request = ImageRequest
+ .builder()
+ .model(DALL_E_3)
+ .size(DALL_E_SIZE_1792_x_1024)
+ .quality(DALL_E_QUALITY_HD)
+ .responseFormat(DALL_E_RESPONSE_FORMAT_B64_JSON) // if you like to get the image within the response body
+ .prompt("Cute red parrot flying in the sky")
+ .build();
+
+ ImageResponse response = client.imagesGenerations(request).execute();
+
+ // your generated image is here locally: 
+ String localImage = response.data().get(0).url();
+```
+
+### Asynchronously
+
 # Useful materials
 
 - How to get best results form AI: https://www.deeplearning.ai/short-courses/chatgpt-prompt-engineering-for-developers/
 - Text version of above course: https://platform.openai.com/docs/guides/gpt-best-practices
 - How to build software powered by
  OpenAI/ChatGPT: https://www.deeplearning.ai/short-courses/building-systems-with-chatgpt/
 - Cookbook with examples of how to use OpenAI API: https://github.com/openai/openai-cookbook
+- ChatGPT DALL-E 3: Complete Guide (Generate Images with Text) https://www.akkio.com/post/chatgpt-dall-e-3

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

@@ -2,10 +2,6 @@
 
 import static dev.ai4j.openai4j.Json.GSON;
 
-import java.io.IOException;
-import java.util.Collections;
-import java.util.List;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -15,9 +11,14 @@
 import dev.ai4j.openai4j.completion.CompletionResponse;
 import dev.ai4j.openai4j.embedding.EmbeddingRequest;
 import dev.ai4j.openai4j.embedding.EmbeddingResponse;
+import dev.ai4j.openai4j.image.GenerateImagesRequest;
+import dev.ai4j.openai4j.image.GenerateImagesResponse;
 import dev.ai4j.openai4j.moderation.ModerationRequest;
 import dev.ai4j.openai4j.moderation.ModerationResponse;
 import dev.ai4j.openai4j.moderation.ModerationResult;
+import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
 import okhttp3.Cache;
 import okhttp3.OkHttpClient;
 import retrofit2.Retrofit;
@@ -38,15 +39,14 @@ public DefaultOpenAiClient(String apiKey) {
  }
 
  private DefaultOpenAiClient(Builder serviceBuilder) {
-
  this.baseUrl = serviceBuilder.baseUrl;
  this.apiVersion = serviceBuilder.apiVersion;
 
  OkHttpClient.Builder okHttpClientBuilder = new OkHttpClient.Builder()
-  .callTimeout(serviceBuilder.callTimeout)
-  .connectTimeout(serviceBuilder.connectTimeout)
-  .readTimeout(serviceBuilder.readTimeout)
-  .writeTimeout(serviceBuilder.writeTimeout);
+ .callTimeout(serviceBuilder.callTimeout)
+ .connectTimeout(serviceBuilder.connectTimeout)
+ .readTimeout(serviceBuilder.readTimeout)
+ .writeTimeout(serviceBuilder.writeTimeout);
 
  if (serviceBuilder.openAiApiKey == null && serviceBuilder.azureApiKey == null) {
  throw new IllegalArgumentException("openAiApiKey OR azureApiKey must be defined");
@@ -78,17 +78,18 @@ private DefaultOpenAiClient(Builder serviceBuilder) {
 
  this.okHttpClient = okHttpClientBuilder.build();
 
- Retrofit retrofit = new Retrofit.Builder()
- .baseUrl(serviceBuilder.baseUrl)
- .client(okHttpClient)
- .addConverterFactory(GsonConverterFactory.create(GSON))
- .build();
+ Retrofit.Builder retrofitBuilder = new Retrofit.Builder().baseUrl(serviceBuilder.baseUrl).client(okHttpClient);
+
+ if (serviceBuilder.persistTo != null) {
+ retrofitBuilder.addConverterFactory(new PersistorConverterFactory(serviceBuilder.persistTo));
+ }
+
+ retrofitBuilder.addConverterFactory(GsonConverterFactory.create(GSON));
 
- this.openAiApi = retrofit.create(OpenAiApi.class);
+ this.openAiApi = retrofitBuilder.build().create(OpenAiApi.class);
  }
 
  public void shutdown() {
-
  okHttpClient.dispatcher().executorService().shutdown();
 
  okHttpClient.connectionPool().evictAll();
@@ -116,122 +117,99 @@ public DefaultOpenAiClient build() {
 
  @Override
  public SyncOrAsyncOrStreaming<CompletionResponse> completion(CompletionRequest request) {
-
- CompletionRequest syncRequest = CompletionRequest.builder()
- .from(request)
- .stream(null)
- .build();
+ CompletionRequest syncRequest = CompletionRequest.builder().from(request).stream(null).build();
 
  return new RequestExecutor<>(
-  openAiApi.completions(syncRequest, apiVersion),
-  (r) -> r,
-  okHttpClient,
-  formatUrl("completions"),
-  () -> CompletionRequest.builder().from(request).stream(true).build(),
-  CompletionResponse.class,
-  (r) -> r,
-  logStreamingResponses
+ openAiApi.completions(syncRequest, apiVersion),
+ r -> r,
+ okHttpClient,
+ formatUrl("completions"),
+ () -> CompletionRequest.builder().from(request).stream(true).build(),
+ CompletionResponse.class,
+ r -> r,
+ logStreamingResponses
  );
  }
 
  @Override
  public SyncOrAsyncOrStreaming<String> completion(String prompt) {
+ CompletionRequest request = CompletionRequest.builder().prompt(prompt).build();
 
- CompletionRequest request = CompletionRequest.builder()
- .prompt(prompt)
- .build();
-
- CompletionRequest syncRequest = CompletionRequest.builder()
- .from(request)
- .stream(null)
- .build();
+ CompletionRequest syncRequest = CompletionRequest.builder().from(request).stream(null).build();
 
  return new RequestExecutor<>(
-  openAiApi.completions(syncRequest, apiVersion),
-  CompletionResponse::text,
-  okHttpClient,
-  formatUrl("completions"),
-  () -> CompletionRequest.builder().from(request).stream(true).build(),
-  CompletionResponse.class,
-  CompletionResponse::text,
-  logStreamingResponses
+ openAiApi.completions(syncRequest, apiVersion),
+ CompletionResponse::text,
+ okHttpClient,
+ formatUrl("completions"),
+ () -> CompletionRequest.builder().from(request).stream(true).build(),
+ CompletionResponse.class,
+ CompletionResponse::text,
+ logStreamingResponses
  );
  }
 
  @Override
  public SyncOrAsyncOrStreaming<ChatCompletionResponse> chatCompletion(ChatCompletionRequest request) {
-
- ChatCompletionRequest syncRequest = ChatCompletionRequest.builder()
- .from(request)
- .stream(null)
- .build();
+ ChatCompletionRequest syncRequest = ChatCompletionRequest.builder().from(request).stream(null).build();
 
  return new RequestExecutor<>(
-  openAiApi.chatCompletions(syncRequest, apiVersion),
-  (r) -> r,
-  okHttpClient,
-  formatUrl("chat/completions"),
-  () -> ChatCompletionRequest.builder().from(request).stream(true).build(),
-  ChatCompletionResponse.class,
-  (r) -> r,
-  logStreamingResponses
+ openAiApi.chatCompletions(syncRequest, apiVersion),
+ r -> r,
+ okHttpClient,
+ formatUrl("chat/completions"),
+ () -> ChatCompletionRequest.builder().from(request).stream(true).build(),
+ ChatCompletionResponse.class,
+ r -> r,
+ logStreamingResponses
  );
  }
 
  @Override
  public SyncOrAsyncOrStreaming<String> chatCompletion(String userMessage) {
+ ChatCompletionRequest request = ChatCompletionRequest.builder().addUserMessage(userMessage).build();
 
- ChatCompletionRequest request = ChatCompletionRequest.builder()
- .addUserMessage(userMessage)
- .build();
-
- ChatCompletionRequest syncRequest = ChatCompletionRequest.builder()
- .from(request)
- .stream(null)
- .build();
+ ChatCompletionRequest syncRequest = ChatCompletionRequest.builder().from(request).stream(null).build();
 
  return new RequestExecutor<>(
-  openAiApi.chatCompletions(syncRequest, apiVersion),
-  ChatCompletionResponse::content,
-  okHttpClient,
-  formatUrl("chat/completions"),
-  () -> ChatCompletionRequest.builder().from(request).stream(true).build(),
-  ChatCompletionResponse.class,
-  (r) -> r.choices().get(0).delta().content(),
-  logStreamingResponses
+ openAiApi.chatCompletions(syncRequest, apiVersion),
+ ChatCompletionResponse::content,
+ okHttpClient,
+ formatUrl("chat/completions"),
+ () -> ChatCompletionRequest.builder().from(request).stream(true).build(),
+ ChatCompletionResponse.class,
+ r -> r.choices().get(0).delta().content(),
+ logStreamingResponses
  );
  }
 
  @Override
  public SyncOrAsync<EmbeddingResponse> embedding(EmbeddingRequest request) {
-
- return new RequestExecutor<>(openAiApi.embeddings(request, apiVersion), (r) -> r);
+ return new RequestExecutor<>(openAiApi.embeddings(request, apiVersion), r -> r);
  }
 
  @Override
  public SyncOrAsync<List<Float>> embedding(String input) {
-
- EmbeddingRequest request = EmbeddingRequest.builder()
- .input(input)
- .build();
+ EmbeddingRequest request = EmbeddingRequest.builder().input(input).build();
 
  return new RequestExecutor<>(openAiApi.embeddings(request, apiVersion), EmbeddingResponse::embedding);
  }
 
  @Override
  public SyncOrAsync<ModerationResponse> moderation(ModerationRequest request) {
-
- return new RequestExecutor<>(openAiApi.moderations(request, apiVersion), (r) -> r);
+ return new RequestExecutor<>(openAiApi.moderations(request, apiVersion), r -> r);
  }
 
  @Override
  public SyncOrAsync<ModerationResult> moderation(String input) {
+ ModerationRequest request = ModerationRequest.builder().input(input).build();
 
- ModerationRequest request = ModerationRequest.builder()
- .input(input)
- .build();
+ return new RequestExecutor<>(openAiApi.moderations(request, apiVersion), r -> r.results().get(0));
+ }
 
- return new RequestExecutor<>(openAiApi.moderations(request, apiVersion), (r) -> r.results().get(0));
+ @Override
+ public SyncOrAsync<GenerateImagesResponse> imagesGeneration(GenerateImagesRequest request) {
+ return new RequestExecutor<>(openAiApi.imagesGenerations(request, apiVersion), r -> r);
  }
 
  private String formatUrl(String endpoint) {

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

@@ -0,0 +1,42 @@
+package dev.ai4j.openai4j;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
+import java.nio.file.StandardOpenOption;
+import java.util.Base64;
+import java.util.UUID;
+
+class FilePersistor {
+
+ static Path persistFromUri(URI uri, Path destinationFolder) {
+ try {
+ Path fileName = Paths.get(uri.getPath()).getFileName();
+ Path destinationFilePath = destinationFolder.resolve(fileName);
+ try (InputStream inputStream = uri.toURL().openStream()) {
+ java.nio.file.Files.copy(inputStream, destinationFilePath, StandardCopyOption.REPLACE_EXISTING);
+ }
+
+ return destinationFilePath;
+ } catch (IOException e) {
+ throw new RuntimeException("Error persisting file from URI: " + uri, e);
+ }
+ }
+
+ public static Path persistFromBase64String(String base64EncodedString, Path destinationFolder) throws IOException {
+ byte[] decodedBytes = Base64.getDecoder().decode(base64EncodedString);
+ Path destinationFile = destinationFolder.resolve(randomFileName());
+
+ Files.write(destinationFile, decodedBytes, StandardOpenOption.CREATE);
+
+ return destinationFile;
+ }
+
+ private static String randomFileName() {
+ return UUID.randomUUID().toString().replaceAll("-", "").substring(0, 20);
+ }
+}

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

@@ -6,6 +6,8 @@
 import dev.ai4j.openai4j.completion.CompletionResponse;
 import dev.ai4j.openai4j.embedding.EmbeddingRequest;
 import dev.ai4j.openai4j.embedding.EmbeddingResponse;
+import dev.ai4j.openai4j.image.GenerateImagesRequest;
+import dev.ai4j.openai4j.image.GenerateImagesResponse;
 import dev.ai4j.openai4j.moderation.ModerationRequest;
 import dev.ai4j.openai4j.moderation.ModerationResponse;
 import retrofit2.Call;
@@ -15,14 +17,16 @@
 import retrofit2.http.Query;
 
 interface OpenAiApi {
-
  @POST("completions")
  @Headers("Content-Type: application/json")
  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, @Query("api-version") String apiVersion);
+ Call<ChatCompletionResponse> chatCompletions(
+ @Body ChatCompletionRequest request,
+ @Query("api-version") String apiVersion
+ );
 
  @POST("embeddings")
  @Headers("Content-Type: application/json")
@@ -31,4 +35,11 @@ interface OpenAiApi {
  @POST("moderations")
  @Headers("Content-Type: application/json")
  Call<ModerationResponse> moderations(@Body ModerationRequest request, @Query("api-version") String apiVersion);
+
+ @POST("images/generations")
+ @Headers({ "Content-Type: application/json" })
+ Call<GenerateImagesResponse> imagesGenerations(
+ @Body GenerateImagesRequest request,
+ @Query("api-version") String apiVersion
+ );
 }