@osirus/agent 1.0.1 → 1.1.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.
Files changed (4) hide show
  1. package/README.md +14 -14
  2. package/dist/umd/osirusai.min.js +1 -1
  3. package/dist/umd/osirusai.min.js.map +1 -1
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -13,15 +13,15 @@ To easily install Osirus AI using NPM, follow these steps:
13
13
  3. Execute the following command:
14
14
 
15
15
  ```bash
16
- npm i @osirus/bot
16
+ npm i @osirus/agent
17
17
  ```
18
18
 
19
- Once you've successfully installed the package, you can initialize your bot by adding the following code to your JavaScript file:
19
+ Once you've successfully installed the package, you can initialize your agent by adding the following code to your JavaScript file:
20
20
 
21
21
  ```Javascript
22
- import OsirusBot from '@osirus/bot';
22
+ import OsirusAgent from '@osirus/agent';
23
23
 
24
- OsirusBot.init(options)
24
+ OsirusAgent.init(options)
25
25
  ```
26
26
 
27
27
  #### CDN Installation
@@ -31,22 +31,22 @@ You can easily set up the widget by adding the following script just before the
31
31
  ```html
32
32
  <script src="https://bot.osirus.ai/lib/umd/osirusai.min.js" type="text/javascript"></script>
33
33
  <script type="text/javascript">
34
- OsirusBot.init(options);
34
+ OsirusAgent.init(options);
35
35
  </script>
36
36
  ```
37
37
 
38
38
  ## Configure your widget
39
- You have two options for initializing the widget. You can either configure it by providing all the necessary settings as a JavaScript object, or you can simply sign up at [https://osirus.ai](https://osirus.ai) and create a bot on the platform. Then, specify the `botId` in your configuration.
39
+ You have two options for initializing the widget. You can either configure it by providing all the necessary settings as a JavaScript object, or you can simply sign up at [https://osirus.ai](https://osirus.ai) and create a agent on the platform. Then, specify the `agentId` in your configuration.
40
40
 
41
41
  The latter method is highly recommended because it allows you to make real-time updates to your widget without requiring any changes to your code.
42
42
 
43
43
  #### App set up
44
- If you choose to create your bot on [https://osirus.ai](https://osirus.ai), you can initialize the bot using the following method:
44
+ If you choose to create your agent on [https://osirus.ai](https://osirus.ai), you can initialize the agent using the following method:
45
45
 
46
46
  ```Javascript
47
- OsirusBot.init({
47
+ OsirusAgent.init({
48
48
  // ideally, you can store your ID in an environment file for easy access, like: `process.env.OSIRUS_BOT_ID`
49
- botId: string,
49
+ agentId: string,
50
50
  })
51
51
  ```
52
52
 
@@ -55,7 +55,7 @@ OsirusBot.init({
55
55
  Below, you will find an example of how to initialize the widget and all the available [configuration options](#osirus-options):
56
56
 
57
57
  ```Javascript
58
- OsirusBot.init({
58
+ OsirusAgent.init({
59
59
  name: string,
60
60
  companyName: string,
61
61
  companyIconUrl: string,
@@ -95,11 +95,11 @@ OsirusBot.init({
95
95
 
96
96
  | Property | Type | <div style="width:260px">Description</div> | Example |
97
97
  |-------------------|----------------------------------|-------------------------------------------------------------------------|--------------------------------|
98
- | name | string | Required. A bot name will appear at the top of the widget and will be a unique identifier if it is registered on the platform in the future. | "OsirusBot" |
99
- | companyName | string | Optional. The company name will replace your bot name in the UI. | "Osirus" |
100
- | companyIconUrl | string | Optional. Your company logo will appear in the widget header. | "https://bot.osirus.ai/images/Osirus-Icon.svg" |
98
+ | name | string | Required. A agent name will appear at the top of the widget and will be a unique identifier if it is registered on the platform in the future. | "OsirusAgent" |
99
+ | companyName | string | Optional. The company name will replace your agent name in the UI. | "Osirus" |
100
+ | companyIconUrl | string | Optional. Your company logo will appear in the widget header. | "https://agent.osirus.ai/images/Osirus-Icon.svg" |
101
101
  | customColor | string | Optional. You can provide a hex color to customize the widget buttons. | "#006FE5" |
102
- | description | string | Optional. Your company description will appear in the widget header. | "Osirus AI is an easy-to-use JavaScript plugin for embedding a customizable chatbot on your app or website, powered by AWS." |
102
+ | description | string | Optional. Your company description will appear in the widget header. | "Osirus AI is an easy-to-use JavaScript plugin for embedding a customizable chatagent on your app or website, powered by AWS." |
103
103
  | phoneNumber | string | Optional. This will activate the call button. | "123-456-7890" |
104
104
  | email | string | Optional. This will activate a `mailto` button that opens the user's default email client. | "info@osirus.ai" |
105
105
  | docUrl | string | Optional. This value will activate a button and will open a window to view your docs in the same page. | "https://osirus.ai/docs" |