You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Document new LLM vendors and tighten onboarding docs.
Add Groq, Vertex AI, Bedrock, Dify, and Custom LLM to vendor references, simplify README and index navigation, and align quick-start and terminology with Agora-managed model language.
-[Access Raw Response Data](#access-raw-response-data)
24
-
-[Retries](#retries)
25
-
-[Timeouts](#timeouts)
26
-
-[Custom Client](#custom-client)
27
-
-[Contributing](#contributing)
12
+
```sh
13
+
pip install agora-agents
14
+
```
28
15
29
16
## Requirements
30
17
31
18
- Python 3.8+
32
19
33
-
## Installation
34
-
35
-
```sh
36
-
pip install agora-agents
37
-
```
38
-
39
20
## Quick Start
40
21
41
-
The recommended onboarding path is a server-side builder flow: define the agent once, configure vendors on the builder, and let AgentKit infer Agora-managed configuration when credentials are omitted.
22
+
Start with the `Agent` builder: create a client with app credentials, choose your ASR, LLM, and TTS providers, then start a session. Omit vendor API keys for supported Agora-managed models, or provide keys when you want BYOK.
`Agora` generates the required ConvoAI REST auth and RTC join tokens automatically when you provide `app_id` and `app_certificate`. AgentKit inspects the builder-provided vendor configs and infers Agora-managed configuration for supported models, so you do not pass vendor API keys in this flow.
130
+
`Agora` generates the required ConvoAI REST auth and RTC join tokens automatically when you provide `app_id` and `app_certificate`. For supported Agora-managed models, leave vendor API keys unset; provide keys when you want BYOK.
150
131
151
-
### BYOK version of the same builder flow
132
+
### BYOK version
152
133
153
-
Use the same `Agent` builder shape, but provide credentials explicitly when you want vendor-managed billing and routing instead of Agora-managed presets.
134
+
Use the same `Agent` builder shape, but provide credentials explicitly when you want vendor-managed billing and routing instead of Agora-managed models.
154
135
155
136
```python
156
137
agent = Agent(
@@ -232,7 +213,7 @@ except ApiError as e:
232
213
233
214
## Pagination
234
215
235
-
Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
216
+
Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the returned object.
|`session.raw`|`AgentsClient`| Direct access to the Fern-generated agents client |
147
147
148
-
## `session.raw` — Escape Hatch
148
+
## Direct API access with `session.raw`
149
149
150
-
If the agentkit does not yet expose a method for a new API endpoint, use `session.raw` to access the underlying Fern-generated `AgentsClient` (sync) or `AsyncAgentsClient` (async) directly:
150
+
If AgentKit does not yet expose a method for a new API endpoint, use `session.raw` to access the generated `AgentsClient` (sync) or `AsyncAgentsClient` (async) directly:
Copy file name to clipboardExpand all lines: docs/getting-started/quick-start.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ description: Build and run your first Agora Conversational AI agent in Python wi
6
6
7
7
# Quick Start
8
8
9
-
This guide uses the recommended onboarding path:
9
+
This guide starts with the standard AgentKit path:
10
10
11
11
-`app_id`, `app_certificate`, and `area` on `Agora` or `AsyncAgora`
12
12
- the `Agent` builder with `.with_stt()`, `.with_llm()`, and `.with_tts()`
@@ -61,7 +61,7 @@ if __name__ == "__main__":
61
61
62
62
1.`Agora` runs in app-credentials mode when you pass `app_id` and `app_certificate` only.
63
63
2.`Agent` holds reusable behavior such as instructions, greeting, and history settings.
64
-
3. Vendor classes on the builder select the ASR, LLM, and TTS stack. AgentKit infers Agora-managed configuration when credentials are omitted for supported models.
64
+
3. Vendor classes on the builder select the ASR, LLM, and TTS stack. Leave vendor credentials unset for supported Agora-managed models, or provide keys when you want BYOK.
65
65
4.`session.start()` generates the required auth tokens and returns the unique agent session ID.
66
66
67
67
## Async applications
@@ -70,7 +70,7 @@ For `asyncio` services, switch to `AsyncAgora` and `await` the session methods.
70
70
71
71
## When to use BYOK instead
72
72
73
-
Use the builder without vendor API keys when you want the fastest path with Agora-managed models.
73
+
Use the builder without vendor API keys when you are using supported Agora-managed models.
Copy file name to clipboardExpand all lines: docs/index.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,29 +19,29 @@ The Agora Conversational AI Python SDK lets you build voice-powered AI agents on
19
19
20
20
**MLLM flow** uses a multimodal model such as OpenAI Realtime, Gemini Live, Vertex AI, or xAI Grok for end-to-end audio.
21
21
22
-
## Choose a starting point
22
+
## Start here
23
23
24
-
-Use [Quick Start](./getting-started/quick-start.md) if you want the recommended builder-based path with app credentials.
25
-
- Use [MLLM Flow](./guides/mllm-flow.md)if you want realtime end-to-end audio with OpenAI Realtime, Gemini Live, Vertex AI, or xAI Grok.
26
-
- Use [Cascading Flow](./guides/cascading-flow.md)if you want separate ASR, LLM, and TTS vendors.
24
+
-Start with [Quick Start](./getting-started/quick-start.md). It shows the baseline app-credentials setup and starts a cascading ASR -> LLM -> TTS agent.
25
+
- Use [MLLM Flow](./guides/mllm-flow.md)when your agent uses one realtime multimodal model, such as OpenAI Realtime, Gemini Live, Vertex AI, or xAI Grok.
26
+
- Use [Cascading Flow](./guides/cascading-flow.md)for more examples of the default ASR -> LLM -> TTS flow, including provider-specific configuration.
27
27
28
-
## SDK layers
28
+
## How the SDK is organized
29
29
30
30
| Layer | What it does | When to use |
31
31
|---|---|---|
32
32
|**AgentKit** (`Agent`, `AgentSession`, vendor classes) | High-level builder pattern, lifecycle, typed vendors | Most use cases |
33
-
|**Fern-generated core** (`client.agents`, `client.telephony`) |Direct REST client mapping every API endpoint| Advanced use cases |
33
+
|**Generated REST clients** (`client.agents`, `client.telephony`) |Typed access to REST APIs not covered by AgentKit| Advanced use cases |
34
34
35
35
## Documentation
36
36
37
37
| Section | What you will learn |
38
38
|---|---|
39
39
|[Installation](./getting-started/installation.md)| Install the SDK and prerequisites |
40
40
|[Authentication](./getting-started/authentication.md)| App credentials and other auth modes |
0 commit comments