on_enter | SignalWire

Lifecycle hook called when the agent enters a session. Override in a subclass to run custom initialization logic when the agent is first bound to an AgentSession.

Parameters

None.

Returns

None

Example

1 from signalwire.livewire import Agent, AgentSession, AgentServer, JobContext, run_app
2 
3 server = AgentServer()
4 
5 class GreeterAgent(Agent):
6     async def on_enter(self):
7         if self.session:
8             self.session.say("Welcome! I just started up.")
9 
10 @server.rtc_session()
11 async def entrypoint(ctx: JobContext):
12     await ctx.connect()
13     agent = GreeterAgent(instructions="You are a friendly greeter.")
14     session = AgentSession()
15     await session.start(agent, room=ctx.room)
16 
17 run_app(server)