@alan-ai/alan-sdk-web 1.8.53 → 1.8.57

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 CHANGED
@@ -1,6 +1,6 @@
1
- # Alan AI: Conversational AI SDK for Web
1
+ # Alan AI: Generative AI SDK for Web
2
2
 
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) •
3
+ [Alan AI](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
  [![npm](https://img.shields.io/npm/v/@alan-ai/alan-sdk-web.svg)](https://www.npmjs.com/package/@alan-ai/alan-sdk-web)
@@ -8,42 +8,44 @@
8
8
  [![CircleCI](https://circleci.com/gh/alan-ai/alan-sdk-web.svg?style=shield)](https://circleci.com/gh/alan-ai/alan-sdk-web)
9
9
 
10
10
 
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.
11
+ Quickly build a Generative AI Agent with Alan AI.
12
12
 
13
- <img src="https://storage.googleapis.com/alan-public-images/github/tablet-tasks.gif" height="325px" align="right"/>
13
+ <img src="https://storage.googleapis.com/alan-public-images/github/alan-git.png" height="400px" align="right"/>
14
14
 
15
15
 
16
- ## Actionable AI Platform
16
+ ## Unified Brain
17
17
 
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:
18
+ Alan AI is a comprehensive AI solution that acts as a 'unified brain' for your enterprise. It interconnects enterprise applications, APIs, static and dynamic data sources to streamline your enterprise workflows.
19
+
20
+ Alan AI offers all necessary tools to design, embed and host Generative AI Agents:
19
21
 
20
22
  #### 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.
23
+ A powerful web-based IDE where you can write, test and debug dialog scenarios for your Generative AI Agent.
22
24
 
23
25
  #### Alan AI SDKs
24
26
 
25
- Alan AI's lightweight SDKs to quickly embed an AI assistant or AI chat to your app.
27
+ Alan AI's lightweight SDKs to quickly embed a Generative AI Agent to your app.
26
28
 
27
29
  #### Alan AI Cloud
28
30
 
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.
31
+ Alan AI's backend powered by the latest AI advancements - LLMs, generative AI and semantic search technologies. Alan AI provisions and handles the infrastructure required to maintain your Generative AI Agent and perform all the data processing tasks.
30
32
 
31
- To get more details on how Alan AI works, see <a href="https://alan.app/platform" target="_blank">Alan AI Platform</a>.
33
+ To get more details on how Alan AI works, see <a href="https://alan.app" target="_blank">Alan AI</a>.
32
34
 
33
35
  ## Why Alan AI?
34
36
 
35
37
  * **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.
38
+ * **Serverless environment**: No need to plan for, deploy and maintain any infrastructure or speech components - Alan AI does the bulk of the work.
37
39
  * **On-the-fly updates**: All changes to the dialogs become available immediately.
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.
40
+ * **Dialog 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
41
 
40
42
 
41
43
  ## How to start
42
44
 
43
- To create an AI assistant or AI chat for your web app or page:
45
+ To create a Generative AI Agent for your web app:
44
46
 
45
47
  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:
48
+ 2. Use the Alan AI SDK for Web to embed a Generative AI Agent to your app or website. For details, see Alan AI documentation for the necessary framework:
47
49
 
48
50
  * <a href="https://alan.app/docs/client-api/web/vanilla" target="_blank">JavaScript</a>
49
51
  * <a href="https://alan.app/docs/client-api/web/react" target="_blank">React</a>
@@ -53,14 +55,12 @@ To create an AI assistant or AI chat for your web app or page:
53
55
  * <a href="https://alan.app/docs/client-api/web/electron" target="_blank">Electron</a>
54
56
 
55
57
 
56
- Check out our <a href="https://alan-ai.github.io/alan-sdk-web/" target="_blank">demo</a>.
57
-
58
58
  ## Downloads
59
59
 
60
60
  * <a href="https://www.npmjs.com/package/@alan-ai/alan-sdk-web" target="_blank">Alan AI package</a>
61
61
  * <a href="https://github.com/alan-ai/alan-sdk-web/releases" target="_blank">Alan AI SDK for Web releases</a>
62
62
 
63
- ## Voice assistant examples
63
+ ## AI Agent 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
 
@@ -72,15 +72,9 @@ In the [Examples](https://github.com/alan-ai/alan-sdk-web/tree/master/examples)
72
72
 
73
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
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/).
80
-
81
75
  ## Other platforms
82
76
 
83
- You may also want to try Alan AI SDKs for the following platforms:
77
+ You may also want to try Alan AI SDKs for the following platforms and frameworks:
84
78
 
85
79
  * <a href="https://github.com/alan-ai/alan-sdk-ios" target="_blank">iOS</a>
86
80
  * <a href="https://github.com/alan-ai/alan-sdk-android" target="_blank">Android</a>
@@ -88,7 +82,6 @@ You may also want to try Alan AI SDKs for the following platforms:
88
82
  * <a href="https://github.com/alan-ai/alan-sdk-ionic" target="_blank">Ionic</a>
89
83
  * <a href="https://github.com/alan-ai/alan-sdk-cordova" target="_blank">Apache Cordova</a>
90
84
  * <a href="https://github.com/alan-ai/alan-sdk-reactnative" target="_blank">React Native</a>
91
- * <a href="https://github.com/alan-ai/alan-sdk-pcf" target="_blank">Power Apps</a>
92
85
 
93
86
 
94
87
  ## Have questions?
@@ -10,6 +10,7 @@ export interface AlanButtonOptions {
10
10
  keepDialogSession?: boolean;
11
11
  showOverlayOnMicPermissionPrompt?: boolean;
12
12
  zIndex?: number;
13
+ host?: string;
13
14
  onCommand?: (commandData: object) => void;
14
15
  onEvent?: (event: object) => void;
15
16
  onButtonState?: (state: string) => void;