nuxt-chatgpt 0.1.10 → 0.2.2

package/README.md

@@ -14,7 +14,7 @@
 
 ## About the module
 
-This user-friendly module boasts of an easy integration process that enables seamless implementation into any [Nuxt 3](https://nuxt.com) project. With type-safe integration, you can integrate [ChatGPT](https://openai.com/) into your [Nuxt 3](https://nuxt.com) project without breaking a <b>sweat</b>. Enjoy easy access to the `chat`, and `chatCompletion` methods through the `useChatgpt()` composable. Additionally, the module guarantees <b><i>security</i></b> as requests are routed through a [Nitro Server](https://nuxt.com/docs/guide/concepts/server-engine), thus preventing the exposure of your <b>API Key</b>.
+This user-friendly module boasts of an easy integration process that enables seamless implementation into any [Nuxt 3](https://nuxt.com) project. With type-safe integration, you can integrate [ChatGPT](https://openai.com/) into your [Nuxt 3](https://nuxt.com) project without breaking a <b>sweat</b>. Enjoy easy access to the `chat`, and `chatCompletion` methods through the `useChatgpt()` composable. Additionally, the module guarantees <b><i>security</i></b> as requests are routed through a [Nitro Server](https://nuxt.com/docs/guide/concepts/server-engine), thus preventing the exposure of your <b>API Key</b>. The module use [openai](https://github.com/openai/openai-node) library version 4.0.0 behind the scene.
 
 ## Features
 
@@ -60,26 +60,27 @@ To access the `chat`, and `chatCompletion` methods in the nuxt-chatgpt module, y
 
 | Name | Type | Default | Description |
 |--|--|--|--|
-|**message**|`String`||A string representing the text message that you want to send to the GPT model for processing.
+|**message**|`String`|available only for `chat()`|A string representing the text message that you want to send to the GPT model for processing.
+|**messages**|`Array`|available only for `chatCompletion()`|An array of objects that contains `role` and `content`
 |**model**|`String`|`text-davinci-003` for `chat()` and `gpt-3.5-turbo` for `chatCompletion()`|Represent certain model for different types of natural language processing tasks.
 |**options**|`Object`|`{ temperature: 0.5, max_tokens: 2048, top_p: 1 frequency_penalty: 0, presence_penalty: 0 }`|An optional object that specifies any additional options you want to pass to the API request, such as the number of responses to generate, and the maximum length of each response.
 
-Available models for `chat`
+Available models:
 
-- text-davinci-003
 - text-davinci-002
-
-Available models for `chatCompletion`
-
+- text-davinci-003
 - gpt-3.5-turbo
 - gpt-3.5-turbo-0301
-
-You need to join waitlist to use gpt-4 models within `chatCompletion` method
-
+- gpt-3.5-turbo-1106
 - gpt-4
+- gpt-4-1106-preview
 - gpt-4-0314
+- gpt-4-0613
 - gpt-4-32k
 - gpt-4-32k-0314
+- gpt-4-32k-0613
+
+You need to join waitlist to use gpt-4 models within `chatCompletion` method
 
 ### Simple `chat` usage 
 In the following example, the model is unspecified, and the text-davinci-003 model will be used by default.
@@ -88,11 +89,15 @@ In the following example, the model is unspecified, and the text-davinci-003 mod
 const { chat } = useChatgpt()
 
 const data = ref('')
-const message = ref('')
+const inputData = ref('')
 
 async function sendMessage() {
-  const response = await chat(message.value)
-  data.value = response
+  try {
+    const response = await chat(inputData.value)
+    data.value = response
+  } catch(error) {
+    alert(`Join the waiting list if you want to use GPT-4 models: ${error}`)
+  }
 }
 
 ```
@@ -100,7 +105,7 @@ async function sendMessage() {
 ```html
 <template>
   <div>
-    <input v-model="message">
+    <input v-model="inputData">
     <button
       @click="sendMessage"
       v-text="'Send'"
@@ -116,11 +121,15 @@ async function sendMessage() {
 const { chat } = useChatgpt()
 
 const data = ref('')
-const message = ref('')
+const inputData = ref('')
 
 async function sendMessage() {
-  const response = await chat(message.value, 'text-davinci-002')
-  data.value = response
+  try {
+    const response = await chat(inputData.value, 'gpt-3.5-turbo')
+    data.value = response
+  } catch(error) {
+    alert(`Join the waiting list if you want to use GPT-4 models: ${error}`)
+  }
 }
 
 ```
@@ -128,7 +137,7 @@ async function sendMessage() {
 ```html
 <template>
   <div>
-    <input v-model="message">
+    <input v-model="inputData">
     <button
       @click="sendMessage"
       v-text="'Send'"
@@ -144,12 +153,29 @@ In the following example, the model is unspecified, and the gpt-3.5-turbo model
 ```js
 const { chatCompletion } = useChatgpt()
 
-const data = ref('')
-const message = ref('')
+const chatTree = ref([])
+const inputData = ref('')
 
 async function sendMessage() {
-  const response = await chatCompletion(message.value)
-  data.value = response
+  try {
+    const message = {
+      role: 'user',
+      content: `${inputData.value}`,
+    }
+
+    chatTree.value.push(message)
+
+    const response = await chatCompletion(chatTree.value)
+    
+    const responseMessage = {
+      role: response[0].message.role,
+      content: response[0].message.content
+    }
+    
+    chatTree.value.push(responseMessage)
+  } catch(error) {
+    alert(`Join the waiting list if you want to use GPT-4 models: ${error}`)
+  }
 }
 
 ```
@@ -157,12 +183,20 @@ async function sendMessage() {
 ```html
 <template>
   <div>
-    <input v-model="message">
+    <input v-model="inputData">
     <button
       @click="sendMessage"
       v-text="'Send'"
     />
-    <div>{{ data }}</div>
+    <div>
+      <div
+        v-for="chat in chatTree"
+        :key="chat"
+      >
+        <strong>{{ chat.role }} :</strong>
+        <div>{{ chat.content }} </div>
+      </div>
+    </div>
   </div>
 </template>
 ```
@@ -172,12 +206,29 @@ async function sendMessage() {
 ```js
 const { chatCompletion } = useChatgpt()
 
-const data = ref('')
-const message = ref('')
+const chatTree = ref([])
+const inputData = ref('')
 
 async function sendMessage() {
-  const response = await chatCompletion(message.value, 'gpt-3.5-turbo-0301')
-  data.value = response
+  try {
+    const message = {
+      role: 'user',
+      content: `${inputData.value}`,
+    }
+
+    chatTree.value.push(message)
+
+    const response = await chatCompletion(chatTree.value, 'gpt-3.5-turbo-0301')
+    
+    const responseMessage = {
+      role: response[0].message.role,
+      content: response[0].message.content
+    }
+    
+    chatTree.value.push(responseMessage)
+  } catch(error) {
+    alert(`Join the waiting list if you want to use GPT-4 models: ${error}`)
+  }
 }
 
 ```
@@ -185,12 +236,20 @@ async function sendMessage() {
 ```html
 <template>
   <div>
-    <input v-model="message">
+    <input v-model="inputData">
     <button
       @click="sendMessage"
       v-text="'Send'"
     />
-    <div>{{ data }}</div>
+    <div>
+      <div
+        v-for="chat in chatTree"
+        :key="chat"
+      >
+        <strong>{{ chat.role }} :</strong>
+        <div>{{ chat.content }} </div>
+      </div>
+    </div>
   </div>
 </template>
 ```

package/dist/module.d.ts

@@ -1,19 +1,19 @@
 import * as _nuxt_schema from '@nuxt/schema';
 
-interface ModuleOptions {
-    /**
-     * Set chatGPT apiKey
-     * @default undefined
-     * @description Set your chatGPT apiKey
-    */
-    apiKey?: string;
-    /**
-     * Setting to `false` disables the module.
-     * @default true
-     * @description Use this setting to disable the module.
-    */
-    isEnabled?: boolean;
-}
+interface ModuleOptions {
+    /**
+     * Set chatGPT apiKey
+     * @default undefined
+     * @description Set your chatGPT apiKey
+    */
+    apiKey?: string;
+    /**
+     * Setting to `false` disables the module.
+     * @default true
+     * @description Use this setting to disable the module.
+    */
+    isEnabled?: boolean;
+}
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 
 export { ModuleOptions, _default as default };

package/dist/module.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": "^3.0.0"
   },
-  "version": "0.1.10"
+  "version": "0.2.2"
 }

package/dist/runtime/composables/useChatgpt.d.ts

@@ -1,2 +1,2 @@
-import type { IChatgptClient } from "../types";
-export declare const useChatgpt: () => IChatgptClient;
+import type { IChatgptClient } from "../types";
+export declare const useChatgpt: () => IChatgptClient;

package/dist/runtime/composables/useChatgpt.mjs

@@ -17,12 +17,12 @@ export const useChatgpt = () => {
       });
     }
   };
-  const chatCompletion = async (message, model, options) => {
+  const chatCompletion = async (messages, model, options) => {
     try {
       return await $fetch("/api/chat-completion", {
         method: "POST",
         body: {
-          message,
+          messages,
           model,
           options
         }

package/dist/runtime/constants/models.d.ts

@@ -1,8 +1,12 @@
-export declare const MODEL_TEXT_DAVINCI_003: string;
-export declare const MODEL_TEXT_DAVINCI_002: string;
-export declare const MODEL_GPT_TURBO_3_5: string;
-export declare const MODEL_GPT_TURBO_3_5_0301: string;
-export declare const MODEL_GPT_4: string;
-export declare const MODEL_GPT_4_0314: string;
-export declare const MODEL_GPT_4_32k: string;
-export declare const MODEL_GPT_4_32k_0314: string;
+export declare const MODEL_TEXT_DAVINCI_002: string;
+export declare const MODEL_TEXT_DAVINCI_003: string;
+export declare const MODEL_GPT_TURBO_3_5: string;
+export declare const MODEL_GPT_TURBO_3_5_0301: string;
+export declare const MODEL_GPT_TURBO_3_5_1106 = "gpt-3.5-turbo-1106";
+export declare const MODEL_GPT_4: string;
+export declare const MODEL_GPT_4_1106_PREVIEW = "gpt-4-1106-preview";
+export declare const MODEL_GPT_4_0314: string;
+export declare const MODEL_GPT_4_0613 = "gpt-4-0613";
+export declare const MODEL_GPT_4_32k: string;
+export declare const MODEL_GPT_4_32k_0314: string;
+export declare const MODEL_GPT_4_32k_0613 = "gpt-4-32k-0613";

package/dist/runtime/constants/models.mjs

@@ -1,8 +1,12 @@
-export const MODEL_TEXT_DAVINCI_003 = "text-davinci-003";
 export const MODEL_TEXT_DAVINCI_002 = "text-davinci-002";
+export const MODEL_TEXT_DAVINCI_003 = "text-davinci-003";
 export const MODEL_GPT_TURBO_3_5 = "gpt-3.5-turbo";
 export const MODEL_GPT_TURBO_3_5_0301 = "gpt-3.5-turbo-0301";
+export const MODEL_GPT_TURBO_3_5_1106 = "gpt-3.5-turbo-1106";
 export const MODEL_GPT_4 = "gpt-4";
+export const MODEL_GPT_4_1106_PREVIEW = "gpt-4-1106-preview";
 export const MODEL_GPT_4_0314 = "gpt-4-0314";
+export const MODEL_GPT_4_0613 = "gpt-4-0613";
 export const MODEL_GPT_4_32k = "gpt-4-32k";
 export const MODEL_GPT_4_32k_0314 = "gpt-4-32k-0314";
+export const MODEL_GPT_4_32k_0613 = "gpt-4-32k-0613";

package/dist/runtime/constants/options.d.ts

@@ -1,7 +1,7 @@
-export declare const defaultOptions: {
-    temperature: number;
-    max_tokens: number;
-    top_p: number;
-    frequency_penalty: number;
-    presence_penalty: number;
-};
+export declare const defaultOptions: {
+    temperature: number;
+    max_tokens: number;
+    top_p: number;
+    frequency_penalty: number;
+    presence_penalty: number;
+};

package/dist/runtime/server/api/chat-completion.d.ts

@@ -1,2 +1,3 @@
-declare const _default: import("h3").EventHandler<string>;
-export default _default;
+import OpenAI from 'openai';
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<OpenAI.Chat.Completions.ChatCompletion.Choice[]>>;
+export default _default;

package/dist/runtime/server/api/chat-completion.mjs

@@ -1,29 +1,28 @@
+import OpenAI from "openai";
 import { createError, defineEventHandler, readBody } from "h3";
-import { Configuration, OpenAIApi } from "openai";
 import { defaultOptions } from "../../constants/options.mjs";
 import { MODEL_GPT_TURBO_3_5 } from "../../constants/models.mjs";
 import { modelMap } from "../../utils/model-map.mjs";
 import { useRuntimeConfig } from "#imports";
 export default defineEventHandler(async (event) => {
-  const { message, model, options } = await readBody(event);
+  const { messages, model, options } = await readBody(event);
   if (!useRuntimeConfig().chatgpt.apiKey) {
     throw createError({
       statusCode: 403,
       message: "Missing OpenAI API Key"
     });
   }
-  const configuration = new Configuration({
+  const openai = new OpenAI({
     apiKey: useRuntimeConfig().chatgpt.apiKey
   });
-  const openai = new OpenAIApi(configuration);
   const requestOptions = {
-    messages: [{ role: "user", content: message }],
+    messages,
     model: !model ? modelMap[MODEL_GPT_TURBO_3_5] : modelMap[model],
     ...options || defaultOptions
   };
   try {
-    const { data } = await openai.createChatCompletion(requestOptions);
-    return data.choices[0].message?.content;
+    const chatCompletion = await openai.chat.completions.create(requestOptions);
+    return chatCompletion.choices;
   } catch (error) {
     throw createError({
       statusCode: 500,

package/dist/runtime/server/api/chat.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("h3").EventHandler<string>;
-export default _default;
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string>>;
+export default _default;

package/dist/runtime/server/api/chat.mjs

@@ -1,6 +1,7 @@
+import OpenAI from "openai";
 import { createError, defineEventHandler, readBody } from "h3";
-import { Configuration, OpenAIApi } from "openai";
 import { defaultOptions } from "../../constants/options.mjs";
+import { MODEL_GPT_TURBO_3_5 } from "../../constants/models.mjs";
 import { modelMap } from "../../utils/model-map.mjs";
 import { useRuntimeConfig } from "#imports";
 export default defineEventHandler(async (event) => {
@@ -11,18 +12,17 @@ export default defineEventHandler(async (event) => {
       message: "Missing OpenAI API Key"
     });
   }
-  const configuration = new Configuration({
+  const openai = new OpenAI({
     apiKey: useRuntimeConfig().chatgpt.apiKey
   });
-  const openai = new OpenAIApi(configuration);
   const requestOptions = {
-    prompt: message,
-    model: !model ? modelMap.default : modelMap[model],
+    messages: [{ role: "user", content: message }],
+    model: !model ? modelMap[MODEL_GPT_TURBO_3_5] : modelMap[model],
     ...options || defaultOptions
   };
   try {
-    const { data } = await openai.createCompletion(requestOptions);
-    return data.choices[0].text?.slice(2);
+    const chatCompletion = await openai.chat.completions.create(requestOptions);
+    return chatCompletion.choices[0].message?.content;
   } catch (error) {
     throw createError({
       statusCode: 500,

package/dist/runtime/utils/model-map.d.ts

@@ -1,4 +1,8 @@
-export declare const modelMap: {
-    [x: string]: string;
-    default: string;
-};
+export declare const modelMap: {
+    [x: string]: string;
+    "gpt-3.5-turbo-1106": string;
+    "gpt-4-1106-preview": string;
+    "gpt-4-0613": string;
+    "gpt-4-32k-0613": string;
+    default: string;
+};

package/dist/runtime/utils/model-map.mjs

@@ -3,19 +3,27 @@ import {
   MODEL_TEXT_DAVINCI_002,
   MODEL_GPT_TURBO_3_5,
   MODEL_GPT_TURBO_3_5_0301,
+  MODEL_GPT_TURBO_3_5_1106,
   MODEL_GPT_4,
+  MODEL_GPT_4_1106_PREVIEW,
   MODEL_GPT_4_0314,
+  MODEL_GPT_4_0613,
   MODEL_GPT_4_32k,
-  MODEL_GPT_4_32k_0314
+  MODEL_GPT_4_32k_0314,
+  MODEL_GPT_4_32k_0613
 } from "../constants/models.mjs";
 export const modelMap = {
   [MODEL_TEXT_DAVINCI_003]: MODEL_TEXT_DAVINCI_003,
   [MODEL_TEXT_DAVINCI_002]: MODEL_TEXT_DAVINCI_002,
   [MODEL_GPT_TURBO_3_5]: MODEL_GPT_TURBO_3_5,
   [MODEL_GPT_TURBO_3_5_0301]: MODEL_GPT_TURBO_3_5_0301,
+  [MODEL_GPT_TURBO_3_5_1106]: MODEL_GPT_TURBO_3_5_1106,
   [MODEL_GPT_4]: MODEL_GPT_4,
+  [MODEL_GPT_4_1106_PREVIEW]: MODEL_GPT_4_1106_PREVIEW,
   [MODEL_GPT_4_0314]: MODEL_GPT_4_0314,
+  [MODEL_GPT_4_0613]: MODEL_GPT_4_0613,
   [MODEL_GPT_4_32k]: MODEL_GPT_4_32k,
   [MODEL_GPT_4_32k_0314]: MODEL_GPT_4_32k_0314,
-  default: MODEL_TEXT_DAVINCI_003
+  [MODEL_GPT_4_32k_0613]: MODEL_GPT_4_32k_0613,
+  default: MODEL_GPT_TURBO_3_5
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-chatgpt",
-  "version": "0.1.10",
+  "version": "0.2.2",
   "description": "ChatGPT integration for Nuxt 3",
   "license": "MIT",
   "type": "module",
@@ -53,18 +53,18 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.1.1",
-    "openai": "^3.2.1",
-    "defu": "^6.1.2"
+    "@nuxt/kit": "latest",
+    "defu": "latest",
+    "openai": "4.0.0"
   },
   "devDependencies": {
-    "@nuxt/eslint-config": "^0.1.1",
+    "@nuxt/eslint-config": "latest",
     "@nuxt/module-builder": "^0.2.1",
-    "@nuxt/schema": "^3.1.1",
-    "@nuxt/test-utils": "^3.1.1",
-    "changelogen": "^0.4.1",
-    "eslint": "^8.32.0",
-    "nuxt": "^3.1.1",
-    "vitest": "^0.28.2"
+    "@nuxt/schema": "latest",
+    "@nuxt/test-utils": "latest",
+    "changelogen": "latest",
+    "eslint": "latest",
+    "nuxt": "latest",
+    "vitest": "latest"
   }
-}
+}