From 5f239e53bb2f4fb7585fb7a176742c49e5e08064 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Mon, 27 Mar 2023 22:13:37 -0500 Subject: [PATCH] chore: update ts docs --- docs/classes/ChatGPTAPI.md | 8 ++--- docs/classes/ChatGPTError.md | 8 ++--- docs/classes/ChatGPTUnofficialProxyAPI.md | 8 ++--- 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 | 35 ++++++++++--------- docs/modules/openai.md | 18 +++++----- docs/readme.md | 10 ++++-- 14 files changed, 89 insertions(+), 82 deletions(-) diff --git a/docs/classes/ChatGPTAPI.md b/docs/classes/ChatGPTAPI.md index 9224ed4..9f8c801 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/c4ffe53/src/chatgpt-api.ts#L49) +[src/chatgpt-api.ts:49](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/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:308](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-api.ts#L308) +[src/chatgpt-api.ts:311](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/chatgpt-api.ts#L311) • `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:312](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-api.ts#L312) +[src/chatgpt-api.ts:315](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/chatgpt-api.ts#L315) ## Methods @@ -94,4 +94,4 @@ The response from ChatGPT #### Defined in -[src/chatgpt-api.ts:131](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-api.ts#L131) +[src/chatgpt-api.ts:132](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/chatgpt-api.ts#L132) diff --git a/docs/classes/ChatGPTError.md b/docs/classes/ChatGPTError.md index 7b02684..3796bc9 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/c4ffe53/src/types.ts#L77) +[src/types.ts:80](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L80) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[src/types.ts:76](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L76) +[src/types.ts:79](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L79) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[src/types.ts:74](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L74) +[src/types.ts:77](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L77) ___ @@ -96,4 +96,4 @@ ___ #### Defined in -[src/types.ts:75](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L75) +[src/types.ts:78](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L78) diff --git a/docs/classes/ChatGPTUnofficialProxyAPI.md b/docs/classes/ChatGPTUnofficialProxyAPI.md index eea3ec0..20574ec 100644 --- a/docs/classes/ChatGPTUnofficialProxyAPI.md +++ b/docs/classes/ChatGPTUnofficialProxyAPI.md @@ -36,7 +36,7 @@ #### Defined in -[src/chatgpt-unofficial-proxy-api.ts:20](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/chatgpt-unofficial-proxy-api.ts#L20) +[src/chatgpt-unofficial-proxy-api.ts:20](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/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/c4ffe53/src/chatgpt-unofficial-proxy-api.ts#L66) +[src/chatgpt-unofficial-proxy-api.ts:66](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/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/c4ffe53/src/chatgpt-unofficial-proxy-api.ts#L70) +[src/chatgpt-unofficial-proxy-api.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/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/c4ffe53/src/chatgpt-unofficial-proxy-api.ts#L97) +[src/chatgpt-unofficial-proxy-api.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/chatgpt-unofficial-proxy-api.ts#L97) diff --git a/docs/interfaces/ChatMessage.md b/docs/interfaces/ChatMessage.md index 1b0958f..6d5215d 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/c4ffe53/src/types.ts#L70) +[src/types.ts:73](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L73) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[src/types.ts:64](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L64) +[src/types.ts:67](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L67) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[src/types.ts:65](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L65) +[src/types.ts:68](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L68) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[src/types.ts:60](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L60) +[src/types.ts:63](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L63) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[src/types.ts:63](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L63) +[src/types.ts:66](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L66) ___ @@ -73,7 +73,7 @@ ___ #### Defined in -[src/types.ts:68](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L68) +[src/types.ts:71](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L71) ___ @@ -83,7 +83,7 @@ ___ #### Defined in -[src/types.ts:62](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L62) +[src/types.ts:65](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L65) ___ @@ -93,4 +93,4 @@ ___ #### Defined in -[src/types.ts:61](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L61) +[src/types.ts:64](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L64) diff --git a/docs/interfaces/openai.ChatCompletionRequestMessage.md b/docs/interfaces/openai.ChatCompletionRequestMessage.md index 991abb0..55ee041 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/c4ffe53/src/types.ts#L208) +[src/types.ts:211](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L211) ___ @@ -48,7 +48,7 @@ ChatCompletionRequestMessage #### Defined in -[src/types.ts:214](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L214) +[src/types.ts:217](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L217) ___ @@ -64,4 +64,4 @@ ChatCompletionRequestMessage #### Defined in -[src/types.ts:202](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L202) +[src/types.ts:205](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L205) diff --git a/docs/interfaces/openai.ChatCompletionResponseMessage.md b/docs/interfaces/openai.ChatCompletionResponseMessage.md index 4ec6445..16bddd0 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/c4ffe53/src/types.ts#L240) +[src/types.ts:243](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L243) ___ @@ -47,4 +47,4 @@ ChatCompletionResponseMessage #### Defined in -[src/types.ts:234](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L234) +[src/types.ts:237](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L237) diff --git a/docs/interfaces/openai.CreateChatCompletionDeltaResponse.md b/docs/interfaces/openai.CreateChatCompletionDeltaResponse.md index a351be2..0f2c3f1 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/c4ffe53/src/types.ts#L179) +[src/types.ts:182](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L182) ___ @@ -32,7 +32,7 @@ ___ #### Defined in -[src/types.ts:177](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L177) +[src/types.ts:180](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L180) ___ @@ -42,7 +42,7 @@ ___ #### Defined in -[src/types.ts:175](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L175) +[src/types.ts:178](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L178) ___ @@ -52,7 +52,7 @@ ___ #### Defined in -[src/types.ts:178](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L178) +[src/types.ts:181](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L181) ___ @@ -62,4 +62,4 @@ ___ #### Defined in -[src/types.ts:176](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L176) +[src/types.ts:179](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L179) diff --git a/docs/interfaces/openai.CreateChatCompletionRequest.md b/docs/interfaces/openai.CreateChatCompletionRequest.md index 9c3899b..533eea8 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/c4ffe53/src/types.ts#L314) +[src/types.ts:317](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L317) ___ @@ -57,7 +57,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:320](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L320) +[src/types.ts:323](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L323) ___ @@ -73,7 +73,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:302](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L302) +[src/types.ts:305](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L305) ___ @@ -89,7 +89,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:266](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L266) +[src/types.ts:269](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L269) ___ @@ -105,7 +105,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:260](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L260) +[src/types.ts:263](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L263) ___ @@ -121,7 +121,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:284](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L284) +[src/types.ts:287](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L287) ___ @@ -137,7 +137,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:308](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L308) +[src/types.ts:311](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L311) ___ @@ -151,7 +151,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:296](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L296) +[src/types.ts:299](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L299) ___ @@ -167,7 +167,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:290](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L290) +[src/types.ts:293](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L293) ___ @@ -183,7 +183,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:272](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L272) +[src/types.ts:275](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L275) ___ @@ -199,7 +199,7 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:278](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L278) +[src/types.ts:281](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L281) ___ @@ -215,4 +215,4 @@ CreateChatCompletionRequest #### Defined in -[src/types.ts:326](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L326) +[src/types.ts:329](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L329) diff --git a/docs/interfaces/openai.CreateChatCompletionResponse.md b/docs/interfaces/openai.CreateChatCompletionResponse.md index 7f57dcf..7edce91 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/c4ffe53/src/types.ts#L369) +[src/types.ts:372](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L372) ___ @@ -47,7 +47,7 @@ CreateChatCompletionResponse #### Defined in -[src/types.ts:357](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L357) +[src/types.ts:360](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L360) ___ @@ -61,7 +61,7 @@ CreateChatCompletionResponse #### Defined in -[src/types.ts:345](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L345) +[src/types.ts:348](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L348) ___ @@ -75,7 +75,7 @@ CreateChatCompletionResponse #### Defined in -[src/types.ts:363](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L363) +[src/types.ts:366](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L366) ___ @@ -89,7 +89,7 @@ CreateChatCompletionResponse #### Defined in -[src/types.ts:351](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L351) +[src/types.ts:354](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L354) ___ @@ -103,4 +103,4 @@ CreateChatCompletionResponse #### Defined in -[src/types.ts:375](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L375) +[src/types.ts:378](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L378) diff --git a/docs/interfaces/openai.CreateChatCompletionResponseChoicesInner.md b/docs/interfaces/openai.CreateChatCompletionResponseChoicesInner.md index 3e3909f..e2ccb3d 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/c4ffe53/src/types.ts#L400) +[src/types.ts:403](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L403) ___ @@ -44,7 +44,7 @@ CreateChatCompletionResponseChoicesInner #### Defined in -[src/types.ts:388](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L388) +[src/types.ts:391](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L391) ___ @@ -58,4 +58,4 @@ CreateChatCompletionResponseChoicesInner #### Defined in -[src/types.ts:394](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L394) +[src/types.ts:397](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L397) diff --git a/docs/interfaces/openai.CreateCompletionResponseUsage.md b/docs/interfaces/openai.CreateCompletionResponseUsage.md index 2d1f7f3..31816ed 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/c4ffe53/src/types.ts#L419) +[src/types.ts:422](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L422) ___ @@ -44,7 +44,7 @@ CreateCompletionResponseUsage #### Defined in -[src/types.ts:413](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L413) +[src/types.ts:416](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L416) ___ @@ -58,4 +58,4 @@ CreateCompletionResponseUsage #### Defined in -[src/types.ts:425](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L425) +[src/types.ts:428](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L428) diff --git a/docs/modules.md b/docs/modules.md index ff7d347..b49f1e8 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -49,7 +49,7 @@ | :------ | :------ | :------ | | `apiBaseUrl?` | `string` | **`Default Value`** `'https://api.openai.com'` * | | `apiKey` | `string` | - | -| `completionParams?` | `Partial`<`Omit`<[`CreateChatCompletionRequest`](interfaces/openai.CreateChatCompletionRequest.md), ``"messages"`` \| ``"n"``\>\> | - | +| `completionParams?` | `Partial`<`Omit`<[`CreateChatCompletionRequest`](interfaces/openai.CreateChatCompletionRequest.md), ``"messages"`` \| ``"n"`` \| ``"stream"``\>\> | - | | `debug?` | `boolean` | **`Default Value`** `false` * | | `fetch?` | [`FetchFn`](modules.md#fetchfn) | - | | `getMessageById?` | [`GetMessageByIdFunction`](modules.md#getmessagebyidfunction) | - | @@ -61,7 +61,7 @@ #### Defined in -[src/types.ts:7](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L7) +[src/types.ts:7](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L7) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[src/types.ts:133](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L133) +[src/types.ts:136](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L136) ___ @@ -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/c4ffe53/src/types.ts#L89) +[src/types.ts:92](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L92) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -[src/types.ts:147](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L147) +[src/types.ts:150](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L150) ___ @@ -121,7 +121,7 @@ ___ #### Defined in -[src/types.ts:5](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L5) +[src/types.ts:5](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/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/c4ffe53/src/types.ts#L81) +[src/types.ts:84](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L84) ___ @@ -172,7 +172,7 @@ ___ #### Defined in -[src/types.ts:153](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L153) +[src/types.ts:156](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L156) ___ @@ -182,7 +182,7 @@ ___ #### Defined in -[src/types.ts:47](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L47) +[src/types.ts:50](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L50) ___ @@ -199,7 +199,7 @@ ___ #### Defined in -[src/types.ts:166](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L166) +[src/types.ts:169](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L169) ___ @@ -209,7 +209,7 @@ ___ #### Defined in -[src/types.ts:171](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L171) +[src/types.ts:174](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L174) ___ @@ -227,7 +227,7 @@ ___ #### Defined in -[src/types.ts:116](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L116) +[src/types.ts:119](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L119) ___ @@ -244,7 +244,7 @@ ___ #### Defined in -[src/types.ts:135](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L135) +[src/types.ts:138](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L138) ___ @@ -254,7 +254,7 @@ ___ #### Defined in -[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L3) +[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L3) ___ @@ -276,7 +276,7 @@ ___ #### Defined in -[src/types.ts:49](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L49) +[src/types.ts:52](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L52) ___ @@ -289,6 +289,7 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | | `abortSignal?` | `AbortSignal` | - | +| `completionParams?` | `Partial`<`Omit`<[`CreateChatCompletionRequest`](interfaces/openai.CreateChatCompletionRequest.md), ``"messages"`` \| ``"n"`` \| ``"stream"``\>\> | - | | `messageId?` | `string` | - | | `name?` | `string` | The name of a user in a multi-user chat. | | `onProgress?` | (`partialResponse`: [`ChatMessage`](interfaces/ChatMessage.md)) => `void` | - | @@ -299,7 +300,7 @@ ___ #### Defined in -[src/types.ts:35](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L35) +[src/types.ts:35](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L35) ___ @@ -325,4 +326,4 @@ Upserts a chat message to a store. #### Defined in -[src/types.ts:84](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L84) +[src/types.ts:87](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L87) diff --git a/docs/modules/openai.md b/docs/modules/openai.md index c6f56e1..08c0543 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/c4ffe53/src/types.ts#L216) +[src/types.ts:219](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L219) -[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L221) +[src/types.ts:224](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L224) ___ @@ -45,9 +45,9 @@ ___ #### Defined in -[src/types.ts:242](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L242) +[src/types.ts:245](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L245) -[src/types.ts:247](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L247) +[src/types.ts:250](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L250) ___ @@ -59,7 +59,7 @@ ___ #### Defined in -[src/types.ts:333](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L333) +[src/types.ts:336](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L336) ## Variables @@ -77,9 +77,9 @@ ___ #### Defined in -[src/types.ts:216](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L216) +[src/types.ts:219](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L219) -[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L221) +[src/types.ts:224](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L224) ___ @@ -97,6 +97,6 @@ ___ #### Defined in -[src/types.ts:242](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L242) +[src/types.ts:245](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L245) -[src/types.ts:247](https://github.com/transitive-bullshit/chatgpt-api/blob/c4ffe53/src/types.ts#L247) +[src/types.ts:250](https://github.com/transitive-bullshit/chatgpt-api/blob/9eac18f/src/types.ts#L250) diff --git a/docs/readme.md b/docs/readme.md index e370947..b0a9549 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -334,8 +334,8 @@ Known reverse proxies run by community members include: | Reverse Proxy URL | Author | Rate Limits | Last Checked | | ------------------------------------------------ | -------------------------------------------- | ----------------- | ------------ | -| `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 | +| `https://bypass.churchless.tech/api/conversation` | [@acheong08](https://github.com/acheong08) | 5 req / 10 seconds by IP | 3/24/2023 | +| `https://api.pawan.krd/backend-api/conversation` | [@PawanOsman](https://github.com/PawanOsman) | 50 req / 15 seconds (~3 r/s) | 3/23/2023 | Note: info on how the reverse proxies work is not being published at this time in order to prevent OpenAI from disabling access. @@ -424,6 +424,7 @@ All of these awesome projects are built using the `chatgpt` package. 🤯 - [Telegram Bot #2](https://github.com/dawangraoming/chatgpt-telegram-bot) - [Telegram Bot #3](https://github.com/RainEggplant/chatgpt-telegram-bot) (group privacy mode, ID-based auth) - [Telegram Bot #4](https://github.com/ArdaGnsrn/chatgpt-telegram) (queue system, ID-based chat thread) +- [Telegram Bot #5](https://github.com/azoway/chatgpt-telegram-bot) (group privacy mode, ID-based chat thread) - [Deno Telegram Bot](https://github.com/Ciyou/chatbot-telegram) - [Go Telegram Bot](https://github.com/m1guelpf/chatgpt-telegram) - [Telegram Bot for YouTube Summaries](https://github.com/codextde/youtube-summary) @@ -434,11 +435,14 @@ All of these awesome projects are built using the `chatgpt` package. 🤯 - [Discord Bot #4 (selfbot)](https://github.com/0x7030676e31/cumsocket) - [Discord Bot #5](https://github.com/itskdhere/ChatGPT-Discord-BOT) - [Discord Bot #6 (Shakespeare bot)](https://gist.github.com/TheBrokenRail/4b37e7c44e8f721d8bd845050d034c16) +- [Discord Bot #7](https://github.com/Elitezen/discordjs-chatgpt) +- [Zoom Chat](https://github.com/shixin-guo/my-bot) - [WeChat Bot #1](https://github.com/AutumnWhj/ChatGPT-wechat-bot) - [WeChat Bot #2](https://github.com/fuergaosi233/wechat-chatgpt) - [WeChat Bot #3](https://github.com/wangrongding/wechat-bot) ( - [WeChat Bot #4](https://github.com/darknightlab/wechat-bot) - [WeChat Bot #5](https://github.com/sunshanpeng/wechaty-chatgpt) +- [WeChat Bot #6](https://github.com/formulahendry/chatgpt-wechat-bot) - [QQ Bot (plugin for Yunzai-bot)](https://github.com/ikechan8370/chatgpt-plugin) - [QQ Bot (plugin for KiviBot)](https://github.com/KiviBotLab/kivibot-plugin-chatgpt) - [QQ Bot (oicq)](https://github.com/easydu2002/chat_gpt_oicq) @@ -484,6 +488,8 @@ All of these awesome projects are built using the `chatgpt` package. 🤯 - [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) +- [wechaty-chatgpt - A chatbot based on Wechaty & ChatGPT](https://github.com/zhengxs2018/wechaty-chatgpt) +- [Julius GPT](https://github.com/christophebe/julius-gpt) : Generate and publish your content from the command line with the help of AI (GPT). If you create a cool integration, feel free to open a PR and add it to the list.