From fc3aad3d7d47aaec5527640e75fae2ab2ee89313 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Sat, 11 Mar 2023 05:08:14 -0600 Subject: [PATCH] chore: update ts docs --- docs/classes/ChatGPTAPI.md | 8 ++--- docs/classes/ChatGPTError.md | 8 ++--- docs/classes/ChatGPTUnofficialProxyAPI.md | 10 +++--- docs/interfaces/ChatMessage.md | 16 +++++----- .../openai.ChatCompletionRequestMessage.md | 6 ++-- .../openai.ChatCompletionResponseMessage.md | 4 +-- ...penai.CreateChatCompletionDeltaResponse.md | 10 +++--- .../openai.CreateChatCompletionRequest.md | 24 +++++++------- .../openai.CreateChatCompletionResponse.md | 12 +++---- ...reateChatCompletionResponseChoicesInner.md | 6 ++-- .../openai.CreateCompletionResponseUsage.md | 6 ++-- docs/modules.md | 32 +++++++++---------- docs/modules/openai.md | 18 +++++------ docs/readme.md | 9 +++--- 14 files changed, 84 insertions(+), 85 deletions(-) diff --git a/docs/classes/ChatGPTAPI.md b/docs/classes/ChatGPTAPI.md index 039495b..9224ed4 100644 --- a/docs/classes/ChatGPTAPI.md +++ b/docs/classes/ChatGPTAPI.md @@ -32,7 +32,7 @@ Creates a new client wrapper around OpenAI's chat completion API, mimicing the o #### Defined in -[src/chatgpt-api.ts:49](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/chatgpt-api.ts#L49) +[src/chatgpt-api.ts:49](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-api.ts#L49) ## Accessors @@ -46,7 +46,7 @@ Creates a new client wrapper around OpenAI's chat completion API, mimicing the o #### Defined in -[src/chatgpt-api.ts:310](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/chatgpt-api.ts#L310) +[src/chatgpt-api.ts:308](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-api.ts#L308) • `set` **apiKey**(`apiKey`): `void` @@ -62,7 +62,7 @@ Creates a new client wrapper around OpenAI's chat completion API, mimicing the o #### Defined in -[src/chatgpt-api.ts:314](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/chatgpt-api.ts#L314) +[src/chatgpt-api.ts:312](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-api.ts#L312) ## Methods @@ -94,4 +94,4 @@ The response from ChatGPT #### Defined in -[src/chatgpt-api.ts:131](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/chatgpt-api.ts#L131) +[src/chatgpt-api.ts:131](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-api.ts#L131) diff --git a/docs/classes/ChatGPTError.md b/docs/classes/ChatGPTError.md index 7265d85..7b02684 100644 --- a/docs/classes/ChatGPTError.md +++ b/docs/classes/ChatGPTError.md @@ -66,7 +66,7 @@ node_modules/.pnpm/typescript@4.9.5/node_modules/typescript/lib/lib.es2022.error #### Defined in -[src/types.ts:77](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L77) +[src/types.ts:77](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L77) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[src/types.ts:76](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L76) +[src/types.ts:76](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L76) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[src/types.ts:74](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L74) +[src/types.ts:74](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L74) ___ @@ -96,4 +96,4 @@ ___ #### Defined in -[src/types.ts:75](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L75) +[src/types.ts:75](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L75) diff --git a/docs/classes/ChatGPTUnofficialProxyAPI.md b/docs/classes/ChatGPTUnofficialProxyAPI.md index 523e252..eea3ec0 100644 --- a/docs/classes/ChatGPTUnofficialProxyAPI.md +++ b/docs/classes/ChatGPTUnofficialProxyAPI.md @@ -28,7 +28,7 @@ | :------ | :------ | :------ | | `opts` | `Object` | - | | `opts.accessToken` | `string` | - | -| `opts.apiReverseProxyUrl?` | `string` | **`Default Value`** `https://chat.openai.com/backend-api/conversation` * | +| `opts.apiReverseProxyUrl?` | `string` | **`Default Value`** `https://bypass.duti.tech/api/conversation` * | | `opts.debug?` | `boolean` | **`Default Value`** `false` * | | `opts.fetch?` | (`input`: `RequestInfo` \| `URL`, `init?`: `RequestInit`) => `Promise`<`Response`\> | - | | `opts.headers?` | `Record`<`string`, `string`\> | **`Default Value`** `undefined` * | @@ -36,7 +36,7 @@ #### Defined in -[src/chatgpt-unofficial-proxy-api.ts:20](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/chatgpt-unofficial-proxy-api.ts#L20) +[src/chatgpt-unofficial-proxy-api.ts:20](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-unofficial-proxy-api.ts#L20) ## Accessors @@ -50,7 +50,7 @@ #### Defined in -[src/chatgpt-unofficial-proxy-api.ts:66](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/chatgpt-unofficial-proxy-api.ts#L66) +[src/chatgpt-unofficial-proxy-api.ts:66](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-unofficial-proxy-api.ts#L66) • `set` **accessToken**(`value`): `void` @@ -66,7 +66,7 @@ #### Defined in -[src/chatgpt-unofficial-proxy-api.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/chatgpt-unofficial-proxy-api.ts#L70) +[src/chatgpt-unofficial-proxy-api.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-unofficial-proxy-api.ts#L70) ## Methods @@ -101,4 +101,4 @@ The response from ChatGPT #### Defined in -[src/chatgpt-unofficial-proxy-api.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/chatgpt-unofficial-proxy-api.ts#L97) +[src/chatgpt-unofficial-proxy-api.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-unofficial-proxy-api.ts#L97) diff --git a/docs/interfaces/ChatMessage.md b/docs/interfaces/ChatMessage.md index c93ce3f..1b0958f 100644 --- a/docs/interfaces/ChatMessage.md +++ b/docs/interfaces/ChatMessage.md @@ -23,7 +23,7 @@ #### Defined in -[src/types.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L70) +[src/types.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L70) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[src/types.ts:64](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L64) +[src/types.ts:64](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L64) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[src/types.ts:65](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L65) +[src/types.ts:65](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L65) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[src/types.ts:60](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L60) +[src/types.ts:60](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L60) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[src/types.ts:63](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L63) +[src/types.ts:63](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L63) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[src/types.ts:68](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L68) +[src/types.ts:68](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L68) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[src/types.ts:62](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L62) +[src/types.ts:62](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L62) ___ @@ -93,4 +93,4 @@ ___ #### Defined in -[src/types.ts:61](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L61) +[src/types.ts:61](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L61) diff --git a/docs/interfaces/openai.ChatCompletionRequestMessage.md b/docs/interfaces/openai.ChatCompletionRequestMessage.md index 744a5b9..991abb0 100644 --- a/docs/interfaces/openai.ChatCompletionRequestMessage.md +++ b/docs/interfaces/openai.ChatCompletionRequestMessage.md @@ -32,7 +32,7 @@ ChatCompletionRequestMessage #### Defined in -[src/types.ts:208](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L208) +[src/types.ts:208](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L208) ___ @@ -48,7 +48,7 @@ ChatCompletionRequestMessage #### Defined in -[src/types.ts:214](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L214) +[src/types.ts:214](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L214) ___ @@ -64,4 +64,4 @@ ChatCompletionRequestMessage #### Defined in -[src/types.ts:202](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L202) +[src/types.ts:202](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L202) diff --git a/docs/interfaces/openai.ChatCompletionResponseMessage.md b/docs/interfaces/openai.ChatCompletionResponseMessage.md index 5ec8a2a..4ec6445 100644 --- a/docs/interfaces/openai.ChatCompletionResponseMessage.md +++ b/docs/interfaces/openai.ChatCompletionResponseMessage.md @@ -31,7 +31,7 @@ ChatCompletionResponseMessage #### Defined in -[src/types.ts:240](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L240) +[src/types.ts:240](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L240) ___ @@ -47,4 +47,4 @@ ChatCompletionResponseMessage #### Defined in -[src/types.ts:234](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L234) +[src/types.ts:234](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L234) diff --git a/docs/interfaces/openai.CreateChatCompletionDeltaResponse.md b/docs/interfaces/openai.CreateChatCompletionDeltaResponse.md index a7e913b..a351be2 100644 --- a/docs/interfaces/openai.CreateChatCompletionDeltaResponse.md +++ b/docs/interfaces/openai.CreateChatCompletionDeltaResponse.md @@ -22,7 +22,7 @@ #### Defined in -[src/types.ts:179](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L179) +[src/types.ts:179](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L179) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[src/types.ts:177](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L177) +[src/types.ts:177](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L177) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[src/types.ts:175](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L175) +[src/types.ts:175](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L175) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[src/types.ts:178](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L178) +[src/types.ts:178](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L178) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -[src/types.ts:176](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L176) +[src/types.ts:176](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L176) diff --git a/docs/interfaces/openai.CreateChatCompletionRequest.md b/docs/interfaces/openai.CreateChatCompletionRequest.md index f446187..9c3899b 100644 --- a/docs/interfaces/openai.CreateChatCompletionRequest.md +++ b/docs/interfaces/openai.CreateChatCompletionRequest.md @@ -41,7 +41,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:314](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L314) +[src/types.ts:314](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L314) ___ @@ -57,7 +57,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:320](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L320) +[src/types.ts:320](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L320) ___ @@ -73,7 +73,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:302](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L302) +[src/types.ts:302](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L302) ___ @@ -89,7 +89,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:266](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L266) +[src/types.ts:266](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L266) ___ @@ -105,7 +105,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:260](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L260) +[src/types.ts:260](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L260) ___ @@ -121,7 +121,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:284](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L284) +[src/types.ts:284](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L284) ___ @@ -137,7 +137,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:308](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L308) +[src/types.ts:308](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L308) ___ @@ -151,7 +151,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:296](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L296) +[src/types.ts:296](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L296) ___ @@ -167,7 +167,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:290](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L290) +[src/types.ts:290](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L290) ___ @@ -183,7 +183,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:272](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L272) +[src/types.ts:272](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L272) ___ @@ -199,7 +199,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:278](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L278) +[src/types.ts:278](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L278) ___ @@ -215,4 +215,4 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:326](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L326) +[src/types.ts:326](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L326) diff --git a/docs/interfaces/openai.CreateChatCompletionResponse.md b/docs/interfaces/openai.CreateChatCompletionResponse.md index 5b6072c..7f57dcf 100644 --- a/docs/interfaces/openai.CreateChatCompletionResponse.md +++ b/docs/interfaces/openai.CreateChatCompletionResponse.md @@ -33,7 +33,7 @@ CreateChatCompletionResponse #### Defined in -[src/types.ts:369](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L369) +[src/types.ts:369](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L369) ___ @@ -47,7 +47,7 @@ CreateChatCompletionResponse #### Defined in -[src/types.ts:357](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L357) +[src/types.ts:357](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L357) ___ @@ -61,7 +61,7 @@ CreateChatCompletionResponse #### Defined in -[src/types.ts:345](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L345) +[src/types.ts:345](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L345) ___ @@ -75,7 +75,7 @@ CreateChatCompletionResponse #### Defined in -[src/types.ts:363](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L363) +[src/types.ts:363](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L363) ___ @@ -89,7 +89,7 @@ CreateChatCompletionResponse #### Defined in -[src/types.ts:351](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L351) +[src/types.ts:351](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L351) ___ @@ -103,4 +103,4 @@ CreateChatCompletionResponse #### Defined in -[src/types.ts:375](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L375) +[src/types.ts:375](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L375) diff --git a/docs/interfaces/openai.CreateChatCompletionResponseChoicesInner.md b/docs/interfaces/openai.CreateChatCompletionResponseChoicesInner.md index b37a24c..3e3909f 100644 --- a/docs/interfaces/openai.CreateChatCompletionResponseChoicesInner.md +++ b/docs/interfaces/openai.CreateChatCompletionResponseChoicesInner.md @@ -30,7 +30,7 @@ CreateChatCompletionResponseChoicesInner #### Defined in -[src/types.ts:400](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L400) +[src/types.ts:400](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L400) ___ @@ -44,7 +44,7 @@ CreateChatCompletionResponseChoicesInner #### Defined in -[src/types.ts:388](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L388) +[src/types.ts:388](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L388) ___ @@ -58,4 +58,4 @@ CreateChatCompletionResponseChoicesInner #### Defined in -[src/types.ts:394](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L394) +[src/types.ts:394](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L394) diff --git a/docs/interfaces/openai.CreateCompletionResponseUsage.md b/docs/interfaces/openai.CreateCompletionResponseUsage.md index e34e21c..2d1f7f3 100644 --- a/docs/interfaces/openai.CreateCompletionResponseUsage.md +++ b/docs/interfaces/openai.CreateCompletionResponseUsage.md @@ -30,7 +30,7 @@ CreateCompletionResponseUsage #### Defined in -[src/types.ts:419](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L419) +[src/types.ts:419](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L419) ___ @@ -44,7 +44,7 @@ CreateCompletionResponseUsage #### Defined in -[src/types.ts:413](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L413) +[src/types.ts:413](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L413) ___ @@ -58,4 +58,4 @@ CreateCompletionResponseUsage #### Defined in -[src/types.ts:425](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L425) +[src/types.ts:425](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L425) diff --git a/docs/modules.md b/docs/modules.md index 95aefb0..ff7d347 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -61,7 +61,7 @@ #### Defined in -[src/types.ts:7](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L7) +[src/types.ts:7](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L7) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[src/types.ts:133](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L133) +[src/types.ts:133](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L133) ___ @@ -93,7 +93,7 @@ https://chat.openapi.com/backend-api/conversation #### Defined in -[src/types.ts:89](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L89) +[src/types.ts:89](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L89) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -[src/types.ts:147](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L147) +[src/types.ts:147](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L147) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -[src/types.ts:5](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L5) +[src/types.ts:5](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L5) ___ @@ -147,7 +147,7 @@ Returns a chat message from a store by it's ID (or null if not found). #### Defined in -[src/types.ts:81](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L81) +[src/types.ts:81](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L81) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[src/types.ts:153](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L153) +[src/types.ts:153](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L153) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[src/types.ts:47](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L47) +[src/types.ts:47](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L47) ___ @@ -199,7 +199,7 @@ ___ #### Defined in -[src/types.ts:166](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L166) +[src/types.ts:166](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L166) ___ @@ -209,7 +209,7 @@ ___ #### Defined in -[src/types.ts:171](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L171) +[src/types.ts:171](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L171) ___ @@ -227,7 +227,7 @@ ___ #### Defined in -[src/types.ts:116](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L116) +[src/types.ts:116](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L116) ___ @@ -244,7 +244,7 @@ ___ #### Defined in -[src/types.ts:135](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L135) +[src/types.ts:135](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L135) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L3) +[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L3) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[src/types.ts:49](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L49) +[src/types.ts:49](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L49) ___ @@ -299,7 +299,7 @@ ___ #### Defined in -[src/types.ts:35](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L35) +[src/types.ts:35](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L35) ___ @@ -325,4 +325,4 @@ Upserts a chat message to a store. #### Defined in -[src/types.ts:84](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L84) +[src/types.ts:84](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L84) diff --git a/docs/modules/openai.md b/docs/modules/openai.md index 1e46294..c6f56e1 100644 --- a/docs/modules/openai.md +++ b/docs/modules/openai.md @@ -33,9 +33,9 @@ #### Defined in -[src/types.ts:216](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L216) +[src/types.ts:216](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L216) -[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L221) +[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L221) ___ @@ -45,9 +45,9 @@ ___ #### Defined in -[src/types.ts:242](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L242) +[src/types.ts:242](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L242) -[src/types.ts:247](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L247) +[src/types.ts:247](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L247) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[src/types.ts:333](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L333) +[src/types.ts:333](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L333) ## Variables @@ -77,9 +77,9 @@ ___ #### Defined in -[src/types.ts:216](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L216) +[src/types.ts:216](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L216) -[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L221) +[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L221) ___ @@ -97,6 +97,6 @@ ___ #### Defined in -[src/types.ts:242](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L242) +[src/types.ts:242](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L242) -[src/types.ts:247](https://github.com/transitive-bullshit/chatgpt-api/blob/48cb944/src/types.ts#L247) +[src/types.ts:247](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L247) diff --git a/docs/readme.md b/docs/readme.md index a365566..e370947 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -71,7 +71,7 @@ We now provide three ways of accessing the unofficial ChatGPT API, all of which **Note**: I recommend that you use either `ChatGPTAPI` or `ChatGPTUnofficialProxyAPI`. -1. `ChatGPTAPI` - Uses `text-davinci-003` to mimic ChatGPT via the official OpenAI completions API (most robust approach, but it's not free and doesn't use a model fine-tuned for chat) +1. `ChatGPTAPI` - (Used to use) `text-davinci-003` to mimic ChatGPT via the official OpenAI completions API (most robust approach, but it's not free and doesn't use a model fine-tuned for chat) 2. `ChatGPTUnofficialProxyAPI` - Uses an unofficial proxy server to access ChatGPT's backend API in a way that circumvents Cloudflare (uses the real ChatGPT and is pretty lightweight, but relies on a third-party server and is rate-limited) 3. `ChatGPTAPIBrowser` - (_deprecated_; v3.5.1 of this package) Uses Puppeteer to access the official ChatGPT webapp (uses the real ChatGPT, but very flaky, heavyweight, and error prone) @@ -131,8 +131,6 @@ npx chatgpt "your prompt here" By default, the response is streamed to stdout, the results are stored in a local config file, and every invocation starts a new conversation. You can use `-c` to continue the previous conversation and `--no-stream` to disable streaming. -Under the hood, the CLI uses `ChatGPTAPI` with `text-davinci-003` to mimic ChatGPT. - ``` Usage: $ chatgpt @@ -319,7 +317,7 @@ See [demos/demo-reverse-proxy](./demos/demo-reverse-proxy.ts) for a full example npx tsx demos/demo-reverse-proxy.ts ``` -`ChatGPTUnofficialProxyAPI` messages also contain a `conversationid` in addition to `parentMessageId`, since the ChatGPT webapp can't reference messages across +`ChatGPTUnofficialProxyAPI` messages also contain a `conversationid` in addition to `parentMessageId`, since the ChatGPT webapp can't reference messages across different accounts & conversations. #### Reverse Proxy @@ -336,7 +334,7 @@ Known reverse proxies run by community members include: | Reverse Proxy URL | Author | Rate Limits | Last Checked | | ------------------------------------------------ | -------------------------------------------- | ----------------- | ------------ | -| `https://chat.duti.tech/api/conversation` | [@acheong08](https://github.com/acheong08) | 120 req/min by IP | 2/19/2023 | +| `https://bypass.duti.tech/api/conversation` | [@acheong08](https://github.com/acheong08) | 5 req / 10 seconds by IP | 3/11/2023 | | `https://gpt.pawan.krd/backend-api/conversation` | [@PawanOsman](https://github.com/PawanOsman) | ? | 2/19/2023 | Note: info on how the reverse proxies work is not being published at this time in order to prevent OpenAI from disabling access. @@ -485,6 +483,7 @@ All of these awesome projects are built using the `chatgpt` package. 🤯 - [AI Poem Generator](https://aipoemgenerator.com/) - [Next.js ChatGPT With Firebase](https://github.com/youngle316/chatgpt) - [ai-commit – GPT-3 Commit Message Generator](https://github.com/insulineru/ai-commit) +- [AItinerary – ChatGPT itinerary Generator](https://aitinerary.ai) If you create a cool integration, feel free to open a PR and add it to the list.