Class ChatClient`Abstract`

Abstract class representing a chat client that can interact with a chat service.

Hierarchy (View Summary)

ChatClient

Index

Constructors

Accessors

Methods

asBuilder getResponse getService getStreamingResponse

Constructors

constructor

new ChatClient(): ChatClient
Returns ChatClient

Accessors

`Abstract`metadata

get metadata(): ChatClientMetadata
Returns ChatClientMetadata
- Defined in src/AI/dist/index.d.ts:396

Methods

asBuilder

asBuilder(): ChatClientBuilder
Returns ChatClientBuilder
- Defined in src/AI/dist/index.d.ts:403

`Abstract`getResponse

getResponse(
chatMessages: string | ChatMessage[],
options?: ChatOptions,
): Promise<ChatResponse>
Get a response from the chat client based on the provided chat messages.
Parameters
- chatMessages: string | ChatMessage[]
  A string or an array of ChatMessage objects representing the conversation history.
- Optionaloptions: ChatOptions
  Optional parameters to customize the chat response, such as temperature, max tokens, etc.
Returns Promise<ChatResponse>
- Defined in src/AI/dist/index.d.ts:389

`Abstract`getService

getService<T>(serviceType: T, serviceKey?: string): undefined | object
Asks the chat client to provide a service of a specific type.
Type Parameters
- T
Parameters
- serviceType: T
  The type of service to retrieve, which is typically a class or interface.
- OptionalserviceKey: string
  An optional key to identify a specific service instance.
Returns undefined | object
- Defined in src/AI/dist/index.d.ts:402

`Abstract`getStreamingResponse

getStreamingResponse(
chatMessages: string | ChatMessage[],
options?: ChatOptions,
): AsyncGenerator<ChatResponseUpdate>
Get a streaming response from the chat client based on the provided chat messages.
Parameters
- chatMessages: string | ChatMessage[]
  A string or an array of ChatMessage objects representing the conversation history.
- Optionaloptions: ChatOptions
  Optional parameters to customize the chat response, such as temperature, max tokens, etc.
Returns AsyncGenerator<ChatResponseUpdate>
- Defined in src/AI/dist/index.d.ts:395