Version Bump 0.2.2

Author: Eric

README.md

@@ -1,5 +1,3 @@
-[![arduino-library-badge](https://www.ardu-badge.com/badge/ChatGPT_Client.svg)](https://www.ardu-badge.com/ChatGPT_Client)
-
 ## Overview
 The ChatGPT Arduino Library provides a convenient way to interact with the OpenAI GPT models from Arduino environments, such as ESP32 devices. With this library, you can easily send text and vision queries to the ChatGPT API and receive responses directly in your Arduino projects.
 

examples/Arduino_BearSSLExample/Arduino_BearSSLExample.ino

@@ -2,7 +2,7 @@
  * Project ChatGPT Client For Arduino
  * Description: For HTTPS connection using ArduinoBearSSL
  * Author: Eric Nam
- * Date: 05-19-2024
+ * Date: 07-17-2024
  */
 
 //#define ARDUINO_DISABLE_ECCX08
@@ -35,11 +35,12 @@ void exampleTextQuestion() {
   max_tokens: Maximum number of tokens to generate in the response.
   content_only: Flag indicating whether to extract only the content of the response. (e.g., true - answer only, false - full response)
   result: Reference to a String variable to store the result of the API call.
+  mem_dynamic: Select whether to use dynamic memory or static memory when configuring the post body (default: dynamic memory)
   */
 
   String result;
   Serial.println("\n\n[ChatGPT] - Asking a Text Question");
-  if (chatGPT_Client.chat_message("gpt-3.5-turbo", "user", "What is the best feature of GPT-4o?", 100, false, result)) {
+  if (chatGPT_Client.chat_message("gpt-3.5-turbo", "user", "What is the best feature of GPT-4o?", 100, false, result, false)) {
     Serial.print("[ChatGPT] Response: ");
     Serial.println(result);
   } else {
@@ -48,7 +49,7 @@ void exampleTextQuestion() {
   }
 }
 
-void exampleVisionQuestionBaee64() {
+void exampleVisionQuestionBase64() {
   /*
   model: Model to use for generating the response (e.g., "gpt-4o").
   role: Role of the message sender (e.g., "user" or "assistant").
@@ -60,6 +61,7 @@ void exampleVisionQuestionBaee64() {
   max_tokens: Maximum number of tokens to generate in the response.
   content_only: Flag indicating whether to extract only the content of the response. (e.g., true - answer only, false - full response)
   result: Reference to a String variable to store the result of the API call.
+  mem_dynamic: Select whether to use dynamic memory or static memory when configuring the post body (default: dynamic memory)
   */
 
   String result;
@@ -110,9 +112,10 @@ void setup() {
 
   Serial.println("[ChatGPT] - Examples");
   delay(1000);
-  exampleTextQuestion();
+  exampleTextQuestion(); // Post Body in Static Memory
+
   delay(1000);
-  exampleVisionQuestionWithURL();
+  exampleVisionQuestionWithURL(); // Post Body in Dynamic memory
 }
 
 void loop() {}

examples/Arduino_SSLClient/Arduino_SSLClient.ino

@@ -2,7 +2,7 @@
  * Project ChatGPT Client For Arduino (Arduino Giga R1, Arduino Portenta H7)
  * Description: For HTTPS connection using Arduino WiFiSSLClient
  * Author: Eric Nam
- * Date: 05-19-2024
+ * Date: 07-17-2024
  */
 
 #include <WiFi.h>
@@ -33,11 +33,12 @@ void exampleTextQuestion() {
   max_tokens: Maximum number of tokens to generate in the response.
   content_only: Flag indicating whether to extract only the content of the response. (e.g., true - answer only, false - full response)
   result: Reference to a String variable to store the result of the API call.
+  mem_dynamic: Select whether to use dynamic memory or static memory when configuring the post body (default: dynamic memory)
   */
 
   String result;
   Serial.println("\n\n[ChatGPT] - Asking a Text Question");
-  if (chatGPT_Client.chat_message("gpt-3.5-turbo", "user", "What is the best feature of GPT-4o?", 100, false, result)) {
+  if (chatGPT_Client.chat_message("gpt-3.5-turbo", "user", "What is the best feature of GPT-4o?", 100, false, result, false)) {
     Serial.print("[ChatGPT] Response: ");
     Serial.println(result);
   } else {
@@ -46,7 +47,7 @@ void exampleTextQuestion() {
   }
 }
 
-void exampleVisionQuestionBaee64() {
+void exampleVisionQuestionBase64() {
   /*
   model: Model to use for generating the response (e.g., "gpt-4o").
   role: Role of the message sender (e.g., "user" or "assistant").
@@ -58,6 +59,7 @@ void exampleVisionQuestionBaee64() {
   max_tokens: Maximum number of tokens to generate in the response.
   content_only: Flag indicating whether to extract only the content of the response. (e.g., true - answer only, false - full response)
   result: Reference to a String variable to store the result of the API call.
+  mem_dynamic: Select whether to use dynamic memory or static memory when configuring the post body (default: dynamic memory)
   */
 
   String result;
@@ -112,9 +114,10 @@ void setup() {
 
   Serial.println("[ChatGPT] - Examples");
   delay(1000);
-  exampleTextQuestion();
+  exampleTextQuestion(); // Post Body in Static Memory
+
   delay(1000);
-  exampleVisionQuestionWithURL();
+  exampleVisionQuestionWithURL(); // Post Body in Dynamic memory
 }
 
 void loop() {}

examples/ESP32_WiFiClientSecure/ESP32_WiFiClientSecure.ino

@@ -2,7 +2,7 @@
  * Project ChatGPT Client For ESP32
  * Description: For HTTPS connection using WiFiClientSecure
  * Author: Eric Nam
- * Date: 05-28-2024
+ * Date: 07-17-2024
  */
 
 #include <WiFi.h>
@@ -32,20 +32,24 @@ void exampleTextQuestion() {
   max_tokens: Maximum number of tokens to generate in the response.
   content_only: Flag indicating whether to extract only the content of the response. (e.g., true - answer only, false - full response)
   result: Reference to a String variable to store the result of the API call.
+  mem_dynamic: Select whether to use dynamic memory or static memory when configuring the post body (default: dynamic memory)
   */
 
   String result;
   Serial.println("\n\n[ChatGPT] - Asking a Text Question");
-  if (chatGPT_Client.chat_message("gpt-3.5-turbo", "user", "What is the best feature of GPT-4o?", 100, false, result)) {
+  if (chatGPT_Client.chat_message("gpt-3.5-turbo", "user", "What is the best feature of GPT-4o?", 100, false, result, false))
+  {
     Serial.print("[ChatGPT] Response: ");
     Serial.println(result);
-  } else {
+  }
+  else
+  {
     Serial.print("[ChatGPT] Error: ");
     Serial.println(result);
   }
 }
 
-void exampleVisionQuestionBaee64() {
+void exampleVisionQuestionBase64() {
   /*
   model: Model to use for generating the response (e.g., "gpt-4o").
   role: Role of the message sender (e.g., "user" or "assistant").
@@ -57,6 +61,7 @@ void exampleVisionQuestionBaee64() {
   max_tokens: Maximum number of tokens to generate in the response.
   content_only: Flag indicating whether to extract only the content of the response. (e.g., true - answer only, false - full response)
   result: Reference to a String variable to store the result of the API call.
+  mem_dynamic: Select whether to use dynamic memory or static memory when configuring the post body (default: dynamic memory)
   */
 
   String result;
@@ -100,9 +105,10 @@ void setup() {
 
   Serial.println("[ChatGPT] - Examples");
   delay(1000);
-  exampleTextQuestion();
+  exampleTextQuestion(); // Post Body in Static Memory
+
   delay(1000);
-  exampleVisionQuestionWithURL();
+  exampleVisionQuestionWithURL(); // Post Body in Dynamic memory
 }
 
 void loop() {}

library.properties

@@ -1,5 +1,5 @@
 name=ChatGPT_Client
-version=0.2.1
+version=0.2.2
 author=Eric Nam <[email protected]>
 maintainer=Eric Nam <[email protected]>
 sentence=Library for communication with ChatGPT

src/ChatGPT.hpp

@@ -2,7 +2,7 @@
  * Project ChatGPT Client
  * Description: The official method using API Key for communication with ChatGPT
  * Author: Eric Nam
- * Date: 05-19-2024
+ * Date: 07-17-2024
  */
 
 #ifndef __CHATGPT__
@@ -22,7 +22,6 @@ class ChatGPT
    * - api_key_in: The API key for authentication.
    * - timeout_in: The timeout duration for requests.
    */
-  ChatGPT() {}
 
   ChatGPT(T *_client,
           const char *api_version_in,
@@ -50,6 +49,7 @@ class ChatGPT
    * - max_tokens: The maximum number of tokens to generate.
    * - content_only: If true, extracts and returns only the content from the response.
    * - result: Stores the response from the API.
+   * - mem_dynamic: Select Dynamic/Static Memory, (Default: Dyanmic Memory)
    *
    * Returns:
    * - True if the request is successful, false otherwise.
@@ -64,20 +64,46 @@ class ChatGPT
       const char *detail,
       int max_tokens,
       bool content_only,
-      String &result)
+      String &result,
+      bool mem_dynamic = true)
   {
-    int post_body_size = snprintf(nullptr, 0,
-                                  "{\"model\": \"%s\", \"messages\": [{\"role\": \"%s\", \"content\": [{\"type\": \"%s\", \"text\": \"%s\"}, {\"type\": \"%s\", \"image_url\": {\"url\": \"%s\", \"detail\": \"%s\"}}]}], \"max_tokens\": %d}",
-                                  model, role, type, text, image_type, image_url, detail, max_tokens) +
-                         1;
+    char *post_body = nullptr; // Initialize post_body pointer
+    int post_body_size = 0;
+    if (mem_dynamic)
+    {
+      // Calculate the required size for dynamic allocation
+      post_body_size = snprintf(nullptr, 0,
+                                "{\"model\": \"%s\", \"messages\": [{\"role\": \"%s\", \"content\": [{\"type\": \"%s\", \"text\": \"%s\"}, {\"type\": \"%s\", \"image_url\": {\"url\": \"%s\", \"detail\": \"%s\"}}]}], \"max_tokens\": %d}",
+                                model, role, type, text, image_type, image_url, detail, max_tokens) + 1;
+      post_body = new char[post_body_size];
+      if (post_body == nullptr)
+      {
+        result = "[ERR] Memory allocation failed!";
+        return false;
+      }
+    }
+    else
+    {
+      // Use a static buffer with a fixed size
+      static const int static_buffer_size = 512;
+      char static_post_body[static_buffer_size];
+      post_body_size = static_buffer_size;
+      post_body = static_post_body;
+    }
 
-    char *post_body = new char[post_body_size];
+    // Format the post_body string
     snprintf(post_body, post_body_size,
              "{\"model\": \"%s\", \"messages\": [{\"role\": \"%s\", \"content\": [{\"type\": \"%s\", \"text\": \"%s\"}, {\"type\": \"%s\", \"image_url\": {\"url\": \"%s\", \"detail\": \"%s\"}}]}], \"max_tokens\": %d}",
              model, role, type, text, image_type, image_url, detail, max_tokens);
 
+    // Call the _post function
     bool success = _postStream(post_body, content_only, result);
-    delete[] post_body;
+
+    // Free dynamic memory if allocated
+    if (mem_dynamic)
+    {
+      delete[] post_body;
+    }
     return success;
   }
 
@@ -92,6 +118,7 @@ class ChatGPT
    * - max_tokens: The maximum number of tokens to generate.
    * - content_only: If true, extracts and returns only the content from the response.
    * - result: Stores the response from the API.
+   * - mem_dynamic: Select Dynamic/Static Memory, (Default: Dyanmic Memory)
    *
    * Returns:
    * - True if the request is successful, false otherwise.
@@ -102,17 +129,43 @@ class ChatGPT
       const char *content,
       int max_tokens,
       bool content_only,
-      String &result)
+      String &result,
+      bool mem_dynamic = true)
   {
-    int post_body_size = snprintf(nullptr, 0, "{\"model\": \"%s\", \"max_tokens\": %d, \"messages\": [{\"role\": \"%s\", \"content\": \"%s\"}]}", model, max_tokens, role, content) + 1;
-    char *post_body = new char[post_body_size];
+    char *post_body = nullptr; // Initialize post_body pointer
+    int post_body_size = 0;
+
+    if (mem_dynamic)
+    {
+      // Calculate the required size for dynamic allocation
+      post_body_size = snprintf(nullptr, 0, "{\"model\": \"%s\", \"max_tokens\": %d, \"messages\": [{\"role\": \"%s\", \"content\": \"%s\"}]}", model, max_tokens, role, content) + 1;
+      post_body = new char[post_body_size];
+      if (post_body == nullptr)
+      {
+        result = "[ERR] Memory allocation failed!";
+        return false;
+      }
+    }
+    else
+    {
+      // Use a static buffer with a fixed size
+      static const int static_buffer_size = 256;
+      char static_post_body[static_buffer_size];
+      post_body_size = static_buffer_size;
+      post_body = static_post_body;
+    }
 
     // Format the post_body string
     snprintf(post_body, post_body_size, "{\"model\": \"%s\", \"max_tokens\": %d, \"messages\": [{\"role\": \"%s\", \"content\": \"%s\"}]}", model, max_tokens, role, content);
 
     // Call the _post function
     bool success = _postStream(post_body, content_only, result);
-    delete[] post_body;
+
+    // Free dynamic memory if allocated
+    if (mem_dynamic)
+    {
+      delete[] post_body;
+    }
     return success;
   }
 
@@ -148,15 +201,15 @@ class ChatGPT
       return false;
     }
 
-    int payload_length = strlen(post_body);
+    size_t payload_length = strlen(post_body);
     String auth_header = _get_auth_header(api_key);
     String http_request = "POST /" + api_version + "/chat/completions HTTP/1.1\r\n" + auth_header + "\r\n" + "Host: " + host + "\r\n" + "Cache-control: no-cache\r\n" + "User-Agent: ESP32 ChatGPT\r\n" + "Content-Type: application/json\r\n" + "Content-Length: " + String(payload_length) + "\r\n" + "Connection: close\r\n" + "\r\n";
 
     // Send the HTTP request headers
     client->print(http_request);
 
     // Send the HTTP request body in chunks
-    int bytes_sent = 0;
+    size_t bytes_sent = 0;
     while (bytes_sent < payload_length)
     {
       size_t chunk_size = minimum(payload_length - bytes_sent, static_cast<size_t>(1024)); // Adjust chunk size as needed