@tencent-ai/agent-sdk 0.0.1 → 0.0.2

package/README.md

@@ -14,19 +14,19 @@
 #### 注册 `ProductProvider`
 
 ```ts
-import { Services } from '@tencent-ai/agent-sdk';
+import * as genie from '@tencent-ai/agent-sdk';
 
 class Component {
     // ...
 
     async init() {
-        await Services.registerProductProvider(CustomProductProvider);
+        await genie.Product.registerProductProvider(CustomProductProvider);
         logger.info('hello world');
     }
     // ...
 }
 
-class CustomProductProvider {
+class CustomProductProvider implements genie.ProductProvider {
     async provide(){
         return {
             endpoint: 'your endpoint'
@@ -39,14 +39,13 @@ class CustomProductProvider {
 #### 获取配置管理组件
 
 ```ts
-import { Services } from '@tencent-ai/agent-sdk';
+import { Product } from '@tencent-ai/agent-sdk';
 
 class Component {
     // ...
 
     async init() {
-        const productManager = await Services.getProductManager();
-        const productConfiguration = await productManager.waitConfiguration();
+        const productConfiguration = await Product.waitConfiguration();
         const logger = await Services.getLogger();
         logger.info(productConfiguration)
     }
@@ -59,13 +58,13 @@ class Component {
 在整个模块中会共用同一个 `axios` 实例用于 http 请求。
 
 ```ts
-import { Services } from '@tencent-ai/agent-sdk';
+import { Http } from '@tencent-ai/agent-sdk';
 
 class Component {
     // ...
 
     async init() {
-        const restOperations = await Services.getRestOperations();
+        const restOperations = await Http.getInstance();
         restOperations.get('path', {});
     }
     // ...
@@ -75,13 +74,13 @@ class Component {
 如果需要注册拦截器，方法与 `axios` 一致。
 
 ```ts
-import { Services } from '@tencent-ai/agent-sdk';
+import { Http } from '@tencent-ai/agent-sdk';
 
 class Component {
     // ...
 
     async init() {
-        const restOperations = await Services.getRestOperations();
+        const restOperations = await  Http.getInstance();
         restOperations.interceptors.request.use(async config => {
             if (!config.headers) {
                 config.headers = {};
@@ -94,16 +93,35 @@ class Component {
 } 
 ```
 
+### Agent
+
+```ts
+import { Agent } from '@tencent-ai/agent-sdk';
+
+class Component {
+    // ...
+
+    async init() {
+        await Agent.dispatch('craft', {
+            // ... context
+        })
+    }
+    // ...
+} 
+```
+
+#### dispatch agent
+
 ### Logger
 
 ```ts
-import { Services } from '@tencent-ai/agent-sdk';
+import { Logger } from '@tencent-ai/agent-sdk';
 
 class Component {
     // ...
 
     async init() {
-        const logger = await Services.getLogger();
+        const logger = await Logger.getLogger();
         logger.info('hello world');
     }
     // ...
@@ -113,20 +131,20 @@ class Component {
 这里默认输出到 `console` 控制台，如果需要自定义输出，可以通过 `registerLogger` 注册自定义的 logger。
 
 ```ts
-import { Services } from '@tencent-ai/agent-sdk';
+import { Logger, ILogger } from '@tencent-ai/agent-sdk';
 
 class Component {
     // ...
     async init() {
-        await Services.registerLogger(CustomLogger);
-        const logger = await Services.getLogger();
+        await Logger.registerLogger(CustomLogger);
+        const logger = await Logger.getLogger();
         logger.info('hello world');
     }
 
     // ...
 } 
 
-class CustomLogger {
+class CustomLogger implements ILogger{
     // ...
     info(){
         // do something
@@ -140,14 +158,13 @@ class CustomLogger {
 #### 初始化和使用
 
 ```ts
-import { Services } from '@tencent-ai/agent-sdk';
+import { Tracing } from '@tencent-ai/agent-sdk';
 
 class Component {
     // ...
 
     async init() {
-        const traceService = await Services.getTraceService();
-        await traceService.init({serviceName: 'Your-Service-Name'});
+        await Tracing.init({serviceName: 'Your-Service-Name'});
         const trace = traceService.startTrace('login');
         trace.markAsSuccessful();
     }
@@ -160,22 +177,21 @@ class Component {
 sourcesProvider 提供的信息会作为公共数据绑定到每一个 trace 链路中
 
 ```ts
-import { Services } from '@tencent-ai/agent-sdk';
+import { Tracing, TracingResourcesProvider } from '@tencent-ai/agent-sdk';
 
 class Component {
     // ...
 
     async init() {
-        await Services.registerResourcesProvider(CustomSourcesProvider);
-        const traceService = await Services.getTraceService();
-        await traceService.init({serviceName: 'Your-Service-Name'});
+        await Tracing.registerResourcesProvider(CustomResourcesProvider);
+        await Tracing.init({serviceName: 'Your-Service-Name'});
         const trace = traceService.startTrace('login');
         trace.markAsSuccessful();
     }
     // ...
 } 
 
-class CustomSourcesProvider {
+class CustomResourcesProvider implements TracingResourcesProvider {
     async provide() {
         return {
             username: '123',
@@ -190,14 +206,13 @@ class CustomSourcesProvider {
 #### 使用
 
 ```ts
-import { Services } from '@tencent-ai/agent-sdk';
+import { Event } from '@tencent-ai/agent-sdk';
 
 class Component {
     // ...
 
     async init() {
-        const eventService = await Services.getEventService();
-        eventService.Event('your-event-name', { payload: 1 })
+        Event.report('your-event-name', { payload: 1 })
     }
     // ...
 } 
@@ -209,20 +224,19 @@ class Component {
 如果还需要携带如用户信息，编辑器信息等，需要通过注册处理器实现。
 
 ```ts
-import { Services } from '@tencent-ai/agent-sdk';
+import { Event, EventProcessor } from '@tencent-ai/agent-sdk';
 
 class Component {
     // ...
 
     async init() {
-        await Services.registerEventProcessor(UserInfoEventProcessor);
-        const eventService = await Services.getEventService();
-        eventService.Event('your-event-name', { payload: 1 })
+        await Event.registerEventProcessor(UserInfoEventProcessor);
+        Event.report('your-event-name', { payload: 1 })
     }
     // ...
 } 
 
-class UserInfoEventProcessor {
+class UserInfoEventProcessor implements EventProcessor {
     async process({
         code: string;
         event: EventPayload;