@tencent-ai/agent-sdk 0.0.9 → 0.0.11

package/README.md

@@ -9,242 +9,4 @@
 - **所有的组件注册都必须在获取组件（容器中的任何一个组件）之前完成，否则注册无效。**
 - **此模块的所有功能都依赖于配置模块 `Product`， 因此在使用时，必须先通过 `registerProductProvider` 去提供配置，才可以正常使用。**
 
-### Product
-
-#### 注册 `ProductProvider`
-
-```ts
-import * as genie from '@tencent-ai/agent-sdk';
-
-class Component {
-    // ...
-
-    async init() {
-        await genie.Product.registerProductProvider(CustomProductProvider);
-        logger.info('hello world');
-    }
-    // ...
-}
-
-class CustomProductProvider implements genie.ProductProvider {
-    async provide(){
-        return {
-            endpoint: 'your endpoint'
-            // ...
-        }
-    }
-}
-```
-
-#### 获取配置管理组件
-
-```ts
-import { Product } from '@tencent-ai/agent-sdk';
-
-class Component {
-    // ...
-
-    async init() {
-        const productConfiguration = await Product.waitConfiguration();
-        const logger = await Services.getLogger();
-        logger.info(productConfiguration)
-    }
-    // ...
-}
-```
-
-### Http Request
-
-在整个模块中会共用同一个 `axios` 实例用于 http 请求。
-
-```ts
-import { Http } from '@tencent-ai/agent-sdk';
-
-class Component {
-    // ...
-
-    async init() {
-        const restOperations = await Http.getInstance();
-        restOperations.get('path', {});
-    }
-    // ...
-} 
-```
-
-如果需要注册拦截器，方法与 `axios` 一致。
-
-```ts
-import { Http } from '@tencent-ai/agent-sdk';
-
-class Component {
-    // ...
-
-    async init() {
-        const restOperations = await  Http.getInstance();
-        restOperations.interceptors.request.use(async config => {
-            if (!config.headers) {
-                config.headers = {};
-            }
-            config.headers['X-User-ID'] = 'user-id'
-            return config;
-        });
-    }
-    // ...
-} 
-```
-
-### Agent
-
-```ts
-import { Agent } from '@tencent-ai/agent-sdk';
-
-class Component {
-    // ...
-
-    async init() {
-        await Agent.dispatch('craft', {
-            // ... context
-        })
-    }
-    // ...
-} 
-```
-
-#### dispatch agent
-
-### Logger
-
-```ts
-import { Logger } from '@tencent-ai/agent-sdk';
-
-class Component {
-    // ...
-
-    async init() {
-        const logger = await Logger.getLogger();
-        logger.info('hello world');
-    }
-    // ...
-} 
-```
-
-这里默认输出到 `console` 控制台，如果需要自定义输出，可以通过 `registerLogger` 注册自定义的 logger。
-
-```ts
-import { Logger, ILogger } from '@tencent-ai/agent-sdk';
-
-class Component {
-    // ...
-    async init() {
-        await Logger.registerLogger(CustomLogger);
-        const logger = await Logger.getLogger();
-        logger.info('hello world');
-    }
-
-    // ...
-} 
-
-class CustomLogger implements ILogger{
-    // ...
-    info(){
-        // do something
-    }
-    // ...
-}
-```
-
-### Tracing
-
-#### 初始化和使用
-
-```ts
-import { Tracing } from '@tencent-ai/agent-sdk';
-
-class Component {
-    // ...
-
-    async init() {
-        await Tracing.init({serviceName: 'Your-Service-Name'});
-        const trace = traceService.startTrace('login');
-        trace.markAsSuccessful();
-    }
-    // ...
-} 
-```
-
-#### 注册公共信息到 sources
-
-sourcesProvider 提供的信息会作为公共数据绑定到每一个 trace 链路中
-
-```ts
-import { Tracing, TracingResourcesProvider } from '@tencent-ai/agent-sdk';
-
-class Component {
-    // ...
-
-    async init() {
-        await Tracing.registerResourcesProvider(CustomResourcesProvider);
-        await Tracing.init({serviceName: 'Your-Service-Name'});
-        const trace = traceService.startTrace('login');
-        trace.markAsSuccessful();
-    }
-    // ...
-} 
-
-class CustomResourcesProvider implements TracingResourcesProvider {
-    async provide() {
-        return {
-            username: '123',
-            userId: '456'
-        }
-    }
-}
-```
-
-### 事件上报
-
-#### 使用
-
-```ts
-import { Event } from '@tencent-ai/agent-sdk';
-
-class Component {
-    // ...
-
-    async init() {
-        Event.report('your-event-name', { payload: 1 })
-    }
-    // ...
-} 
-```
-
-#### 处理事件公共字段
-
-模块内部会自动收集操作系统相关的信息，作为公共字段。
-如果还需要携带如用户信息，编辑器信息等，需要通过注册处理器实现。
-
-```ts
-import { Event, EventProcessor } from '@tencent-ai/agent-sdk';
-
-class Component {
-    // ...
-
-    async init() {
-        await Event.registerEventProcessor(UserInfoEventProcessor);
-        Event.report('your-event-name', { payload: 1 })
-    }
-    // ...
-} 
-
-class UserInfoEventProcessor implements EventProcessor {
-    async process({
-        code: string;
-        event: EventPayload;
-    }) {
-        // 这样子所有的事件上报的时候都会带上以下用户信息字段
-        event.username = '张三'；
-        event.userId = '123';
-        event.userNickname = '李四'
-    }
-}
-```
+[示例](https://cnb.cool/carmeloren/agent-sdk-sample)