kopia lustrzana https://github.com/transitive-bullshit/chatgpt-api
182 wiersze
4.6 KiB
Markdown
182 wiersze
4.6 KiB
Markdown
[chatgpt](../readme.md) / [Exports](../modules.md) / ChatGPTAPI
|
|
|
|
# Class: ChatGPTAPI
|
|
|
|
## Table of contents
|
|
|
|
### Constructors
|
|
|
|
- [constructor](ChatGPTAPI.md#constructor)
|
|
|
|
### Accessors
|
|
|
|
- [user](ChatGPTAPI.md#user)
|
|
|
|
### Methods
|
|
|
|
- [ensureAuth](ChatGPTAPI.md#ensureauth)
|
|
- [getConversation](ChatGPTAPI.md#getconversation)
|
|
- [getIsAuthenticated](ChatGPTAPI.md#getisauthenticated)
|
|
- [refreshAccessToken](ChatGPTAPI.md#refreshaccesstoken)
|
|
- [sendMessage](ChatGPTAPI.md#sendmessage)
|
|
|
|
## Constructors
|
|
|
|
### constructor
|
|
|
|
• **new ChatGPTAPI**(`opts`)
|
|
|
|
Creates a new client wrapper around the unofficial ChatGPT REST API.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `opts` | `Object` | - |
|
|
| `opts.accessToken?` | `string` | - |
|
|
| `opts.accessTokenTTL?` | `number` | **`Default Value`** 60000 (60 seconds) |
|
|
| `opts.apiBaseUrl?` | `string` | **`Default Value`** `'https://chat.openai.com/api'` * |
|
|
| `opts.backendApiBaseUrl?` | `string` | **`Default Value`** `'https://chat.openai.com/backend-api'` * |
|
|
| `opts.clearanceToken` | `string` | - |
|
|
| `opts.markdown?` | `boolean` | **`Default Value`** `true` * |
|
|
| `opts.sessionToken` | `string` | = **Required** OpenAI session token which can be found in a valid session's cookies (see readme for instructions) |
|
|
| `opts.userAgent?` | `string` | **`Default Value`** `'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36'` * |
|
|
|
|
#### Defined in
|
|
|
|
[src/chatgpt-api.ts:39](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L39)
|
|
|
|
## Accessors
|
|
|
|
### user
|
|
|
|
• `get` **user**(): [`User`](../modules.md#user)
|
|
|
|
Gets the currently signed-in user, if authenticated, `null` otherwise.
|
|
|
|
#### Returns
|
|
|
|
[`User`](../modules.md#user)
|
|
|
|
#### Defined in
|
|
|
|
[src/chatgpt-api.ts:98](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L98)
|
|
|
|
## Methods
|
|
|
|
### ensureAuth
|
|
|
|
▸ **ensureAuth**(): `Promise`<`string`\>
|
|
|
|
Refreshes the client's access token which will succeed only if the session
|
|
is still valid.
|
|
|
|
#### Returns
|
|
|
|
`Promise`<`string`\>
|
|
|
|
#### Defined in
|
|
|
|
[src/chatgpt-api.ts:250](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L250)
|
|
|
|
___
|
|
|
|
### getConversation
|
|
|
|
▸ **getConversation**(`opts?`): [`ChatGPTConversation`](ChatGPTConversation.md)
|
|
|
|
Gets a new ChatGPTConversation instance, which can be used to send multiple
|
|
messages as part of a single conversation.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `opts` | `Object` | - |
|
|
| `opts.conversationId?` | `string` | Optional ID of the previous message in a conversation |
|
|
| `opts.parentMessageId?` | `string` | Optional ID of the previous message in a conversation |
|
|
|
|
#### Returns
|
|
|
|
[`ChatGPTConversation`](ChatGPTConversation.md)
|
|
|
|
The new conversation instance
|
|
|
|
#### Defined in
|
|
|
|
[src/chatgpt-api.ts:344](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L344)
|
|
|
|
___
|
|
|
|
### getIsAuthenticated
|
|
|
|
▸ **getIsAuthenticated**(): `Promise`<`boolean`\>
|
|
|
|
#### Returns
|
|
|
|
`Promise`<`boolean`\>
|
|
|
|
`true` if the client has a valid acces token or `false` if refreshing
|
|
the token fails.
|
|
|
|
#### Defined in
|
|
|
|
[src/chatgpt-api.ts:237](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L237)
|
|
|
|
___
|
|
|
|
### refreshAccessToken
|
|
|
|
▸ **refreshAccessToken**(): `Promise`<`string`\>
|
|
|
|
Attempts to refresh the current access token using the ChatGPT
|
|
`sessionToken` cookie.
|
|
|
|
Access tokens will be cached for up to `accessTokenTTL` milliseconds to
|
|
prevent refreshing access tokens too frequently.
|
|
|
|
**`Throws`**
|
|
|
|
An error if refreshing the access token fails.
|
|
|
|
#### Returns
|
|
|
|
`Promise`<`string`\>
|
|
|
|
A valid access token
|
|
|
|
#### Defined in
|
|
|
|
[src/chatgpt-api.ts:264](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L264)
|
|
|
|
___
|
|
|
|
### sendMessage
|
|
|
|
▸ **sendMessage**(`message`, `opts?`): `Promise`<`string`\>
|
|
|
|
Sends a message to ChatGPT, waits for the response to resolve, and returns
|
|
the response.
|
|
|
|
If you want to receive a stream of partial responses, use `opts.onProgress`.
|
|
If you want to receive the full response, including message and conversation IDs,
|
|
you can use `opts.onConversationResponse` or use the `ChatGPTAPI.getConversation`
|
|
helper.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `message` | `string` | The prompt message to send |
|
|
| `opts` | [`SendMessageOptions`](../modules.md#sendmessageoptions) | - |
|
|
|
|
#### Returns
|
|
|
|
`Promise`<`string`\>
|
|
|
|
The response from ChatGPT
|
|
|
|
#### Defined in
|
|
|
|
[src/chatgpt-api.ts:121](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L121)
|