@telnyx/ai-agent-widget 0.34.3 → 0.35.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -4
- package/dist/bundle.min.js +24 -24
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -47,6 +47,8 @@ You can customize the call options by adding attributes to the `<telnyx-ai-agent
|
|
|
47
47
|
- [`call-caller-name`](https://developers.telnyx.com/development/webrtc/js-sdk/interfaces/icalloptions#callername)
|
|
48
48
|
- [`call-custom-headers`](https://developers.telnyx.com/development/webrtc/js-sdk/interfaces/icalloptions#customheaders)
|
|
49
49
|
- [`call-audio`](https://developers.telnyx.com/development/webrtc/js-sdk/interfaces/icalloptions#audio)
|
|
50
|
+
- `trickle-ice` — enable/disable trickle ICE. Defaults to `true`; set `trickle-ice="false"` to disable.
|
|
51
|
+
- `prefetch-ice-candidates` — enable/disable ICE candidate prefetching. Defaults to `true`; set `prefetch-ice-candidates="false"` to disable.
|
|
50
52
|
- `chat-mode` — enable text-only mode (no microphone). See [Chat Mode](#chat-mode) below.
|
|
51
53
|
|
|
52
54
|
### Chat Mode
|
|
@@ -108,13 +110,16 @@ Known regions: `us-east`, `us-central`, `us-west`, `ca-central`, `eu`, `apac`, `
|
|
|
108
110
|
|
|
109
111
|
Select which Telnyx environment the widget connects to with the `environment` attribute. It is forwarded to the underlying `@telnyx/webrtc` SDK, which picks the WebRTC signalling host accordingly. Defaults to `production`.
|
|
110
112
|
|
|
111
|
-
| Value | WebRTC signalling host
|
|
112
|
-
| ---------------------- |
|
|
113
|
-
| `production` (default) | `wss://rtc.telnyx.com`
|
|
113
|
+
| Value | WebRTC signalling host | When to use |
|
|
114
|
+
| ---------------------- | ------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
115
|
+
| `production` (default) | `wss://rtc.telnyx.com` | Normal usage against Telnyx production. |
|
|
114
116
|
| `development` | `wss://rtcdev.telnyx.com` | Testing an agent/backend deployed to the Telnyx dev environment (e.g. pre-release AI features). |
|
|
115
117
|
|
|
116
118
|
```html
|
|
117
|
-
<telnyx-ai-agent
|
|
119
|
+
<telnyx-ai-agent
|
|
120
|
+
agent-id="assistant-xxx"
|
|
121
|
+
environment="development"
|
|
122
|
+
></telnyx-ai-agent>
|
|
118
123
|
```
|
|
119
124
|
|
|
120
125
|
> `development` routes signalling to `rtcdev.telnyx.com`. Only use it when your assistant **and** the backend changes you are testing are deployed to Telnyx dev — production assistants are not reachable there. `environment` and [`region`](#region) are independent: `region` only rewrites the production host and does not apply to `development`.
|