@alan-ai/alan-sdk-web 1.8.43 → 1.8.44
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 +30 -24
- package/dist/AlanButtonOptions.d.ts +1 -0
- package/dist/alan_lib.js +6323 -2828
- package/dist/alan_lib.min.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# Alan AI:
|
|
1
|
+
# Alan AI: Conversational AI SDK for Web
|
|
2
2
|
|
|
3
|
-
[Alan Platform](https://alan.app/) • [Alan Studio](https://studio.alan.app/register) • [Docs](https://alan.app/docs) • [FAQ](https://alan.app/docs/usage/additional/faq) •
|
|
3
|
+
[Alan AI Platform](https://alan.app/) • [Alan AI Studio](https://studio.alan.app/register) • [Docs](https://alan.app/docs) • [FAQ](https://alan.app/docs/usage/additional/faq) •
|
|
4
4
|
[Blog](https://alan.app/blog/) • [Twitter](https://twitter.com/alanvoiceai)
|
|
5
5
|
|
|
6
6
|
[](https://www.npmjs.com/package/@alan-ai/alan-sdk-web)
|
|
@@ -8,42 +8,42 @@
|
|
|
8
8
|
[](https://circleci.com/gh/alan-ai/alan-sdk-web)
|
|
9
9
|
|
|
10
10
|
|
|
11
|
-
Quickly
|
|
11
|
+
Quickly create AI assistants and AI chats with the Alan AI Platform. Enable human-like conversations and perform actions in any app through voice and text commands.
|
|
12
12
|
|
|
13
13
|
<img src="https://storage.googleapis.com/alan-public-images/github/tablet-tasks.gif" height="325px" align="right"/>
|
|
14
14
|
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Actionable AI Platform
|
|
17
17
|
|
|
18
|
-
Alan is
|
|
18
|
+
Alan AI is an Actionable AI Platform that lets you create a voice AI assistant and voice/text AI chat for your app. It offers all necessary tools to design, embed and host conversational experiences:
|
|
19
19
|
|
|
20
|
-
#### Alan Studio
|
|
21
|
-
A powerful web-based IDE where you can write, test and debug dialog scenarios for your
|
|
20
|
+
#### Alan AI Studio
|
|
21
|
+
A powerful web-based IDE where you can write, test and debug dialog scenarios for your AI assistant or AI chat.
|
|
22
22
|
|
|
23
|
-
#### Alan
|
|
23
|
+
#### Alan AI SDKs
|
|
24
24
|
|
|
25
|
-
Alan's lightweight SDKs to quickly embed
|
|
25
|
+
Alan AI's lightweight SDKs to quickly embed an AI assistant or AI chat to your app.
|
|
26
26
|
|
|
27
|
-
#### Alan Cloud
|
|
27
|
+
#### Alan AI Cloud
|
|
28
28
|
|
|
29
|
-
Alan's
|
|
29
|
+
Alan AI's backend powered by the industry’s best Automatic Speech Recognition (ASR), Natural Language Understanding (NLU) and Speech Synthesis. Alan AI provisions and handles the infrastructure required to maintain your conversational experiences and perform all the data processing tasks.
|
|
30
30
|
|
|
31
|
-
To get more details on how Alan works, see <a href="https://alan.app/platform" target="_blank">Alan Platform</a>.
|
|
31
|
+
To get more details on how Alan AI works, see <a href="https://alan.app/platform" target="_blank">Alan AI Platform</a>.
|
|
32
32
|
|
|
33
|
-
## Why Alan?
|
|
33
|
+
## Why Alan AI?
|
|
34
34
|
|
|
35
|
-
* **No or minimum changes to your UI**: To
|
|
36
|
-
* **Serverless environment**: No need to plan for, deploy and maintain any infrastructure or speech components - the Alan Platform does the bulk of the work.
|
|
35
|
+
* **No or minimum changes to your UI**: To create a conversational experience, you only need to get the Alan AI SDK and drop it to your app.
|
|
36
|
+
* **Serverless environment**: No need to plan for, deploy and maintain any infrastructure or speech components - the Alan AI Platform does the bulk of the work.
|
|
37
37
|
* **On-the-fly updates**: All changes to the dialogs become available immediately.
|
|
38
|
-
* **
|
|
38
|
+
* **Dialog flow testing and analytics**: Alan AI Studio provides advanced tools for testing your dialog flows and getting the conversational analytics data on users' interactions, all in the same console.
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
## How to start
|
|
42
42
|
|
|
43
|
-
To create
|
|
43
|
+
To create an AI assistant or AI chat for your web app or page:
|
|
44
44
|
|
|
45
|
-
1. <a href="https://studio.alan.app/register" target="_blank">Sign up for Alan Studio</a> to build
|
|
46
|
-
2. Use the Alan
|
|
45
|
+
1. <a href="https://studio.alan.app/register" target="_blank">Sign up for Alan AI Studio</a> to build dialog scripts in JavaScript and test them.
|
|
46
|
+
2. Use the Alan AI SDK for Web to embed an AI assistant or chat to your app or page. For details, see Alan AI documentation for the necessary framework:
|
|
47
47
|
|
|
48
48
|
* <a href="https://alan.app/docs/client-api/web/vanilla" target="_blank">JavaScript</a>
|
|
49
49
|
* <a href="https://alan.app/docs/client-api/web/react" target="_blank">React</a>
|
|
@@ -57,10 +57,10 @@ Check out our <a href="https://alan-ai.github.io/alan-sdk-web/" target="_blank">
|
|
|
57
57
|
|
|
58
58
|
## Downloads
|
|
59
59
|
|
|
60
|
-
* <a href="https://www.npmjs.com/package/@alan-ai/alan-sdk-web" target="_blank">Alan package</a>
|
|
61
|
-
* <a href="https://github.com/alan-ai/alan-sdk-web/releases" target="_blank">Alan
|
|
60
|
+
* <a href="https://www.npmjs.com/package/@alan-ai/alan-sdk-web" target="_blank">Alan AI package</a>
|
|
61
|
+
* <a href="https://github.com/alan-ai/alan-sdk-web/releases" target="_blank">Alan AI SDK for Web releases</a>
|
|
62
62
|
|
|
63
|
-
##
|
|
63
|
+
## Voice assistant examples
|
|
64
64
|
|
|
65
65
|
In the [Examples](https://github.com/alan-ai/alan-sdk-web/tree/master/examples) folder, you can find example web apps created with:
|
|
66
66
|
|
|
@@ -70,11 +70,17 @@ In the [Examples](https://github.com/alan-ai/alan-sdk-web/tree/master/examples)
|
|
|
70
70
|
* Ember
|
|
71
71
|
* Electron
|
|
72
72
|
|
|
73
|
-
To launch the app, follow the instructions in the README file inside the example app folder. Then press the Alan button and try interacting with Alan.
|
|
73
|
+
To launch the app, follow the instructions in the README file inside the example app folder. Then press the Alan AI button and try interacting with Alan AI.
|
|
74
|
+
|
|
75
|
+
## Web chat example
|
|
76
|
+
|
|
77
|
+
In the [Website chat demo](https://github.com/alan-ai/website-chat-demo) repository, you can find an example project demonstrating how to quickly add a voice and text AI chat to your web page, website or web app.
|
|
78
|
+
|
|
79
|
+
Check out the live web chat demo here: [https://alan-ai.github.io/website-chat-demo/](https://alan-ai.github.io/website-chat-demo/).
|
|
74
80
|
|
|
75
81
|
## Other platforms
|
|
76
82
|
|
|
77
|
-
You may also want to try Alan
|
|
83
|
+
You may also want to try Alan AI SDKs for the following platforms:
|
|
78
84
|
|
|
79
85
|
* <a href="https://github.com/alan-ai/alan-sdk-ios" target="_blank">iOS</a>
|
|
80
86
|
* <a href="https://github.com/alan-ai/alan-sdk-android" target="_blank">Android</a>
|