nuxt-chatgpt 0.1.9 → 0.2.1

package/README.md

@@ -14,13 +14,13 @@
 
 ## 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 `send` method 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
 
 - 💪 &nbsp; Easy implementation into any [Nuxt 3](https://nuxt.com) project.
 - 👉 &nbsp; Type-safe integration of Chatgpt into your [Nuxt 3](https://nuxt.com) project.
-- 🕹️ &nbsp; Provides a `useChatgpt()` composable that grants easy access to the `send` method.
+- 🕹️ &nbsp; Provides a `useChatgpt()` composable that grants easy access to the `chat`, and `chatCompletion` methods.
 - 🔥 &nbsp; Ensures security by routing requests through a [Nitro Server](https://nuxt.com/docs/guide/concepts/server-engine), preventing the <b>API Key</b> from being exposed.
 - 🧱 &nbsp; It is lightweight and performs well.
 
@@ -53,21 +53,45 @@ export default defineNuxtConfig({
 ```
 That's it! You can now use Nuxt Chatgpt in your Nuxt app 🔥
 
-## Example & Usage
+## Usage & Examples
 
-To access the `send` method in the nuxt-chatgpt module, you can use the `useChatgpt()` composable, which provides easy access to the method. The send method requires two parameters:
+To access the `chat`, and `chatCompletion` methods in the nuxt-chatgpt module, you can use the `useChatgpt()` composable, which provides easy access to them. The `chat`, and `chatCompletion` methods requires three parameters:
 
-- `message`: a string representing the text message that you want to send to the GPT-3 model for processing.
-- `options`: an optional object that specifies any additional options you want to pass to the API request, such as the GPT-3 model ID, the number of responses to generate, and the maximum length of each response.
+
+| Name | Type | Default | Description |
+|--|--|--|--|
+|**message**|`String`||A string representing the text message that you want to send to the GPT model for processing.
+|**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`
+
+- text-davinci-003
+- text-davinci-002
+
+Available models for `chatCompletion`
+
+- gpt-3.5-turbo
+- gpt-3.5-turbo-0301
+
+You need to join waitlist to use gpt-4 models within `chatCompletion` method
+
+- gpt-4
+- gpt-4-0314
+- gpt-4-32k
+- gpt-4-32k-0314
+
+### Simple `chat` usage 
+In the following example, the model is unspecified, and the text-davinci-003 model will be used by default.
 
 ```js
-const { send } = useChatgpt()
+const { chat } = useChatgpt()
 
 const data = ref('')
 const message = ref('')
 
 async function sendMessage() {
-  const response = await send(message.value)
+  const response = await chat(message.value)
   data.value = response
 }
 
@@ -86,6 +110,98 @@ async function sendMessage() {
 </template>
 ```
 
+### Usage of `chat` with different model
+
+```js
+const { chat } = useChatgpt()
+
+const data = ref('')
+const message = ref('')
+
+async function sendMessage() {
+  const response = await chat(message.value, 'text-davinci-002')
+  data.value = response
+}
+
+```
+
+```html
+<template>
+  <div>
+    <input v-model="message">
+    <button
+      @click="sendMessage"
+      v-text="'Send'"
+    />
+    <div>{{ data }}</div>
+  </div>
+</template>
+```
+
+### Simple `chatCompletion` usage 
+In the following example, the model is unspecified, and the gpt-3.5-turbo model will be used by default.
+
+```js
+const { chatCompletion } = useChatgpt()
+
+const data = ref('')
+const message = ref('')
+
+async function sendMessage() {
+  const response = await chatCompletion(message.value)
+  data.value = response
+}
+
+```
+
+```html
+<template>
+  <div>
+    <input v-model="message">
+    <button
+      @click="sendMessage"
+      v-text="'Send'"
+    />
+    <div>{{ data }}</div>
+  </div>
+</template>
+```
+
+### Usage of `chatCompletion` with different model
+
+```js
+const { chatCompletion } = useChatgpt()
+
+const data = ref('')
+const message = ref('')
+
+async function sendMessage() {
+  const response = await chatCompletion(message.value, 'gpt-3.5-turbo-0301')
+  data.value = response
+}
+
+```
+
+```html
+<template>
+  <div>
+    <input v-model="message">
+    <button
+      @click="sendMessage"
+      v-text="'Send'"
+    />
+    <div>{{ data }}</div>
+  </div>
+</template>
+```
+
+## chat vs chatCompletion
+
+The `chat` method allows the user to send a prompt to the OpenAI API and receive a response. You can use this endpoint to build conversational interfaces that can interact with users in a natural way. For example, you could use the chat method to build a chatbot that can answer customer service questions or provide information about a product or service.
+
+The `chatCompletion` method is similar to the `chat` method, but it provides additional functionality for generating longer, more complex responses. Specifically, the chatCompletion method allows you to provide a conversation history as input, which the API can use to generate a response that is consistent with the context of the conversation. This makes it possible to build chatbots that can engage in longer, more natural conversations with users.
+
+
 ## Module Options
 
 | Name | Type | Default | Description |

package/dist/module.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": "^3.0.0"
   },
-  "version": "0.1.9"
+  "version": "0.2.1"
 }

package/dist/module.mjs

@@ -31,11 +31,20 @@ const module = defineNuxtModule({
       apiKey: options.apiKey
     });
     addImportsDir(resolve("./runtime/composables"));
-    addServerHandler({
-      route: "/api/openai",
-      method: "post",
-      handler: resolve(runtimeDir, "server/api/openai")
-    });
+    addServerHandler(
+      {
+        route: "/api/chat",
+        method: "post",
+        handler: resolve(runtimeDir, "server/api/chat")
+      }
+    );
+    addServerHandler(
+      {
+        route: "/api/chat-completion",
+        method: "post",
+        handler: resolve(runtimeDir, "server/api/chat-completion")
+      }
+    );
     nuxt.options.build.transpile.push(runtimeDir);
   }
 });

