diff --git a/docs/classes/ChatGPTAPI.md b/docs/classes/ChatGPTAPI.md index 758d233..538fdcf 100644 --- a/docs/classes/ChatGPTAPI.md +++ b/docs/classes/ChatGPTAPI.md @@ -29,7 +29,7 @@ unofficial ChatGPT model. | `opts.apiBaseUrl?` | `string` | **`Default Value`** `'https://api.openai.com'` * | | `opts.apiKey` | `string` | - | | `opts.assistantLabel?` | `string` | **`Default Value`** `'ChatGPT'` * | -| `opts.completionParams?` | [`CompletionParams`](../modules/openai.md#completionparams) | - | +| `opts.completionParams?` | `Partial`<[`CompletionParams`](../modules/openai.md#completionparams)\> | - | | `opts.debug?` | `boolean` | **`Default Value`** `false` * | | `opts.getMessageById?` | [`GetMessageByIdFunction`](../modules.md#getmessagebyidfunction) | - | | `opts.maxModelTokens?` | `number` | **`Default Value`** `4096` * | @@ -40,7 +40,7 @@ unofficial ChatGPT model. #### Defined in -[src/chatgpt-api.ts:47](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/chatgpt-api.ts#L47) +[src/chatgpt-api.ts:48](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/chatgpt-api.ts#L48) ## Methods @@ -75,4 +75,4 @@ The response from ChatGPT #### Defined in -[src/chatgpt-api.ts:145](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/chatgpt-api.ts#L145) +[src/chatgpt-api.ts:146](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/chatgpt-api.ts#L146) diff --git a/docs/classes/ChatGPTError.md b/docs/classes/ChatGPTError.md index 5a32d5e..174f674 100644 --- a/docs/classes/ChatGPTError.md +++ b/docs/classes/ChatGPTError.md @@ -64,7 +64,7 @@ node_modules/.pnpm/typescript@4.9.5/node_modules/typescript/lib/lib.es2022.error #### Defined in -[src/types.ts:24](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L24) +[src/types.ts:24](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L24) ___ @@ -74,4 +74,4 @@ ___ #### Defined in -[src/types.ts:25](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L25) +[src/types.ts:25](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L25) diff --git a/docs/interfaces/ChatMessage.md b/docs/interfaces/ChatMessage.md index 27e4c7a..97ad29a 100644 --- a/docs/interfaces/ChatMessage.md +++ b/docs/interfaces/ChatMessage.md @@ -20,7 +20,7 @@ #### Defined in -[src/types.ts:20](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L20) +[src/types.ts:20](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L20) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[src/types.ts:16](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L16) +[src/types.ts:16](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L16) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[src/types.ts:19](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L19) +[src/types.ts:19](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L19) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[src/types.ts:18](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L18) +[src/types.ts:18](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L18) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -[src/types.ts:17](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L17) +[src/types.ts:17](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L17) diff --git a/docs/modules.md b/docs/modules.md index be0e1fa..fcf205a 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -48,7 +48,7 @@ Returns a chat message from a store by it's ID (or null if not found). #### Defined in -[src/types.ts:29](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L29) +[src/types.ts:29](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L29) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[src/types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L1) +[src/types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L1) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L3) +[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L3) ___ @@ -108,4 +108,4 @@ Upserts a chat message to a store. #### Defined in -[src/types.ts:32](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L32) +[src/types.ts:32](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L32) diff --git a/docs/modules/openai.md b/docs/modules/openai.md index 1c2166f..90f765c 100644 --- a/docs/modules/openai.md +++ b/docs/modules/openai.md @@ -38,7 +38,7 @@ #### Defined in -[src/types.ts:35](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L35) +[src/types.ts:35](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L35) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[src/types.ts:117](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L117) +[src/types.ts:117](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L117) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[src/types.ts:126](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L126) +[src/types.ts:126](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L126) ___ @@ -87,4 +87,4 @@ ___ #### Defined in -[src/types.ts:138](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L138) +[src/types.ts:138](https://github.com/transitive-bullshit/chatgpt-api/blob/aefae23/src/types.ts#L138) diff --git a/docs/readme.md b/docs/readme.md index e649d5d..388ec84 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -15,9 +15,9 @@ const res = await api.sendMessage('Hello World!') console.log(res.text) ``` -Please upgrade to `chatgpt@latest` (at least [v4.0.0](https://github.com/transitive-bullshit/chatgpt-api/releases/tag/v4.0.0)). The updated version is **significantly more lightweight and robust** compared with previous versions. You also don't have to worry about IP issues or rate limiting! +Please upgrade to `chatgpt@latest` (at least [v4.0.0](https://github.com/transitive-bullshit/chatgpt-api/releases/tag/v4.0.0)). The updated version is **significantly more lightweight and robust** compared with previous versions. You also don't have to worry about IP issues or rate limiting. -Huge shoutout to [@waylaidwanderer](https://github.com/waylaidwanderer) for discovering the leaked chat model! 💪 +Huge shoutout to [@waylaidwanderer](https://github.com/waylaidwanderer) for discovering the leaked chat model! If you run into any issues, we do have a pretty active [Discord](https://discord.gg/v9gERj825w) with a bunch of ChatGPT hackers from the Node.js & Python communities. @@ -79,7 +79,7 @@ async function example() { } ``` -If you want to track the conversation, use the `conversationId` and `id` in the result object, and pass them to `sendMessage` as `conversationId` and `parentMessageId` respectively. `parentMessageId` is the most important parameter for recalling previous message context. +If you want to track the conversation, you'll need to pass the `parentMessageid` and `conversationid`: ```ts const api = new ChatGPTAPI({ apiKey: process.env.OPENAI_API_KEY }) @@ -197,7 +197,7 @@ A [conversation demo](./demos/demo-conversation.ts): npx tsx demos/demo-conversation.ts ``` -Lastly, a [persitence demo](./demos/demo-persistence.ts) shows how to store messages in Redis for persistence: +A [persistence demo](./demos/demo-persistence.ts) shows how to store messages in Redis for persistence: ```bash npx tsx demos/demo-conversation.ts @@ -205,7 +205,7 @@ npx tsx demos/demo-conversation.ts Any [keyv adaptor](https://github.com/jaredwray/keyv) is supported for persistence, and there are overrides if you'd like to use a different way of storing / retrieving messages. -Note that persisting message is very important for remembering the context of previous conversations. +Note that persisting message is required for remembering the context of previous conversations beyond the scope of the current Node.js process, since by default, we only store messages in memory. ## Projects @@ -214,6 +214,7 @@ All of these awesome projects are built using the `chatgpt` package. 🤯 - [Twitter Bot](https://github.com/transitive-bullshit/chatgpt-twitter-bot) powered by ChatGPT ✨ - Mention [@ChatGPTBot](https://twitter.com/ChatGPTBot) on Twitter with your prompt to try it out - [ChatGPT API Server](https://github.com/waylaidwanderer/node-chatgpt-api) - API server for this package with support for multiple OpenAI accounts, proxies, and load-balancing requests between accounts. +- [ChatGPT Prompts](https://github.com/pacholoamit/chatgpt-prompts) - A collection of 140+ of the best ChatGPT prompts from the community. - [Lovelines.xyz](https://lovelines.xyz?ref=chatgpt-api) - [Chrome Extension](https://github.com/gragland/chatgpt-everywhere) ([demo](https://twitter.com/gabe_ragland/status/1599466486422470656)) - [VSCode Extension #1](https://github.com/mpociot/chatgpt-vscode) ([demo](https://twitter.com/marcelpociot/status/1599180144551526400), [updated version](https://github.com/timkmecl/chatgpt-vscode), [marketplace](https://marketplace.visualstudio.com/items?itemName=timkmecl.chatgpt)) @@ -264,6 +265,8 @@ All of these awesome projects are built using the `chatgpt` package. 🤯 - [iOS Shortcut](https://github.com/leecobaby/shortcuts/blob/master/other/ChatGPT_EN.md) - [Slack Bot #1](https://github.com/trietphm/chatgpt-slackbot/) - [Slack Bot #2](https://github.com/lokwkin/chatgpt-slackbot-node/) (with queueing mechanism) +- [Slack Bot #3](https://github.com/NessunKim/slack-chatgpt/) +- [Slack Bot #4](https://github.com/MarkusGalant/chatgpt-slackbot-serverless/) ( Serverless AWS Lambda ) - [Electron Bot](https://github.com/ShiranAbir/chaty) - [Kodyfire CLI](https://github.com/nooqta/chatgpt-kodyfire) - [Twitch Bot](https://github.com/BennyDeeDev/chatgpt-twitch-bot) @@ -273,6 +276,8 @@ All of these awesome projects are built using the `chatgpt` package. 🤯 - [NestJS ChatGPT Starter Boilerplate](https://github.com/mitkodkn/nestjs-chatgpt-starter) - [Wordsmith: Add-in for Microsoft Word](https://github.com/xtremehpx/Wordsmith) - [QuizGPT: Create Kahoot quizzes with ChatGPT](https://github.com/Kladdy/quizgpt) +- [openai-chatgpt: Talk to ChatGPT from the terminal](https://github.com/gmpetrov/openai-chatgpt) +- [Clippy the Saleforce chatbot](https://github.com/sebas00/chatgptclippy) ClippyJS joke bot If you create a cool integration, feel free to open a PR and add it to the list. @@ -282,7 +287,7 @@ If you create a cool integration, feel free to open a PR and add it to the list. - This package supports `node >= 14`. - This module assumes that `fetch` is installed. - In `node >= 18`, it's installed by default. - - In `node < 18`, you need to install a polyfill like `unfetch/polyfill` ([guide](https://github.com/developit/unfetch#usage-as-a-polyfill)) + - In `node < 18`, you need to install a polyfill like `unfetch/polyfill` ([guide](https://github.com/developit/unfetch#usage-as-a-polyfill)) or `isomorphic-fetch` ([guide](https://github.com/matthew-andrews/isomorphic-fetch#readme)). - If you want to build a website using `chatgpt`, we recommend using it only from your backend API ## Credits