update to 0.4.0

Author: artemnefedov

README.md

@@ -1,126 +1,93 @@
 ![JavaAI logo](https://github.com/artemnefedov/JavaAI/blob/resource/img/javaAi_logo.png?raw=true)
 
-
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/artemnefedov/JavaAI?logo=GitHub)](https://github.com/artemnefedov/JavaAI/releases)
 [![Maven Central](https://img.shields.io/maven-central/v/io.github.artemnefedov/javaai.svg?label=Maven%20Central&logo=apachemaven)](https://central.sonatype.com/artifact/io.github.artemnefedov/javaai/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/artemnefedov/JavaAI/blob/main/LICENSE)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/1194ce221f4f46ed950d4b05e6fd248c)](https://app.codacy.com/gh/artemnefedov/JavaAI/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
-![GitHub repo size](https://img.shields.io/github/repo-size/artemnefedov/JavaAI)
 
 
 
 
-## JavaAI is an open source library that allows you to interact with OpenAI models with just a few lines of code
+## Is a lightweight and easy to use library that allows you to interact with OpenAI models with just a few lines of code
 
-#### Note:
+## How to use?
 
-> I wrote this library for myself since I couldn't find anything more suitable for my project, so I decided to share it
-> with the community. I hope this library will help you.<br>
-> Any help is welcome. I am always glad to hear new ideas and criticism.
+### Integration
 
-## How to use it?
+#### _Maven_
 
-### Integration
+```xml
+<dependency>
+    <groupId>io.github.artemnefedov</groupId>
+    <artifactId>javaai</artifactId>
+    <version>0.4.0</version>
+</dependency>
+```
+ ___
+#### _Gradle_
 
->#### _Maven_
->
->```xml
-><dependency>
->    <groupId>io.github.artemnefedov</groupId>
->    <artifactId>javaai</artifactId>
->    <version>0.3.5</version>
-></dependency>
->```
-> ___
->#### _Gradle_
->
->```groovy
->implementation 'io.github.artemnefedov:javaai:0.3.5'
->```
+```groovy
+implementation 'io.github.artemnefedov:javaai:0.4.0'
+```
 
 ### Initialize JavaAI
 
-> You can pass your _**API-Key**_ in java code
->```java
->JavaAI javaAI = javaAiBuilder("YOUR_API-KEY");
->```
-> ___
->
-> Or paste it into the api-key field in the _**javaai.yaml**_, everyone loves yaml
->```yaml
->openai:
->   api-key: "YOUR_API-KEY"
->```
->```java
->JavaAI javaAI = javaAiBuilder();
->```
+```java
+   JavaAI javaAI = javaAiBuilder("YOUR_API-KEY");
+```
 
 ## Java AI example
 
 ### ChatGPT
 
->You have 2 options to use JavaAI to work with ChatGPT.
+You have 2 options to use JavaAI to work with ChatGPT.
 You can make a first request using List<ChatMessage> to set the context and get a response, and after that use a string.
 <br>Both options retain the message history.
 <br>The "**assistant**" role is used by default for answers, be careful.
->```java
->var messages = List.of(
->        new ChatMessage("user","Hello!"),
->        new ChatMessage("assistant","Hello! How can I assist you today?"));
->
->String chatResponse = javaAI.chat(messages);
->```
->#### _OR_
->```java
->javaAI.chat("What's 2 2?"); 
->javaAI.chat("What did I ask in the last question?");
->```
-> > **user:** What's 2 2?<br>
-> > **assistant:** 2 + 2 equals 4<br>
-> > **user**: What did I ask in the last question?<br>
-> > **assistant**: In your last question, you asked "What's 2 2?"<br>
+```java
+var messages = List.of(
+        new ChatMessage("user","Hello!"),
+        new ChatMessage("assistant","Hello! How can I assist you today?"));
+
+String chatResponse = javaAI.chat(messages);
+```
+#### _OR_
+```java
+javaAI.chat("What's 2 2?"); 
+javaAI.chat("What did I ask in the last question?");
+```
+> ### Example of communication
+> **user:** What's 2 2?<br>
+> **assistant:** 2 + 2 equals 4<br>
+> **user**: What did I ask in the last question?<br>
+> **assistant**: In your last question, you asked "What's 2 2?"<br>
 ---
 ### DALL·E 2
->Image generation, the model will return a URL to the result, as a List of String
->```java
->String imgUrl = javaAI.generateImage("cat sitting next to a cup of coffee");
->```
-> ![cat_image](https://github.com/artemnefedov/JavaAI/blob/resource/img/cat_%20of_coffee.png?raw=true)
+Image generation, the model will return a URL to the result, as a List of String
+```java
+String imgUrl = javaAI.generateImage("cat sitting next to a cup of coffee");
+```
+ ![cat_image](https://github.com/artemnefedov/JavaAI/blob/resource/img/cat_%20of_coffee.png?raw=true)
 ---
 ### Completions
->Text generation, the model will return the response as a String
->```java
->String response = javaAI.generateText("Say this is a test");
->```
+Text generation, the model will return the response as a String
+```java
+String response = javaAI.generateText("Say this is a test");
+```
 ---
-**Notice:**
 
-> You can always set your parameters for the models
+### You can always set your parameters for the models
 
 Example for Chat:
-> _In java code_
->```java
->javaAI.setChat(
->        Chat.builder()
->            .messages(new ArrayList<>())
->            .model("gpt-3.5-turbo")
->            .maxTokens(2000)
->            .n(1)
->            .build()
->        );
->```
-> _or in **javaai.yaml**_(if you use javaai.yaml to pass api-key)
-> ```yaml
-> chat:
->   model: gpt-3.5-turbo
->   temperature: 0.9
->   top_p: 1
->   n: 1
->   stream: false
->   stop: \n
->   max_tokens: 2000
->   user:
-> ```
+```java
+javaAI.setChat(
+        Chat.builder()
+            .messages(new ArrayList<>())
+            .model("gpt-3.5-turbo")
+            .maxTokens(2000)
+            .n(1)
+            .build()
+        );
+```
 ---
 
 ## Models that JavaAI works with:
@@ -132,4 +99,4 @@ Example for Chat:
 ---
 ## License
 
-#### Distributed under the [MIT License](./LICENSE)
+#### Distributed under the [MIT License](./LICENSE)

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.artemnefedov</groupId>
     <artifactId>javaai</artifactId>
-    <version>0.3.5</version>
+    <version>0.4.0</version>
     <packaging>jar</packaging>
 
     <name>JavaAI</name>
@@ -74,12 +74,6 @@
             <version>5.10.0</version>
             <scope>test</scope>
         </dependency>
-
-        <dependency>
-            <groupId>org.yaml</groupId>
-            <artifactId>snakeyaml</artifactId>
-            <version>2.2</version>
-        </dependency>
     </dependencies>
 
     <build>

src/main/java/io/github/artemnefedov/javaai/dto/Chat.java

@@ -93,21 +93,13 @@ public record ChatResponse(
         /**
          * The type Chat choice.
          */
-        public record ChatChoice(
-                int index,
-                ChatMessage message,
-                String finishReason
-        ) {
+        public record ChatChoice(int index, ChatMessage message, String finishReason) {
         }
 
         /**
          * The type Usage.
          */
-        record Usage(
-                int promptTokens,
-                int completionTokens,
-                int totalTokens
-        ) {
+        record Usage(int promptTokens, int completionTokens, int totalTokens) {
         }
 
         /**
@@ -116,7 +108,6 @@ record Usage(
          * @return the response
          */
         public String getResponse() {
-
             return this.choices().get(0).message().getContent().trim();
         }
     }

src/main/java/io/github/artemnefedov/javaai/dto/ChatMessage.java

@@ -28,14 +28,12 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
-import lombok.ToString;
 
 /**
  * Helper class for {@link io.github.artemnefedov.javaai.dto.Chat}
  */
 @Getter
 @Setter
-@ToString
 @AllArgsConstructor
 @NoArgsConstructor
 public class ChatMessage {

src/main/java/io/github/artemnefedov/javaai/dto/Completions.java

@@ -101,22 +101,13 @@ public record LanguageModelResponse(
         /**
          * The type Choice.
          */
-        record Choice(
-                String text,
-                int index,
-                Object logprobs,
-                String finishReason
-        ) {
+        record Choice(String text, int index, Object logprobs, String finishReason) {
         }
 
         /**
          * The type Usage.
          */
-        record Usage(
-                int promptTokens,
-                int completionTokens,
-                int totalTokens
-        ) {
+        record Usage(int promptTokens, int completionTokens, int totalTokens) {
         }
 
         /**

src/main/java/io/github/artemnefedov/javaai/dto/ErrorDetails.java

@@ -68,11 +68,6 @@ public String getErrorDetails() {
     /**
      * The type Error.
      */
-    record Error(
-            String message,
-            String type,
-            String param,
-            String code
-    ) {
+    record Error(String message, String type, String param, String code) {
     }
 }

src/main/java/io/github/artemnefedov/javaai/dto/ImageBuilder.java

@@ -25,27 +25,29 @@
 package io.github.artemnefedov.javaai.dto;
 
 import com.google.gson.annotations.SerializedName;
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.Data;
-import lombok.NoArgsConstructor;
+import lombok.Getter;
+import lombok.Setter;
 
 import java.util.List;
 
 /**
  * dto to send a request to the <a href="https://platform.openai.com/docs/api-reference/images/create">Create image</a>.
  */
-@Data
-@Builder
-@AllArgsConstructor
-@NoArgsConstructor
+@Getter
+@Setter
 public class ImageBuilder implements OpenAIModel {
 
     private String prompt;
-    private final int n = 1;
-    private final String size = "1024x1024";
+    private final int n;
+    private final String size;
     @SerializedName("response_format")
-    private final String responseFormat = "url";
+    private final String responseFormat;
+
+    public ImageBuilder() {
+        this.n = 1;
+        this.size = "1024x1024";
+        this.responseFormat = "url";
+    }
 
     @Override
     public Class<? extends ModelResponse> getResponseModel() {
@@ -57,23 +59,17 @@ public Class<? extends ModelResponse> getResponseModel() {
      */
     public record ImageModelResponse(
             long created,
-            List<ImageData> data
-
-    ) implements ModelResponse {
+            List<ImageData> data) implements ModelResponse {
 
         @Override
         public String getResponse() {
-
             return this.data.get(0).url();
         }
 
         /**
          * The type Image data.
          */
-        public record ImageData(
-                String url,
-                String b64Json
-        ) {
+        public record ImageData(String url, String b64Json) {
         }
     }
 }

src/main/java/io/github/artemnefedov/javaai/service/JavaAI.java

@@ -89,15 +89,6 @@ static JavaAI javaAiBuilder(String apiKey) {
         return new JavaAIImplementation(apiKey);
     }
 
-    /**
-     * JavaAI builder
-     *
-     * @return the JavaAI implementation
-     */
-    static JavaAI javaAiBuilder() {
-        return new JavaAIImplementation();
-    }
-
     /**
      * Sets your dto to work with the API
      *