Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
C
Chatgpt Puppeteer
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
nanahira
Chatgpt Puppeteer
Commits
f01fe5c7
Commit
f01fe5c7
authored
Dec 19, 2022
by
optionsx
Committed by
GitHub
Dec 19, 2022
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update modules.md
parent
73d60c6b
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
174 additions
and
175 deletions
+174
-175
docs/modules.md
docs/modules.md
+174
-175
No files found.
docs/modules.md
View file @
f01fe5c7
...
@@ -55,13 +55,13 @@
...
@@ -55,13 +55,13 @@
### AvailableModerationModels
### AvailableModerationModels
Ƭ
**AvailableModerationModels**
:
`
`"text-moderation-playground"`
`
Ƭ
**AvailableModerationModels**
:
`
"text-moderation-playground"
`
#### Defined in
#### Defined in
[
src/types.ts:109
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L109
)
[
src/types.ts:109
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L109
)
__
_
---
### ChatError
### ChatError
...
@@ -70,7 +70,7 @@ ___
...
@@ -70,7 +70,7 @@ ___
#### Type declaration
#### Type declaration
| Name | Type |
| Name | Type |
| :------
| :
------ |
| :------
------------ | :--------------------------------------------------------------------
------ |
|
`conversationId?`
|
`string`
|
|
`conversationId?`
|
`string`
|
|
`error`
| {
`message`
:
`string`
;
`statusCode?`
:
`number`
;
`statusText?`
:
`string`
} |
|
`error`
| {
`message`
:
`string`
;
`statusCode?`
:
`number`
;
`statusText?`
:
`string`
} |
|
`error.message`
|
`string`
|
|
`error.message`
|
`string`
|
...
@@ -82,7 +82,7 @@ ___
...
@@ -82,7 +82,7 @@ ___
[
src/types.ts:300
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L300
)
[
src/types.ts:300
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L300
)
__
_
---
### ChatResponse
### ChatResponse
...
@@ -91,7 +91,7 @@ ___
...
@@ -91,7 +91,7 @@ ___
#### Type declaration
#### Type declaration
| Name | Type |
| Name | Type |
| :------
| :
------ |
| :------
--------- | :-
------ |
|
`conversationId`
|
`string`
|
|
`conversationId`
|
`string`
|
|
`messageId`
|
`string`
|
|
`messageId`
|
`string`
|
|
`response`
|
`string`
|
|
`response`
|
`string`
|
...
@@ -100,17 +100,17 @@ ___
...
@@ -100,17 +100,17 @@ ___
[
src/types.ts:306
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L306
)
[
src/types.ts:306
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L306
)
__
_
---
### ContentType
### ContentType
Ƭ
**ContentType**
:
`
`"text"`
`
Ƭ
**ContentType**
:
`
"text"
`
#### Defined in
#### Defined in
[
src/types.ts:1
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L1
)
[
src/types.ts:1
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L1
)
__
_
---
### ConversationJSONBody
### ConversationJSONBody
...
@@ -121,7 +121,7 @@ https://chat.openapi.com/backend-api/conversation
...
@@ -121,7 +121,7 @@ https://chat.openapi.com/backend-api/conversation
#### Type declaration
#### Type declaration
| Name | Type | Description |
| Name | Type | Description |
| :------
| :------ | :
------ |
| :------
------------ | :------------------------------ | :-------------------
------ |
|
`action`
|
`string`
| The action to take |
|
`action`
|
`string`
| The action to take |
|
`conversation_id?`
|
`string`
| The ID of the conversation |
|
`conversation_id?`
|
`string`
| The ID of the conversation |
|
`messages`
|
[
`Prompt`
](
modules.md#prompt
)[]
| Prompts to provide |
|
`messages`
|
[
`Prompt`
](
modules.md#prompt
)[]
| Prompts to provide |
...
@@ -132,7 +132,7 @@ https://chat.openapi.com/backend-api/conversation
...
@@ -132,7 +132,7 @@ https://chat.openapi.com/backend-api/conversation
[
src/types.ts:134
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L134
)
[
src/types.ts:134
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L134
)
__
_
---
### ConversationResponseEvent
### ConversationResponseEvent
...
@@ -141,16 +141,16 @@ ___
...
@@ -141,16 +141,16 @@ ___
#### Type declaration
#### Type declaration
| Name | Type |
| Name | Type |
| :------
| :
------ |
| :------
----------- | :------------------------
------ |
|
`conversation_id?`
|
`string`
|
|
`conversation_id?`
|
`string`
|
|
`error?`
|
`string`
\|
``null``
|
|
`error?`
|
`string`
\|
`null`
|
|
`message?`
|
[
`Message`
](
modules.md#message
)
|
|
`message?`
|
[
`Message`
](
modules.md#message
)
|
#### Defined in
#### Defined in
[
src/types.ts:251
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L251
)
[
src/types.ts:251
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L251
)
__
_
---
### Message
### Message
...
@@ -159,33 +159,33 @@ ___
...
@@ -159,33 +159,33 @@ ___
#### Type declaration
#### Type declaration
| Name | Type |
| Name | Type |
| :------
| :
------ |
| :------
------ | :----------------------------------------
------ |
|
`content`
|
[
`MessageContent`
](
modules.md#messagecontent
)
|
|
`content`
|
[
`MessageContent`
](
modules.md#messagecontent
)
|
|
`create_time`
|
`string`
\|
`
`null``
|
|
`create_time`
|
`string`
\|
`
null`
|
|
`end_turn`
|
``null``
|
|
`end_turn`
|
`null`
|
|
`id`
|
`string`
|
|
`id`
|
`string`
|
|
`metadata`
|
[
`MessageMetadata`
](
modules.md#messagemetadata
)
|
|
`metadata`
|
[
`MessageMetadata`
](
modules.md#messagemetadata
)
|
|
`recipient`
|
`string`
|
|
`recipient`
|
`string`
|
|
`role`
|
`string`
|
|
`role`
|
`string`
|
|
`update_time`
|
`string`
\|
`
`null``
|
|
`update_time`
|
`string`
\|
`
null`
|
|
`user`
|
`string`
\|
``null``
|
|
`user`
|
`string`
\|
`null`
|
|
`weight`
|
`number`
|
|
`weight`
|
`number`
|
#### Defined in
#### Defined in
[
src/types.ts:257
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L257
)
[
src/types.ts:257
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L257
)
__
_
---
### MessageActionType
### MessageActionType
Ƭ
**MessageActionType**
:
`
`"next"``
\|
``"variant"`
`
Ƭ
**MessageActionType**
:
`
"next"`
\|
`"variant"
`
#### Defined in
#### Defined in
[
src/types.ts:276
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L276
)
[
src/types.ts:276
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L276
)
__
_
---
### MessageContent
### MessageContent
...
@@ -194,7 +194,7 @@ ___
...
@@ -194,7 +194,7 @@ ___
#### Type declaration
#### Type declaration
| Name | Type |
| Name | Type |
| :------
| :
------ |
| :------
------- | :---
------ |
|
`content_type`
|
`string`
|
|
`content_type`
|
`string`
|
|
`parts`
|
`string`
[] |
|
`parts`
|
`string`
[] |
...
@@ -202,7 +202,7 @@ ___
...
@@ -202,7 +202,7 @@ ___
[
src/types.ts:270
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L270
)
[
src/types.ts:270
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L270
)
__
_
---
### MessageFeedbackJSONBody
### MessageFeedbackJSONBody
...
@@ -213,7 +213,7 @@ https://chat.openapi.com/backend-api/conversation/message_feedback
...
@@ -213,7 +213,7 @@ https://chat.openapi.com/backend-api/conversation/message_feedback
#### Type declaration
#### Type declaration
| Name | Type | Description |
| Name | Type | Description |
| :------
| :------ | :
------ |
| :------
---------- | :---------------------------------------------------------- | :-------------------
------ |
|
`conversation_id`
|
`string`
| The ID of the conversation |
|
`conversation_id`
|
`string`
| The ID of the conversation |
|
`message_id`
|
`string`
| The message ID |
|
`message_id`
|
`string`
| The message ID |
|
`rating`
|
[
`MessageFeedbackRating`
](
modules.md#messagefeedbackrating
)
| The rating |
|
`rating`
|
[
`MessageFeedbackRating`
](
modules.md#messagefeedbackrating
)
| The rating |
...
@@ -224,17 +224,17 @@ https://chat.openapi.com/backend-api/conversation/message_feedback
...
@@ -224,17 +224,17 @@ https://chat.openapi.com/backend-api/conversation/message_feedback
[
src/types.ts:193
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L193
)
[
src/types.ts:193
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L193
)
__
_
---
### MessageFeedbackRating
### MessageFeedbackRating
Ƭ
**MessageFeedbackRating**
:
`
`"thumbsUp"``
\|
``"thumbsDown"`
`
Ƭ
**MessageFeedbackRating**
:
`
"thumbsUp"`
\|
`"thumbsDown"
`
#### Defined in
#### Defined in
[
src/types.ts:249
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L249
)
[
src/types.ts:249
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L249
)
__
_
---
### MessageFeedbackResult
### MessageFeedbackResult
...
@@ -243,7 +243,7 @@ ___
...
@@ -243,7 +243,7 @@ ___
#### Type declaration
#### Type declaration
| Name | Type | Description |
| Name | Type | Description |
| :------
| :------ | :
------ |
| :------
---------- | :---------------------------------------------------------- | :-------------------------------------
------ |
|
`conversation_id`
|
`string`
| The ID of the conversation |
|
`conversation_id`
|
`string`
| The ID of the conversation |
|
`message_id`
|
`string`
| The message ID |
|
`message_id`
|
`string`
| The message ID |
|
`rating`
|
[
`MessageFeedbackRating`
](
modules.md#messagefeedbackrating
)
| The rating |
|
`rating`
|
[
`MessageFeedbackRating`
](
modules.md#messagefeedbackrating
)
| The rating |
...
@@ -254,17 +254,17 @@ ___
...
@@ -254,17 +254,17 @@ ___
[
src/types.ts:222
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L222
)
[
src/types.ts:222
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L222
)
__
_
---
### MessageFeedbackTags
### MessageFeedbackTags
Ƭ
**MessageFeedbackTags**
:
`
`"harmful"``
\|
``"false"``
\|
``"not-helpful"`
`
Ƭ
**MessageFeedbackTags**
:
`
"harmful"`
\|
`"false"`
\|
`"not-helpful"
`
#### Defined in
#### Defined in
[
src/types.ts:220
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L220
)
[
src/types.ts:220
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L220
)
__
_
---
### MessageMetadata
### MessageMetadata
...
@@ -274,7 +274,7 @@ ___
...
@@ -274,7 +274,7 @@ ___
[
src/types.ts:275
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L275
)
[
src/types.ts:275
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L275
)
__
_
---
### Model
### Model
...
@@ -283,7 +283,7 @@ ___
...
@@ -283,7 +283,7 @@ ___
#### Type declaration
#### Type declaration
| Name | Type | Description |
| Name | Type | Description |
| :------
| :------ | :
------ |
| :------
----- | :-------- | :----------------------------
------ |
|
`is_special`
|
`boolean`
| Whether or not the model is special |
|
`is_special`
|
`boolean`
| Whether or not the model is special |
|
`max_tokens`
|
`number`
| Max tokens of the model |
|
`max_tokens`
|
`number`
| Max tokens of the model |
|
`slug`
|
`string`
| Name of the model |
|
`slug`
|
`string`
| Name of the model |
...
@@ -292,7 +292,7 @@ ___
...
@@ -292,7 +292,7 @@ ___
[
src/types.ts:77
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L77
)
[
src/types.ts:77
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L77
)
__
_
---
### ModelsResult
### ModelsResult
...
@@ -303,14 +303,14 @@ https://chat.openapi.com/backend-api/models
...
@@ -303,14 +303,14 @@ https://chat.openapi.com/backend-api/models
#### Type declaration
#### Type declaration
| Name | Type | Description |
| Name | Type | Description |
| :------
| :------ | :
------ |
| :------
- | :---------------------------- | :--------
------ |
|
`models`
|
[
`Model`
](
modules.md#model
)[]
| Array of models |
|
`models`
|
[
`Model`
](
modules.md#model
)[]
| Array of models |
#### Defined in
#### Defined in
[
src/types.ts:70
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L70
)
[
src/types.ts:70
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L70
)
__
_
---
### ModerationsJSONBody
### ModerationsJSONBody
...
@@ -321,7 +321,7 @@ https://chat.openapi.com/backend-api/moderations
...
@@ -321,7 +321,7 @@ https://chat.openapi.com/backend-api/moderations
#### Type declaration
#### Type declaration
| Name | Type | Description |
| Name | Type | Description |
| :------ | :------
| :
------ |
| :------ | :------
------------------------------------------------------------ | :--------------------------
------ |
|
`input`
|
`string`
| Input for the moderation decision |
|
`input`
|
`string`
| Input for the moderation decision |
|
`model`
|
[
`AvailableModerationModels`
](
modules.md#availablemoderationmodels
)
| The model to use in the decision |
|
`model`
|
[
`AvailableModerationModels`
](
modules.md#availablemoderationmodels
)
| The model to use in the decision |
...
@@ -329,7 +329,7 @@ https://chat.openapi.com/backend-api/moderations
...
@@ -329,7 +329,7 @@ https://chat.openapi.com/backend-api/moderations
[
src/types.ts:97
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L97
)
[
src/types.ts:97
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L97
)
__
_
---
### ModerationsJSONResult
### ModerationsJSONResult
...
@@ -340,7 +340,7 @@ https://chat.openapi.com/backend-api/moderations
...
@@ -340,7 +340,7 @@ https://chat.openapi.com/backend-api/moderations
#### Type declaration
#### Type declaration
| Name | Type | Description |
| Name | Type | Description |
| :------
| :------ | :
------ |
| :------
-------- | :-------- | :----------------------------
------ |
|
`blocked`
|
`boolean`
| Whether or not the input is blocked |
|
`blocked`
|
`boolean`
| Whether or not the input is blocked |
|
`flagged`
|
`boolean`
| Whether or not the input is flagged |
|
`flagged`
|
`boolean`
| Whether or not the input is flagged |
|
`moderation_id`
|
`string`
| The ID of the decision |
|
`moderation_id`
|
`string`
| The ID of the decision |
...
@@ -349,7 +349,7 @@ https://chat.openapi.com/backend-api/moderations
...
@@ -349,7 +349,7 @@ https://chat.openapi.com/backend-api/moderations
[
src/types.ts:114
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L114
)
[
src/types.ts:114
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L114
)
__
_
---
### OpenAIAuth
### OpenAIAuth
...
@@ -361,7 +361,7 @@ to authenticate with the unofficial ChatGPT API.
...
@@ -361,7 +361,7 @@ to authenticate with the unofficial ChatGPT API.
#### Type declaration
#### Type declaration
| Name | Type |
| Name | Type |
| :------
| :
------ |
| :------
--------- | :---------------------------------------
------ |
|
`clearanceToken`
|
`string`
|
|
`clearanceToken`
|
`string`
|
|
`cookies?`
|
`Record`
<
`string`
,
`Protocol.Network.Cookie`
\>
|
|
`cookies?`
|
`Record`
<
`string`
,
`Protocol.Network.Cookie`
\>
|
|
`sessionToken`
|
`string`
|
|
`sessionToken`
|
`string`
|
...
@@ -371,7 +371,7 @@ to authenticate with the unofficial ChatGPT API.
...
@@ -371,7 +371,7 @@ to authenticate with the unofficial ChatGPT API.
[
src/openai-auth.ts:27
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/openai-auth.ts#L27
)
[
src/openai-auth.ts:27
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/openai-auth.ts#L27
)
__
_
---
### Prompt
### Prompt
...
@@ -380,7 +380,7 @@ ___
...
@@ -380,7 +380,7 @@ ___
#### Type declaration
#### Type declaration
| Name | Type | Description |
| Name | Type | Description |
| :------
| :------ | :
------ |
| :------
-- | :------------------------------------------ | :----------------------
------ |
|
`content`
|
[
`PromptContent`
](
modules.md#promptcontent
)
| The content of the prompt |
|
`content`
|
[
`PromptContent`
](
modules.md#promptcontent
)
| The content of the prompt |
|
`id`
|
`string`
| The ID of the prompt |
|
`id`
|
`string`
| The ID of the prompt |
|
`role`
|
[
`Role`
](
modules.md#role
)
| The role played in the prompt |
|
`role`
|
[
`Role`
](
modules.md#role
)
| The role played in the prompt |
...
@@ -389,7 +389,7 @@ ___
...
@@ -389,7 +389,7 @@ ___
[
src/types.ts:161
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L161
)
[
src/types.ts:161
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L161
)
__
_
---
### PromptContent
### PromptContent
...
@@ -398,7 +398,7 @@ ___
...
@@ -398,7 +398,7 @@ ___
#### Type declaration
#### Type declaration
| Name | Type | Description |
| Name | Type | Description |
| :------
| :------ | :
------ |
| :------
------- | :-------------------------------------- | :-----------------------
------ |
|
`content_type`
|
[
`ContentType`
](
modules.md#contenttype
)
| The content type of the prompt |
|
`content_type`
|
[
`ContentType`
](
modules.md#contenttype
)
| The content type of the prompt |
|
`parts`
|
`string`
[] | The parts to the prompt |
|
`parts`
|
`string`
[] | The parts to the prompt |
...
@@ -406,27 +406,27 @@ ___
...
@@ -406,27 +406,27 @@ ___
[
src/types.ts:178
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L178
)
[
src/types.ts:178
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L178
)
__
_
---
### Role
### Role
Ƭ
**Role**
:
`
`"user"``
\|
``"assistant"`
`
Ƭ
**Role**
:
`
"user"`
\|
`"assistant"
`
#### Defined in
#### Defined in
[
src/types.ts:3
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L3
)
[
src/types.ts:3
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L3
)
__
_
---
### SendConversationMessageOptions
### SendConversationMessageOptions
Ƭ
**SendConversationMessageOptions**
:
`Omit`
<
[
`SendMessageOptions`
](
modules.md#sendmessageoptions
)
,
`
`"conversationId"``
\|
``"parentMessageId"`
`
\>
Ƭ
**SendConversationMessageOptions**
:
`Omit`
<
[
`SendMessageOptions`
](
modules.md#sendmessageoptions
)
,
`
"conversationId"`
\|
`"parentMessageId"
`
\>
#### Defined in
#### Defined in
[
src/types.ts:288
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L288
)
[
src/types.ts:288
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L288
)
__
_
---
### SendMessageOptions
### SendMessageOptions
...
@@ -435,7 +435,7 @@ ___
...
@@ -435,7 +435,7 @@ ___
#### Type declaration
#### Type declaration
| Name | Type |
| Name | Type |
| :------
| :
------ |
| :------
----------- | :-----------------------------------------------------------------
------ |
|
`abortSignal?`
|
`AbortSignal`
|
|
`abortSignal?`
|
`AbortSignal`
|
|
`action?`
|
[
`MessageActionType`
](
modules.md#messageactiontype
)
|
|
`action?`
|
[
`MessageActionType`
](
modules.md#messageactiontype
)
|
|
`conversationId?`
|
`string`
|
|
`conversationId?`
|
`string`
|
...
@@ -448,7 +448,7 @@ ___
...
@@ -448,7 +448,7 @@ ___
[
src/types.ts:278
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L278
)
[
src/types.ts:278
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L278
)
__
_
---
### SessionResult
### SessionResult
...
@@ -459,9 +459,9 @@ https://chat.openapi.com/api/auth/session
...
@@ -459,9 +459,9 @@ https://chat.openapi.com/api/auth/session
#### Type declaration
#### Type declaration
| Name | Type | Description |
| Name | Type | Description |
| :------
| :------ | :
------ |
| :------
------ | :------------------------ | :--------------------------------------------
------ |
|
`accessToken`
|
`string`
| The access token |
|
`accessToken`
|
`string`
| The access token |
|
`error?`
|
`string`
\|
``null``
| If there was an error associated with this request
|
|
`error?`
|
`string`
\|
`null`
| If there was an error associated with this request
|
|
`expires`
|
`string`
| ISO date of the expiration date of the access token |
|
`expires`
|
`string`
| ISO date of the expiration date of the access token |
|
`user`
|
[
`User`
](
modules.md#user
)
| Authenticated user |
|
`user`
|
[
`User`
](
modules.md#user
)
| Authenticated user |
...
@@ -469,7 +469,7 @@ https://chat.openapi.com/api/auth/session
...
@@ -469,7 +469,7 @@ https://chat.openapi.com/api/auth/session
[
src/types.ts:8
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L8
)
[
src/types.ts:8
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/types.ts#L8
)
__
_
---
### User
### User
...
@@ -478,7 +478,7 @@ ___
...
@@ -478,7 +478,7 @@ ___
#### Type declaration
#### Type declaration
| Name | Type | Description |
| Name | Type | Description |
| :------
| :------ | :
------ |
| :------
--- | :--------- | :----------------
------ |
|
`email?`
|
`string`
| Email of the user |
|
`email?`
|
`string`
| Email of the user |
|
`features`
|
`string`
[] | Features the user is in |
|
`features`
|
`string`
[] | Features the user is in |
|
`groups`
|
`string`
[] | Groups the user is in |
|
`groups`
|
`string`
[] | Groups the user is in |
...
@@ -504,7 +504,7 @@ included them in here.
...
@@ -504,7 +504,7 @@ included them in here.
#### Parameters
#### Parameters
| Name | Type |
| Name | Type |
| :------
| :
------ |
| :------
------ | :--------------------------------------------------
------ |
|
`url`
|
`string`
|
|
`url`
|
`string`
|
|
`accessToken`
|
`string`
|
|
`accessToken`
|
`string`
|
|
`body`
|
[
`ConversationJSONBody`
](
modules.md#conversationjsonbody
)
|
|
`body`
|
[
`ConversationJSONBody`
](
modules.md#conversationjsonbody
)
|
...
@@ -518,7 +518,7 @@ included them in here.
...
@@ -518,7 +518,7 @@ included them in here.
[
src/utils.ts:73
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/utils.ts#L73
)
[
src/utils.ts:73
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/utils.ts#L73
)
__
_
---
### defaultChromeExecutablePath
### defaultChromeExecutablePath
...
@@ -534,7 +534,7 @@ Gets the default path to chrome's executable for the current platform.
...
@@ -534,7 +534,7 @@ Gets the default path to chrome's executable for the current platform.
[
src/openai-auth.ts:362
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/openai-auth.ts#L362
)
[
src/openai-auth.ts:362
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/openai-auth.ts#L362
)
__
_
---
### getBrowser
### getBrowser
...
@@ -547,7 +547,7 @@ recognizes it and blocks access.
...
@@ -547,7 +547,7 @@ recognizes it and blocks access.
#### Parameters
#### Parameters
| Name | Type |
| Name | Type |
| :-----
- | :
------ |
| :-----
| :---------------------------------------------------------------------------
------ |
|
`opts`
|
`PuppeteerLaunchOptions`
& {
`captchaToken?`
:
`string`
;
`nopechaKey?`
:
`string`
} |
|
`opts`
|
`PuppeteerLaunchOptions`
& {
`captchaToken?`
:
`string`
;
`nopechaKey?`
:
`string`
} |
#### Returns
#### Returns
...
@@ -558,7 +558,7 @@ recognizes it and blocks access.
...
@@ -558,7 +558,7 @@ recognizes it and blocks access.
[
src/openai-auth.ts:215
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/openai-auth.ts#L215
)
[
src/openai-auth.ts:215
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/openai-auth.ts#L215
)
__
_
---
### getOpenAIAuth
### getOpenAIAuth
...
@@ -581,14 +581,13 @@ with your updated credentials.
...
@@ -581,14 +581,13 @@ with your updated credentials.
#### Parameters
#### Parameters
| Name | Type |
| Name | Type |
| :------
| :
------ |
| :------
---------------------------- | :--
------ |
|
`__namedParameters`
|
`Object`
|
|
`__namedParameters`
|
`Object`
|
|
`__namedParameters.browser?`
|
`Browser`
|
|
`__namedParameters.browser?`
|
`Browser`
|
|
`__namedParameters.captchaToken?`
|
`string`
|
|
`__namedParameters.captchaToken?`
|
`string`
|
|
`__namedParameters.email?`
|
`string`
|
|
`__namedParameters.email?`
|
`string`
|
|
`__namedParameters.executablePath?`
|
`string`
|
|
`__namedParameters.executablePath?`
|
`string`
|
|
`__namedParameters.isGoogleLogin?`
|
`boolean`
|
|
`__namedParameters.isGoogleLogin?`
|
`boolean`
|
|
`__namedParameters.isWindowsLogin?`
|
`boolean`
|
|
`__namedParameters.nopechaKey?`
|
`string`
|
|
`__namedParameters.nopechaKey?`
|
`string`
|
|
`__namedParameters.page?`
|
`Page`
|
|
`__namedParameters.page?`
|
`Page`
|
|
`__namedParameters.password?`
|
`string`
|
|
`__namedParameters.password?`
|
`string`
|
...
@@ -602,7 +601,7 @@ with your updated credentials.
...
@@ -602,7 +601,7 @@ with your updated credentials.
[
src/openai-auth.ts:49
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/openai-auth.ts#L49
)
[
src/openai-auth.ts:49
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/openai-auth.ts#L49
)
__
_
---
### isRelevantRequest
### isRelevantRequest
...
@@ -611,7 +610,7 @@ ___
...
@@ -611,7 +610,7 @@ ___
#### Parameters
#### Parameters
| Name | Type |
| Name | Type |
| :----
-- | :
------ |
| :----
| :-
------ |
|
`url`
|
`string`
|
|
`url`
|
`string`
|
#### Returns
#### Returns
...
@@ -622,7 +621,7 @@ ___
...
@@ -622,7 +621,7 @@ ___
[
src/utils.ts:39
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/utils.ts#L39
)
[
src/utils.ts:39
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/utils.ts#L39
)
__
_
---
### markdownToText
### markdownToText
...
@@ -631,7 +630,7 @@ ___
...
@@ -631,7 +630,7 @@ ___
#### Parameters
#### Parameters
| Name | Type |
| Name | Type |
| :------
| :
------ |
| :------
---- | :-
------ |
|
`markdown?`
|
`string`
|
|
`markdown?`
|
`string`
|
#### Returns
#### Returns
...
@@ -642,7 +641,7 @@ ___
...
@@ -642,7 +641,7 @@ ___
[
src/utils.ts:12
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/utils.ts#L12
)
[
src/utils.ts:12
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/utils.ts#L12
)
__
_
---
### maximizePage
### maximizePage
...
@@ -651,7 +650,7 @@ ___
...
@@ -651,7 +650,7 @@ ___
#### Parameters
#### Parameters
| Name | Type |
| Name | Type |
| :-----
- | :-
----- |
| :-----
| :
----- |
|
`page`
|
`Page`
|
|
`page`
|
`Page`
|
#### Returns
#### Returns
...
@@ -662,7 +661,7 @@ ___
...
@@ -662,7 +661,7 @@ ___
[
src/utils.ts:29
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/utils.ts#L29
)
[
src/utils.ts:29
](
https://github.com/transitive-bullshit/chatgpt-api/blob/d87ae67/src/utils.ts#L29
)
__
_
---
### minimizePage
### minimizePage
...
@@ -671,7 +670,7 @@ ___
...
@@ -671,7 +670,7 @@ ___
#### Parameters
#### Parameters
| Name | Type |
| Name | Type |
| :-----
- | :-
----- |
| :-----
| :
----- |
|
`page`
|
`Page`
|
|
`page`
|
`Page`
|
#### Returns
#### Returns
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment