opc-agent 1.2.1 → 1.3.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.
- package/.github/workflows/ci.yml +24 -0
- package/CONTRIBUTING.md +75 -75
- package/README.md +235 -358
- package/README.zh-CN.md +415 -415
- package/dist/channels/web.js +256 -256
- package/dist/cli.js +118 -34
- package/dist/core/knowledge.d.ts +5 -0
- package/dist/core/knowledge.js +39 -2
- package/dist/deploy/hermes.js +22 -22
- package/dist/deploy/openclaw.js +31 -40
- package/dist/index.d.ts +3 -6
- package/dist/index.js +7 -11
- package/dist/providers/index.d.ts +1 -1
- package/dist/providers/index.js +158 -14
- package/dist/schema/oad.d.ts +4 -5
- package/dist/templates/code-reviewer.d.ts +0 -8
- package/dist/templates/code-reviewer.js +5 -9
- package/dist/templates/customer-service.d.ts +0 -8
- package/dist/templates/customer-service.js +2 -6
- package/dist/templates/data-analyst.d.ts +0 -8
- package/dist/templates/data-analyst.js +5 -9
- package/dist/templates/knowledge-base.d.ts +0 -8
- package/dist/templates/knowledge-base.js +2 -6
- package/dist/templates/sales-assistant.d.ts +0 -8
- package/dist/templates/sales-assistant.js +4 -8
- package/dist/templates/teacher.d.ts +0 -8
- package/dist/templates/teacher.js +6 -10
- package/dist/traces/index.d.ts +49 -0
- package/dist/traces/index.js +102 -0
- package/docs/.vitepress/config.ts +103 -103
- package/docs/api/cli.md +48 -48
- package/docs/api/oad-schema.md +64 -64
- package/docs/api/sdk.md +80 -80
- package/docs/guide/concepts.md +51 -51
- package/docs/guide/configuration.md +79 -79
- package/docs/guide/deployment.md +42 -42
- package/docs/guide/getting-started.md +44 -44
- package/docs/guide/templates.md +28 -28
- package/docs/guide/testing.md +84 -84
- package/docs/index.md +27 -27
- package/docs/zh/api/cli.md +54 -54
- package/docs/zh/api/oad-schema.md +87 -87
- package/docs/zh/api/sdk.md +102 -102
- package/docs/zh/guide/concepts.md +104 -104
- package/docs/zh/guide/configuration.md +135 -135
- package/docs/zh/guide/deployment.md +81 -81
- package/docs/zh/guide/getting-started.md +82 -82
- package/docs/zh/guide/templates.md +84 -84
- package/docs/zh/guide/testing.md +88 -88
- package/docs/zh/index.md +27 -27
- package/examples/customer-service-demo/README.md +90 -90
- package/examples/customer-service-demo/oad.yaml +107 -107
- package/package.json +1 -1
- package/src/analytics/index.ts +66 -66
- package/src/channels/discord.ts +192 -192
- package/src/channels/email.ts +177 -177
- package/src/channels/feishu.ts +236 -236
- package/src/channels/index.ts +15 -15
- package/src/channels/slack.ts +160 -160
- package/src/channels/telegram.ts +90 -90
- package/src/channels/voice.ts +106 -106
- package/src/channels/webhook.ts +199 -199
- package/src/channels/websocket.ts +87 -87
- package/src/channels/wechat.ts +149 -149
- package/src/cli.ts +124 -32
- package/src/core/a2a.ts +143 -143
- package/src/core/agent.ts +152 -152
- package/src/core/analytics-engine.ts +186 -186
- package/src/core/auth.ts +57 -57
- package/src/core/cache.ts +141 -141
- package/src/core/compose.ts +77 -77
- package/src/core/config.ts +14 -14
- package/src/core/errors.ts +148 -148
- package/src/core/hitl.ts +138 -138
- package/src/core/logger.ts +57 -57
- package/src/core/orchestrator.ts +215 -215
- package/src/core/performance.ts +187 -187
- package/src/core/rate-limiter.ts +128 -128
- package/src/core/room.ts +109 -109
- package/src/core/runtime.ts +152 -152
- package/src/core/sandbox.ts +101 -101
- package/src/core/security.ts +171 -171
- package/src/core/types.ts +68 -68
- package/src/core/versioning.ts +106 -106
- package/src/core/watch.ts +178 -178
- package/src/core/workflow.ts +235 -235
- package/src/deploy/hermes.ts +156 -156
- package/src/deploy/openclaw.ts +190 -200
- package/src/i18n/index.ts +216 -216
- package/src/index.ts +5 -6
- package/src/memory/deepbrain.ts +108 -108
- package/src/memory/index.ts +34 -34
- package/src/plugins/index.ts +208 -208
- package/src/schema/oad.ts +154 -155
- package/src/skills/base.ts +16 -16
- package/src/skills/document.ts +100 -100
- package/src/skills/http.ts +35 -35
- package/src/skills/index.ts +27 -27
- package/src/skills/scheduler.ts +80 -80
- package/src/skills/webhook-trigger.ts +59 -59
- package/src/templates/code-reviewer.ts +30 -34
- package/src/templates/customer-service.ts +76 -80
- package/src/templates/data-analyst.ts +66 -70
- package/src/templates/executive-assistant.ts +71 -71
- package/src/templates/financial-advisor.ts +60 -60
- package/src/templates/knowledge-base.ts +27 -31
- package/src/templates/legal-assistant.ts +71 -71
- package/src/templates/sales-assistant.ts +75 -79
- package/src/templates/teacher.ts +75 -79
- package/src/testing/index.ts +181 -181
- package/src/tools/calculator.ts +73 -73
- package/src/tools/datetime.ts +149 -149
- package/src/tools/json-transform.ts +187 -187
- package/src/tools/mcp.ts +76 -76
- package/src/tools/text-analysis.ts +116 -116
- package/src/traces/index.ts +132 -0
- package/templates/Dockerfile +15 -15
- package/templates/code-reviewer/README.md +27 -27
- package/templates/code-reviewer/oad.yaml +41 -41
- package/templates/customer-service/README.md +22 -22
- package/templates/customer-service/oad.yaml +36 -36
- package/templates/docker-compose.yml +21 -21
- package/templates/ecommerce-assistant/README.md +45 -45
- package/templates/ecommerce-assistant/oad.yaml +47 -47
- package/templates/knowledge-base/README.md +28 -28
- package/templates/knowledge-base/oad.yaml +38 -38
- package/templates/sales-assistant/README.md +26 -26
- package/templates/sales-assistant/oad.yaml +43 -43
- package/templates/tech-support/README.md +43 -43
- package/templates/tech-support/oad.yaml +45 -45
- package/tests/a2a.test.ts +66 -66
- package/tests/agent.test.ts +72 -72
- package/tests/analytics.test.ts +50 -50
- package/tests/channel.test.ts +39 -39
- package/tests/e2e.test.ts +134 -134
- package/tests/errors.test.ts +83 -83
- package/tests/hitl.test.ts +71 -71
- package/tests/i18n.test.ts +41 -41
- package/tests/mcp.test.ts +54 -54
- package/tests/oad.test.ts +68 -68
- package/tests/performance.test.ts +115 -115
- package/tests/plugin.test.ts +74 -74
- package/tests/room.test.ts +106 -106
- package/tests/runtime.test.ts +42 -42
- package/tests/sandbox.test.ts +46 -46
- package/tests/security.test.ts +60 -60
- package/tests/templates.test.ts +77 -77
- package/tests/v070.test.ts +76 -76
- package/tests/versioning.test.ts +75 -75
- package/tests/voice.test.ts +61 -61
- package/tests/webhook.test.ts +29 -29
- package/tests/workflow.test.ts +143 -143
- package/tsconfig.json +19 -19
- package/vitest.config.ts +9 -9
- package/src/dtv/data.ts +0 -29
- package/src/dtv/trust.ts +0 -43
- package/src/dtv/value.ts +0 -47
- package/src/marketplace/index.ts +0 -223
|
@@ -1,90 +1,90 @@
|
|
|
1
|
-
# ShopBot — Customer Service Demo
|
|
2
|
-
|
|
3
|
-
A complete e-commerce customer service agent built with OPC Agent, deployable to OpenClaw.
|
|
4
|
-
|
|
5
|
-
## What's Inside
|
|
6
|
-
|
|
7
|
-
- `oad.yaml` — Full agent definition with product FAQ, order tracking, complaint handling
|
|
8
|
-
- Rich system prompt with personality, escalation rules, and response templates
|
|
9
|
-
- Telegram + Web channel configuration
|
|
10
|
-
|
|
11
|
-
## Quick Start
|
|
12
|
-
|
|
13
|
-
### 1. Install OPC Agent
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
npm install -g opc-agent
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
### 2. Validate the Agent
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
cd examples/customer-service-demo
|
|
23
|
-
opc info
|
|
24
|
-
opc build
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
### 3. Deploy to OpenClaw
|
|
28
|
-
|
|
29
|
-
**Option A: Generate workspace files**
|
|
30
|
-
```bash
|
|
31
|
-
opc deploy --target openclaw --output ./shopbot-workspace
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
This creates a complete OpenClaw agent workspace with:
|
|
35
|
-
- `IDENTITY.md` — Agent identity
|
|
36
|
-
- `SOUL.md` — System prompt and model config
|
|
37
|
-
- `AGENTS.md` — Skills, memory, and trust config
|
|
38
|
-
- `USER.md` — User preferences template
|
|
39
|
-
- `MEMORY.md` — Persistent memory template
|
|
40
|
-
|
|
41
|
-
**Option B: Deploy and auto-register**
|
|
42
|
-
```bash
|
|
43
|
-
opc deploy --target openclaw --install
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
This generates the workspace AND registers the agent in `~/.openclaw/openclaw.json`.
|
|
47
|
-
|
|
48
|
-
### 4. Restart OpenClaw
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
openclaw gateway restart
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
### 5. Test in Telegram
|
|
55
|
-
|
|
56
|
-
Send a message to your OpenClaw Telegram bot. ShopBot will respond!
|
|
57
|
-
|
|
58
|
-
Try these:
|
|
59
|
-
- "What headphones do you sell?"
|
|
60
|
-
- "Track my order TS-123456"
|
|
61
|
-
- "I want to return my laptop stand"
|
|
62
|
-
- "This is unacceptable, I want to speak to a manager"
|
|
63
|
-
|
|
64
|
-
## Architecture
|
|
65
|
-
|
|
66
|
-
```
|
|
67
|
-
OPC Agent (Development) OpenClaw (Runtime)
|
|
68
|
-
┌─────────────────────┐ ┌──────────────────────┐
|
|
69
|
-
│ oad.yaml │ │ IDENTITY.md │
|
|
70
|
-
│ (agent definition) │──deploy─│ SOUL.md │
|
|
71
|
-
│ │ │ AGENTS.md │
|
|
72
|
-
│ opc build/test │ │ USER.md │
|
|
73
|
-
│ opc deploy │ │ MEMORY.md │
|
|
74
|
-
└─────────────────────┘ │ │
|
|
75
|
-
│ ← Telegram/Web → │
|
|
76
|
-
└──────────────────────┘
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
OPC Agent is the **development framework**. OpenClaw is the **runtime**.
|
|
80
|
-
|
|
81
|
-
## Customization
|
|
82
|
-
|
|
83
|
-
Edit `oad.yaml` to:
|
|
84
|
-
- Change the product catalog
|
|
85
|
-
- Adjust escalation rules
|
|
86
|
-
- Add new skills
|
|
87
|
-
- Switch LLM provider/model
|
|
88
|
-
- Modify the system prompt personality
|
|
89
|
-
|
|
90
|
-
Then re-deploy: `opc deploy --target openclaw --install`
|
|
1
|
+
# ShopBot — Customer Service Demo
|
|
2
|
+
|
|
3
|
+
A complete e-commerce customer service agent built with OPC Agent, deployable to OpenClaw.
|
|
4
|
+
|
|
5
|
+
## What's Inside
|
|
6
|
+
|
|
7
|
+
- `oad.yaml` — Full agent definition with product FAQ, order tracking, complaint handling
|
|
8
|
+
- Rich system prompt with personality, escalation rules, and response templates
|
|
9
|
+
- Telegram + Web channel configuration
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
### 1. Install OPC Agent
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install -g opc-agent
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### 2. Validate the Agent
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
cd examples/customer-service-demo
|
|
23
|
+
opc info
|
|
24
|
+
opc build
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### 3. Deploy to OpenClaw
|
|
28
|
+
|
|
29
|
+
**Option A: Generate workspace files**
|
|
30
|
+
```bash
|
|
31
|
+
opc deploy --target openclaw --output ./shopbot-workspace
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
This creates a complete OpenClaw agent workspace with:
|
|
35
|
+
- `IDENTITY.md` — Agent identity
|
|
36
|
+
- `SOUL.md` — System prompt and model config
|
|
37
|
+
- `AGENTS.md` — Skills, memory, and trust config
|
|
38
|
+
- `USER.md` — User preferences template
|
|
39
|
+
- `MEMORY.md` — Persistent memory template
|
|
40
|
+
|
|
41
|
+
**Option B: Deploy and auto-register**
|
|
42
|
+
```bash
|
|
43
|
+
opc deploy --target openclaw --install
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
This generates the workspace AND registers the agent in `~/.openclaw/openclaw.json`.
|
|
47
|
+
|
|
48
|
+
### 4. Restart OpenClaw
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
openclaw gateway restart
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### 5. Test in Telegram
|
|
55
|
+
|
|
56
|
+
Send a message to your OpenClaw Telegram bot. ShopBot will respond!
|
|
57
|
+
|
|
58
|
+
Try these:
|
|
59
|
+
- "What headphones do you sell?"
|
|
60
|
+
- "Track my order TS-123456"
|
|
61
|
+
- "I want to return my laptop stand"
|
|
62
|
+
- "This is unacceptable, I want to speak to a manager"
|
|
63
|
+
|
|
64
|
+
## Architecture
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
OPC Agent (Development) OpenClaw (Runtime)
|
|
68
|
+
┌─────────────────────┐ ┌──────────────────────┐
|
|
69
|
+
│ oad.yaml │ │ IDENTITY.md │
|
|
70
|
+
│ (agent definition) │──deploy─│ SOUL.md │
|
|
71
|
+
│ │ │ AGENTS.md │
|
|
72
|
+
│ opc build/test │ │ USER.md │
|
|
73
|
+
│ opc deploy │ │ MEMORY.md │
|
|
74
|
+
└─────────────────────┘ │ │
|
|
75
|
+
│ ← Telegram/Web → │
|
|
76
|
+
└──────────────────────┘
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
OPC Agent is the **development framework**. OpenClaw is the **runtime**.
|
|
80
|
+
|
|
81
|
+
## Customization
|
|
82
|
+
|
|
83
|
+
Edit `oad.yaml` to:
|
|
84
|
+
- Change the product catalog
|
|
85
|
+
- Adjust escalation rules
|
|
86
|
+
- Add new skills
|
|
87
|
+
- Switch LLM provider/model
|
|
88
|
+
- Modify the system prompt personality
|
|
89
|
+
|
|
90
|
+
Then re-deploy: `opc deploy --target openclaw --install`
|
|
@@ -1,107 +1,107 @@
|
|
|
1
|
-
apiVersion: opc/v1
|
|
2
|
-
kind: Agent
|
|
3
|
-
metadata:
|
|
4
|
-
name: ShopBot
|
|
5
|
-
version: "1.0.0"
|
|
6
|
-
description: "E-commerce customer service agent for TechStyle — handles product FAQs, order tracking, returns, and complaint escalation"
|
|
7
|
-
author: "TechStyle Inc."
|
|
8
|
-
license: Apache-2.0
|
|
9
|
-
marketplace:
|
|
10
|
-
category: customer-service
|
|
11
|
-
pricing: free
|
|
12
|
-
tags: [ecommerce, support, faq, orders]
|
|
13
|
-
|
|
14
|
-
spec:
|
|
15
|
-
provider:
|
|
16
|
-
default: deepseek
|
|
17
|
-
allowed: [openai, deepseek, qwen]
|
|
18
|
-
model: deepseek-chat
|
|
19
|
-
|
|
20
|
-
systemPrompt: |
|
|
21
|
-
You are ShopBot, the friendly and professional customer service agent for TechStyle,
|
|
22
|
-
an online electronics and lifestyle store.
|
|
23
|
-
|
|
24
|
-
## Personality
|
|
25
|
-
- Warm, helpful, and patient
|
|
26
|
-
- Professional but not robotic — use a conversational tone
|
|
27
|
-
- Proactive: anticipate follow-up questions
|
|
28
|
-
- Empathetic: acknowledge customer frustration before solving problems
|
|
29
|
-
|
|
30
|
-
## Core Capabilities
|
|
31
|
-
1. **Product FAQ**: Answer questions about products, specs, pricing, availability
|
|
32
|
-
2. **Order Tracking**: Look up order status by order ID (format: TS-XXXXXX)
|
|
33
|
-
3. **Returns & Refunds**: Guide customers through return process (30-day policy)
|
|
34
|
-
4. **Complaint Handling**: De-escalate issues, offer solutions, escalate when needed
|
|
35
|
-
|
|
36
|
-
## Escalation Rules
|
|
37
|
-
- Escalate to human agent if:
|
|
38
|
-
- Customer asks 3+ times about the same unresolved issue
|
|
39
|
-
- Customer explicitly requests a human
|
|
40
|
-
- Issue involves billing disputes over $100
|
|
41
|
-
- Customer uses abusive language (remain calm, offer to transfer)
|
|
42
|
-
- Say: "Let me connect you with a specialist who can help further."
|
|
43
|
-
|
|
44
|
-
## Response Guidelines
|
|
45
|
-
- Keep responses under 200 words unless detailed explanation is needed
|
|
46
|
-
- Always confirm understanding: "Just to make sure I understand..."
|
|
47
|
-
- End with a follow-up: "Is there anything else I can help with?"
|
|
48
|
-
- For order lookups, ask for order ID if not provided
|
|
49
|
-
- Never make up order status — if you can't find it, say so
|
|
50
|
-
|
|
51
|
-
## Product Catalog (Quick Reference)
|
|
52
|
-
- TechStyle Pro Headphones — $149, wireless, ANC, 30hr battery
|
|
53
|
-
- TechStyle Slim Laptop Stand — $59, aluminum, adjustable
|
|
54
|
-
- TechStyle Power Bank 20K — $39, 20000mAh, USB-C PD
|
|
55
|
-
- TechStyle Smart Watch S3 — $199, health tracking, 5-day battery
|
|
56
|
-
- TechStyle Webcam 4K — $89, autofocus, built-in mic
|
|
57
|
-
|
|
58
|
-
## Return Policy
|
|
59
|
-
- 30-day return window from delivery date
|
|
60
|
-
- Item must be in original packaging
|
|
61
|
-
- Free return shipping for defective items
|
|
62
|
-
- Refund processed within 5-7 business days
|
|
63
|
-
- Gift cards and sale items are final sale
|
|
64
|
-
|
|
65
|
-
skills:
|
|
66
|
-
- name: product-faq
|
|
67
|
-
description: "Answer product questions from the catalog knowledge base"
|
|
68
|
-
config:
|
|
69
|
-
source: catalog
|
|
70
|
-
fallback: "I don't have that info right now. Let me check with the team."
|
|
71
|
-
|
|
72
|
-
- name: order-lookup
|
|
73
|
-
description: "Look up order status by order ID"
|
|
74
|
-
config:
|
|
75
|
-
idPattern: "TS-\\d{6}"
|
|
76
|
-
notFoundMessage: "I couldn't find that order. Double-check the ID (format: TS-XXXXXX)."
|
|
77
|
-
|
|
78
|
-
- name: complaint-handler
|
|
79
|
-
description: "Handle complaints with empathy and escalation logic"
|
|
80
|
-
config:
|
|
81
|
-
maxAttempts: 3
|
|
82
|
-
escalationMessage: "Let me connect you with a specialist who can help further."
|
|
83
|
-
|
|
84
|
-
channels:
|
|
85
|
-
- type: telegram
|
|
86
|
-
config:
|
|
87
|
-
welcomeMessage: "Hi! 👋 I'm ShopBot from TechStyle. How can I help you today?"
|
|
88
|
-
- type: web
|
|
89
|
-
port: 3000
|
|
90
|
-
|
|
91
|
-
memory:
|
|
92
|
-
shortTerm: true
|
|
93
|
-
longTerm: false
|
|
94
|
-
|
|
95
|
-
dtv:
|
|
96
|
-
trust:
|
|
97
|
-
level: verified
|
|
98
|
-
value:
|
|
99
|
-
metrics:
|
|
100
|
-
- response_time
|
|
101
|
-
- resolution_rate
|
|
102
|
-
- customer_satisfaction
|
|
103
|
-
|
|
104
|
-
streaming:
|
|
105
|
-
enabled: true
|
|
106
|
-
|
|
107
|
-
locale: en
|
|
1
|
+
apiVersion: opc/v1
|
|
2
|
+
kind: Agent
|
|
3
|
+
metadata:
|
|
4
|
+
name: ShopBot
|
|
5
|
+
version: "1.0.0"
|
|
6
|
+
description: "E-commerce customer service agent for TechStyle — handles product FAQs, order tracking, returns, and complaint escalation"
|
|
7
|
+
author: "TechStyle Inc."
|
|
8
|
+
license: Apache-2.0
|
|
9
|
+
marketplace:
|
|
10
|
+
category: customer-service
|
|
11
|
+
pricing: free
|
|
12
|
+
tags: [ecommerce, support, faq, orders]
|
|
13
|
+
|
|
14
|
+
spec:
|
|
15
|
+
provider:
|
|
16
|
+
default: deepseek
|
|
17
|
+
allowed: [openai, deepseek, qwen]
|
|
18
|
+
model: deepseek-chat
|
|
19
|
+
|
|
20
|
+
systemPrompt: |
|
|
21
|
+
You are ShopBot, the friendly and professional customer service agent for TechStyle,
|
|
22
|
+
an online electronics and lifestyle store.
|
|
23
|
+
|
|
24
|
+
## Personality
|
|
25
|
+
- Warm, helpful, and patient
|
|
26
|
+
- Professional but not robotic — use a conversational tone
|
|
27
|
+
- Proactive: anticipate follow-up questions
|
|
28
|
+
- Empathetic: acknowledge customer frustration before solving problems
|
|
29
|
+
|
|
30
|
+
## Core Capabilities
|
|
31
|
+
1. **Product FAQ**: Answer questions about products, specs, pricing, availability
|
|
32
|
+
2. **Order Tracking**: Look up order status by order ID (format: TS-XXXXXX)
|
|
33
|
+
3. **Returns & Refunds**: Guide customers through return process (30-day policy)
|
|
34
|
+
4. **Complaint Handling**: De-escalate issues, offer solutions, escalate when needed
|
|
35
|
+
|
|
36
|
+
## Escalation Rules
|
|
37
|
+
- Escalate to human agent if:
|
|
38
|
+
- Customer asks 3+ times about the same unresolved issue
|
|
39
|
+
- Customer explicitly requests a human
|
|
40
|
+
- Issue involves billing disputes over $100
|
|
41
|
+
- Customer uses abusive language (remain calm, offer to transfer)
|
|
42
|
+
- Say: "Let me connect you with a specialist who can help further."
|
|
43
|
+
|
|
44
|
+
## Response Guidelines
|
|
45
|
+
- Keep responses under 200 words unless detailed explanation is needed
|
|
46
|
+
- Always confirm understanding: "Just to make sure I understand..."
|
|
47
|
+
- End with a follow-up: "Is there anything else I can help with?"
|
|
48
|
+
- For order lookups, ask for order ID if not provided
|
|
49
|
+
- Never make up order status — if you can't find it, say so
|
|
50
|
+
|
|
51
|
+
## Product Catalog (Quick Reference)
|
|
52
|
+
- TechStyle Pro Headphones — $149, wireless, ANC, 30hr battery
|
|
53
|
+
- TechStyle Slim Laptop Stand — $59, aluminum, adjustable
|
|
54
|
+
- TechStyle Power Bank 20K — $39, 20000mAh, USB-C PD
|
|
55
|
+
- TechStyle Smart Watch S3 — $199, health tracking, 5-day battery
|
|
56
|
+
- TechStyle Webcam 4K — $89, autofocus, built-in mic
|
|
57
|
+
|
|
58
|
+
## Return Policy
|
|
59
|
+
- 30-day return window from delivery date
|
|
60
|
+
- Item must be in original packaging
|
|
61
|
+
- Free return shipping for defective items
|
|
62
|
+
- Refund processed within 5-7 business days
|
|
63
|
+
- Gift cards and sale items are final sale
|
|
64
|
+
|
|
65
|
+
skills:
|
|
66
|
+
- name: product-faq
|
|
67
|
+
description: "Answer product questions from the catalog knowledge base"
|
|
68
|
+
config:
|
|
69
|
+
source: catalog
|
|
70
|
+
fallback: "I don't have that info right now. Let me check with the team."
|
|
71
|
+
|
|
72
|
+
- name: order-lookup
|
|
73
|
+
description: "Look up order status by order ID"
|
|
74
|
+
config:
|
|
75
|
+
idPattern: "TS-\\d{6}"
|
|
76
|
+
notFoundMessage: "I couldn't find that order. Double-check the ID (format: TS-XXXXXX)."
|
|
77
|
+
|
|
78
|
+
- name: complaint-handler
|
|
79
|
+
description: "Handle complaints with empathy and escalation logic"
|
|
80
|
+
config:
|
|
81
|
+
maxAttempts: 3
|
|
82
|
+
escalationMessage: "Let me connect you with a specialist who can help further."
|
|
83
|
+
|
|
84
|
+
channels:
|
|
85
|
+
- type: telegram
|
|
86
|
+
config:
|
|
87
|
+
welcomeMessage: "Hi! 👋 I'm ShopBot from TechStyle. How can I help you today?"
|
|
88
|
+
- type: web
|
|
89
|
+
port: 3000
|
|
90
|
+
|
|
91
|
+
memory:
|
|
92
|
+
shortTerm: true
|
|
93
|
+
longTerm: false
|
|
94
|
+
|
|
95
|
+
dtv:
|
|
96
|
+
trust:
|
|
97
|
+
level: verified
|
|
98
|
+
value:
|
|
99
|
+
metrics:
|
|
100
|
+
- response_time
|
|
101
|
+
- resolution_rate
|
|
102
|
+
- customer_satisfaction
|
|
103
|
+
|
|
104
|
+
streaming:
|
|
105
|
+
enabled: true
|
|
106
|
+
|
|
107
|
+
locale: en
|
package/package.json
CHANGED
package/src/analytics/index.ts
CHANGED
|
@@ -1,66 +1,66 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Agent Analytics — track messages, response times, skill usage, errors, tokens.
|
|
3
|
-
*/
|
|
4
|
-
export interface AnalyticsSnapshot {
|
|
5
|
-
messagesProcessed: number;
|
|
6
|
-
avgResponseTimeMs: number;
|
|
7
|
-
skillUsage: Record<string, number>;
|
|
8
|
-
errorCount: number;
|
|
9
|
-
tokenUsage: { input: number; output: number; total: number };
|
|
10
|
-
uptime: number;
|
|
11
|
-
startedAt: number;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
export class Analytics {
|
|
15
|
-
private messagesProcessed = 0;
|
|
16
|
-
private totalResponseTimeMs = 0;
|
|
17
|
-
private skillUsage: Record<string, number> = {};
|
|
18
|
-
private errorCount = 0;
|
|
19
|
-
private tokenUsage = { input: 0, output: 0 };
|
|
20
|
-
private startedAt = Date.now();
|
|
21
|
-
|
|
22
|
-
recordMessage(responseTimeMs: number): void {
|
|
23
|
-
this.messagesProcessed++;
|
|
24
|
-
this.totalResponseTimeMs += responseTimeMs;
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
recordSkillUsage(skillName: string): void {
|
|
28
|
-
this.skillUsage[skillName] = (this.skillUsage[skillName] ?? 0) + 1;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
recordError(): void {
|
|
32
|
-
this.errorCount++;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
recordTokens(input: number, output: number): void {
|
|
36
|
-
this.tokenUsage.input += input;
|
|
37
|
-
this.tokenUsage.output += output;
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
getSnapshot(): AnalyticsSnapshot {
|
|
41
|
-
return {
|
|
42
|
-
messagesProcessed: this.messagesProcessed,
|
|
43
|
-
avgResponseTimeMs: this.messagesProcessed > 0
|
|
44
|
-
? Math.round(this.totalResponseTimeMs / this.messagesProcessed)
|
|
45
|
-
: 0,
|
|
46
|
-
skillUsage: { ...this.skillUsage },
|
|
47
|
-
errorCount: this.errorCount,
|
|
48
|
-
tokenUsage: {
|
|
49
|
-
input: this.tokenUsage.input,
|
|
50
|
-
output: this.tokenUsage.output,
|
|
51
|
-
total: this.tokenUsage.input + this.tokenUsage.output,
|
|
52
|
-
},
|
|
53
|
-
uptime: Date.now() - this.startedAt,
|
|
54
|
-
startedAt: this.startedAt,
|
|
55
|
-
};
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
reset(): void {
|
|
59
|
-
this.messagesProcessed = 0;
|
|
60
|
-
this.totalResponseTimeMs = 0;
|
|
61
|
-
this.skillUsage = {};
|
|
62
|
-
this.errorCount = 0;
|
|
63
|
-
this.tokenUsage = { input: 0, output: 0 };
|
|
64
|
-
this.startedAt = Date.now();
|
|
65
|
-
}
|
|
66
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Agent Analytics — track messages, response times, skill usage, errors, tokens.
|
|
3
|
+
*/
|
|
4
|
+
export interface AnalyticsSnapshot {
|
|
5
|
+
messagesProcessed: number;
|
|
6
|
+
avgResponseTimeMs: number;
|
|
7
|
+
skillUsage: Record<string, number>;
|
|
8
|
+
errorCount: number;
|
|
9
|
+
tokenUsage: { input: number; output: number; total: number };
|
|
10
|
+
uptime: number;
|
|
11
|
+
startedAt: number;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export class Analytics {
|
|
15
|
+
private messagesProcessed = 0;
|
|
16
|
+
private totalResponseTimeMs = 0;
|
|
17
|
+
private skillUsage: Record<string, number> = {};
|
|
18
|
+
private errorCount = 0;
|
|
19
|
+
private tokenUsage = { input: 0, output: 0 };
|
|
20
|
+
private startedAt = Date.now();
|
|
21
|
+
|
|
22
|
+
recordMessage(responseTimeMs: number): void {
|
|
23
|
+
this.messagesProcessed++;
|
|
24
|
+
this.totalResponseTimeMs += responseTimeMs;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
recordSkillUsage(skillName: string): void {
|
|
28
|
+
this.skillUsage[skillName] = (this.skillUsage[skillName] ?? 0) + 1;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
recordError(): void {
|
|
32
|
+
this.errorCount++;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
recordTokens(input: number, output: number): void {
|
|
36
|
+
this.tokenUsage.input += input;
|
|
37
|
+
this.tokenUsage.output += output;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
getSnapshot(): AnalyticsSnapshot {
|
|
41
|
+
return {
|
|
42
|
+
messagesProcessed: this.messagesProcessed,
|
|
43
|
+
avgResponseTimeMs: this.messagesProcessed > 0
|
|
44
|
+
? Math.round(this.totalResponseTimeMs / this.messagesProcessed)
|
|
45
|
+
: 0,
|
|
46
|
+
skillUsage: { ...this.skillUsage },
|
|
47
|
+
errorCount: this.errorCount,
|
|
48
|
+
tokenUsage: {
|
|
49
|
+
input: this.tokenUsage.input,
|
|
50
|
+
output: this.tokenUsage.output,
|
|
51
|
+
total: this.tokenUsage.input + this.tokenUsage.output,
|
|
52
|
+
},
|
|
53
|
+
uptime: Date.now() - this.startedAt,
|
|
54
|
+
startedAt: this.startedAt,
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
reset(): void {
|
|
59
|
+
this.messagesProcessed = 0;
|
|
60
|
+
this.totalResponseTimeMs = 0;
|
|
61
|
+
this.skillUsage = {};
|
|
62
|
+
this.errorCount = 0;
|
|
63
|
+
this.tokenUsage = { input: 0, output: 0 };
|
|
64
|
+
this.startedAt = Date.now();
|
|
65
|
+
}
|
|
66
|
+
}
|