From f248ad2490af414e55f8c7d1eb9a5470ce00bfc7 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Wed, 1 Feb 2023 18:15:56 -0600 Subject: [PATCH] chore: update docs --- docs/classes/ChatGPTAPI.md | 4 ++-- docs/classes/ChatGPTError.md | 4 ++-- docs/interfaces/ChatMessage.md | 10 +++++----- docs/modules.md | 8 ++++---- docs/modules/openai.md | 8 ++++---- docs/readme.md | 4 ++-- readme.md | 2 +- 7 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/classes/ChatGPTAPI.md b/docs/classes/ChatGPTAPI.md index c267758..758d233 100644 --- a/docs/classes/ChatGPTAPI.md +++ b/docs/classes/ChatGPTAPI.md @@ -40,7 +40,7 @@ unofficial ChatGPT model. #### Defined in -[src/chatgpt-api.ts:47](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/chatgpt-api.ts#L47) +[src/chatgpt-api.ts:47](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/chatgpt-api.ts#L47) ## Methods @@ -75,4 +75,4 @@ The response from ChatGPT #### Defined in -[src/chatgpt-api.ts:145](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/chatgpt-api.ts#L145) +[src/chatgpt-api.ts:145](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/chatgpt-api.ts#L145) diff --git a/docs/classes/ChatGPTError.md b/docs/classes/ChatGPTError.md index 340f386..5a32d5e 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/9d49e78/src/types.ts#L24) +[src/types.ts:24](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L24) ___ @@ -74,4 +74,4 @@ ___ #### Defined in -[src/types.ts:25](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/types.ts#L25) +[src/types.ts:25](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L25) diff --git a/docs/interfaces/ChatMessage.md b/docs/interfaces/ChatMessage.md index 7239912..27e4c7a 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/9d49e78/src/types.ts#L20) +[src/types.ts:20](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L20) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[src/types.ts:16](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/types.ts#L16) +[src/types.ts:16](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L16) ___ @@ -40,7 +40,7 @@ ___ #### Defined in -[src/types.ts:19](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/types.ts#L19) +[src/types.ts:19](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L19) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[src/types.ts:18](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/types.ts#L18) +[src/types.ts:18](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L18) ___ @@ -60,4 +60,4 @@ ___ #### Defined in -[src/types.ts:17](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/types.ts#L17) +[src/types.ts:17](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L17) diff --git a/docs/modules.md b/docs/modules.md index f940f55..be0e1fa 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/9d49e78/src/types.ts#L29) +[src/types.ts:29](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L29) ___ @@ -58,7 +58,7 @@ ___ #### Defined in -[src/types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/types.ts#L1) +[src/types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L1) ___ @@ -82,7 +82,7 @@ ___ #### Defined in -[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/types.ts#L3) +[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/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/9d49e78/src/types.ts#L32) +[src/types.ts:32](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L32) diff --git a/docs/modules/openai.md b/docs/modules/openai.md index dbb4e87..1c2166f 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/9d49e78/src/types.ts#L35) +[src/types.ts:35](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L35) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[src/types.ts:117](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/types.ts#L117) +[src/types.ts:117](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L117) ___ @@ -69,7 +69,7 @@ ___ #### Defined in -[src/types.ts:126](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/types.ts#L126) +[src/types.ts:126](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L126) ___ @@ -87,4 +87,4 @@ ___ #### Defined in -[src/types.ts:138](https://github.com/transitive-bullshit/chatgpt-api/blob/9d49e78/src/types.ts#L138) +[src/types.ts:138](https://github.com/transitive-bullshit/chatgpt-api/blob/2dd0ca9/src/types.ts#L138) diff --git a/docs/readme.md b/docs/readme.md index 957cc03..e649d5d 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -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. +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. ```ts const api = new ChatGPTAPI({ apiKey: process.env.OPENAI_API_KEY }) @@ -167,7 +167,7 @@ async function example() { ### Docs -See the [auto-generated docs](./docs/classes/ChatGPTAPI.md) for more info on methods and parameters. Here are the [docs](./docs/classes/ChatGPTAPI.md) for the browser-based version. +See the [auto-generated docs](./docs/classes/ChatGPTAPI.md) for more info on methods and parameters. ### Demos diff --git a/readme.md b/readme.md index cc333e1..d8fcae5 100644 --- a/readme.md +++ b/readme.md @@ -165,7 +165,7 @@ async function example() { ### Docs -See the [auto-generated docs](./docs/classes/ChatGPTAPI.md) for more info on methods and parameters. Here are the [docs](./docs/classes/ChatGPTAPI.md) for the browser-based version. +See the [auto-generated docs](./docs/classes/ChatGPTAPI.md) for more info on methods and parameters. ### Demos