chatgpt-api/docs/modules.md

chatgpt / Exports

chatgpt

Table of contents

Namespaces

• openai

Classes

• ChatGPTAPI
• ChatGPTError

Interfaces

• ChatMessage

Type Aliases

• FetchFn
• GetMessageByIdFunction
• Role
• SendMessageOptions
• UpsertMessageFunction

Type Aliases

FetchFn

Ƭ FetchFn: typeof fetch

Defined in

src/types.ts:3

---

GetMessageByIdFunction

Ƭ GetMessageByIdFunction: (id: string) => Promise<ChatMessage>

Type declaration

▸ (id): Promise<ChatMessage>

Returns a chat message from a store by it's ID (or null if not found).

Parameters

Name	Type
id	string

Returns

Promise<ChatMessage>

Defined in

src/types.ts:32

---

Role

Ƭ Role: "user" | "assistant"

Defined in

src/types.ts:1

---

SendMessageOptions

Ƭ SendMessageOptions: Object

Type declaration

Name	Type
abortSignal?	AbortSignal
conversationId?	string
messageId?	string
onProgress?	(partialResponse: ChatMessage) => void
parentMessageId?	string
promptPrefix?	string
promptSuffix?	string
stream?	boolean
timeoutMs?	number

Defined in

src/types.ts:5

---

UpsertMessageFunction

Ƭ UpsertMessageFunction: (message: ChatMessage) => Promise<void>

Type declaration

▸ (message): Promise<void>

Upserts a chat message to a store.

Parameters

Name	Type
message	ChatMessage

Returns

Promise<void>

Defined in

src/types.ts:35