Class ChatClient

Hierarchy (View Summary)

QbraidClient
- ChatClient

Index

Constructors

Properties

Methods

createMessage getModels getUser runningInLab

Constructors

constructor

new ChatClient(session?: QbraidSession): ChatClient
Parameters
- Optionalsession: QbraidSession
Returns ChatClient
Overrides QbraidClient.constructor
- Defined in chat/src/client.ts:9

Properties

`Protected`session

session: QbraidSession

The QbraidSession instance used by this client.

Methods

createMessage

createMessage(
    prompt: string,
    model?: string,
    stream?: boolean,
): Promise<string | ChatResponse>
Parameters
- prompt: string
- model: string = 'gpt-4o-mini'
- stream: boolean = false
Returns Promise<string | ChatResponse>
- Defined in chat/src/client.ts:13

getModels

getModels(): Promise<ChatModel[]>
Returns Promise<ChatModel[]>
- Defined in chat/src/client.ts:51

getUser

getUser(): Promise<QbraidUser>
Returns Promise<QbraidUser>
Inherited from QbraidClient.getUser
- Defined in base/dist/src/client.d.ts:9

runningInLab

runningInLab(): Promise<boolean>
Returns Promise<boolean>
Inherited from QbraidClient.runningInLab
- Defined in base/dist/src/client.d.ts:10