Class OpenAIChatClient

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

Hierarchy (View Summary)

ChatClient
- OpenAIChatClient

Index

Constructors

Accessors

Methods

asBuilder getResponse getService getStreamingResponse

Constructors

constructor

new OpenAIChatClient(
    __namedParameters: {
        apiKey?: string;
        modelId: string;
        openAIClient?: OpenAI;
    },
): OpenAIChatClient
Parameters
- __namedParameters: { apiKey?: string; modelId: string; openAIClient?: OpenAI }
Returns OpenAIChatClient
Overrides ChatClient.constructor
- Defined in openai/src/OpenAIChatClient.ts:14

Accessors

metadata

get metadata(): ChatClientMetadata
Returns ChatClientMetadata
Overrides ChatClient.metadata
- Defined in openai/src/OpenAIChatClient.ts:32

Methods

asBuilder

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

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>
Overrides ChatClient.getResponse
- Defined in openai/src/OpenAIChatClient.ts:52

getService

getService<T>(
serviceType: T,
serviceKey?: string,
): undefined | OpenAI | OpenAIChatClient
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 | OpenAI | OpenAIChatClient
Overrides ChatClient.getService
- Defined in openai/src/OpenAIChatClient.ts:36

getStreamingResponse

getStreamingResponse(
chatMessages: string | ChatMessage[],
options?: ChatOptions,
): AsyncGenerator<ChatResponseUpdate, void, unknown>
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, void, unknown>
Overrides ChatClient.getStreamingResponse
- Defined in openai/src/OpenAIChatClient.ts:77