Refactor AIChatbot examples and improve error handling in API requests

Author: bayeggex

Docs.md

@@ -29,21 +29,19 @@ Before using the AI Chat Library, you need to set your API keys for the respecti
 AIChatbot chatbot;
 
 void setup() {
-    Serial.begin(115200);
+    chatbot.begin(115200);
 
     // Set API keys
     chatbot.setKey("YOUR_CHATGPT_API_KEY", "chatgpt");
     chatbot.setKey("YOUR_HUGGING_FACE_API_KEY", "huggingface");
 
-    // Begin WiFi connection
-    WiFi.begin("SSID", "PASSWORD");
-    while (WiFi.status() != WL_CONNECTED) {
-        delay(1000);
-        Serial.println("Connecting to WiFi...");
+    // Connect to WiFi
+    if (!chatbot.connectWiFi("SSID", "PASSWORD")) {
+        Serial.println("Failed to connect to WiFi");
+        while (true); // Halt if WiFi connection fails
     }
-    Serial.println("Connected to WiFi");
 
-    // Select AI and optionally specify version
+    // Select AI service and optionally specify version
     chatbot.selectAI("chatgpt", "gpt-3.5-turbo");
 }
 
@@ -55,6 +53,28 @@ void loop() {
 
 ### 📄Functions
 
+### `begin(long baudRate)`
+
+- **Description**: Initializes the serial communication with the specified baud rate.
+- **Parameters**:
+  - `baudRate`: The baud rate for serial communication (e.g., 115200).
+- **Example**:
+  ```cpp
+  chatbot.begin(115200);
+
+#### `connectWiFi(const char* ssid, const char* password, unsigned long timeoutMs = 10000)`
+
+- **Description**: Connects to a WiFi network with the given SSID and password.
+- **Parameters**:
+  - `ssid`: WiFi SSID(Name).
+  - `password`: WiFi password.
+  - `timeoutMs`:  (optional): Connection timeout in milliseconds (default is 10 seconds).
+- **Example**:
+  ```cpp
+    if (!chatbot.connectWiFi("YourSSID", "YourPassword")) {
+      Serial.println("WiFi connection failed");
+    }
+
 #### `selectAI(const String& aiName, const String& aiVersion = "gpt-3.5-turbo")`
 
 - **Description**: Selects the AI service to use.
@@ -75,7 +95,7 @@ void loop() {
   ```cpp
   chatbot.setKey("YOUR_CHATGPT_API_KEY", "chatgpt");
 
-#### `send(const String& message)`
+#### `getResponse(const String& message)`
 
 - **Description**: Sends a message to the selected AI service manually.
 - **Parameters**:
@@ -93,3 +113,102 @@ void loop() {
   void loop() {
     chatbot.update();
   }
+
+### `sanitizeInput(const String& input)`
+
+- **Description**: Sanitizes the input string to prevent issues with special characters.
+- **Parameters**:
+  - `input`:The input string to sanitize.
+
+
+### 🔧 Internal Functions (Private)
+
+These functions are used internally by the library and are not intended to be called directly by users.
+
+`sendToChatGPT(const String& message)`
+
+- Sends a message to the OpenAI ChatGPT API and returns the response.
+
+`sendToHuggingFace(const String& message)`
+
+- Sends a message to the Hugging Face API and returns the response.
+
+`makeHttpRequest(const String& url, const String& payload, const String& apiKey)`
+
+-Makes an HTTP POST request to the specified URL with the given payload and API key.
+
+### 📚 Header File (AIChatbot.h)
+
+```h
+#ifndef AI_CHATBOT_H
+#define AI_CHATBOT_H
+
+#include <Arduino.h>
+
+#if defined(ESP32)
+#include <WiFi.h>
+#include <WiFiClientSecure.h>
+#include <HTTPClient.h>
+#define PLATFORM_NAME "ESP32"
+#elif defined(ESP8266)
+#include <ESP8266WiFi.h>
+#include <ESP8266HTTPClient.h>
+#define PLATFORM_NAME "ESP8266"
+#endif
+
+class AIChatbot {
+public:
+    AIChatbot();
+    bool connectWiFi(const char* ssid, const char* password, unsigned long timeoutMs = 10000);
+    bool validateKeys();
+    void begin(long baudRate);
+    void update();
+    void setKey(const String& key, const String& aiName);
+    void selectAI(const String& aiName, const String& aiVersion = "gpt-3.5-turbo");
+    String sanitizeInput(const String& input);
+    String getResponse(const String& message);
+
+private:
+    String chatGPTApiKey;
+    String huggingFaceApiKey;
+    String selectedAI;
+    String selectedAIVersion;
+    String sendToChatGPT(const String& message);
+    String sendToHuggingFace(const String& message);
+    String makeHttpRequest(const String& url, const String& payload, const String& apiKey);
+};
+
+#endif // AI_CHATBOT_H
+```
+
+### 🔧 Example Sketches
+
+`AITranslation.ino`: Demonstrates translation capabilities using the library.
+
+`ChatGPT.ino`: Example of integrating with ChatGPT for general conversation.
+
+`DataTest.ino`: Verifies communication and tests various AI responses.
+
+`HuggingFace.ino`: Shows usage with Hugging Face models.
+
+`QuestionAnswering.ino`: Example for question-answering tasks.
+
+`TextGeneration.ino`: Demonstrates text generation capabilities.
+
+`TextSummarization.ino`: Example for summarizing input text.
+
+### 📈 Roadmap
+
+- Add support for more AI services.
+
+- Improve error handling and debugging tools.
+
+- Enhance documentation with more detailed examples.
+
+- Voice & Image Cration.
+
+### 🛠️ Support
+
+For [issues](https://github.com/bayeggex/Arduino-AI-Chat-Library/issues/new), [feature requests](https://github.com/bayeggex/Arduino-AI-Chat-Library/issues/new), or [Contributions](https://github.com/bayeggex/Arduino-AI-Chat-Library/pulls), please visit the [GitHub repository](https://github.com/bayeggex/Arduino-AI-Chat-Library).
+
+This library is maintained by [BayEggex](https://github.com/bayeggex). Contributions are welcome!

examples/Datatest/AITranslation.ino

@@ -1,19 +1,38 @@
-#include <AIChatbot.h>
+#include "AIChatbot.h" // Include the AIChatbot library
 
-AIChatbot chatbot;
+AIChatbot chatbot; // Create an instance of AIChatbot
+
+// WiFi and API credentials
+const char* ssid = "YOUR_SSID";
+const char* password = "YOUR_PASSWORD";
+const char* apiKey = "YOUR_API_KEY";
 
 void setup() {
-    Serial.begin(115200);
-    chatbot.setKey("YOUR_CHATGPT_API_KEY", "chatgpt");
-    chatbot.connectWiFi("YOUR_SSID", "YOUR_PASSWORD");
-    chatbot.selectAI("chatgpt", "gpt-3.5-turbo");
+    Serial.begin(115200); // Initialize serial communication at 115200 baud rate
+    chatbot.begin(115200); // Initialize chatbot communication at 115200 baud rate
+
+    // Connect to WiFi
+    if (chatbot.connectWiFi(ssid, password)) {
+        // Set the API key and select the AI model for translation
+        chatbot.setKey(apiKey, "huggingface");
+        chatbot.selectAI("huggingface", "Helsinki-NLP/opus-mt-en-tr"); // English to Turkish translation
+        Serial.println("WiFi connected. Enter text to translate:");
+    } else {
+        Serial.println("WiFi connection failed.");
+    }
 }
 
 void loop() {
     if (Serial.available() > 0) {
-        String incomingMessage = Serial.readString();
-        String message = "Translate this text to France: " + incomingMessage;
-        String response = chatbot.getResponse(message);
-        Serial.println("Translation: " + response);
+        String inputText = Serial.readStringUntil('\n');
+        inputText.trim();
+
+        if (inputText.length() > 0) {
+            String response = chatbot.getResponse(inputText);
+            Serial.println("Translated Text: " + response);
+        } else {
+            Serial.println("Please enter valid text.");
+        }
     }
 }
+

examples/Datatest/ChatGpt.ino

@@ -1,22 +1,40 @@
-#include <AIChatbot.h>
+#include "AIChatbot.h" // Include the AIChatbot library
 
-AIChatbot chatbot;
+AIChatbot chatbot; // Create an instance of the AIChatbot class
+
+// WiFi and ChatGPT API credentials
+const char* ssid = "YOUR_SSID";
+const char* password = "YOUR_PASSWORD";
+const char* apiKey = "YOUR_CHATGPT_API_KEY";
 
 void setup() {
-    //changed to ESP32 115200 or ESP8266 9600
-    Serial.begin(115200);
-    
-    // Set ChatGPT API key
-    chatbot.setKey("YOUR_CHATGPT_API_KEY", "chatgpt");
+    Serial.begin(115200); // Initialize serial communication at 115200 baud rate
+    chatbot.begin(115200); // Initialize chatbot communication at 115200 baud rate
 
-    // Begin WiFi connection
-    chatbot.connectWiFi("YOUR_SSID", "YOUR_PASSWORD");
-    
-    // Select AI and specify version
-    chatbot.selectAI("chatgpt", "gpt-3.5-turbo");
+    // Connect to WiFi
+    if (chatbot.connectWiFi(ssid, password)) {
+        // Set the API key and select the AI model
+        chatbot.setKey(apiKey, "chatgpt");
+        chatbot.selectAI("chatgpt", "gpt-3.5-turbo");
+        Serial.println("WiFi connected. Enter your question:");
+    } else {
+        Serial.println("WiFi connection failed.");
+    }
 }
 
 void loop() {
-    // Update and handle incoming messages
-    chatbot.update();
+    // Check if there is any data available in the serial buffer
+    if (Serial.available() > 0) {
+        // Read the input question from the serial monitor
+        String question = Serial.readStringUntil('\n');
+        question.trim(); // Remove any leading or trailing whitespace
+
+        // If the question is not empty, get the response from ChatGPT
+        if (question.length() > 0) {
+            String response = chatbot.getResponse(question);
+            Serial.println("ChatGPT Response: " + response); // Print the response
+        } else {
+            Serial.println("Please enter a valid question.");
+        }
+    }
 }

examples/Datatest/Datatest.ino

@@ -1,21 +1,38 @@
-#include <AIChatbot.h>
+#include "AIChatbot.h" // Include the AIChatbot library
 
-AIChatbot chatbot;
+AIChatbot chatbot; // Create an instance of the AIChatbot class
+
+// WiFi credentials and API key
+const char* ssid = "YOUR_SSID";
+const char* password = "YOUR_PASSWORD";
+const char* apiKey = "YOUR_API_KEY";
 
 void setup() {
-    Serial.begin(115200);
-    
-    // Set API keys
-    chatbot.setKey("YOUR_CHATGPT_API_KEY", "chatgpt");
+    Serial.begin(115200); // Initialize serial communication at 115200 baud rate
+    chatbot.begin(115200); // Initialize chatbot communication at 115200 baud rate
 
-    //Begin WiFi connection
-    chatbot.connectWiFi("YOUR_SSID", "YOUR_PASSWORD");
-    
-    // Select AI and optionally specify version
-    chatbot.selectAI("chatgpt", "gpt-3.5-turbo");
+    // Attempt to connect to WiFi
+    if (chatbot.connectWiFi(ssid, password)) {
+        chatbot.setKey(apiKey, "chatgpt"); // Set the API key for the chatbot
+        chatbot.selectAI("chatgpt"); // Select the AI model to use
+        Serial.println(" test ready. Enter any text:"); // Indicate that the is ready for input
+    } else {
+        Serial.println("WiFi connection failed."); // Indicate that the WiFi connection failed
+    }
 }
 
 void loop() {
-    // Update and handle incoming messages
-    chatbot.update();
-}
+    // Check if there is any input from the serial monitor
+    if (Serial.available() > 0) {
+        String inputText = Serial.readStringUntil('\n'); // Read the input text until a newline character is encountered
+        inputText.trim(); // Remove any leading or trailing whitespace
+
+        // Check if the input text is not empty
+        if (inputText.length() > 0) {
+            String response = chatbot.getResponse(inputText); // Get the response from the chatbot
+            Serial.println("Response: " + response); // Print the response to the serial monitor
+        } else {
+            Serial.println("Please enter valid text."); // Prompt the user to enter valid text
+        }
+    }
+}

examples/Datatest/HuggingFace.ino

@@ -1,23 +1,41 @@
-#include <AIChatbot.h>
+#include "AIChatbot.h"  // Include the AIChatbot library
 
-AIChatbot chatbot;
+AIChatbot chatbot;  // Create an instance of the AIChatbot class
+
+// WiFi credentials
+const char* ssid = "YOUR_SSID";
+const char* password = "YOUR_PASSWORD";
+
+// API key for HuggingFace
+const char* apiKey = "YOUR_HUGGINGFACE_API_KEY";
 
 void setup() {
-    //changed to ESP32 115200 or ESP8266 9600
-    Serial.begin(115200);
-    
-    // Set API keys
-    chatbot.setKey("HUGGING FACE API KEY", "huggingface");
+    Serial.begin(115200);  // Initialize serial communication at 115200 baud rate
+    chatbot.begin(115200);  // Initialize the chatbot with the same baud rate
 
-    //Begin WiFi connection
-    chatbot.connectWiFi("YOUR_SSID", "YOUR_PASSWORD");
-    
-    // Select AI and optionally specify version
-    // Tested and used google/flan-t5-small
-    chatbot.selectAI("huggingface", "google/flan-t5-small");
+    // Attempt to connect to WiFi
+    if (chatbot.connectWiFi(ssid, password)) {
+        // Set the API key and select the AI model
+        chatbot.setKey(apiKey, "huggingface");
+        chatbot.selectAI("huggingface", "distilbert-base-uncased");
+        Serial.println("WiFi connected. Enter text:");
+    } else {
+        Serial.println("WiFi connection failed.");
+    }
 }
 
 void loop() {
-    // Update and handle incoming messages
-    chatbot.update();
-}
+    // Check if there is any input from the serial monitor
+    if (Serial.available() > 0) {
+        String inputText = Serial.readStringUntil('\n');  // Read the input text until newline character
+        inputText.trim();  // Remove any leading or trailing whitespace
+
+        // If the input text is not empty, get the AI response
+        if (inputText.length() > 0) {
+            String response = chatbot.getResponse(inputText);
+            Serial.println("AI Response: " + response);  // Print the AI response
+        } else {
+            Serial.println("Please enter valid text.");  // Prompt user to enter valid text
+        }
+    }
+}