@egain/ai-agent-sdk 0.1.0 → 0.1.2
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 +23 -18
- package/dist/browser.js +1 -1
- package/dist/core/AiAgent.d.ts +2 -2
- package/dist/core/AiAgent.js +2 -2
- package/dist/core/api/CacheAdapter.d.ts +1 -1
- package/dist/core/api/CacheAdapter.js +1 -1
- package/dist/core/events/EventEmitter.d.ts +1 -1
- package/dist/core/events/EventEmitter.js +1 -1
- package/dist/core/message/BaseMessageHandler.d.ts +1 -1
- package/dist/core/message/BaseMessageHandler.js +1 -1
- package/dist/index.d.ts +10 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +10 -3
- package/dist/index.js.map +1 -1
- package/package.json +2 -1
package/dist/core/AiAgent.d.ts
CHANGED
|
@@ -410,7 +410,7 @@ export interface AgentEvents {
|
|
|
410
410
|
*
|
|
411
411
|
* @example Direct flow (typical non–Contact Center agent)
|
|
412
412
|
* ```typescript
|
|
413
|
-
* import { AiAgent } from "@
|
|
413
|
+
* import { AiAgent } from "@egain/ai-agent-sdk";
|
|
414
414
|
*
|
|
415
415
|
* const agent = new AiAgent({
|
|
416
416
|
* id: "agent-id",
|
|
@@ -447,7 +447,7 @@ export interface AgentEvents {
|
|
|
447
447
|
*
|
|
448
448
|
* @example With context
|
|
449
449
|
* ```typescript
|
|
450
|
-
* import { AiAgent, createContextMessage } from "@
|
|
450
|
+
* import { AiAgent, createContextMessage } from "@egain/ai-agent-sdk";
|
|
451
451
|
*
|
|
452
452
|
* await agent.send(createContextMessage({
|
|
453
453
|
* context: { userId: "123", accountType: "premium" },
|
package/dist/core/AiAgent.js
CHANGED
|
@@ -57,7 +57,7 @@ const PIPELINE_PROFILES_CACHE_KEY_PREFIX = 'eg_profiles_';
|
|
|
57
57
|
*
|
|
58
58
|
* @example Direct flow (typical non–Contact Center agent)
|
|
59
59
|
* ```typescript
|
|
60
|
-
* import { AiAgent } from "@
|
|
60
|
+
* import { AiAgent } from "@egain/ai-agent-sdk";
|
|
61
61
|
*
|
|
62
62
|
* const agent = new AiAgent({
|
|
63
63
|
* id: "agent-id",
|
|
@@ -94,7 +94,7 @@ const PIPELINE_PROFILES_CACHE_KEY_PREFIX = 'eg_profiles_';
|
|
|
94
94
|
*
|
|
95
95
|
* @example With context
|
|
96
96
|
* ```typescript
|
|
97
|
-
* import { AiAgent, createContextMessage } from "@
|
|
97
|
+
* import { AiAgent, createContextMessage } from "@egain/ai-agent-sdk";
|
|
98
98
|
*
|
|
99
99
|
* await agent.send(createContextMessage({
|
|
100
100
|
* context: { userId: "123", accountType: "premium" },
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
* Implement your own cache adapter for custom storage backends (Redis, IndexedDB, etc.):
|
|
53
53
|
*
|
|
54
54
|
* ```typescript
|
|
55
|
-
* import { CacheAdapter, CacheEntry } from "@
|
|
55
|
+
* import { CacheAdapter, CacheEntry } from "@egain/ai-agent-sdk";
|
|
56
56
|
*
|
|
57
57
|
* class RedisCacheAdapter implements CacheAdapter {
|
|
58
58
|
* get<T>(key: string): CacheEntry<T> | null {
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
* Implement your own cache adapter for custom storage backends (Redis, IndexedDB, etc.):
|
|
53
53
|
*
|
|
54
54
|
* ```typescript
|
|
55
|
-
* import { CacheAdapter, CacheEntry } from "@
|
|
55
|
+
* import { CacheAdapter, CacheEntry } from "@egain/ai-agent-sdk";
|
|
56
56
|
*
|
|
57
57
|
* class RedisCacheAdapter implements CacheAdapter {
|
|
58
58
|
* get<T>(key: string): CacheEntry<T> | null {
|
|
@@ -18,7 +18,7 @@ type EventMap = Record<string, any>;
|
|
|
18
18
|
*
|
|
19
19
|
* @example Creating a custom event emitter
|
|
20
20
|
* ```typescript
|
|
21
|
-
* import { EventEmitter } from "@
|
|
21
|
+
* import { EventEmitter } from "@egain/ai-agent-sdk";
|
|
22
22
|
*
|
|
23
23
|
* interface MyEvents {
|
|
24
24
|
* data: { value: number };
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
* Extend `BaseMessageHandler` to create your own:
|
|
28
28
|
*
|
|
29
29
|
* ```typescript
|
|
30
|
-
* import { BaseMessageHandler, Message, MessageHandlerResult } from "@
|
|
30
|
+
* import { BaseMessageHandler, Message, MessageHandlerResult } from "@egain/ai-agent-sdk";
|
|
31
31
|
*
|
|
32
32
|
* class CustomHandler extends BaseMessageHandler {
|
|
33
33
|
* canHandle(message: Message): boolean {
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
* Extend `BaseMessageHandler` to create your own:
|
|
28
28
|
*
|
|
29
29
|
* ```typescript
|
|
30
|
-
* import { BaseMessageHandler, Message, MessageHandlerResult } from "@
|
|
30
|
+
* import { BaseMessageHandler, Message, MessageHandlerResult } from "@egain/ai-agent-sdk";
|
|
31
31
|
*
|
|
32
32
|
* class CustomHandler extends BaseMessageHandler {
|
|
33
33
|
* canHandle(message: Message): boolean {
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* # @
|
|
2
|
+
* # @egain/ai-agent-sdk
|
|
3
3
|
*
|
|
4
4
|
* TypeScript-first SDK for eGain's AI Agent platform.
|
|
5
5
|
*
|
|
@@ -13,8 +13,15 @@
|
|
|
13
13
|
*
|
|
14
14
|
* ## Quick Start
|
|
15
15
|
*
|
|
16
|
+
* The example below uses the **pre-auth** option — your server obtains an access token and passes it to the SDK. To generate one, follow the instructions for [Generating An Access Token using PKCE Flow](https://apidev.egain.com/developer-portal/guides/authentication/pkce-flow).
|
|
17
|
+
*
|
|
18
|
+
* **Required scopes:**
|
|
19
|
+
* - `core.aiservices.read`
|
|
20
|
+
* - `knowledge.portalmgr.manage`
|
|
21
|
+
* - `core.customermgr.read` *(required for AI Agent for Customer Self Service only)*
|
|
22
|
+
*
|
|
16
23
|
* ```typescript
|
|
17
|
-
* import { AiAgent } from "@
|
|
24
|
+
* import { AiAgent } from "@egain/ai-agent-sdk";
|
|
18
25
|
*
|
|
19
26
|
* const agent = new AiAgent({
|
|
20
27
|
* id: "your-agent-id",
|
|
@@ -33,7 +40,7 @@
|
|
|
33
40
|
* ```
|
|
34
41
|
*
|
|
35
42
|
* @packageDocumentation
|
|
36
|
-
* @module @
|
|
43
|
+
* @module @egain/ai-agent-sdk
|
|
37
44
|
*/
|
|
38
45
|
import './core/polyfills.js';
|
|
39
46
|
export { AiAgent } from './core/AiAgent.js';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAIH,OAAO,qBAAqB,CAAC;AAG7B,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,YAAY,EACV,aAAa,EACb,WAAW,EACX,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,WAAW,GACZ,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAGtF,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACrG,YAAY,EAAE,wBAAwB,EAAE,MAAM,6CAA6C,CAAC;AAG5F,YAAY,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,YAAY,EAAE,YAAY,EAAE,0BAA0B,EAAE,6BAA6B,EAAE,MAAM,6BAA6B,CAAC;AAC3H,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,YAAY,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAC1G,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,YAAY,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,6BAA6B,EAAE,MAAM,8CAA8C,CAAC;AAC7F,YAAY,EAAE,2BAA2B,EAAE,MAAM,8CAA8C,CAAC;AAChG,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAG3F,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,YAAY,EACV,2BAA2B,EAC3B,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,EAC1B,qBAAqB,EACrB,oBAAoB,EACpB,kCAAkC,GACnC,MAAM,sCAAsC,CAAC;AAG9C,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAGvE,OAAO,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAC3D,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACvF,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAC;AAC7E,YAAY,EAAE,wBAAwB,EAAE,MAAM,yCAAyC,CAAC;AAGxF,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,YAAY,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAGlE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAG7D,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,YAAY,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACnG,YAAY,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAG9D,OAAO,EACL,QAAQ,EACR,SAAS,EACT,eAAe,EACf,YAAY,GACb,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,YAAY,EACV,eAAe,EACf,WAAW,EACX,wBAAwB,EACxB,wBAAwB,EACxB,uBAAuB,EACvB,uBAAuB,EACvB,4BAA4B,EAC5B,yBAAyB,EACzB,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,yBAAyB,GAC1B,MAAM,yBAAyB,CAAC;AACjC,YAAY,EAAE,gBAAgB,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC7F,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAGzG,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,gDAAgD,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,+CAA+C,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,MAAM,gDAAgD,CAAC;AACrF,YAAY,EAAE,0BAA0B,EAAE,MAAM,gDAAgD,CAAC;AACjG,OAAO,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,gDAAgD,CAAC;AACrF,OAAO,EACL,OAAO,EACP,IAAI,EACJ,WAAW,GACZ,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACV,OAAO,EACP,IAAI,EACJ,WAAW,EACX,oBAAoB,GACrB,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,qBAAqB,EACrB,kBAAkB,EAClB,+BAA+B,EAC/B,kBAAkB,GACnB,MAAM,gCAAgC,CAAC;AACxC,YAAY,EACV,oBAAoB,EACpB,uBAAuB,EACvB,qBAAqB,EACrB,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,EAClB,aAAa,GACd,MAAM,gCAAgC,CAAC;AAGxC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,YAAY,EACV,eAAe,EACf,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,8BAA8B,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* # @
|
|
2
|
+
* # @egain/ai-agent-sdk
|
|
3
3
|
*
|
|
4
4
|
* TypeScript-first SDK for eGain's AI Agent platform.
|
|
5
5
|
*
|
|
@@ -13,8 +13,15 @@
|
|
|
13
13
|
*
|
|
14
14
|
* ## Quick Start
|
|
15
15
|
*
|
|
16
|
+
* The example below uses the **pre-auth** option — your server obtains an access token and passes it to the SDK. To generate one, follow the instructions for [Generating An Access Token using PKCE Flow](https://apidev.egain.com/developer-portal/guides/authentication/pkce-flow).
|
|
17
|
+
*
|
|
18
|
+
* **Required scopes:**
|
|
19
|
+
* - `core.aiservices.read`
|
|
20
|
+
* - `knowledge.portalmgr.manage`
|
|
21
|
+
* - `core.customermgr.read` *(required for AI Agent for Customer Self Service only)*
|
|
22
|
+
*
|
|
16
23
|
* ```typescript
|
|
17
|
-
* import { AiAgent } from "@
|
|
24
|
+
* import { AiAgent } from "@egain/ai-agent-sdk";
|
|
18
25
|
*
|
|
19
26
|
* const agent = new AiAgent({
|
|
20
27
|
* id: "your-agent-id",
|
|
@@ -33,7 +40,7 @@
|
|
|
33
40
|
* ```
|
|
34
41
|
*
|
|
35
42
|
* @packageDocumentation
|
|
36
|
-
* @module @
|
|
43
|
+
* @module @egain/ai-agent-sdk
|
|
37
44
|
*/
|
|
38
45
|
// Initialize polyfills for Node.js environment (WebSocket, fetch)
|
|
39
46
|
// This must be imported first to ensure polyfills are set up before any SDK code runs
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAEH,kEAAkE;AAClE,sFAAsF;AACtF,OAAO,qBAAqB,CAAC;AAE7B,aAAa;AACb,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAkB5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAE7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAE,6BAA6B,EAAE,MAAM,8CAA8C,CAAC;AAE7F,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAGjE,wDAAwD;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAW7E,aAAa;AACb,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAE7D,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAEvE,YAAY;AACZ,OAAO,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAE3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAC;AAG7E,QAAQ;AACR,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAG5D,SAAS;AACT,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D,UAAU;AACV,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAEnG,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAE9D,SAAS;AACT,OAAO,EACL,QAAQ,EACR,SAAS,EACT,eAAe,EACf,YAAY,GACb,MAAM,2BAA2B,CAAC;AAEnC,aAAa;AACb,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAkBpD,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEzG,UAAU;AACV,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,gDAAgD,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,+CAA+C,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,MAAM,gDAAgD,CAAC;AAErF,OAAO,EAAE,gBAAgB,EAAE,MAAM,6CAA6C,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,gDAAgD,CAAC;AACrF,OAAO,EACL,OAAO,EACP,IAAI,EACJ,WAAW,GACZ,MAAM,yBAAyB,CAAC;AAQjC,uBAAuB;AACvB,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,qBAAqB,EACrB,kBAAkB,EAClB,+BAA+B,EAC/B,kBAAkB,GACnB,MAAM,gCAAgC,CAAC;AAWxC,aAAa;AACb,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@egain/ai-agent-sdk",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "TypeScript SDK for eGain's AI Agent platform",
|
|
5
|
+
"homepage": "https://egain.github.io/ai-agent-sdk",
|
|
5
6
|
"type": "module",
|
|
6
7
|
"main": "./dist/index.js",
|
|
7
8
|
"types": "./dist/index.d.ts",
|