package/dist/runtime/composables/useChatgpt.mjs

@@ -1,10 +1,14 @@
 import { createError } from "h3";
 export const useChatgpt = () => {
-  const send = async (message) => {
+  const chat = async (message, model, options) => {
     try {
-      return await $fetch("/api/openai", {
+      return await $fetch("/api/chat", {
         method: "POST",
-        body: message
+        body: {
+          message,
+          model,
+          options
+        }
       });
     } catch (error) {
       throw createError({
@@ -13,5 +17,22 @@ export const useChatgpt = () => {
       });
     }
   };
-  return { send };
+  const chatCompletion = async (message, model, options) => {
+    try {
+      return await $fetch("/api/chat-completion", {
+        method: "POST",
+        body: {
+          message,
+          model,
+          options
+        }
+      });
+    } catch (error) {
+      throw createError({
+        statusCode: 500,
+        message: "Failed to forward request to server"
+      });
+    }
+  };
+  return { chat, chatCompletion };
 };

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

@@ -0,0 +1,8 @@
+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;

package/dist/runtime/constants/models.mjs

@@ -0,0 +1,8 @@
+export const MODEL_TEXT_DAVINCI_003 = "text-davinci-003";
+export const MODEL_TEXT_DAVINCI_002 = "text-davinci-002";
+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_4 = "gpt-4";
+export const MODEL_GPT_4_0314 = "gpt-4-0314";
+export const MODEL_GPT_4_32k = "gpt-4-32k";
+export const MODEL_GPT_4_32k_0314 = "gpt-4-32k-0314";

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

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

package/dist/runtime/constants/options.mjs

@@ -0,0 +1,7 @@
+export const defaultOptions = {
+  temperature: 0.5,
+  max_tokens: 2048,
+  top_p: 1,
+  frequency_penalty: 0,
+  presence_penalty: 0
+};

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

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

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

@@ -0,0 +1,32 @@
+import OpenAI from "openai";
+import { createError, defineEventHandler, readBody } from "h3";
+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);
+  if (!useRuntimeConfig().chatgpt.apiKey) {
+    throw createError({
+      statusCode: 403,
+      message: "Missing OpenAI API Key"
+    });
+  }
+  const openai = new OpenAI({
+    apiKey: useRuntimeConfig().chatgpt.apiKey
+  });
+  const requestOptions = {
+    messages: [{ role: "user", content: message }],
+    model: !model ? modelMap[MODEL_GPT_TURBO_3_5] : modelMap[model],
+    ...options || defaultOptions
+  };
+  try {
+    const chatCompletion = await openai.chat.completions.create(requestOptions);
+    return chatCompletion.choices[0].message?.content;
+  } catch (error) {
+    throw createError({
+      statusCode: 500,
+      message: "Failed to forward request to OpenAI API"
+    });
+  }
+});

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

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

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

@@ -0,0 +1,31 @@
+import OpenAI from "openai";
+import { createError, defineEventHandler, readBody } from "h3";
+import { defaultOptions } from "../../constants/options.mjs";
+import { modelMap } from "../../utils/model-map.mjs";
+import { useRuntimeConfig } from "#imports";
+export default defineEventHandler(async (event) => {
+  const { message, model, options } = await readBody(event);
+  if (!useRuntimeConfig().chatgpt.apiKey) {
+    throw createError({
+      statusCode: 403,
+      message: "Missing OpenAI API Key"
+    });
+  }
+  const openai = new OpenAI({
+    apiKey: useRuntimeConfig().chatgpt.apiKey
+  });
+  const requestOptions = {
+    prompt: message,
+    model: !model ? modelMap.default : modelMap[model],
+    ...options || defaultOptions
+  };
+  try {
+    const completion = await openai.completions.create(requestOptions);
+    return completion.choices[0].text?.slice(2);
+  } catch (error) {
+    throw createError({
+      statusCode: 500,
+      message: "Failed to forward request to OpenAI API"
+    });
+  }
+});

package/dist/runtime/types/index.d.ts

@@ -1,8 +1,20 @@
 export interface IChatgptClient {
-  send ( IMessage ) : Promise
+  chat(IMessage): Promise,
+  chatCompletion(IMessage): Promise
 }
 
 export interface IMessage {
   message: string
 }
 
+export interface IModel {
+  model: string
+}
+
+export interface IOptions {
+  temperature: number,
+  max_tokens: number,
+  top_p: number,
+  frequency_penalty: number,
+  presence_penalty: number,
+}

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

@@ -0,0 +1,4 @@
+export declare const modelMap: {
+    [x: string]: string;
+    default: string;
+};

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

@@ -0,0 +1,21 @@
+import {
+  MODEL_TEXT_DAVINCI_003,
+  MODEL_TEXT_DAVINCI_002,
+  MODEL_GPT_TURBO_3_5,
+  MODEL_GPT_TURBO_3_5_0301,
+  MODEL_GPT_4,
+  MODEL_GPT_4_0314,
+  MODEL_GPT_4_32k,
+  MODEL_GPT_4_32k_0314
+} 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_4]: MODEL_GPT_4,
+  [MODEL_GPT_4_0314]: MODEL_GPT_4_0314,
+  [MODEL_GPT_4_32k]: MODEL_GPT_4_32k,
+  [MODEL_GPT_4_32k_0314]: MODEL_GPT_4_32k_0314,
+  default: MODEL_TEXT_DAVINCI_003
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-chatgpt",
-  "version": "0.1.9",
+  "version": "0.2.1",
   "description": "ChatGPT integration for Nuxt 3",
   "license": "MIT",
   "type": "module",
