examples added within the "example" directory, redid the translate/transcription classes

Author: jetkai

src/main/java/examples/ExampleChatGPT.java

@@ -0,0 +1,78 @@
+package examples;
+
+import io.github.jetkai.openai.OpenAI;
+import io.github.jetkai.openai.api.CreateChatCompletion;
+import io.github.jetkai.openai.api.data.completion.chat.ChatCompletionData;
+import io.github.jetkai.openai.api.data.completion.chat.ChatCompletionMessageData;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * ExampleChatGPT
+ *
+ * @author <a href="https://github.com/jetkai">Kai</a>
+ * @version 1.0.0
+ * {@code - 05/03/2023}
+ * @since 1.0.0
+ * {@code - 05/03/2023}
+ *
+ * <p>
+ * Note - This is just a test class, it is recommended to import this project as a library
+ * and then call OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+ * </p>
+ */
+public class ExampleChatGPT {
+
+    /*
+     * You can get a free API key from https://platform.openai.com/account/api-keys
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY");
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+     */
+    private final OpenAI openAI = new OpenAI(System.getenv("OPEN_AI_API_KEY"));
+
+    //This is a List that will store all our conversation history
+    //This includes our chat history and the AI's
+    private final List<ChatCompletionMessageData> messageHistory = new ArrayList<>();
+
+    public static void main(String[] args) {
+        ExampleChatGPT gpt = new ExampleChatGPT();
+
+        //The first message that we want to send
+        String message1 = "Hello ChatGPT!";
+        //The second message that we want to send
+        String message2 = "What was the last thing I just said?";
+
+        //Response 1 from ChatGPT
+        String response1 = gpt.communicate(message1);
+        System.out.println("Sent: " + message1);
+        System.out.println("Response: " + response1);
+
+        //Response 2 from ChatGPT
+        String response2 = gpt.communicate(message2);
+        System.out.println("Sent: " + message2);
+        System.out.println("Response: " + response2);
+    }
+
+    private String communicate(String message) {
+        //Create the Message Data object with the message we wish to send
+        ChatCompletionMessageData messageData = ChatCompletionMessageData.create(message);
+
+        //Store the message that we want to send, to the MessageHistory List
+        messageHistory.add(messageData);
+
+        //Send the request to OpenAI, along with the MessageHistory data
+        ChatCompletionData completionData = ChatCompletionData.create(messageHistory);
+
+        //Send the request to OpenAI, along with the MessageHistory data
+        CreateChatCompletion response = openAI.createChatCompletion(completionData);
+
+        //Store chat response from AI, this allows the AI to see the full history of our chat
+        //Including both our messages and the AI's messages
+        messageHistory.addAll(response.asChatResponseDataList());
+
+        //Replace \n & ascii characters (Šťŕĭńġ -> String)
+        return response.asNormalizedText();
+    }
+
+}

src/main/java/examples/ExampleGetModel.java

@@ -0,0 +1,50 @@
+package examples;
+
+import io.github.jetkai.openai.OpenAI;
+import io.github.jetkai.openai.api.GetModel;
+
+/**
+ * ExampleGetModel
+ *
+ * @author <a href="https://github.com/jetkai">Kai</a>
+ * @version 1.0.0
+ * {@code - 05/03/2023}
+ * @since 1.0.0
+ * {@code - 05/03/2023}
+ *
+ * <p>
+ * Note - This is just a test class, it is recommended to import this project as a library
+ * and then call OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+ * </p>
+ */
+public class ExampleGetModel {
+
+    /*
+     * You can get a free API key from https://platform.openai.com/account/api-keys
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY");
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+     */
+    private final OpenAI openAI = new OpenAI(System.getenv("OPEN_AI_API_KEY"));
+
+    public static void main(String[] args) {
+        //Initialize ExampleGetModel class
+        ExampleGetModel getModel = new ExampleGetModel();
+
+        String modelName = "davinci";
+
+        //Send request to API - response as JSON string
+        String modelJson = getModel.communicate(modelName);
+
+        //Print out the model information in JSON
+        System.out.println(modelJson);
+    }
+
+    private String communicate(String modelName) {
+        //Call the GetModels API from OpenAI & create instance
+        GetModel getModels = openAI.getModel(modelName);
+
+        //Return model as a JSON string
+        return getModels.asJson();
+    }
+
+}

