Preparing search index...
The search index is not available
LiveKit Agents
LiveKit Agents
agents
llm
ChatMessage
Class ChatMessage
Index
Properties
content?
id?
name?
role
tool
Call
Id?
tool
Calls?
tool
Exception?
Methods
copy
create
create
Tool
Calls
create
Tool
From
Function
Result
Properties
Optional
Readonly
content
content
?:
ChatContent
|
ChatContent
[]
Optional
Readonly
id
id
?:
string
Optional
Readonly
name
name
?:
string
Readonly
role
role
:
ChatRole
Optional
Readonly
tool
Call
Id
tool
Call
Id
?:
string
Optional
Readonly
tool
Calls
tool
Calls
?:
FunctionCallInfo
<
any
,
any
>
[]
Optional
Readonly
tool
Exception
tool
Exception
?:
Error
Methods
copy
copy
(
)
:
ChatMessage
Returns a structured clone of this message.
Returns
ChatMessage
Static
create
create
(
options
)
:
ChatMessage
Parameters
options
:
Partial
<
{
images
:
ChatImage
[]
;
role
:
ChatRole
;
text
?:
string
;
}
>
Returns
ChatMessage
Static
create
Tool
Calls
create
Tool
Calls
(
toolCalls
,
text
?
)
:
ChatMessage
Parameters
toolCalls
:
FunctionCallInfo
<
any
,
any
>
[]
text
:
string
= ''
Returns
ChatMessage
Static
create
Tool
From
Function
Result
create
Tool
From
Function
Result
(
func
)
:
ChatMessage
Parameters
func
:
CallableFunctionResult
Returns
ChatMessage
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
content
id
name
role
tool
Call
Id
tool
Calls
tool
Exception
copy
create
create
Tool
Calls
create
Tool
From
Function
Result
LiveKit Agents
Loading...
Returns a structured clone of this message.