docs

Author: bcherry

README.md

@@ -43,8 +43,6 @@ uv run python src/agent.py console
 
 ## Web playground
 
-## Web frontend
-
 This agent is compatible with the [LiveKit Agents Playground](https://agents-playground.livekit.io). 
 
 To run the agent for the playground, use the `dev` subcomand:
@@ -81,4 +79,83 @@ To run the tests in a CI environment, you must also [add repository secrets](htt
 
 ## Deploying to production
 
-This project is production-ready and includes a working `Dockerfile`. To deploy it to LiveKit Cloud or another environment, see the [deploying to production](https://docs.livekit.io/agents/ops/deployment/) guide.
+This project is production-ready and includes a working `Dockerfile`. To deploy it to LiveKit Cloud or another environment, see the [deploying to production](https://docs.livekit.io/agents/ops/deployment/) guide.
+
+## Models
+
+This project uses models from AssemblyAI and Rime, as well as GPT-4o-mini from Azure OpenAI. By default, these are served through early-access to LiveKit Inference and no extra account is required.
+
+### AssemblyAI customization
+
+To customize the AssemblyAI model, while still using LiveKit Cloud, you can use the following session setup instead of the version above:
+
+```python
+from livekit.agents import inference
+
+session = AgentSession(
+    stt=inference.STT(model="assemblyai", extra_kwargs={ ... })
+)
+```
+
+Refer to the [source code](https://github.com/livekit/agents/blob/main/livekit-agents/livekit/agents/inference/stt.py#L57) for available parameters (docs for LiveKit Inference are coming soon)
+
+#### AssemblyAI plugin
+
+To use your own AssemblyAI account, or access additional features, use the AssemblyAI plugin:
+
+```shell
+uv add livekit-agents[assemblyai]
+```
+
+```python
+from livekit.plugins import assemblyai
+
+session = AgentSession(
+    stt=assemblyai.STT()
+)
+```
+
+Refer to the [plugin documentation](https://docs.livekit.io/agents/integrations/stt/assemblyai/) for more information.
+
+### Rime customization
+
+To use a different Rime voice, while still using LiveKit Cloud, just change the voice name after the colon:
+
+```python
+session = AgentSession(
+    tts="rime/arcana:andromeda"
+)
+```
+
+Refer to the [Rime voices list](https://docs.rime.ai/api-reference/voices) for more information.
+
+#### Rime plugin
+
+To use your own Rime account, or access additional features, use the Rime plugin:
+
+```shell
+uv add livekit-agents[rime]
+```
+
+```python
+from livekit.plugins import rime
+
+session = AgentSession(
+    tts=rime.TTS(model="arcana", speaker="andromeda")
+)
+```
+
+Refer to the [plugin documentation](https://docs.livekit.io/agents/integrations/tts/rime/) for more information.
+
+
+## Other large language models
+
+Refer to the [source code](https://github.com/livekit/agents/blob/main/livekit-agents/livekit/agents/inference/llm.py) for available models (LiveKit Inference docs are coming soon).
+
+```python
+session = AgentSession(
+    llm="azure/gpt-4o-mini"
+)
+```
+
+Or, use an [LLM plugin](https://docs.livekit.io/agents/integrations/llm/) for a wider range of models and more configuration options.

src/agent.py

@@ -85,7 +85,7 @@ async def entrypoint(ctx: JobContext):
 
         # This starter template uses Rime via LiveKit Cloud
         # To change the voice, alter the voice name (currently "luna") after the colon.
-        # See available voices at https://docs.livekit.io/agents/integrations/tts/rime/#voices
+        # See available voices at https://docs.rime.ai/api-reference/voices
         #
         # Or, to use your own Rime account:
         # 1. Install livekit-agents[rime]