src/main/java/examples/ExampleGetModels.java

@@ -0,0 +1,51 @@
+package examples;
+
+import io.github.jetkai.openai.OpenAI;
+import io.github.jetkai.openai.api.GetModels;
+import io.github.jetkai.openai.api.data.model.ModelData;
+
+import java.util.List;
+
+/**
+ * ExampleGetModels
+ *
+ * @author <a href="https://github.com/jetkai">Kai</a>
+ * @version 1.0.0
+ * {@code - 05/03/2023}
+ * @since 1.0.0
+ * {@code - 05/03/2023}
+ *
+ * <p>
+ * Note - This is just a test class, it is recommended to import this project as a library
+ * and then call OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+ * </p>
+ */
+public class ExampleGetModels {
+
+    /*
+     * You can get a free API key from https://platform.openai.com/account/api-keys
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY");
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+     */
+    private final OpenAI openAI = new OpenAI(System.getenv("OPEN_AI_API_KEY"));
+
+    public static void main(String[] args) {
+        //Initialize ExampleGetModels class
+        ExampleGetModels getModels = new ExampleGetModels();
+
+        //Send request to API and deserialize response as List<ModalData>
+        List<ModelData> models = getModels.communicate();
+
+        //Print out the names of all the available models, to the console
+        models.stream().map(ModelData::getId).forEach(System.out::println);
+    }
+
+    private List<ModelData> communicate() {
+        //Call the GetModels API from OpenAI & create instance
+        GetModels getModels = openAI.getModels();
+
+        //Return models as a data structure list, so that we can get the name from each model
+        return getModels.asDataList();
+    }
+
+}

src/main/java/examples/ExampleImageCreation.java

@@ -0,0 +1,72 @@
+package examples;
+
+import io.github.jetkai.openai.OpenAI;
+import io.github.jetkai.openai.api.CreateImage;
+import io.github.jetkai.openai.api.data.image.ImageData;
+
+import java.awt.*;
+import java.io.IOException;
+import java.net.URI;
+
+/**
+ * ExampleImageCreation
+ *
+ * @author <a href="https://github.com/jetkai">Kai</a>
+ * @version 1.0.0
+ * {@code - 05/03/2023}
+ * @since 1.0.0
+ * {@code - 05/03/2023}
+ *
+ * <p>
+ * Note - This is just a test class, it is recommended to import this project as a library
+ * and then call OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+ * </p>
+ */
+public class ExampleImageCreation {
+
+    /*
+     * You can get a free API key from https://platform.openai.com/account/api-keys
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY");
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+     */
+    private final OpenAI openAI = new OpenAI(System.getenv("OPEN_AI_API_KEY"));
+
+    public static void main(String[] args) throws IOException {
+        //Initialize ExampleImageCreation class
+        ExampleImageCreation imageCreation = new ExampleImageCreation();
+
+        //A text description of the desired image(s). The maximum length is 1000 characters
+        String description = "A picture of a red panda with glasses, drawn as a cartoon.";
+
+        //The number of images to generate. Must be between 1 and 10.
+        int amount = 1;
+
+        //The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024
+        String size = "1024x1024";
+
+        URI[] imageLinks = imageCreation.communicate(description, amount, size);
+
+        for(URI imageLink : imageLinks) {
+            System.out.println("Opening URI ["+imageLink+"] in the web browser.");
+            Desktop.getDesktop().browse(imageLink);
+        }
+    }
+
+    private URI[] communicate(String imageDescription, int numberOfImages, String size) {
+        //Alternatively can use ImageData.create(imageDescription, numberOfImages, size);
+        ImageData imageData = ImageData.create()
+                //A text description of the desired image(s). The maximum length is 1000 characters
+                .setPrompt(imageDescription)
+                //The number of images to generate. Must be between 1 and 10.
+                .setN(numberOfImages)
+                //The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024
+                .setSize(size);
+
+        //Call the CreateImage API from OpenAI & create instance
+        CreateImage createImage = openAI.createImage(imageData);
+
+        //Gather the URI(s) from the API response
+        return createImage.asUriArray();
+    }
+
+}

src/main/java/examples/ExampleSpellingCorrection.java

