refine, documentation, sample and structuring

- add the java docs.
- refine the classes style.
- update the sample project to call text2speech.

Author: Barqawiz

README.md

@@ -1,5 +1,5 @@
 # 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.6.2)
+[![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)
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/Barqawiz/IntelliJava?style=for-the-badge)](https://github.com/Barqawiz/IntelliJava/releases)
 [![GitHub](https://img.shields.io/github/license/Barqawiz/IntelliJava?style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)
 
@@ -9,12 +9,13 @@ Intelligent java (IntelliJava) is the ultimate tool for Java developers looking
 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.
 - **Cohere.ai**: Generate text; Cohere allows you to generate your language model to suit your specific needs.
+- **Google AI**: Generate audio from text; Access DeepMind’s speech models.
 
 # How to use
 
 1. Import the core jar file OR maven dependency (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 and ``RemoteImageModel`` for image generation.
+3. Call the ``RemoteLanguageModel`` for the language models, ``RemoteImageModel`` for image generation and ``RemoteSpeechModel`` for text to speech models.
 
 ## Integration
 The package released to Maven Central Repository:
@@ -24,23 +25,23 @@ Maven:
 <dependency>
     <groupId>io.github.barqawiz</groupId>
     <artifactId>intellijava.core</artifactId>
-    <version>0.6.2</version>
+    <version>0.7.0</version>
 </dependency>
 ```
 
 Gradle:
 
 ```
-implementation 'io.github.barqawiz:intellijava.core:0.6.2'
+implementation 'io.github.barqawiz:intellijava.core:0.7.0'
 ```
 
 Gradle(Kotlin):
 ```
-implementation("io.github.barqawiz:intellijava.core:0.6.2")
+implementation("io.github.barqawiz:intellijava.core:0.7.0")
 ```
 
 Jar download:
-[intellijava.jar](https://repo1.maven.org/maven2/io/github/barqawiz/intellijava.core/0.6.2/intellijava.core-0.6.2.jar).
+[intellijava.jar](https://repo1.maven.org/maven2/io/github/barqawiz/intellijava.core/0.6.2/intellijava.core-0.7.0.jar).
 
 For ready integration: try the [sample_code](https://github.com/Barqawiz/IntelliJava/tree/main/sample_code).
 
@@ -80,21 +81,21 @@ The only dependencies is **GSON**.
 For Maven:
 ```
 <dependency>
-    <groupId>com.google.code.gson</groupId>
-    <artifactId>gson</artifactId>
-    <version>2.8.9</version>
+  <groupId>com.google.code.gson</groupId>
+  <artifactId>gson</artifactId>
+  <version>2.10.1</version>
 </dependency>
 ```
 
 For Gradle:
 ```
 dependencies {
-  implementation 'com.google.code.gson:gson:2.8.9'
+  implementation 'com.google.code.gson:gson:2.10.1'
 }
 ```
 
 For jar download:
-[gson download repo](https://search.maven.org/artifact/com.google.code.gson/gson/2.8.9/jar)
+[gson download repo](https://search.maven.org/artifact/com.google.code.gson/gson/2.10.1/jar)
 
 ## Documentation
 [Go to Java docs](https://barqawiz.github.io/IntelliJava/javadocs/)
@@ -106,12 +107,11 @@ Call for contributors:
 - [ ] Add support to other OpenAI functions.
 - [x] Add support to cohere generate API.
 - [ ] Add support to Google language models.
+- [x] Add support to Google speech models.
 - [ ] Add support to Amazon language models.
-- [ ] Add support to Azure models.
+- [ ] Add support to Azure nlp models.
 - [ ] Add support to Midjourney image generation.
 - [ ] Add support to WuDao 2.0 model.
-- [ ] Add support to an audio model.
-
 
 # License
 Apache License

core/com.intellijava.core/pom.xml

@@ -66,7 +66,7 @@
     <dependency>
       <groupId>com.google.code.gson</groupId>
       <artifactId>gson</artifactId>
-      <version>2.8.9</version>
+      <version>2.10.1</version>
     </dependency>
   </dependencies>
 

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

@@ -1,4 +1,20 @@
+/**
+ * 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.core.controller;
+
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -11,11 +27,32 @@
 import com.intellijava.core.utils.AudioHelper;
 import com.intellijava.core.wrappers.GoogleAIWrapper;
 
+/**
+ * RemoteSpeechModel class provides a remote speech model implementation. 
+ * It generates speech from text using the Wrapper classes. 
+ * 
+ * This version support google speech models only.
+ * 
+ * To use Google speech services:
+ * 1- Go to console.cloud.google.com.
+ * 2- Enable "Cloud Text-to-Speech API".
+ * 3- Generate API key from "Credentials" page. 
+ * 
+ *  @author github.com/Barqawiz
+ */
 public class RemoteSpeechModel {
 
 	private SpeechModels keyType;
 	private GoogleAIWrapper wrapper;
 
+	/**
+	 * 
+	 * Constructs a new RemoteSpeechModel object with the specified key value and key type string.
+	 * If keyTypeString is empty, it is set to "google" by default.
+	 * 
+	 * @param keyValue the API key value to use.
+	 * @param keyTypeString the string representation of the key type.
+	 */
 	public RemoteSpeechModel(String keyValue, String keyTypeString) {
 
 		if (keyTypeString.isEmpty()) {
@@ -33,16 +70,34 @@ public RemoteSpeechModel(String keyValue, String keyTypeString) {
 		}
 	}
 
+	/**
+	 * 
+	 * Constructs a new RemoteSpeechModel object with the specified key value and key type.
+	 * 
+	 * @param keyValue The API key value to use.
+	 * @param keyType The SpeechModels enum value representing the key type.
+	 */
 	public RemoteSpeechModel(String keyValue, SpeechModels keyType) { 
 		this.initiate(keyValue, keyType);
 	}
 
+	/**
+	 * Initiate the object with the specified key value and key type.
+	 * 
+	 * @param keyValue the API key value to use.
+	 * @param keyType the SpeechModels enum value representing the key type.
+	 */
 	private void initiate(String keyValue, SpeechModels keyType) {
 
 		this.keyType = keyType;
 		wrapper = new GoogleAIWrapper(keyValue);
 	}
 
+	/**
+	 * Get a list of supported key type models.
+	 * 
+	 * @return list of the supported SpeechModels enum values.
+	 */
 	public List<String> getSupportedModels() {
 		SpeechModels[] values = SpeechModels.values();
 		List<String> enumValues = new ArrayList<>();
@@ -54,6 +109,15 @@ public List<String> getSupportedModels() {
 		return enumValues;
 	}
 
+	/**
+	 * Generates speech from text using the support models.
+	 * 
+	 * You can save the returned byte to audio file using FileOutputStream("path/audio.mp3"). 
+	 * 
+	 * @param input SpeechInput object containing the text and gender to use.
+	 * @return byte array of the decoded audio content.
+	 * @throws IOException in case of communication error.
+	 */
 	public byte[] generateEnglishText(SpeechInput input) throws IOException {
 
 		if (this.keyType == SpeechModels.google) {
@@ -63,14 +127,23 @@ public byte[] generateEnglishText(SpeechInput input) throws IOException {
 		}
 	}
 
-	private byte[] generateGoogleText(String text, Gender geneder, String language) throws IOException {
+	/**
+	 * Generates speech from text using the Google Speech service API.
+	 * 
+	 * @param text text to generate the speech.
+	 * @param gender gender to use (male or female).
+	 * @param language en-gb.
+	 * @return
+	 * @throws IOException in case of communication error.
+	 */
+	private byte[] generateGoogleText(String text, Gender gender, String language) throws IOException {
 		byte[] decodedAudio = null;
 
 		Map<String, Object> params = new HashMap<>();
 		params.put("text", text);
 		params.put("languageCode", language);
 
-		if (geneder == Gender.FEMALE) {
+		if (gender == Gender.FEMALE) {
 			params.put("name", "en-GB-Standard-A");
 			params.put("ssmlGender", "FEMALE");
 		} else {

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

@@ -1,16 +1,55 @@
+/**
+ * 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.core.model;
 
 import com.google.gson.annotations.SerializedName;
 
+/**
+ * 
+ * AudioResponse represents the response from the speech API that contains the audio content.
+ * 
+ * @author github.com/Barqawiz
+ *
+ */
 public class AudioResponse extends BaseRemoteModel {
 
+	/**
+	 * Default AudioResponse constructor.
+	 */
+	public AudioResponse() {}
+	
+	/**
+	 * The audio content generated from a text.
+	 */
 	@SerializedName("audioContent")
     private String audioContent;
 
+	/**
+	 * Gets the audio content generated from a text.
+	 * @return audio content as a base64 string.
+	 */
 	public String getAudioContent() {
 		return audioContent;
 	}
 
+	/**
+	 * Sets the audio content generated from a text.
+	 * 
+	 * @param audioContent audio content as a base64 string.
+	 */
 	public void setAudioContent(String audioContent) {
 		this.audioContent = audioContent;
 	}

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

@@ -1,5 +1,11 @@
 package com.intellijava.core.model;
 
+/**
+ * Supported speech models.
+ * 
+ * @author github.com/Barqawiz
+ *
+ */
 public enum SpeechModels {
-	google
+	/** google model */google
 }

core/com.intellijava.core/src/main/java/com/intellijava/core/model/input/ImageModelInput.java

@@ -110,7 +110,7 @@ public ImageModelInput build() {
         }
     }
     /**
-     * Getter for prompt.
+     * Getter for prompt the text of the required action or the question.
      * @return prompt
      */
     public String getPrompt() {
@@ -146,7 +146,7 @@ public void setPrompt(String prompt) {
 
 	/**
 	 * Setter for numberOfImages.
-	 * @param numberOfImages
+	 * @param numberOfImages the number of the generated images.
 	 */
 	public void setNumberOfImages(int numberOfImages) {
 		this.numberOfImages = numberOfImages;
@@ -156,7 +156,7 @@ public void setNumberOfImages(int numberOfImages) {
 	/**
 	 * Setter for imageSize.
 	 * 
-	 * @param imageSize
+	 * @param imageSize the size of the generated images, options are: 256x256, 512x512, or 1024x1024.
 	 */
 	public void setImageSize(String imageSize) {
 		this.imageSize = imageSize;

core/com.intellijava.core/src/main/java/com/intellijava/core/model/input/LanguageModelInput.java

@@ -203,7 +203,7 @@ public void setPrompt(String prompt) {
 	/**
 	 * Setter for temperature.
 	 * 
-	 * @param temperature
+	 * @param temperature higher values means more risks and creativity.
 	 */
 	public void setTemperature(float temperature) {
 		this.temperature = temperature;
@@ -212,7 +212,7 @@ public void setTemperature(float temperature) {
 	/**
 	 * Setter for maxTokens.
 	 * 
-	 * @param maxTokens
+	 * @param maxTokens maximum size of the model input and output.
 	 */
 	public void setMaxTokens(int maxTokens) {
 		this.maxTokens = maxTokens;
@@ -221,7 +221,7 @@ public void setMaxTokens(int maxTokens) {
 	/**
 	 * Setter for numberOfOutputs.
 	 * 
-	 * @param numberOfOutputs
+	 * @param numberOfOutputs number of model outputs, default value is 1.
 	 */
 	public void setNumberOfOutputs(int numberOfOutputs) {
 		this.numberOfOutputs = numberOfOutputs;