Skip to content

docs: update inference README to reflect new RPC handlers and control types #5786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
detail-app wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update inference README to reflect new RPC handlers and control types #5786

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions examples/inference/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A minimal voice agent powered end-to-end by [LiveKit Inference](https://docs.liv

## How the live swap works

The playground sends an RPC on every dropdown change:
The playground sends an RPC when a control is changed. For the model-picker dropdowns:

```ts
room.localParticipant.performRpc({
Expand All @@ -14,7 +14,7 @@ room.localParticipant.performRpc({
});
```

The agent registers one handler per control. All three (STT, LLM, TTS) call `update_options(model=...)` to swap the active model without restarting the session.
The agent registers one handler per control. The three model-swap handlers (STT, LLM, TTS) call `update_options(model=...)` to swap the active model without restarting the session. The `set_system_prompt` handler calls `update_instructions(...)` to replace the agent's system prompt live. The `open_in_builder` handler returns a Cloud Builder URL that the playground opens in a new tab.

## Run locally

Expand Down