Support edit images

Author: qianmoQ

src/main/java/org/devlive/sdk/openai/DefaultApi.java

@@ -1,6 +1,8 @@
 package org.devlive.sdk.openai;
 
 import io.reactivex.Single;
+import okhttp3.MultipartBody;
+import okhttp3.RequestBody;
 import org.devlive.sdk.openai.entity.CompletionChatEntity;
 import org.devlive.sdk.openai.entity.CompletionEntity;
 import org.devlive.sdk.openai.entity.ImageEntity;
@@ -13,10 +15,15 @@
 import org.devlive.sdk.openai.response.UserKeyResponse;
 import retrofit2.http.Body;
 import retrofit2.http.GET;
+import retrofit2.http.Multipart;
 import retrofit2.http.POST;
+import retrofit2.http.Part;
+import retrofit2.http.PartMap;
 import retrofit2.http.Path;
 import retrofit2.http.Url;
 
+import java.util.Map;
+
 public interface DefaultApi
 {
     /**
@@ -64,4 +71,14 @@ Single<CompleteChatResponse> fetchChatCompletions(@Url String url,
      */
     @POST
     Single<ImageResponse> fetchImagesGenerations(@Url String url, @Body ImageEntity configure);
+
+    /**
+     * Creates an edited or extended image given an original image and a prompt.
+     */
+    @POST
+    @Multipart
+    Single<ImageResponse> fetchImagesEdits(@Url String url,
+                                           @Part() MultipartBody.Part image,
+                                           @Part() MultipartBody.Part mask,
+                                           @PartMap Map<String, RequestBody> configure);
 }

src/main/java/org/devlive/sdk/openai/DefaultClient.java

@@ -1,8 +1,12 @@
 package org.devlive.sdk.openai;
 
+import com.google.common.collect.Maps;
 import lombok.extern.slf4j.Slf4j;
+import okhttp3.MultipartBody;
 import okhttp3.OkHttpClient;
+import okhttp3.RequestBody;
 import org.apache.commons.lang3.ObjectUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.devlive.sdk.openai.entity.CompletionChatEntity;
 import org.devlive.sdk.openai.entity.CompletionEntity;
 import org.devlive.sdk.openai.entity.ImageEntity;
@@ -15,8 +19,12 @@
 import org.devlive.sdk.openai.response.ImageResponse;
 import org.devlive.sdk.openai.response.ModelResponse;
 import org.devlive.sdk.openai.response.UserKeyResponse;
+import org.devlive.sdk.openai.utils.MultipartBodyUtils;
 import org.devlive.sdk.openai.utils.ProviderUtils;
 
+import java.io.File;
+import java.util.Map;
+
 @Slf4j
 public abstract class DefaultClient implements AutoCloseable
 {
@@ -66,6 +74,30 @@ public ImageResponse createImages(ImageEntity configure)
                 .blockingGet();
     }
 
+    public ImageResponse editImages(File image, File mask, ImageEntity configure)
+    {
+        MultipartBody.Part imageBody = MultipartBodyUtils.getPart(image, "image");
+        MultipartBody.Part maskBody = null;
+        if (ObjectUtils.isNotEmpty(mask)) {
+            maskBody = MultipartBodyUtils.getPart(mask, "mask");
+        }
+
+        Map<String, RequestBody> map = Maps.newConcurrentMap();
+        map.put("prompt", RequestBody.create(MultipartBodyUtils.TYPE, configure.getPrompt()));
+        map.put("n", RequestBody.create(MultipartBodyUtils.TYPE, configure.getCount().toString()));
+        map.put("size", RequestBody.create(MultipartBodyUtils.TYPE, configure.getSize()));
+        map.put("response_format", RequestBody.create(MultipartBodyUtils.TYPE, configure.getFormat()));
+        if (StringUtils.isNotEmpty(configure.getUser())) {
+            map.put("user", RequestBody.create(MultipartBodyUtils.TYPE, configure.getUser()));
+        }
+
+        return this.api.fetchImagesEdits(ProviderUtils.getUrl(provider, UrlModel.FETCH_EDITS_GENERATIONS),
+                        imageBody,
+                        maskBody,
+                        map)
+                .blockingGet();
+    }
+
     public void close()
     {
         if (ObjectUtils.isNotEmpty(this.client)) {

src/main/java/org/devlive/sdk/openai/model/UrlModel.java

@@ -8,5 +8,6 @@ public enum UrlModel
     FETCH_CHAT_COMPLETIONS,
     FETCH_USER_API_KEYS,
     FETCH_CREATE_USER_API_KEY,
-    FETCH_IMAGES_GENERATIONS
+    FETCH_IMAGES_GENERATIONS,
+    FETCH_EDITS_GENERATIONS
 }

src/main/java/org/devlive/sdk/openai/response/ImageResponse.java

@@ -1,5 +1,6 @@
 package org.devlive.sdk.openai.response;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.Data;
@@ -11,6 +12,10 @@
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class ImageResponse
 {
+    @JsonProperty(value = "created")
+    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+    private String createTime;
+
     @JsonProperty(value = "data")
     private List<ImageEntity> images;
 }

src/main/java/org/devlive/sdk/openai/utils/MultipartBodyUtils.java

@@ -0,0 +1,22 @@
+package org.devlive.sdk.openai.utils;
+
+import okhttp3.MediaType;
+import okhttp3.MultipartBody;
+import okhttp3.RequestBody;
+
+import java.io.File;
+
+public class MultipartBodyUtils
+{
+    public final static MediaType TYPE = MediaType.parse("multipart/form-data");
+
+    private MultipartBodyUtils()
+    {
+    }
+
+    public static MultipartBody.Part getPart(File image, String name)
+    {
+        RequestBody body = RequestBody.create(TYPE, image);
+        return MultipartBody.Part.createFormData(name, image.getName(), body);
+    }
+}

src/main/java/org/devlive/sdk/openai/utils/ProviderUtils.java

@@ -21,6 +21,7 @@ public class ProviderUtils
         DEFAULT_PROVIDER.put(UrlModel.FETCH_CHAT_COMPLETIONS, "v1/chat/completions");
         AZURE_PROVIDER.put(UrlModel.FETCH_CHAT_COMPLETIONS, "chat/completions");
         DEFAULT_PROVIDER.put(UrlModel.FETCH_IMAGES_GENERATIONS, "v1/images/generations");
+        DEFAULT_PROVIDER.put(UrlModel.FETCH_EDITS_GENERATIONS, "v1/images/edits");
     }
 
     private ProviderUtils()

src/test/java/org/devlive/sdk/openai/OpenAiClientTest.java

@@ -14,6 +14,7 @@
 import org.junit.Before;
 import org.junit.Test;
 
+import java.io.File;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 import java.util.stream.Collectors;
@@ -140,4 +141,14 @@ public void testCreateImages()
                 .build();
         Assert.assertTrue(client.createImages(configure).getImages().size() > 0);
     }
+
+    @Test
+    public void testEditImages()
+    {
+        ImageEntity configure = ImageEntity.builder()
+                .prompt("Add hello to image")
+                .build();
+        String file = this.getClass().getResource("/logo.png").getFile();
+        Assert.assertTrue(client.editImages(new File(file), null, configure).getImages().size() > 0);
+    }
 }