{"_id":"@ag-kit/adapter-adp","name":"@ag-kit/adapter-adp","dist-tags":{"alpha":"1.0.1-alpha.8","latest":"1.0.1-alpha.8"},"versions":{"1.0.1-alpha.8":{"name":"@ag-kit/adapter-adp","version":"1.0.1-alpha.8","description":"ADP adapter for AG-Kit agents","publishConfig":{"access":"public"},"main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","exports":{".":{"import":{"types":"./dist/index.d.mts","default":"./dist/index.mjs"},"require":{"types":"./dist/index.d.ts","default":"./dist/index.js"}}},"keywords":["ag-kit","adp","adapter","agent"],"author":"","license":"ISC","devDependencies":{"@types/node":"^20.0.0","tsup":"^8.5.0","typescript":"^5.0.0"},"dependencies":{"@cloudbase/agent-agents":"0.0.12","@ag-ui/client":"0.0.42","axios":"^1.13.2","cos-nodejs-sdk-v5":"^2.15.4","rxjs":"^7.8.1","tencentcloud-sdk-nodejs-lke":"^4.1.169","zod":"^3.25.0 || ^4.0.0"},"peerDependencies":{"@cloudbase/agent-agents":"0.0.12","zod":"^3.25.0 || ^4.0.0"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsup --config tsup.config.ts"},"_id":"@ag-kit/adapter-adp@1.0.1-alpha.8","_integrity":"sha512-bd1l50YA0O+NHu/m3x/SM92chz3lqDN4fKRgTjAlPTBgZQPwuKXxm2X2MAVbz0903J+9x6TSs+4ZFGWcwAcYkA==","_resolved":"/tmp/7e63c629b75a597f49d806a40de45cfa/ag-kit-adapter-adp-1.0.1-alpha.8.tgz","_from":"file:ag-kit-adapter-adp-1.0.1-alpha.8.tgz","_nodeVersion":"20.18.1","_npmVersion":"10.8.2","dist":{"integrity":"sha512-bd1l50YA0O+NHu/m3x/SM92chz3lqDN4fKRgTjAlPTBgZQPwuKXxm2X2MAVbz0903J+9x6TSs+4ZFGWcwAcYkA==","shasum":"8e28d20adaaaec3768554881bd02c9fc059c6a68","tarball":"https://registry.npmjs.org/@ag-kit/adapter-adp/-/adapter-adp-1.0.1-alpha.8.tgz","fileCount":9,"unpackedSize":129670,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIAxfM7RPrH2TBrhzbXHoKJXSOdJv7y/SVIE1aGe2Aw/jAiEAzscq/haWWKUAvJ3Co0xpvv3tPvJuR2IpXriJ5bGUA3Q="}]},"_npmUser":{"name":"binggg","email":"being99@qq.com"},"directories":{},"maintainers":[{"name":"areo-joe","email":"zengjoe@foxmail.com"},{"name":"binggg","email":"being99@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/adapter-adp_1.0.1-alpha.8_1769135491479_0.02610902291903683"},"_hasShrinkwrap":false}},"time":{"created":"2026-01-23T02:31:31.358Z","1.0.1-alpha.8":"2026-01-23T02:31:31.694Z","modified":"2026-01-23T02:31:31.991Z"},"maintainers":[{"name":"areo-joe","email":"zengjoe@foxmail.com"},{"name":"binggg","email":"being99@qq.com"}],"description":"ADP adapter for AG-Kit agents","keywords":["ag-kit","adp","adapter","agent"],"license":"ISC","readme":"# @ag-kit/adapter-adp\n\nTencent Cloud ADP (Agent Development Platform) adapter for AG-Kit agents. This package provides integration between AG-Kit and Tencent Cloud's LKE (Large Knowledge Engine) service, enabling you to use ADP chatbots with AG-Kit's agent infrastructure.\n\n## Installation\n\n```bash\nnpm install @ag-kit/agents @ag-kit/adapter-adp\n```\n\n## Features\n\n- **AdpAgent**: Agent implementation that connects to Tencent Cloud ADP chatbot services\n- **Streaming Support**: Real-time SSE (Server-Sent Events) streaming responses\n- **Thinking Events**: Support for thinking/reasoning process events from the model\n- **Workflow Integration**: Support for ADP workflows with tool call events\n- **Custom Variables**: Pass custom parameters to workflows and knowledge base\n\n## Environment Variables\n\nConfigure the following environment variables:\n\n```bash\nADP_APP_KEY=your-adp-app-key  # ADP application key, required if not passed in config when creating the agent\nTENCENTCLOUD_SECRETID=your-tencent-cloud-secret-id\nTENCENTCLOUD_SECRETKEY=your-tencent-cloud-secret-key\nTENCENTCLOUD_SESSIONTOKEN=your-tencent-cloud-session-token  # Optional, for temporary credentials\n```\n\n## Usage\n\n### Basic Agent Setup\n\n```typescript\nimport { AdpAgent } from \"@ag-kit/adapter-adp\";\n\n// Create the agent\nconst agent = new AdpAgent({\n  name: \"my-adp-agent\",\n  description: \"A Tencent Cloud ADP chatbot agent\",\n  adpConfig: {\n    appKey: process.env.ADP_APP_KEY, // Optional if set in env\n  },\n});\n```\n\n### With Credentials in Config\n\n```typescript\nimport { AdpAgent } from \"@ag-kit/adapter-adp\";\n\nconst agent = new AdpAgent({\n  name: \"my-adp-agent\",\n  description: \"An ADP agent with inline credentials\",\n  adpConfig: {\n    appKey: \"your-app-key\", // Optional if ADP_APP_KEY env is set\n    credential: {\n      secretId: \"your-secret-id\", // Optional if TENCENTCLOUD_SECRETID env is set\n      secretKey: \"your-secret-key\", // Optional if TENCENTCLOUD_SECRETKEY env is set\n      token: \"your-session-token\", // Optional if TENCENTCLOUD_SESSIONTOKEN env is set\n    },\n  },\n});\n```\n\n### With Custom Request Options\n\n```typescript\nimport { AdpAgent } from \"@ag-kit/adapter-adp\";\n\nconst agent = new AdpAgent({\n  name: \"my-adp-agent\",\n  description: \"An ADP agent with custom config\",\n  adpConfig: {\n    appKey: \"your-app-key\",\n    request: {\n      baseUrl: \"https://wss.lke.cloud.tencent.com\", // Custom base URL (leave empty for default value)\n      endpoint: \"/v1/qbot/chat/sse\", // Custom endpoint (leave empty for default value)\n      body: {\n        modelName: \"gpt-4\", // Specify model\n        searchNetwork: \"enable\", // Enable web search\n        workflowStatus: \"enable\", // Enable workflows\n        systemRole: \"You are a helpful assistant\", // Custom system prompt\n      },\n    },\n  },\n});\n```\n\n### Running the Agent\n\n```typescript\nimport { randomUUID } from \"crypto\";\n\nconst runId = randomUUID();\nconst threadId = randomUUID();\n\nconst observable = agent.run({\n  runId,\n  threadId,\n  messages: [\n    {\n      id: randomUUID(),\n      role: \"user\",\n      content: \"Hello, how can you help me?\",\n    },\n  ],\n  forwardedProps: {\n    // Request body options\n    visitorBizId: \"user-123\", // Visitor (User) ID\n    customVariables: {\n      key1: \"value1\",\n    },\n  },\n});\n\nobservable.subscribe({\n  next: (event) => console.log(event),\n  complete: () => console.log(\"Done\"),\n  error: (err) => console.error(err),\n});\n```\n\n## API Reference\n\n### AdpAgent\n\nAgent class that extends `AbstractAgent` and connects to Tencent Cloud ADP services.\n\n**Constructor:**\n\n```typescript\nconstructor(config: AgentConfig & { adpConfig: AdpConfig })\n```\n\n### AdpConfig\n\nConfiguration options for the ADP adapter.\n\n```typescript\ninterface AdpConfig {\n  appKey?: string; // ADP application key (optional if ADP_APP_KEY env is set)\n  credential?: {\n    secretId?: string; // Tencent Cloud secret ID (optional if TENCENTCLOUD_SECRETID env is set)\n    secretKey?: string; // Tencent Cloud secret key (optional if TENCENTCLOUD_SECRETKEY env is set)\n    token?: string; // Session token (optional if TENCENTCLOUD_SESSIONTOKEN env is set)\n  };\n  historyCount?: number; // Number of history messages to retrieve (reserved)\n  request?: {\n    baseUrl?: string; // Base URL for ADP API (default: https://wss.lke.cloud.tencent.com)\n    endpoint?: string; // API endpoint (default: /v1/qbot/chat/sse)\n    body?: Partial<AdpChatRequest>; // Additional request body options\n  };\n}\n```\n\n### AdpChatRequest Options\n\nFor further information, please check the [ADP product documentation](https://cloud.tencent.com/document/product/1759/105561#ba7e0c00-8616-468c-8734-6cc13b4c51af).\n\n```typescript\ninterface AdpChatRequest {\n  streamingThrottle?: number; // Stream reply frequency control\n  customVariables?: Record<string, string>; // Custom parameters for workflows\n  systemRole?: string; // Role instructions (prompt)\n  incremental?: boolean; // Whether to output content incrementally\n  searchNetwork?: \"\" | \"enable\" | \"disable\"; // Web search toggle\n  modelName?: string; // Specify model name\n  stream?: \"\" | \"enable\" | \"disable\"; // Streaming toggle\n  workflowStatus?: \"\" | \"enable\" | \"disable\"; // Workflow toggle\n}\n```\n\n### Supported Events\n\nThe adapter emits the following AG-UI events:\n\n- `RUN_STARTED` / `RUN_FINISHED` / `RUN_ERROR` - Run lifecycle events\n- `TEXT_MESSAGE_CHUNK` (`TEXT_MESSAGE_START` / `TEXT_MESSAGE_CONTENT` / `TEXT_MESSAGE_END`) - Streaming text response chunks\n- `THINKING_START` / `THINKING_END` - Thinking process boundaries\n- `THINKING_TEXT_MESSAGE_START` / `THINKING_TEXT_MESSAGE_CONTENT` / `THINKING_TEXT_MESSAGE_END` - Thinking content events\n- `TOOL_CALL_START` / `TOOL_CALL_ARGS` / `TOOL_CALL_END` / `TOOL_CALL_RESULT` - Workflow tool call events\n\n## Requirements\n\n- `@ag-ui/client`: AG-UI client protocol\n- `axios`: HTTP client for API requests\n- `rxjs`: Reactive extensions for JavaScript\n- `tencentcloud-sdk-nodejs-lke`: Tencent Cloud LKE SDK\n\n## Related Resources\n\n- [AG-Kit Documentation](https://docs.agkit.dev)\n- [Tencent Cloud ADP Documentation](https://cloud.tencent.com/document/product/1759)\n- [AG-Kit Examples](https://github.com/AgiClass/AG-Kit/tree/main/typescript-sdk/packages/examples)\n","readmeFilename":"README.md","_rev":"1-2eb55da780552911892be3cb6bb94e77"}