chatgpt-optimized-official - npm Package Compare versions

Comparing version 1.2.3 to 1.2.4

package.json

 {
 	"name": "chatgpt-optimized-official",
-	"version": "1.2.3",
+	"version": "1.2.4",
 	"description": "ChatGPT Client using official OpenAI API",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,145 +0,154 @@
-# chatgpt-optimized-official - a simple library to create ChatGPT that uses OpenAI official API 
+* * *
 
-A simple Node.js module for creating ChatGPT using OpenAI official API.
+chatgpt-optimized-official - Create ChatGPT effortlessly using OpenAI's official API
+====================================================================================
 
-## Installation
+`chatgpt-optimized-official` is a streamlined Node.js module built to facilitate the creation and interaction of ChatGPT bots using the official OpenAI API.
 
-To install the package, run the following command:
+📦 Installation
+---------------
 
+Install the package using npm:
+
+
 ```bash
+
 npm install chatgpt-optimized-official
+
+
 ```
 
-### Official Chat Completion API from OpenAI
+🚀 Quick Start
+--------------
 
+### Using ChatGPT with OpenAI's Chat Completion API
+
+
 ```javascript
+
 import { ChatGPT } from "chatgpt-optimized-official";
 
-let bot = new ChatGPT("<OPENAI_API_KEY>");
+const bot = new ChatGPT("<OPENAI_API_KEY>");
+const response = await bot.ask("Hello?");
+console.log(response);
 
-let response = await bot.ask("Hello?");
-console.log(response);
 ```
 
-### Creating ChatGPT with Official OpenAI Completion API
+### Using OpenAI's Official Completion API
 
+
 ```javascript
+
 import { OpenAI } from "chatgpt-optimized-official";
 
-let bot = new OpenAI("<OPENAI_API_KEY>");
+const bot = new OpenAI("<OPENAI_API_KEY>");
+const response = await bot.ask("Hello?");
+console.log(response);
 
-let response = await bot.ask("Hello?");
-console.log(response);
 ```
 
-## Usage: Official Chat Completion API from OpenAI
+🛠 Advanced Usage
+-----------------
 
+### Detailed Configuration with ChatGPT
+
+Here, we provide various OpenAI parameters and set up different conversation scenarios:
+
+
 ```javascript
+
 import { ChatGPT } from "chatgpt-optimized-official";
 
-let options = {
-	temperature: 0.7, // OpenAI parameter
-	max_tokens: 100, // OpenAI parameter [Max response size by tokens]
-	top_p: 0.9, // OpenAI parameter
-	frequency_penalty: 0, // OpenAI parameter
-	presence_penalty: 0, // OpenAI parameter
-	instructions: `You are ChatGPT, a large language model trained by OpenAI.`, // initial instructions for the bot
-	model: "gpt-3.5-turbo", // OpenAI parameter  `gpt-3.5-turbo` is PAID
+const options = {
+    temperature: 0.7,
+    max_tokens: 100,
+    top_p: 0.9,
+    frequency_penalty: 0,
+    presence_penalty: 0,
+    instructions: `You are ChatGPT, a large language model trained by OpenAI.`,
+    model: "gpt-3.5-turbo", 
 };
 
-let bot = new ChatGPT("<OPENAI_API_KEY>", options); // Note: options is optional
+const bot = new ChatGPT("<OPENAI_API_KEY>", options); 
 
-let response = await bot.ask("Hello?");
+// Basic Interaction
+const response = await bot.ask("Hello?");
 console.log(response);
 
-let conversationId = "conversation name";
-let response1 = await bot.ask("Hello?", conversationId);
+// Conversation scenarios with unique IDs
+const response1 = await bot.ask("Hello?", "conversation1");
 console.log(response1);
 
-let conversationId2 = "another conversation name";
-let response2 = await bot.ask("Hello?", conversationId2);
+const response2 = await bot.ask("Hello?", "conversation2");
 console.log(response2);
+
 ```
-## Usage: Official Chat Completion API from OpenAI with functions
+### Advanced Features: Functions & Variations
 
+Incorporate functions and use advanced features such as specifying message roles and custom user names:
+
+
 ```javascript
+
 import { ChatGPT } from "chatgpt-optimized-official";
 
-let options = {
-	temperature: 0.7, // OpenAI parameter
-	max_tokens: 100, // OpenAI parameter [Max response size by tokens]
-	top_p: 0.9, // OpenAI parameter
-	frequency_penalty: 0, // OpenAI parameter
-	presence_penalty: 0, // OpenAI parameter
-	instructions: `You are ChatGPT, a large language model trained by OpenAI.`, // initial instructions for the bot
-    model: "gpt-3.5-turbo-0613", // OpenAI parameter  `gpt-3.5-turbo` is PAID
-	functions: [
-		{
-		"name": "saveDataUser",
-		"description": "Save data",
-		"parameters": {
-			"type": "object",
-			"properties": {
-			"name": {
-				"type": "string",
-				"description": "name user",
-			},
-			"email": {
-				"type": "string",
-				"description": "email user",
-			},
-			"phone": {
-				"type": "string",
-				"description": "phone user",
-			}
-			},
-			"required": ["name", "email", "phone"],
-		},
-		}
-	],
-	function_call: "auto", 
+const options = {
+    ...,
+    model: "gpt-3.5-turbo-0613",
+    functions: [{
+        "name": "saveDataUser",
+        "description": "Save user data",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "name": {"type": "string", "description": "User's name"},
+                "email": {"type": "string", "description": "User's email"},
+                "phone": {"type": "string", "description": "User's phone number"}
+            },
+            "required": ["name", "email", "phone"],
+        }
+    }],
+    function_call: "auto"
 };
 
-let bot = new ChatGPT("<OPENAI_API_KEY>", options); // Note: options is optional
+const bot = new ChatGPT("<OPENAI_API_KEY>", options); 
 
-let response = await bot.askV1("Hello?");
+const response = await bot.askV1("Hello?");
 console.log(response);
 
-let conversationId = "conversation name";
-let type = 1 // type 1 is user, 2 is assistant  this is optional 1 (User) is default
-let userName="User" //default value this is optional, username is other id for the conversation
-let response1 = await bot.askV1("Hello?", conversationId, type, userName);
+const type = 1; // 1: User, 2: Assistant. Default is 1.
+const userName = "User"; // Optional: Custom username.
+const response1 = await bot.askV1("Hello?", "conversation1", type, userName);
 console.log(response1);
 
-
 ```
 
-## Usage: Creating ChatGPT with Official OpenAI Completion API
+### Using OpenAI's Completion API
 
+Demonstrate the use of a different model with OpenAI's API:
+
+
 ```javascript
+
 import { OpenAI } from "chatgpt-optimized-official";
 
-let options = {
-	temperature: 0.7, // OpenAI parameter
-	max_tokens: 256, // OpenAI parameter [Max response size by tokens]
-	top_p: 0.9, // OpenAI parameter
-	frequency_penalty: 0, // OpenAI parameter
-	presence_penalty: 0, // OpenAI parameter
-	instructions: `You are ChatGPT, a large language model trained by OpenAI.`, // initial instructions for the bot
-	model: "text-davinci-003", // OpenAI parameter  `text-davinci-003` is PAID
-	stop: "<|im_end|>", // OpenAI parameter
+const options = {
+    ...,
+    model: "text-davinci-003", 
 };
 
-let bot = new OpenAI("<OPENAI_API_KEY>", options); // Note: options is optional
+const bot = new OpenAI("<OPENAI_API_KEY>", options); 
 
-let response = await bot.ask("Hello?");
+const response = await bot.ask("Hello?");
 console.log(response);
 
-let conversationId = "conversation name";
-let response1 = await bot.ask("Hello?", conversationId);
+const response1 = await bot.ask("Hello?", "conversation1");
 console.log(response1);
 
-let conversationId2 = "another conversation name";
-let response2 = await bot.ask("Hello?", conversationId2);
+const response2 = await bot.ask("Hello?", "conversation2");
 console.log(response2);
+
 ```
+* * *
+
+This version organizes the information more cleanly, uses icons for better visibility, adds subtitles for clarity, and improves the general flow and wording.

No alert changes

Improved metrics

Number of lines in readme file

154

increased by5.48%

Worsened metrics

Total package byte prevSize

434235

decreased by-0.13%

No dependency changes