Skip to main content

Module agent

Module agent 

Source
Expand description

The livekit.agent protobuf package: AgentSessionEvent, SessionRequest and the agent worker/inference messages. Generated by generate_proto.sh; a new package needs its own include! or the types exist on disk and are reachable from nowhere.

Modules§

agent_dev_message
Nested message and enum types in AgentDevMessage.
agent_session_event
Nested message and enum types in AgentSessionEvent.
agent_session_message
Nested message and enum types in AgentSessionMessage.
agent_session_state
Nested message and enum types in AgentSessionState.
agent_task
Nested message and enum types in AgentTask.
agent_thread
Nested message and enum types in AgentThread.
chat_context
Nested message and enum types in ChatContext.
chat_message
Nested message and enum types in ChatMessage.
client_message
Nested message and enum types in ClientMessage.
eot_prediction
Nested message and enum types in EotPrediction.
inference_request
Nested message and enum types in InferenceRequest.
inference_response
Nested message and enum types in InferenceResponse.
model_usage
Nested message and enum types in ModelUsage.
server_message
Nested message and enum types in ServerMessage.
session_request
Nested message and enum types in SessionRequest.
session_response
Nested message and enum types in SessionResponse.
session_settings
Nested message and enum types in SessionSettings.
text_message_complete
Nested message and enum types in TextMessageComplete.
text_message_response
Nested message and enum types in TextMessageResponse.

Structs§

AgentConfigUpdate
AgentDevMessage
AgentDevMessage is used for IPC between the CLI and agent processes during dev-mode hot reload.
AgentHandoff
AgentSessionEvent
AgentSessionMessage
AgentSessionState
AgentSessionUsage
AgentTask
AgentTask: background work an agent runs within a thread, such as a booking that takes minutes.
AgentThread
BufferStart
audio buffer sentinel messages
BufferStop
ChatContext
ChatMessage
ClientMessage
DebugMessage
Debug/trace payload carried over the remote session wire. Internal: surfaced only to the debugger/recorder, not to user code.
EotInferenceRequest
EotInferenceResponse
EotInputChatContext
EotModelUsage
EotPrediction
EotSettings
FunctionCall
FunctionCallOutput
GetRunningAgentJobsRequest
GetRunningAgentJobsResponse
InferenceError
InferenceRequest
InferenceResponse
InferenceStart
InferenceStarted
InferenceStats
InferenceStop
InferenceStopped
InputAudio
InterruptionInferenceRequest
InterruptionInferenceResponse
InterruptionModelUsage
InterruptionPrediction
InterruptionSettings
LlmModelUsage
MetricsReport
ModelUsage
RunningAgentJobInfo
ServerInfo
ServerInfo is sent by the agent to the CLI when the dev-reload channel opens,
ServerMessage
SessionClose
SessionClosed
SessionCreate
SessionCreated
SessionFlush
SessionRequest
SessionResponse
SessionSettings
SttModelUsage
TextMessageComplete
Indicates the text message session is complete.
TextMessageError
TextMessageRequest
Request to send a text message to an agent.
TextMessageResponse
Response to a text message request, multiple responses may be sent for a single request until it is complete.
TimedString
TtsModelUsage

Enums§

AgentState
AmdCategory
AudioEncoding
ChatRole
TextMessageErrorCode
ToolCallStatus
ToolReplyStatus
UserState

Constants§

THREAD_SCHEMA_V1
Version 1 of the conversation schema inside a thread’s database, one statement per ; (comments hold none).
THREAD_SCHEMA_VERSION
The newest conversation schema a thread’s database can hold (protocol’s livekit/agent/thread_schema.go).