Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/schnapsterdog/nuxt-chatgpt

ChatGPT integration for Nuxt 3
https://github.com/schnapsterdog/nuxt-chatgpt
chatgpt chatgpt-api chatgpt-bot chatgpt3 nuxt3 typescript vue3
Last synced: 1 day ago
JSON representation
ChatGPT integration for Nuxt 3
Host: GitHub
URL: https://github.com/schnapsterdog/nuxt-chatgpt
Owner: SchnapsterDog
License: mit
Created: 2023-03-16T18:43:04.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-04-03T13:29:38.000Z (8 months ago)
Last Synced: 2024-04-26T19:48:14.847Z (7 months ago)
Topics: chatgpt, chatgpt-api, chatgpt-bot, chatgpt3, nuxt3, typescript, vue3
Language: TypeScript
Homepage: https://www.buymeacoffee.com/schnapsterdog
Size: 930 KB
Stars: 151
Watchers: 2
Forks: 17
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project

README

        





  

  Nuxt Chatgpt + Image Generator🔥(VIEW DEMO)🔥

  

  



  

  

  


  > [ChatGPT](https://nuxtchatgpt.com) integration for [Nuxt 3](https://nuxt.com).

  [![npm version][npm-version-src]][npm-version-href]

  [![npm downloads][npm-downloads-src]][npm-downloads-href]

  [![License][license-src]][license-href]






## About the project

[Nuxt ChatGPT](https://nuxtchatgpt.com) is a project built to showcase the capabilities of the Nuxt3 ChatGPT module. It functions as a ChatGPT clone with enhanced features, including the ability to organize and sort created documents into folders, offering an improved user experience for managing conversations and outputs.

## 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 sweat. Enjoy easy access to the `chat`, and `chatCompletion` methods through the `useChatgpt()` composable. Additionally, the module guarantees security as requests are routed through a [Nitro Server](https://nuxt.com/docs/guide/concepts/server-engine), thus preventing the exposure of your API Key. The module use [openai](https://github.com/openai/openai-node) library version 4.0.0 behind the scene.

## Features

- 💪   Easy implementation into any [Nuxt 3](https://nuxt.com) project.

- 👉   Type-safe integration of Chatgpt into your [Nuxt 3](https://nuxt.com) project.

- 🕹️   Provides a `useChatgpt()` composable that grants easy access to the `chat`, and `chatCompletion`, and `generateImage` methods.

- 🔥   Ensures security by routing requests through a [Nitro Server](https://nuxt.com/docs/guide/concepts/server-engine), preventing the API Key from being exposed.

- 🧱   It is lightweight and performs well.

## Getting Started

1. Add nuxt-chatgpt dependency to your project

* npm

  ```sh

  npm install --save-dev nuxt-chatgpt

  ```

* pnpm

  ```sh

  pnpm add -D nuxt-chatgpt

  ```

* yarn

  ```sh

  yarn add --dev nuxt-chatgpt

  ```

2. Add nuxt-chatgpt to the modules section of nuxt.config.ts

```js

export default defineNuxtConfig({

  modules: ["nuxt-chatgpt"],

  // entirely optional

  chatgpt: {

    apiKey: 'Your apiKey here goes here'

  },

})

```

That's it! You can now use Nuxt Chatgpt in your Nuxt app 🔥

## Usage & Examples

To access the `chat`, `chatCompletion`, and `generateImage` 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:

| Name | Type | Default | Description |

|--|--|--|--|

|**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`|`gpt-4o-mini` for `chat()` and `gpt-4o-mini` 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.

The `generateImage` method requires one parameters:

| Name | Type | Default | Description |

|--|--|--|--|

|**message**|`String`| A text description of the desired image(s). The maximum length is 1000 characters.

|**model**|`String`|`dall-e-2` or `dall-e-3`| The model to use for image generation. Only dall-e-2 is supported at this time.

|**options**|`Object`|`{ n: 1, quality: 'standard', response_format: 'url', size: '1024x1024', style: 'natural' }`|An optional object that specifies any additional options you want to pass to the API request, such as, the number of images to generate, quality, size and style of the generated images.

Available models:

- text-davinci-002

- text-davinci-003

- gpt-3.5-turbo

- gpt-3.5-turbo-0301

- gpt-3.5-turbo-1106

- gpt-4

- gpt-4o

- gpt-4o-mini

- gpt-4-turbo

- gpt-4-1106-preview

- gpt-4-0314

- gpt-4-0613

- gpt-4-32k

- gpt-4-32k-0314

- gpt-4-32k-0613

- dall-e-2

- dall-e-3

### Simple `chat` usage 

In the following example, the model is unspecified, and the gpt-4o-mini model will be used by default.

```js

const { chat } = useChatgpt()

const data = ref('')

const inputData = ref('')

async function sendMessage() {

  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}`)

  }

}

```

```html

  


    

    

    {{ data }}

  


```

### Usage of `chat` with different model

```js

const { chat } = useChatgpt()

const data = ref('')

const inputData = ref('')

async function sendMessage() {

  try {

    const response = await chat(inputData.value, 'gpt-4o-mini')

    data.value = response

  } catch(error) {

    alert(`Join the waiting list if you want to use GPT-4 models: ${error}`)

  }

}

```

```html

  


    

    

    {{ data }}

  


```

### Simple `chatCompletion` usage 

In the following example, the model is unspecified, and the gpt-4o-mini model will be used by default.

```js

const { chatCompletion } = useChatgpt()

const chatTree = ref([])

const inputData = ref('')

async function sendMessage() {

  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}`)

  }

}

```

```html

  


    

    

    

      

        {{ chat.role }} :

        {{ chat.content }} 

      

    

  


```

### Usage of `chatCompletion` with different model

```js

const { chatCompletion } = useChatgpt()

const chatTree = ref([])

const inputData = ref('')

async function sendMessage() {

  try {

    const message = {

      role: 'user',

      content: `${inputData.value}`,

    }

    chatTree.value.push(message)

    const response = await chatCompletion(chatTree.value, 'gpt-4o-mini')

    

    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}`)

  }

}

```

```html

  


    

    

    

      

        {{ chat.role }} :

        {{ chat.content }} 

      

    

  


```

### Simple `generateImage` usage 

In the following example, the model is unspecified, and the dall-e-2 model will be used by default.

```js

const { generateImage } = useChatgpt()

const images = ref([])

const inputData = ref('')

const loading = ref(false)

async function sendPrompt() {

  loading.value = true

  try {

    images.value = await generateImage(inputData.value)

  } catch (error) {

    alert(`Error: ${error}`)

  }

  loading.value = false

}

```

```html

  


    

      

      

    

    Generating, please wait ...

    

      

    

  


```

### Usage of `generateImage` with different model, and options

```js

const { generateImage } = useChatgpt()

const images = ref([])

const inputData = ref('')

const loading = ref(false)

async function sendPrompt() {

  loading.value = true

  try {

    images.value = await generateImage(inputData.value, 'dall-e-2', {

      n: 1,

      quality: 'standard',

      response_format: 'url',

      size: '1024x1024',

      style: 'natural'

    })

  } catch (error) {

    alert(`Error: ${error}`)

  }

  loading.value = false

}

```

```html

  


    

      

      

    

    Generating, please wait ...

    

      

    

  


```

## 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 |

|--|--|--|--|

|**apiKey**|`String`|`xxxxxx`|Your apiKey here goes here

|**isEnabled**|`Boolean`|`true`| Enable or disable the module. `True` by default.

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

## Contact

Oliver Trajceski - [LinkedIn](https://mk.linkedin.com/in/oliver-trajceski-8a28b070) - [email protected]

Project Link: [https://nuxtchatgpt.com](https://nuxtchatgpt.com)

## Development

```bash

# Install dependencies

npm install

# Generate type stubs

npm run dev:prepare

# Develop with the playground

npm run dev

# Build the playground

npm run dev:build

# Run ESLint

npm run lint

# Run Vitest

npm run test

npm run test:watch

# Release new version

npm run release

```

## Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

* [Choose an Open Source License](https://choosealicense.com)

* [Img Shields](https://shields.io)

* [GitHub Pages](https://pages.github.com)

[contributors-shield]: https://img.shields.io/github/contributors/schnapsterdog/nuxt-chatgpt.svg?style=for-the-badge

[contributors-url]: https://github.com/schnapsterdog/nuxt-chatgpt/graphs/contributors

[downloads-shield]: https://img.shields.io/npm/dw/nuxt-chatgpt.svg?style=for-the-badge

[downloads-url]: https://www.npmjs.com/package/nuxt-chatgpt

[stars-shield]: https://img.shields.io/github/stars/nuxt-chatgpt.svg?style=for-the-badge

[stars-url]: https://github.com/schnapsterdog/nuxt-chatgpt/stargazers

[issues-shield]: https://img.shields.io/github/issues/schnapsterdog/nuxt-chatgpt.svg?style=for-the-badge

[issues-url]: https://github.com/schnapsterdog/nuxt-chatgpt/issues

[license-shield]: https://img.shields.io/github/license/schnapsterdog/nuxt-chatgpt.svg?style=for-the-badge

[license-url]: https://github.com/schnapsterdog/nuxt-chatgpt/blob/master/LICENSE.txt

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://mk.linkedin.com/in/oliver-trajceski-8a28b070

[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D

[Vue-url]: https://vuejs.org/

[npm-version-src]: https://img.shields.io/npm/v/nuxt-chatgpt/latest.svg?style=flat&colorA=18181B&colorB=28CF8D

[npm-version-href]: https://npmjs.com/package/nuxt-chatgpt

[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-chatgpt.svg?style=flat&colorA=18181B&colorB=28CF8D

[npm-downloads-href]: https://npmjs.com/package/nuxt-chatgpt

[license-src]: https://img.shields.io/npm/l/nuxt-chatgpt.svg?style=flat&colorA=18181B&colorB=28CF8D

[license-href]: https://npmjs.com/package/nuxt-chatgpt