@webless/agent 0.6.2 → 0.6.3
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 +22 -41
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,63 +1,44 @@
|
|
|
1
1
|
# @webless/agent
|
|
2
2
|
|
|
3
|
-
Webless Agent — AI
|
|
3
|
+
Webless Agent — an AI assistant for your website, grounded in your own content. No code to write, no infrastructure to manage. Webless builds and hosts the agent for you.
|
|
4
4
|
|
|
5
|
-
## Get started
|
|
5
|
+
## Get started in 4 steps
|
|
6
6
|
|
|
7
|
-
1.
|
|
8
|
-
2. Create and publish an index
|
|
9
|
-
3. Open **Agent Studio** for that index
|
|
10
|
-
4. Build a preview bundle, then copy the **install snippet**
|
|
11
|
-
5. Paste the snippet into your site HTML
|
|
7
|
+
### 1. Create your account
|
|
12
8
|
|
|
13
|
-
|
|
9
|
+
Sign up at [app.webless.ai](https://app.webless.ai).
|
|
14
10
|
|
|
15
|
-
|
|
11
|
+
### 2. Create and publish an index
|
|
16
12
|
|
|
17
|
-
|
|
18
|
-
<script defer src="…"></script>
|
|
19
|
-
```
|
|
13
|
+
An index is the content your agent answers from. Add your sources (URLs, sitemaps, docs), then publish the index.
|
|
20
14
|
|
|
21
|
-
The exact URL is generated in the console when you build your bundle.
|
|
22
15
|
|
|
23
|
-
|
|
16
|
+
### 3. Configure your agent in Agent Studio
|
|
24
17
|
|
|
25
|
-
|
|
26
|
-
- Answers grounded in your published index
|
|
27
|
-
- Edge tab launcher (position configured in Agent Studio)
|
|
28
|
-
- Session continuity for returning visitors
|
|
29
|
-
- Page content shifts to make room for the desktop side rail (`pageShift`, default `true`)
|
|
18
|
+
Open **Agent Studio** for your index. Customize the launcher position, appearance, and behavior, then build a preview bundle.
|
|
30
19
|
|
|
31
|
-
|
|
20
|
+
### 4. Copy the install snippet
|
|
32
21
|
|
|
33
|
-
|
|
22
|
+
After building the bundle, copy the **install snippet** — a single script tag:
|
|
23
|
+
|
|
24
|
+
```html
|
|
25
|
+
<script defer src="https://tags.webless.ai/..."></script>
|
|
26
|
+
```
|
|
34
27
|
|
|
35
|
-
|
|
36
|
-
|---|---|---|
|
|
37
|
-
| `pageShift` | `true` | On desktop, apply `margin-right` to `html` when the side rail is open so page content reflows instead of sitting under the overlay. Disabled when collapsed, expanded modal, or mobile. |
|
|
28
|
+
Paste it into your site's HTML, before the closing `</body>` tag. That's the full integration.
|
|
38
29
|
|
|
39
|
-
Example:
|
|
40
30
|
|
|
41
|
-
|
|
42
|
-
{
|
|
43
|
-
"customerId": "your_customer_id",
|
|
44
|
-
"indexId": "your_index_id",
|
|
45
|
-
"runtimeOrigin": "https://runtime.webless.ai",
|
|
46
|
-
"version": "published",
|
|
47
|
-
"pageShift": true
|
|
48
|
-
}
|
|
49
|
-
```
|
|
31
|
+
## What you get
|
|
50
32
|
|
|
51
|
-
|
|
33
|
+
- A collapsible Agent panel on your site.
|
|
34
|
+
- Edge tab launcher, positioned where you configure it in Agent Studio.
|
|
35
|
+
- Session continuity for returning visitors.
|
|
36
|
+
- Page content shifts to make room for the desktop side rail.
|
|
52
37
|
|
|
53
|
-
|
|
38
|
+
## Preview before you install
|
|
54
39
|
|
|
55
|
-
|
|
40
|
+
Agent Studio generates a live preview of the agent on your pages, so you can check the look and feel before adding the snippet to your site.
|
|
56
41
|
|
|
57
42
|
## This npm package
|
|
58
43
|
|
|
59
44
|
`@webless/agent` is published for Webless tooling and internal use. It powers the script bundle served from the console install flow.
|
|
60
|
-
|
|
61
|
-
Customers integrate via the **console snippet only** — not via `@webless/agent/react` or a direct npm dependency.
|
|
62
|
-
|
|
63
|
-
If you are building on Webless internally, see the package source and `apps/agent-demo` in the [webless-sdk](https://github.com/tech-webless/webless-sdk) repo.
|