@@ -54,8 +54,8 @@
   },
   "dependencies": {
     "@nuxt/kit": "^3.1.1",
-    "openai": "^3.2.1",
-    "defu": "^6.1.2"
+    "defu": "^6.1.2",
+    "openai": "^4.0.0"
   },
   "devDependencies": {
     "@nuxt/eslint-config": "^0.1.1",

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

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

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

@@ -1,27 +0,0 @@
-import { createError, defineEventHandler, readBody } from "h3";
-import { Configuration, OpenAIApi } from "openai";
-import { useRuntimeConfig } from "#imports";
-export default defineEventHandler(async (event) => {
-  const prompt = await readBody(event);
-  const configuration = new Configuration({
-    apiKey: useRuntimeConfig().chatgpt.apiKey
-  });
-  const openai = new OpenAIApi(configuration);
-  try {
-    const response = await openai.createCompletion({
-      model: "text-davinci-003",
-      prompt,
-      temperature: 0.5,
-      max_tokens: 2048,
-      top_p: 1,
-      frequency_penalty: 0,
-      presence_penalty: 0
-    });
-    return response.data.choices[0].text?.slice(2);
-  } catch (error) {
-    throw createError({
-      statusCode: 500,
-      message: "Failed to forward request to OpenAI API"
-    });
-  }
-});