update the web page with chatGPT details

Barqawiz · Barqawiz · commit c797a6a8a994 · 2023-03-04T13:28:55.000Z
diff --git a/README.md b/README.md
@@ -1,20 +1,20 @@
 # Intelligent Java
 
-[![Maven Central](https://img.shields.io/maven-central/v/io.github.barqawiz/intellijava.core?style=for-the-badge)](https://central.sonatype.com/artifact/io.github.barqawiz/intellijava.core/0.7.0)
+[![Maven Central](https://img.shields.io/maven-central/v/io.github.barqawiz/intellijava.core?style=for-the-badge)](https://central.sonatype.com/artifact/io.github.barqawiz/intellijava.core/0.8.0)
 [![GitHub](https://img.shields.io/github/license/Barqawiz/IntelliJava?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
 
-Intelligent java is the ultimate tool for Java developers looking to integrate with the latest language models and deep learning frameworks. The library provides a simple and intuitive API with convenient methods for sending input to models like GPT-3 and DALL·E, and receiving generated text, speech or images. With just a few lines of code, you can easily access the power of cutting-edge AI models to enhance your projects.
+Intelligent java (IntelliJava) is the ultimate tool to integrate with the latest language models and deep learning frameworks using java. The library provides an intuitive functions for sending input to models like ChatGPT and DALL·E, and receiving generated text, speech or images. With just a few lines of code, you can easily access the power of cutting-edge AI models to enhance your projects.
 
 The supported models:
-- **OpenAI**: Access GPT-3 to generate text and DALL·E to generate images. OpenAI is preferred when you want quality results without tuning.
+- **OpenAI**: Access ChatGPT, GPT3 to generate text and DALL·E to generate images. OpenAI is preferred for quality results without tuning.
 - **Cohere.ai**: Generate text; Cohere allows you to generate a language model to suit your specific needs.
 - **Google AI**: Generate audio from text; Access DeepMind’s speech models.
 
 # How to use
 
 1. Add the maven dependency or import the core jar file (check the Integration section).
 2. Add Gson dependency if using the jar file; otherwise, it's handled by maven or Gradle.
-3. Call the ``RemoteLanguageModel`` for the language models, ``RemoteImageModel`` for image generation and ``RemoteSpeechModel`` for text to speech models.
+3. Call the ``RemoteLanguageModel`` for the language models, ``RemoteImageModel`` for image generation and ``RemoteSpeechModel`` for text to speech models, ``Chatbot`` for ChatGPT.
 
 ## Integration
 The package released to Maven Central Repository:
@@ -24,23 +24,23 @@ Maven:
 <dependency>
     <groupId>io.github.barqawiz</groupId>
     <artifactId>intellijava.core</artifactId>
-    <version>0.7.0</version>
+    <version>0.8.0</version>
 </dependency>
 ```
 
 Gradle:
 
 ```
-implementation 'io.github.barqawiz:intellijava.core:0.7.0'
+implementation 'io.github.barqawiz:intellijava.core:0.8.0'
 ```
 
 Gradle(Kotlin):
 ```
-implementation("io.github.barqawiz:intellijava.core:0.7.0")
+implementation("io.github.barqawiz:intellijava.core:0.8.0")
 ```
 
 Jar download:
-[intellijava.jar](https://repo1.maven.org/maven2/io/github/barqawiz/intellijava.core/0.7.0/intellijava.core-0.7.0.jar).
+[intellijava.jar](https://repo1.maven.org/maven2/io/github/barqawiz/intellijava.core/0.8.0/intellijava.core-0.8.0.jar).
 
 ## Code Example
 **Language model code** (2 steps):
@@ -55,7 +55,9 @@ LanguageModelInput langInput = new LanguageModelInput.Builder("Summarize the plo
 String resValue = langModel.generateText(langInput);
 ```
 Output:```Inception follows Dom Cobb, a professional thief, who is offered a chance at redemption in exchange for planting an idea in a target's mind. He must navigate a dangerous landscape of dream-sharing technology and battle his inner demons in order to complete the mission and find his way back to reality.```
-<br><br>
+
+<br>
+
 **Image generation code** (2 steps):
 ```java
 // 1- initiate the remote image model
@@ -68,7 +70,27 @@ List<String> images = imageModel.generateImages(imageInput);
 ```
 Output:<br>
 <img src="images/response_image.png" height="220px">
-<br><br>
+
+<br>
+
+**ChatGPT code**:
+```java
+// 1- initiate the chat model.
+Chatbot bot = new Chatbot(apiKey, "openai");
+
+// 2- prepare the chat history by calling addMessage.
+String mode = "You are a helpful astronomy assistant.";
+ChatModelInput input = new ChatGPTInput.Builder(mode)
+								.addUserMessage("what is the space between moon and earth")
+								.build();
+
+// 3- call chat!
+List<String> resValues =  bot.chat(input);
+```
+Output:``` The average distance between the Moon and the Earth is about 238,855 miles (384,400 kilometers). ```
+
+<br>
+
 **Text to speech code** (2 steps):
 ```java
 // 1- initiate the remote speech model
@@ -81,7 +103,7 @@ byte[] decodedAudio = model.generateEnglishText(input);
 Output:
 <iframe width="100%" height="166" scrolling="no" frameborder="no" allow="autoplay" src="https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/tracks/1450836247&color=%2328262c&auto_play=false&hide_related=false&show_comments=true&show_user=true&show_reposts=false&show_teaser=true"></iframe><div style="font-size: 10px; color: #cccccc;line-break: anywhere;word-break: normal;overflow: hidden;white-space: nowrap;text-overflow: ellipsis; font-family: Interstate,Lucida Grande,Lucida Sans Unicode,Lucida Sans,Garuda,Verdana,Tahoma,sans-serif;font-weight: 100;"><a href="https://soundcloud.com/sam-572736789" title="Sam" target="_blank" style="color: #cccccc; text-decoration: none;">Sam</a> · <a href="https://soundcloud.com/sam-572736789/intelligent-java-intro" title="Intelligent Java Intro" target="_blank" style="color: #cccccc; text-decoration: none;">Intelligent Java Intro</a></div>
 
-
+<br>
 
 For full example check the [sample_code project](https://github.com/Barqawiz/IntelliJava/tree/main/sample_code).
 
@@ -96,7 +118,7 @@ The only dependencies is **GSON**.
 
 # Roadmap
 Call for contributors:
-- [x]  Add support to OpenAI Completion API.
+- [x]  Add support to OpenAI Completion.
 - [x]  Add support to OpenAI DALL·E 2.
 - [ ]  Add support to other OpenAI functions.
 - [x]  Add support to cohere generate API.
