Skip to content

Latest commit

 

History

History
128 lines (70 loc) · 2.7 KB

ChatGPTAPI.md

File metadata and controls

128 lines (70 loc) · 2.7 KB

chatgpt / Exports / ChatGPTAPI

Class: ChatGPTAPI

Table of contents

Constructors

Accessors

Methods

Constructors

constructor

new ChatGPTAPI(opts)

Creates a new client wrapper around OpenAI's chat completion API, mimicing the official ChatGPT webapp's functionality as closely as possible.

Parameters

Name Type
opts ChatGPTAPIOptions

Defined in

src/chatgpt-api.ts:51

Accessors

apiKey

get apiKey(): string

Returns

string

Defined in

src/chatgpt-api.ts:345

set apiKey(apiKey): void

Parameters

Name Type
apiKey string

Returns

void

Defined in

src/chatgpt-api.ts:349


apiOrg

get apiOrg(): string

Returns

string

Defined in

src/chatgpt-api.ts:353

set apiOrg(apiOrg): void

Parameters

Name Type
apiOrg string

Returns

void

Defined in

src/chatgpt-api.ts:357

Methods

sendMessage

sendMessage(text, opts?): Promise<ChatMessage>

Sends a message to the OpenAI chat completions endpoint, waits for the response to resolve, and returns the response.

If you want your response to have historical context, you must provide a valid parentMessageId.

If you want to receive a stream of partial responses, use opts.onProgress.

Set debug: true in the ChatGPTAPI constructor to log more info on the full prompt sent to the OpenAI chat completions API. You can override the systemMessage in opts to customize the assistant's instructions.

Parameters

Name Type
text string
opts SendMessageOptions

Returns

Promise<ChatMessage>

The response from ChatGPT

Defined in

src/chatgpt-api.ts:137