Semantic Kernel JavaScript
Preparing search index...
@semantic-kernel/openai
OpenAIChatClient
Class OpenAIChatClient
Hierarchy (
View Summary
)
ChatClient
OpenAIChatClient
Index
Constructors
constructor
Accessors
metadata
Methods
as
Builder
complete
complete
Streaming
get
Service
Constructors
constructor
new
OpenAIChatClient
(
__namedParameters
:
{
apiKey
?:
string
;
modelId
:
string
;
openAIClient
?:
OpenAI
;
}
,
)
:
OpenAIChatClient
Parameters
__namedParameters
:
{
apiKey
?:
string
;
modelId
:
string
;
openAIClient
?:
OpenAI
}
Returns
OpenAIChatClient
Accessors
metadata
get
metadata
()
:
ChatClientMetadata
Returns
ChatClientMetadata
Methods
as
Builder
asBuilder
()
:
ChatClientBuilder
Returns
ChatClientBuilder
complete
complete
(
chatMessages
:
string
|
ChatMessage
[]
,
options
?:
ChatOptions
,
)
:
Promise
<
ChatResponse
>
Parameters
chatMessages
:
string
|
ChatMessage
[]
Optional
options
:
ChatOptions
Returns
Promise
<
ChatResponse
>
complete
Streaming
completeStreaming
(
chatMessages
:
string
|
ChatMessage
[]
,
options
?:
ChatOptions
,
)
:
AsyncGenerator
<
ChatResponseUpdate
,
void
,
unknown
>
Parameters
chatMessages
:
string
|
ChatMessage
[]
Optional
options
:
ChatOptions
Returns
AsyncGenerator
<
ChatResponseUpdate
,
void
,
unknown
>
get
Service
getService
<
T
>
(
serviceType
:
T
,
serviceKey
?:
string
,
)
:
undefined
|
OpenAIChatClient
|
OpenAI
Type Parameters
T
Parameters
serviceType
:
T
Optional
serviceKey
:
string
Returns
undefined
|
OpenAIChatClient
|
OpenAI
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Accessors
metadata
Methods
as
Builder
complete
complete
Streaming
get
Service
Semantic Kernel JavaScript
Loading...