kopia lustrzana https://github.com/transitive-bullshit/chatgpt-api
chore: update docs
Travis Fischer
rodzic
2dd0ca9196
commit
f248ad2490
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue