Add support to image generation

- support image generation API.
- update the documentation.
- minor structure updates.
- update the examples.

Author: Barqawiz

README.md

@@ -1,28 +1,43 @@
 # IntelliJava-OpenaiAPI
-*IntelliJava V0.2 beta*
+*IntelliJava V0.3*
 
 IntelliJava allows java developers to easily integrate with the latest language models and deep learning frameworks like GPT-3 using few lines of code.
-The first version supports only Openai APIs. It provides a simple and intuitive API with convenient methods for sending text input to GPT-3 and receiving generated text in return.
+The first version supports only Openai APIs. It provides a simple and intuitive API with convenient methods for sending text input to models like (GPT-3 and DALL·E) and receiving generated text in return.
 
 
 # How to use
-1. Import the core jar file to your project [intellijava.jar](https://insta-answer-public.s3.amazonaws.com/opensource/IntelliJava/version0.2/com.intellijava.core-0.2.jar).
+1. Import the core jar file to your project [intellijava.jar](https://insta-answer-public.s3.amazonaws.com/opensource/IntelliJava/version0.3/com.intellijava.core-0.3.jar).
 2. Add gson dependency using maven or the jar file (check the dependencies section).
-3. Call the RemoteLanguageModel as described in the code example.
+3. Call the ``RemoteLanguageModel`` for the language model and ``RemoateImageModel`` for image generation.
 
-# Code Example
+## Code Example
+**Language model code** (2 steps):
 ```
 // 1- initiate the remote language model 
-String apiKey = "<todo-add-api-key>";
-RemoteLanguageModel wrapper = new RemoteLanguageModel(apiKey, "openai");
+String apiKey = "<add-openai-api-key>";
+RemoteLanguageModel langModel = new RemoteLanguageModel(apiKey, "openai");
 
 // 2- call generateText with any command !
 String command = "return a java code that says hello wrold";
-String resValue = wrapper.generateText("text-davinci-002", command, 0.5F, 100);
+String resValue = langModel.generateText("text-davinci-002", command, 0.5F, 100);
 ```
-For full example check the samples projects inside sample_code folder.
+Output:
+``` System.out.println("Hello, World!");```<br><br>
+**Image generation code** (2 steps):
+```
+// 1- initiate the remote image model 
+RemoateImageModel imageModel = new RemoateImageModel(apiKey, "openai");
+
+// 2- call generateImages with any command !
+String prompt = "teddy writing a blog in times square";
+List<String> images = imageModel.generateImages(prompt, 2/*number of images*/, "1024x1024");
+```
+Output:<br>
+<img src="images/response_image.png" height="250px">
+
+For full example check the code inside sample_code project.
 
-# Dependencies 
+## Third-party dependencies
 The only dependencies is **GSON**.
 
 For Maven:
@@ -48,7 +63,7 @@ For jar download:
 # Roadmap
 Call for contributors:
 - [x] Add support to OpenAI Completion API.
-- [ ] Add support to OpenAI DALL·E 2 (under development).
+- [x] Add support to OpenAI DALL·E 2.
 - [ ] Add support to other OpenAI functions.
 - [ ] Add support to Google language models.
 - [ ] Add support to Amazon language models.

core/com.intellijava.core/pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>com.intellijava</groupId>
   <artifactId>com.intellijava.core</artifactId>
-  <version>0.2</version>
+  <version>0.3</version>
 
   <name>com.intellijava.core</name>
   <url>https://github.com/Barqawiz/IntelliJava</url>

core/com.intellijava.core/resources/config.properties

@@ -1,3 +1,4 @@
 url.openai.base=https://api.openai.com
 url.openai.completions=/v1/completions
+url.openai.imagegenerate=/v1/images/generations
 url.openai.testkey=

core/com.intellijava.core/src/main/java/com/intellijava/com/intellijava/core/controller/RemoateImageModel.java

@@ -0,0 +1,104 @@
+/**
+ * Copyright 2023 Github.com/Barqawiz/IntelliJava
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.intellijava.com.intellijava.core.controller;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import com.intellijava.com.intellijava.core.model.OpenaiImageResponse;
+import com.intellijava.com.intellijava.core.model.OpenaiImageResponse.Data;
+import com.intellijava.com.intellijava.core.wrappers.OpenAIWrapper;
+
+/**
+ * 
+ * @author github.com/Barqawiz
+ * 
+ * A class to call the most sophisticated remote image models.
+ * 
+ * This version support Openai GPT model only, with a plan to add more models in the future.
+ *
+ */
+public class RemoateImageModel {
+	
+	private String keyType;
+	private OpenAIWrapper openaiWrapper;
+	
+	/**
+	 * 
+	 * @param keyValue the API key.
+	 * @param keyType support openai only.
+	 */
+	public RemoateImageModel(String keyValue, String keyType) {
+		
+		if (keyType == "" || keyType == "openai") {
+			this.keyType = "openai";
+			openaiWrapper = new OpenAIWrapper(keyValue);
+		} else {
+			throw new IllegalArgumentException("This version support openai keyType only");
+		}
+	}
+
+	
+	/**
+	 * 
+	 * Generate images from any text description.
+	 * 
+	 * @param prompt text of the required action or the question.
+	 * @param numberOfImages number of the generated images.
+	 * @param imageSize 256x256, 512x512, or 1024x1024.
+	 * @return List of images URL.
+	 * @throws IOException
+	 */
+	public List<String> generateImages(String prompt, int numberOfImages, String imageSize) throws IOException { 
+		
+		if (this.keyType == "openai") {
+			return this.generateOpenaiImage(prompt, numberOfImages, imageSize);
+		} else {
+			throw new IllegalArgumentException("This version support openai keyType only");
+		}
+		
+	}
+	
+	/**
+	 * 
+	 * @param prompt text of the required action or the question.
+	 * @param numberOfImages number of the generated images.
+	 * @param imageSize 256x256, 512x512, or 1024x1024.
+	 * @return List of images URL.
+	 * @throws IOException
+	 */
+	private List<String>  generateOpenaiImage(String prompt, int numberOfImages, String imageSize) throws IOException { 
+		
+		List<String> images = new ArrayList<>();
+		
+		Map<String, Object> params = new HashMap<>();
+		params.put("prompt", prompt);
+        params.put("n", numberOfImages);
+        params.put("size", imageSize);
+        
+        OpenaiImageResponse resModel = (OpenaiImageResponse) openaiWrapper.generateImages(params);
+		
+		List<Data> responseImages = resModel.getData();
+    	for (Data data: responseImages) {
+    		images.add(data.getUrl().toString());
+    	}
+    	
+		return images;
+		
+	}
+}

core/com.intellijava.core/src/main/java/com/intellijava/com/intellijava/core/controller/RemoteLanguageModel.java

@@ -19,7 +19,7 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import com.intellijava.com.intellijava.core.model.OpenaiResponseModel;
+import com.intellijava.com.intellijava.core.model.OpenaiLanguageResponse;
 import com.intellijava.com.intellijava.core.wrappers.OpenAIWrapper;
 
 /**
@@ -65,7 +65,7 @@ public RemoteLanguageModel(String keyValue, String keyType) {
 	public String generateText(String model, String prompt, float temperature, int maxTokens) throws IOException { 
 
 		if (this.keyType == "openai") {
-			return this.generateOpensiText(model, prompt, temperature, maxTokens);
+			return this.generateOpenaiText(model, prompt, temperature, maxTokens);
 		} else {
 			throw new IllegalArgumentException("This version support openai keyType only");
 		}
@@ -78,18 +78,18 @@ public String generateText(String model, String prompt, float temperature, int m
 	 * @param prompt text of the required action or the question.
 	 * @param temperature higher values means more risks and creativity.
 	 * @param maxTokens maximum size of the model input and output.
-	 * @return string model response
+	 * @return string model response.
 	 * @throws IOException
 	 */
-	private String generateOpensiText(String model, String prompt, float temperature, int maxTokens) throws IOException { 
+	private String generateOpenaiText(String model, String prompt, float temperature, int maxTokens) throws IOException { 
 
 		Map<String, Object> params = new HashMap<>();
         params.put("model", model);
         params.put("prompt", prompt);
         params.put("temperature", temperature);
         params.put("max_tokens", maxTokens);
 
-		OpenaiResponseModel resModel = (OpenaiResponseModel) openaiWrapper.generateText(params);
+		OpenaiLanguageResponse resModel = (OpenaiLanguageResponse) openaiWrapper.generateText(params);
 
 		return resModel.getChoices().get(0).getText();
 

core/com.intellijava.core/src/main/java/com/intellijava/com/intellijava/core/model/OpenaiImageResponse.java

@@ -0,0 +1,30 @@
+package com.intellijava.com.intellijava.core.model;
+
+import java.util.List;
+import com.google.gson.annotations.SerializedName;
+
+public class OpenaiImageResponse extends BaseRemoteModel {
+
+
+	private long created;
+
+
+	private List<Data> data;
+
+	public static class Data {
+		private String url;
+
+		public String getUrl() {
+			return url;
+		}
+	}
+
+	public long getCreated() {
+		return created;
+	}
+
+	public List<Data> getData() {
+		return data;
+	}
+
+}

…java/core/model/OpenaiResponseModel.java …a/core/model/OpenaiLanguageResponse.javacore/com.intellijava.core/src/main/java/com/intellijava/com/intellijava/core/model/OpenaiResponseModel.java renamed to core/com.intellijava.core/src/main/java/com/intellijava/com/intellijava/core/model/OpenaiLanguageResponse.java core/com.intellijava.core/src/main/java/com/intellijava/com/intellijava/core/model/OpenaiResponseModel.java renamed to core/com.intellijava.core/src/main/java/com/intellijava/com/intellijava/core/model/OpenaiLanguageResponse.java

@@ -24,7 +24,7 @@
  * A model class to parse openai completion API response.
  *
  */
-public class OpenaiResponseModel extends BaseRemoteModel {
+public class OpenaiLanguageResponse extends BaseRemoteModel {
 
     private String object;
     private long created;

core/com.intellijava.core/src/main/java/com/intellijava/com/intellijava/core/utils/ConnHelper.java

@@ -25,7 +25,7 @@
 import java.util.Map;
 
 import com.google.gson.Gson;
-import com.intellijava.com.intellijava.core.model.OpenaiResponseModel;
+import com.intellijava.com.intellijava.core.model.OpenaiLanguageResponse;
 
 /**
  * 

core/com.intellijava.core/src/main/java/com/intellijava/com/intellijava/core/wrappers/ImageModelInterface.java

@@ -0,0 +1,17 @@
+package com.intellijava.com.intellijava.core.wrappers;
+
+import java.io.IOException;
+import java.util.Map;
+
+import com.intellijava.com.intellijava.core.model.BaseRemoteModel;
+
+public interface ImageModelInterface {
+
+	/**
+	 * 
+	 * @param params map of input parameters keys and values
+	 * @return
+	 * @throws IOException
+	 */
+	public BaseRemoteModel generateImages(Map<String, Object> params) throws IOException;
+}

core/com.intellijava.core/src/main/java/com/intellijava/com/intellijava/core/wrappers/OpenAIWrapper.java

@@ -27,7 +27,8 @@
 
 import com.google.gson.Gson;
 import com.intellijava.com.intellijava.core.model.BaseRemoteModel;
-import com.intellijava.com.intellijava.core.model.OpenaiResponseModel;
+import com.intellijava.com.intellijava.core.model.OpenaiImageResponse;
+import com.intellijava.com.intellijava.core.model.OpenaiLanguageResponse;
 import com.intellijava.com.intellijava.core.utils.Config2;
 import com.intellijava.com.intellijava.core.utils.ConnHelper;
 
@@ -38,7 +39,7 @@
  * A wrapper to hide the complexity of openai API.
  *
  */
-public class OpenAIWrapper implements LanguageModelInterface {
+public class OpenAIWrapper implements LanguageModelInterface, ImageModelInterface {
 
     private final String API_BASE_URL = Config2.getInstance().getProperty("url.openai.base");
     private String API_KEY;
@@ -52,14 +53,17 @@ public OpenAIWrapper(String apiKey) {
     }
 
     /**
-     * 
-     * @param model the model name, example: text-davinci-002. For more details about GPT3 models: https://beta.openai.com/docs/models/gpt-3
-     * @param prompt text of the required action or the question.
-     * @param temperature higher values means more risks and creativity.
-     * @param maxTokens maximum size of the model input and output.
-     * @return the model response.
-     * @throws IOException
-     */
+	 * 
+	 * Generate text from remote large language model based on the received prompt.
+	 * 
+	 * @param params key and value for the API parameters
+	 * 			model the model name, example: text-davinci-002. For more details about GPT3 models: https://beta.openai.com/docs/models/gpt-3
+	 * 			prompt text of the required action or the question.
+	 * 			temperature higher values means more risks and creativity.
+	 * 			maxTokens maximum size of the model input and output.
+	 * @return BaseRemoteModel for model response
+	 * @throws IOException
+	 */
     public BaseRemoteModel generateText(Map<String, Object> params) throws IOException {
 
         String url = API_BASE_URL + Config2.getInstance().getProperty("url.openai.completions");
@@ -82,7 +86,42 @@ public BaseRemoteModel generateText(Map<String, Object> params) throws IOExcepti
         }
 
         // get the response and convert to model 
-        OpenaiResponseModel resModel = ConnHelper.convertSteamToModel(connection.getInputStream(), OpenaiResponseModel.class);
+        OpenaiLanguageResponse resModel = ConnHelper.convertSteamToModel(connection.getInputStream(), OpenaiLanguageResponse.class);
+        return resModel;
+    }
+    
+    /**
+     * 
+     * @param params should include prompt, n, size
+     * 			prompt: text of the required action or the question.
+     * 			n: number of the generated images.
+     * 			size: 256x256, 512x512, or 1024x1024.
+     * @return
+     * @throws IOException
+     */
+    public BaseRemoteModel generateImages(Map<String, Object> params) throws IOException {
+    	
+        String url = API_BASE_URL + Config2.getInstance().getProperty("url.openai.imagegenerate");
+
+        String json = ConnHelper.convertMaptToJson(params);
+
+        HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
+        connection.setRequestMethod("POST");
+        connection.setRequestProperty("Content-Type", "application/json");
+        connection.setRequestProperty("Authorization", "Bearer " + API_KEY);
+        connection.setDoOutput(true);
+
+        try (OutputStream outputStream = connection.getOutputStream()) {
+            outputStream.write(json.getBytes(StandardCharsets.UTF_8));
+        }
+
+        if (connection.getResponseCode() != HttpURLConnection.HTTP_OK) {
+        	String errorMessage = ConnHelper.getErrorMessage(connection);
+            throw new IOException(errorMessage);
+        }
+
+        // get the response and convert to model
+        OpenaiImageResponse resModel = ConnHelper.convertSteamToModel(connection.getInputStream(), OpenaiImageResponse.class);
         return resModel;
     }
 }