mirror
/
chatgpt-api
kopia lustrzana https://github.com/transitive-bullshit/chatgpt-api
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

chore: update ts docs

pull/466/head
Travis Fischer 2023-03-11 05:08:14 -06:00
rodzic c4ffe539a4
commit fc3aad3d7d
14 zmienionych plików z 84 dodań i 85 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

8
docs/classes/ChatGPTAPI.md
Wyświetl plik

@ -32,7 +32,7 @@ Creates a new client wrapper around OpenAI's chat completion API, mimicing the o
#### Defined in #### 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 ## Accessors
@ -46,7 +46,7 @@ Creates a new client wrapper around OpenAI's chat completion API, mimicing the o
#### Defined in #### 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` • `set` **apiKey**(`apiKey`): `void`
@ -62,7 +62,7 @@ Creates a new client wrapper around OpenAI's chat completion API, mimicing the o
#### Defined in #### 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 ## Methods
@ -94,4 +94,4 @@ The response from ChatGPT
#### Defined in #### 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)

8
docs/classes/ChatGPTError.md
Wyświetl plik

@ -66,7 +66,7 @@ node_modules/.pnpm/typescript@4.9.5/node_modules/typescript/lib/lib.es2022.error
#### Defined in #### 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 #### 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 #### 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 #### 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)

10
docs/classes/ChatGPTUnofficialProxyAPI.md
Wyświetl plik

@ -28,7 +28,7 @@
| :------ | :------ | :------ | | :------ | :------ | :------ |
| `opts` | `Object` | - | | `opts` | `Object` | - |
| `opts.accessToken` | `string` | - | | `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.debug?` | `boolean` | **`Default Value`** `false` * |
| `opts.fetch?` | (`input`: `RequestInfo` \| `URL`, `init?`: `RequestInit`) => `Promise`<`Response`\> | - | | `opts.fetch?` | (`input`: `RequestInfo` \| `URL`, `init?`: `RequestInit`) => `Promise`<`Response`\> | - |
| `opts.headers?` | `Record`<`string`, `string`\> | **`Default Value`** `undefined` * | | `opts.headers?` | `Record`<`string`, `string`\> | **`Default Value`** `undefined` * |
@ -36,7 +36,7 @@
#### Defined in #### 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 ## Accessors
@ -50,7 +50,7 @@
#### Defined in #### 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` • `set` **accessToken**(`value`): `void`
@ -66,7 +66,7 @@
#### Defined in #### 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 ## Methods
@ -101,4 +101,4 @@ The response from ChatGPT
#### Defined in #### 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)

16
docs/interfaces/ChatMessage.md
Wyświetl plik

@ -23,7 +23,7 @@
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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)

6
docs/interfaces/openai.ChatCompletionRequestMessage.md
Wyświetl plik

@ -32,7 +32,7 @@ ChatCompletionRequestMessage
#### Defined in #### 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 #### 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 #### 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)

4
docs/interfaces/openai.ChatCompletionResponseMessage.md
Wyświetl plik

@ -31,7 +31,7 @@ ChatCompletionResponseMessage
#### Defined in #### 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 #### 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)

10
docs/interfaces/openai.CreateChatCompletionDeltaResponse.md
Wyświetl plik

@ -22,7 +22,7 @@
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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)

24
docs/interfaces/openai.CreateChatCompletionRequest.md
Wyświetl plik

@ -41,7 +41,7 @@ CreateChatCompletionRequest
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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)

12
docs/interfaces/openai.CreateChatCompletionResponse.md
Wyświetl plik

@ -33,7 +33,7 @@ CreateChatCompletionResponse
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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 #### 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)

6
docs/interfaces/openai.CreateChatCompletionResponseChoicesInner.md
Wyświetl plik

@ -30,7 +30,7 @@ CreateChatCompletionResponseChoicesInner
#### Defined in #### 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 #### 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 #### 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)

6
docs/interfaces/openai.CreateCompletionResponseUsage.md
Wyświetl plik

@ -30,7 +30,7 @@ CreateCompletionResponseUsage
#### Defined in #### 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 #### 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 #### 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)

32
docs/modules.md
Wyświetl plik

@ -61,7 +61,7 @@
#### Defined in #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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 #### 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)

18
docs/modules/openai.md
Wyświetl plik

@ -33,9 +33,9 @@
#### Defined in #### 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 #### 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 #### 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 ## Variables
@ -77,9 +77,9 @@ ___
#### Defined in #### 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 #### 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)

9
docs/readme.md
Wyświetl plik

@ -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`. **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) 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) 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. 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: Usage:
$ chatgpt <prompt> $ chatgpt <prompt>
@ -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 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 #### Reverse Proxy
@ -336,7 +334,7 @@ Known reverse proxies run by community members include:
| Reverse Proxy URL | Author | Rate Limits | Last Checked | | 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 | | `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. 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/) - [AI Poem Generator](https://aipoemgenerator.com/)
- [Next.js ChatGPT With Firebase](https://github.com/youngle316/chatgpt) - [Next.js ChatGPT With Firebase](https://github.com/youngle316/chatgpt)
- [ai-commit – GPT-3 Commit Message Generator](https://github.com/insulineru/ai-commit) - [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. If you create a cool integration, feel free to open a PR and add it to the list.