@@ -0,0 +1,58 @@
+package examples;
+
+import io.github.jetkai.openai.OpenAI;
+import io.github.jetkai.openai.api.CreateEdit;
+import io.github.jetkai.openai.api.data.edit.EditData;
+
+/**
+ * ExampleSpellingCorrection
+ *
+ * @author <a href="https://github.com/jetkai">Kai</a>
+ * @version 1.0.0
+ * {@code - 05/03/2023}
+ * @since 1.0.0
+ * {@code - 05/03/2023}
+ *
+ * <p>
+ * Note - This is just a test class, it is recommended to import this project as a library
+ * and then call OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+ * </p>
+ */
+public class ExampleSpellingCorrection {
+
+    /*
+     * You can get a free API key from https://platform.openai.com/account/api-keys
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY");
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+     */
+    private final OpenAI openAI = new OpenAI(System.getenv("OPEN_AI_API_KEY"));
+
+    public static void main(String[] args) {
+        //Initialize ExampleSpellingCorrection class
+        ExampleSpellingCorrection getModel = new ExampleSpellingCorrection();
+
+        String spellingMistake = "Wha dai of the wek is it?";
+        String instruction = "Fix the spelling mistakes";
+
+        //Send request to API - response as string
+        String spellingCorrection = getModel.communicate(spellingMistake, instruction);
+
+        //Print out the mistake & correction
+        System.out.println("Mistake: " + spellingMistake);
+        System.out.println("Correction: " + spellingCorrection);
+    }
+
+    private String communicate(String spellingMistake, String instruction) {
+        //Call the GetModels API from OpenAI & create instance
+        //You can also specify the model and use the following:
+        //EditData.create(model, spellingMistake, instruction);
+        EditData editData = EditData.create(spellingMistake, instruction);
+
+        //Call the CreateEdit API from OpenAI & create instance
+        CreateEdit createEdit = openAI.createEdit(editData);
+
+        //Return model as a JSON string
+        return createEdit.asText();
+    }
+
+}

src/main/java/examples/ExampleTranscriptionFromAudioFile.java

@@ -0,0 +1,63 @@
+package examples;
+
+import io.github.jetkai.openai.OpenAI;
+import io.github.jetkai.openai.api.CreateTranscription;
+import io.github.jetkai.openai.api.data.audio.AudioData;
+
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.nio.file.Path;
+
+/**
+ * ExampleTranscriptionFromAudioFile
+ *
+ * @author <a href="https://github.com/jetkai">Kai</a>
+ * @version 1.0.0
+ * {@code - 05/03/2023}
+ * @since 1.0.0
+ * {@code - 05/03/2023}
+ *
+ * <p>
+ * Note - This is just a test class, it is recommended to import this project as a library
+ * and then call OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+ * </p>
+ */
+public class ExampleTranscriptionFromAudioFile {
+
+    /*
+     * You can get a free API key from https://platform.openai.com/account/api-keys
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY");
+     * private final OpenAI openAI = new OpenAI("YOUR_API_KEY", "YOUR_ORGANIZATION");
+     */
+    private final OpenAI openAI = new OpenAI(System.getenv("OPEN_AI_API_KEY"));
+
+    public static void main(String[] args) throws URISyntaxException {
+        //Initialize ExampleTranslationFromAudioFile class
+        ExampleTranscriptionFromAudioFile transcriptAudioFile = new ExampleTranscriptionFromAudioFile();
+
+        //Example audio file that we are going to upload to OpenAI to be translated
+        URL audioUrl = ExampleTranscriptionFromAudioFile.class.getResource("what-can-i-do.mp3");
+        Path filePath = null;
+        if (audioUrl != null) {
+            filePath = Path.of(audioUrl.toURI());
+        }
+
+        //Response from OpenAI with the translated string
+        String response = transcriptAudioFile.communicate(filePath);
+
+        //Print the translation to the console
+        System.out.println(response);
+    }
+
+    private String communicate(Path filePath) {
+        //AudioData, ready to send to the OpenAI API
+        AudioData transcriptionData = AudioData.create(filePath);
+
+        //Call the CreateTranscription API from OpenAI & create instance
+        CreateTranscription createTranslation = openAI.createTranscription(transcriptionData);
+
+        //Return as text, do not replace \n or ascii characters
+        return createTranslation.asText();
+    }
+
+}