@telnyx/ai-agent-widget 0.31.0 → 0.31.2
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 +27 -2
- package/dist/bundle.min.js +6 -6
- package/package.json +12 -13
package/README.md
CHANGED
|
@@ -1,18 +1,43 @@
|
|
|
1
1
|
# Telnyx Voice AI Widget
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@telnyx/ai-agent-widget)
|
|
4
|
+
[](https://www.npmjs.com/package/@telnyx/ai-agent-widget)
|
|
5
|
+
|
|
3
6
|
## Overview
|
|
4
7
|
|
|
5
8
|
The Telnyx Voice AI Widget is a web component that allows you to easily integrate voice capabilities into your web applications. It provides a simple interface for making and receiving calls, as well as handling voice interactions using Telnyx's Voice AI services.
|
|
6
9
|
|
|
7
|
-
##
|
|
10
|
+
## Installation
|
|
8
11
|
|
|
9
|
-
|
|
12
|
+
### Via CDN (recommended for quick start)
|
|
10
13
|
|
|
11
14
|
```html
|
|
12
15
|
<telnyx-ai-agent agent-id="assistant-xxx"></telnyx-ai-agent>
|
|
13
16
|
<script async src="https://unpkg.com/@telnyx/ai-agent-widget"></script>
|
|
14
17
|
```
|
|
15
18
|
|
|
19
|
+
### Via npm/yarn
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install @telnyx/ai-agent-widget
|
|
23
|
+
# or
|
|
24
|
+
yarn add @telnyx/ai-agent-widget
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Then import in your application:
|
|
28
|
+
|
|
29
|
+
```javascript
|
|
30
|
+
import '@telnyx/ai-agent-widget';
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Usage
|
|
34
|
+
|
|
35
|
+
To use the Telnyx Voice AI Widget, add the custom element to your HTML:
|
|
36
|
+
|
|
37
|
+
```html
|
|
38
|
+
<telnyx-ai-agent agent-id="assistant-xxx"></telnyx-ai-agent>
|
|
39
|
+
```
|
|
40
|
+
|
|
16
41
|
### Call Options
|
|
17
42
|
|
|
18
43
|
You can customize the call options by adding attributes to the `<telnyx-ai-agent>` tag:
|