2022-12-03 00:04:53 +00:00
|
|
|
[chatgpt](readme.md) / Exports
|
|
|
|
|
|
|
|
# chatgpt
|
|
|
|
|
|
|
|
## Table of contents
|
|
|
|
|
|
|
|
### Classes
|
|
|
|
|
|
|
|
- [ChatGPTAPI](classes/ChatGPTAPI.md)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
### Type Aliases
|
|
|
|
|
|
|
|
- [AvailableModerationModels](modules.md#availablemoderationmodels)
|
|
|
|
- [ContentType](modules.md#contenttype)
|
|
|
|
- [ConversationJSONBody](modules.md#conversationjsonbody)
|
|
|
|
- [ConversationResponseEvent](modules.md#conversationresponseevent)
|
|
|
|
- [Message](modules.md#message)
|
|
|
|
- [MessageContent](modules.md#messagecontent)
|
|
|
|
- [MessageFeedbackJSONBody](modules.md#messagefeedbackjsonbody)
|
|
|
|
- [MessageFeedbackRating](modules.md#messagefeedbackrating)
|
|
|
|
- [MessageFeedbackResult](modules.md#messagefeedbackresult)
|
|
|
|
- [MessageFeedbackTags](modules.md#messagefeedbacktags)
|
|
|
|
- [MessageMetadata](modules.md#messagemetadata)
|
|
|
|
- [Model](modules.md#model)
|
|
|
|
- [ModelsResult](modules.md#modelsresult)
|
|
|
|
- [ModerationsJSONBody](modules.md#moderationsjsonbody)
|
|
|
|
- [ModerationsJSONResult](modules.md#moderationsjsonresult)
|
|
|
|
- [Prompt](modules.md#prompt)
|
|
|
|
- [PromptContent](modules.md#promptcontent)
|
|
|
|
- [Role](modules.md#role)
|
|
|
|
- [SessionResult](modules.md#sessionresult)
|
|
|
|
- [User](modules.md#user)
|
|
|
|
|
|
|
|
### Functions
|
|
|
|
|
|
|
|
- [markdownToText](modules.md#markdowntotext)
|
|
|
|
|
|
|
|
## Type Aliases
|
|
|
|
|
|
|
|
### AvailableModerationModels
|
|
|
|
|
|
|
|
Ƭ **AvailableModerationModels**: ``"text-moderation-playground"``
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:109](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L109)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### ContentType
|
|
|
|
|
|
|
|
Ƭ **ContentType**: ``"text"``
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L1)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### ConversationJSONBody
|
|
|
|
|
|
|
|
Ƭ **ConversationJSONBody**: `Object`
|
|
|
|
|
|
|
|
https://chat.openapi.com/backend-api/conversation
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
| :------ | :------ | :------ |
|
|
|
|
| `action` | `string` | The action to take |
|
|
|
|
| `conversation_id?` | `string` | The ID of the conversation |
|
|
|
|
| `messages` | [`Prompt`](modules.md#prompt)[] | Prompts to provide |
|
|
|
|
| `model` | `string` | The model to use |
|
|
|
|
| `parent_message_id` | `string` | The parent message ID |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:134](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L134)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### ConversationResponseEvent
|
|
|
|
|
|
|
|
Ƭ **ConversationResponseEvent**: `Object`
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type |
|
|
|
|
| :------ | :------ |
|
|
|
|
| `conversation_id?` | `string` |
|
|
|
|
| `error?` | `string` \| ``null`` |
|
|
|
|
| `message?` | [`Message`](modules.md#message) |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:251](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L251)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### Message
|
|
|
|
|
|
|
|
Ƭ **Message**: `Object`
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type |
|
|
|
|
| :------ | :------ |
|
|
|
|
| `content` | [`MessageContent`](modules.md#messagecontent) |
|
|
|
|
| `create_time` | `string` \| ``null`` |
|
|
|
|
| `end_turn` | ``null`` |
|
|
|
|
| `id` | `string` |
|
|
|
|
| `metadata` | [`MessageMetadata`](modules.md#messagemetadata) |
|
|
|
|
| `recipient` | `string` |
|
|
|
|
| `role` | `string` |
|
|
|
|
| `update_time` | `string` \| ``null`` |
|
|
|
|
| `user` | `string` \| ``null`` |
|
|
|
|
| `weight` | `number` |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:257](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L257)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### MessageContent
|
|
|
|
|
|
|
|
Ƭ **MessageContent**: `Object`
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type |
|
|
|
|
| :------ | :------ |
|
|
|
|
| `content_type` | `string` |
|
|
|
|
| `parts` | `string`[] |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:270](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L270)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### MessageFeedbackJSONBody
|
|
|
|
|
|
|
|
Ƭ **MessageFeedbackJSONBody**: `Object`
|
|
|
|
|
|
|
|
https://chat.openapi.com/backend-api/conversation/message_feedback
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
| :------ | :------ | :------ |
|
|
|
|
| `conversation_id` | `string` | The ID of the conversation |
|
|
|
|
| `message_id` | `string` | The message ID |
|
|
|
|
| `rating` | [`MessageFeedbackRating`](modules.md#messagefeedbackrating) | The rating |
|
|
|
|
| `tags?` | [`MessageFeedbackTags`](modules.md#messagefeedbacktags)[] | Tags to give the rating |
|
|
|
|
| `text?` | `string` | The text to include |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:193](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L193)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### MessageFeedbackRating
|
|
|
|
|
|
|
|
Ƭ **MessageFeedbackRating**: ``"thumbsUp"`` \| ``"thumbsDown"``
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:249](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L249)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### MessageFeedbackResult
|
|
|
|
|
|
|
|
Ƭ **MessageFeedbackResult**: `Object`
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
| :------ | :------ | :------ |
|
|
|
|
| `conversation_id` | `string` | The ID of the conversation |
|
|
|
|
| `message_id` | `string` | The message ID |
|
|
|
|
| `rating` | [`MessageFeedbackRating`](modules.md#messagefeedbackrating) | The rating |
|
|
|
|
| `text?` | `string` | The text the server received, including tags |
|
|
|
|
| `user_id` | `string` | The ID of the user |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:222](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L222)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### MessageFeedbackTags
|
|
|
|
|
|
|
|
Ƭ **MessageFeedbackTags**: ``"harmful"`` \| ``"false"`` \| ``"not-helpful"``
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:220](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L220)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### MessageMetadata
|
|
|
|
|
|
|
|
Ƭ **MessageMetadata**: `any`
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:275](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L275)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### Model
|
|
|
|
|
|
|
|
Ƭ **Model**: `Object`
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
| :------ | :------ | :------ |
|
|
|
|
| `is_special` | `boolean` | Whether or not the model is special |
|
|
|
|
| `max_tokens` | `number` | Max tokens of the model |
|
|
|
|
| `slug` | `string` | Name of the model |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:77](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L77)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### ModelsResult
|
|
|
|
|
|
|
|
Ƭ **ModelsResult**: `Object`
|
|
|
|
|
|
|
|
https://chat.openapi.com/backend-api/models
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
| :------ | :------ | :------ |
|
|
|
|
| `models` | [`Model`](modules.md#model)[] | Array of models |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L70)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### ModerationsJSONBody
|
|
|
|
|
|
|
|
Ƭ **ModerationsJSONBody**: `Object`
|
|
|
|
|
|
|
|
https://chat.openapi.com/backend-api/moderations
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
| :------ | :------ | :------ |
|
|
|
|
| `input` | `string` | Input for the moderation decision |
|
|
|
|
| `model` | [`AvailableModerationModels`](modules.md#availablemoderationmodels) | The model to use in the decision |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L97)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### ModerationsJSONResult
|
|
|
|
|
|
|
|
Ƭ **ModerationsJSONResult**: `Object`
|
|
|
|
|
|
|
|
https://chat.openapi.com/backend-api/moderations
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
| :------ | :------ | :------ |
|
|
|
|
| `blocked` | `boolean` | Whether or not the input is blocked |
|
|
|
|
| `flagged` | `boolean` | Whether or not the input is flagged |
|
|
|
|
| `moderation_id` | `string` | The ID of the decision |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:114](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L114)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### Prompt
|
|
|
|
|
|
|
|
Ƭ **Prompt**: `Object`
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
| :------ | :------ | :------ |
|
|
|
|
| `content` | [`PromptContent`](modules.md#promptcontent) | The content of the prompt |
|
|
|
|
| `id` | `string` | The ID of the prompt |
|
|
|
|
| `role` | [`Role`](modules.md#role) | The role played in the prompt |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:161](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L161)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### PromptContent
|
|
|
|
|
|
|
|
Ƭ **PromptContent**: `Object`
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
| :------ | :------ | :------ |
|
|
|
|
| `content_type` | [`ContentType`](modules.md#contenttype) | The content type of the prompt |
|
|
|
|
| `parts` | `string`[] | The parts to the prompt |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:178](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L178)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### Role
|
|
|
|
|
|
|
|
Ƭ **Role**: ``"user"`` \| ``"assistant"``
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L3)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### SessionResult
|
|
|
|
|
|
|
|
Ƭ **SessionResult**: `Object`
|
|
|
|
|
|
|
|
https://chat.openapi.com/api/auth/session
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
| :------ | :------ | :------ |
|
|
|
|
| `accessToken` | `string` | The access token |
|
2022-12-06 04:53:20 +00:00
|
|
|
| `error?` | `string` \| ``null`` | If there was an error associated with this request |
|
2022-12-05 05:13:36 +00:00
|
|
|
| `expires` | `string` | ISO date of the expiration date of the access token |
|
2022-12-06 04:53:20 +00:00
|
|
|
| `user` | [`User`](modules.md#user) | Authenticated user |
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:8](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L8)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
___
|
|
|
|
|
|
|
|
### User
|
|
|
|
|
|
|
|
Ƭ **User**: `Object`
|
|
|
|
|
|
|
|
#### Type declaration
|
|
|
|
|
|
|
|
| Name | Type | Description |
|
|
|
|
| :------ | :------ | :------ |
|
|
|
|
| `email` | `string` | Email of the user |
|
|
|
|
| `features` | `string`[] \| [] | Features the user is in |
|
|
|
|
| `groups` | `string`[] \| [] | Groups the user is in |
|
|
|
|
| `id` | `string` | ID of the user |
|
|
|
|
| `image` | `string` | Image of the user |
|
|
|
|
| `name` | `string` | Name of the user |
|
|
|
|
| `picture` | `string` | Picture of the user |
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[types.ts:30](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/types.ts#L30)
|
2022-12-05 05:13:36 +00:00
|
|
|
|
|
|
|
## Functions
|
|
|
|
|
|
|
|
### markdownToText
|
|
|
|
|
|
|
|
▸ **markdownToText**(`markdown?`): `string`
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|
|
| Name | Type |
|
|
|
|
| :------ | :------ |
|
|
|
|
| `markdown?` | `string` |
|
|
|
|
|
|
|
|
#### Returns
|
|
|
|
|
|
|
|
`string`
|
|
|
|
|
|
|
|
#### Defined in
|
|
|
|
|
2022-12-06 08:40:40 +00:00
|
|
|
[utils.ts:4](https://github.com/transitive-bullshit/chatgpt-api/blob/80d77a3/src/utils.ts#L4)
|