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
agents
cli
runApp
ipc
InferenceExecutor
llm
ChatRole
LLMEvent
ChatContext
ChatMessage
LLM
LLMStream
CallableFunction
CallableFunctionResult
ChatAudio
ChatChunk
ChatImage
Choice
ChoiceDelta
CompletionUsage
FunctionCallInfo
ChatContent
FunctionContext
LLMCallbacks
inferParameters
metrics
MultimodalLLMError
UsageCollector
LLMMetrics
MultimodalLLMMetrics
PipelineEOUMetrics
PipelineLLMMetrics
PipelineTTSMetrics
STTMetrics
TTSMetrics
UsageSummary
VADMetrics
AgentMetrics
PipelineSTTMetrics
PipelineVADMetrics
logMetrics
multimodal
AgentPlayout
MultimodalAgent
PlayoutHandle
AgentState
AGENT_STATE_ATTRIBUTE
proto
pipeline
VPAEvent
AgentCallContext
VoicePipelineAgent
AgentTranscriptionOptions
VPAOptions
AgentState
BeforeLLMCallback
BeforeTTSCallback
VPACallbacks
stt
SpeechEventType
STT
SpeechStream
StreamAdapter
StreamAdapterWrapper
RecognitionUsage
STTCapabilities
SpeechData
SpeechEvent
STTCallbacks
tokenize
basic
SentenceTokenizer
WordTokenizer
hyphenateWord
splitWords
tokenizeParagraphs
BufferedSentenceStream
BufferedTokenStream
BufferedWordStream
SentenceStream
SentenceTokenizer
WordStream
WordTokenizer
TokenData
tts
TTSEvent
ChunkedStream
StreamAdapter
StreamAdapterWrapper
SynthesizeStream
TTS
SynthesizedAudio
TTSCapabilities
TTSCallbacks
AutoSubscribe
VADEventType
AudioByteStream
CurrentJobContext
FunctionExistsError
JobContext
JobProcess
JobRequest
MissingCredentialsError
Plugin
TextAudioSynchronizer
VAD
VADStream
Worker
WorkerError
WorkerOptions
WorkerPermissions
Agent
TextSyncOptions
VADCapabilities
VADEvent
AudioBuffer
JobAcceptArguments
RunningJobInfo
VADCallbacks
defaultTextSyncOptions
version
defineAgent
findMicroTrackId
mergeFrames
plugins
agents-plugin-cartesia
ChunkedStream
SynthesizeStream
TTS
TTSOptions
agents-plugin-deepgram
STT
SpeechStream
STTOptions
agents-plugin-elevenlabs
SynthesizeStream
TTS
TTSOptions
agents-plugin-silero
turnDetector
default
EOUModel
EOURunner
agents-plugin-openai
realtime
RealtimeModel
RealtimeSession
AssistantItem
AssistantItemCreate
AudioContent
BaseItem
ConversationCreatedEvent
ConversationItemCreateEvent
ConversationItemCreatedEvent
ConversationItemDeleteEvent
ConversationItemDeletedEvent
ConversationItemInputAudioTranscriptionCompletedEvent
ConversationItemInputAudioTranscriptionFailedEvent
ConversationItemTruncateEvent
ConversationItemTruncatedEvent
ConversationResource
ErrorEvent
FunctionCallItem
FunctionCallOutputItem
FunctionCallOutputItemCreate
InputAudioBufferAppendEvent
InputAudioBufferClearEvent
InputAudioBufferClearedEvent
InputAudioBufferCommitEvent
InputAudioBufferCommittedEvent
InputAudioBufferSpeechStartedEvent
InputAudioBufferSpeechStoppedEvent
InputAudioContent
InputSpeechCommitted
InputSpeechStarted
InputSpeechTranscriptionCompleted
InputSpeechTranscriptionFailed
InputTextContent
ModelUsage
RateLimitsUpdatedEvent
RealtimeContent
RealtimeOutput
RealtimeResponse
RealtimeToolCall
ResponseAudioDeltaEvent
ResponseAudioDoneEvent
ResponseAudioTranscriptDeltaEvent
ResponseAudioTranscriptDoneEvent
ResponseCancelEvent
ResponseContentPartAddedEvent
ResponseContentPartDoneEvent
ResponseCreateEvent
ResponseCreatedEvent
ResponseDoneEvent
ResponseFunctionCallArgumentsDeltaEvent
ResponseFunctionCallArgumentsDoneEvent
ResponseOutputItemAddedEvent
ResponseOutputItemDoneEvent
ResponseResource
ResponseTextDeltaEvent
ResponseTextDoneEvent
SessionCreatedEvent
SessionResource
SessionUpdateEvent
SessionUpdatedEvent
SystemItem
SystemItemCreate
TextContent
Tool
UserItem
UserItemCreate
AudioBase64Bytes
AudioFormat
ClientEvent
ClientEventType
Content
ContentPart
ConversationItemCreateContent
GenerationFinishedReason
InputAudioTranscription
InputTranscriptionModel
ItemResource
Modality
Model
ResponseStatus
ResponseStatusDetails
Role
ServerEvent
ServerEventType
State
ToolChoice
TurnDetectionType
Voice
BASE_URL
IN_FRAME_SIZE
NUM_CHANNELS
OUT_FRAME_SIZE
SAMPLE_RATE
ChunkedStream
LLM
LLMStream
STT
TTS
LLMOptions
STTOptions
TTSOptions
CerebrasChatModels
ChatModels
DeepSeekChatModels
GroqAudioModels
GroqChatModels
OctoChatModels
PerplexityChatModels
TTSModels
TTSVoices
TelnyxChatModels
TogetherChatModels
WhisperModels
XAIChatModels
agents-plugin-silero
VAD
VADStream
Returns a structured clone of this message.