@cloudbase/agent-adapter-adp 1.0.0 → 1.0.1-alpha.11

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @cloudbase/agent-adapter-adp
 
+## 1.0.1-alpha.8
+
+### Patch Changes
+
+- alpha release 0.1.2-alpha.1
+  - Update all public packages to version 0.1.2-alpha.1
+  - Trigger automated alpha release workflow
+  - Includes latest features and improvements
+
+## 1.0.1-alpha.7
+
+### Patch Changes
+
+- alpha release 0.1.2-alpha.1
+  - Update all public packages to version 0.1.2-alpha.1
+  - Trigger automated alpha release workflow
+  - Includes latest features and improvements
+
 ## 1.0.1-alpha.6
 
 ### Features

package/README.md

@@ -12,8 +12,8 @@ npm install @cloudbase/agent-agents @cloudbase/agent-adapter-adp
 
 - **AdpAgent**: Agent implementation that connects to Tencent Cloud ADP chatbot services
 - **Streaming Support**: Real-time SSE (Server-Sent Events) streaming responses
+- **Thinking Events**: Support for thinking/reasoning process events from the model
 - **Workflow Integration**: Support for ADP workflows with tool call events
-- **Document Parsing**: Built-in document extraction support (PDF, Word, PPT, TXT)
 - **Custom Variables**: Pass custom parameters to workflows and knowledge base
 
 ## Environment Variables
@@ -21,9 +21,10 @@ npm install @cloudbase/agent-agents @cloudbase/agent-adapter-adp
 Configure the following environment variables:
 
 ```bash
-ADP_APP_KEY=your-adp-app-key
-CAPI_SECRET_ID=your-tencent-cloud-secret-id
-CAPI_SECRET_KEY=your-tencent-cloud-secret-key
+ADP_APP_KEY=your-adp-app-key  # ADP application key, required if not passed in config when creating the agent
+TENCENTCLOUD_SECRETID=your-tencent-cloud-secret-id
+TENCENTCLOUD_SECRETKEY=your-tencent-cloud-secret-key
+TENCENTCLOUD_SESSIONTOKEN=your-tencent-cloud-session-token  # Optional, for temporary credentials
 ```
 
 ## Usage
@@ -39,7 +40,6 @@ const agent = new AdpAgent({
   description: "A Tencent Cloud ADP chatbot agent",
   adpConfig: {
     appKey: process.env.ADP_APP_KEY, // Optional if set in env
-    historyCount: 30, // Number of history messages to retrieve
   },
 });
 ```
@@ -54,16 +54,17 @@ const agent = new AdpAgent({
   description: "An ADP agent with inline credentials",
   adpConfig: {
     appKey: "your-app-key", // Optional if ADP_APP_KEY env is set
-    secretId: "your-secret-id", // Optional if CAPI_SECRET_ID env is set
-    secretKey: "your-secret-key", // Optional if CAPI_SECRET_KEY env is set
+    credential: {
+      secretId: "your-secret-id", // Optional if TENCENTCLOUD_SECRETID env is set
+      secretKey: "your-secret-key", // Optional if TENCENTCLOUD_SECRETKEY env is set
+      token: "your-session-token", // Optional if TENCENTCLOUD_SESSIONTOKEN env is set
+    },
   },
 });
 ```
 
 ### With Custom Request Options
 
-For further information, please check the [official documentation](https://cloud.tencent.com/document/product/1759/105561#ba7e0c00-8616-468c-8734-6cc13b4c51af).
-
 ```typescript
 import { AdpAgent } from "@cloudbase/agent-adapter-adp";
 
@@ -73,11 +74,14 @@ const agent = new AdpAgent({
   adpConfig: {
     appKey: "your-app-key",
     request: {
-      modelName: "gpt-4", // Specify model
-      searchNetwork: "enable", // Enable web search
-      workflowStatus: "enable", // Enable workflows
-      systemRole: "You are a helpful assistant", // Custom system prompt
-      ...otherConfigs,
+      baseUrl: "https://wss.lke.cloud.tencent.com", // Custom base URL (leave empty for default value)
+      endpoint: "/v1/qbot/chat/sse", // Custom endpoint (leave empty for default value)
+      body: {
+        modelName: "gpt-4", // Specify model
+        searchNetwork: "enable", // Enable web search
+        workflowStatus: "enable", // Enable workflows
+        systemRole: "You are a helpful assistant", // Custom system prompt
+      },
     },
   },
 });
@@ -102,7 +106,8 @@ const observable = agent.run({
     },
   ],
   forwardedProps: {
-    userId: "user-123",
+    // Request body options
+    visitorBizId: "user-123", // Visitor (User) ID
     customVariables: {
       key1: "value1",
     },
@@ -135,20 +140,30 @@ Configuration options for the ADP adapter.
 ```typescript
 interface AdpConfig {
   appKey?: string; // ADP application key (optional if ADP_APP_KEY env is set)
-  secretId?: string; // Tencent Cloud secret ID (optional if CAPI_SECRET_ID env is set)
-  secretKey?: string; // Tencent Cloud secret key (optional if CAPI_SECRET_KEY env is set)
-  historyCount?: number; // Number of history messages to retrieve
-  request?: Partial<AdpChatRequest>; // Additional request options
+  credential?: {
+    secretId?: string; // Tencent Cloud secret ID (optional if TENCENTCLOUD_SECRETID env is set)
+    secretKey?: string; // Tencent Cloud secret key (optional if TENCENTCLOUD_SECRETKEY env is set)
+    token?: string; // Session token (optional if TENCENTCLOUD_SESSIONTOKEN env is set)
+  };
+  historyCount?: number; // Number of history messages to retrieve (reserved)
+  request?: {
+    baseUrl?: string; // Base URL for ADP API (default: https://wss.lke.cloud.tencent.com)
+    endpoint?: string; // API endpoint (default: /v1/qbot/chat/sse)
+    body?: Partial<AdpChatRequest>; // Additional request body options
+  };
 }
 ```
 
 ### AdpChatRequest Options
 
+For further information, please check the [ADP product documentation](https://cloud.tencent.com/document/product/1759/105561#ba7e0c00-8616-468c-8734-6cc13b4c51af).
+
 ```typescript
 interface AdpChatRequest {
   streamingThrottle?: number; // Stream reply frequency control
   customVariables?: Record<string, string>; // Custom parameters for workflows
   systemRole?: string; // Role instructions (prompt)
+  incremental?: boolean; // Whether to output content incrementally
   searchNetwork?: "" | "enable" | "disable"; // Web search toggle
   modelName?: string; // Specify model name
   stream?: "" | "enable" | "disable"; // Streaming toggle
@@ -156,23 +171,22 @@ interface AdpChatRequest {
 }
 ```
 
-## Supported File Types
+### Supported Events
 
-The adapter supports document extraction for:
+The adapter emits the following AG-UI events:
 
-- Text files (`.txt`)
-- Microsoft Word (`.doc`, `.docx`)
-- PDF documents (`.pdf`)
-- Microsoft PowerPoint (`.ppt`, `.pptx`)
+- `RUN_STARTED` / `RUN_FINISHED` / `RUN_ERROR` - Run lifecycle events
+- `TEXT_MESSAGE_CHUNK` (`TEXT_MESSAGE_START` / `TEXT_MESSAGE_CONTENT` / `TEXT_MESSAGE_END`) - Streaming text response chunks
+- `THINKING_START` / `THINKING_END` - Thinking process boundaries
+- `THINKING_TEXT_MESSAGE_START` / `THINKING_TEXT_MESSAGE_CONTENT` / `THINKING_TEXT_MESSAGE_END` - Thinking content events
+- `TOOL_CALL_START` / `TOOL_CALL_ARGS` / `TOOL_CALL_END` / `TOOL_CALL_RESULT` - Workflow tool call events
 
 ## Requirements
 
-- `@cloudbase/agent-agents`: Core agent functionality
 - `@ag-ui/client`: AG-UI client protocol
 - `axios`: HTTP client for API requests
 - `rxjs`: Reactive extensions for JavaScript
 - `tencentcloud-sdk-nodejs-lke`: Tencent Cloud LKE SDK
-- `cos-nodejs-sdk-v5`: Tencent Cloud Object Storage SDK
 
 ## Related Resources
 

package/dist/index.d.mts

@@ -54,7 +54,11 @@ interface AdpChatRequest {
     [key: string]: any;
 }
 type AdpConfig = {
-    request?: Partial<AdpChatRequest>;
+    request?: {
+        baseUrl?: string;
+        endpoint?: string;
+        body?: Partial<AdpChatRequest>;
+    };
     historyCount?: number;
     appKey?: string;
     credential?: {
@@ -63,14 +67,202 @@ type AdpConfig = {
         token?: string;
     };
 };
+type AdpChunk = {
+    type: "reply";
+    payload: ReplyEvent;
+    message_id: string;
+} | {
+    type: "thought";
+    payload: ThoughtEvent;
+    message_id: string;
+} | {
+    type: "token_stat";
+    payload: TokenStatEvent;
+    message_id: string;
+} | {
+    type: "reference";
+    payload: ReferenceEvent;
+    message_id: string;
+} | {
+    type: "error";
+    error: ErrorInfo;
+};
+interface ReplyEvent {
+    request_id: string;
+    content: string;
+    file_infos: FileInfo[];
+    record_id: string;
+    related_record_id: string;
+    session_id: string;
+    is_from_self: boolean;
+    can_rating: boolean;
+    timestamp: number;
+    is_final: boolean;
+    is_evil: boolean;
+    is_llm_generated: boolean;
+    reply_method: ReplyMethod;
+    knowledge?: Knowledge[];
+    option_cards?: string[];
+    custom_params?: string[];
+    task_flow?: TaskFlow;
+    work_flow?: WorkFlow;
+    quote_infos?: QuoteInfo[];
+}
+declare enum ReplyMethod {
+    LLM_REPLY = 1,
+    UNKNOWN_QUESTION_REPLY = 2,
+    REJECT_QUESTION_REPLY = 3,
+    SENSITIVE_REPLY = 4,
+    ADOPTED_QA_PRIORITY_REPLY = 5,
+    WELCOME_REPLY = 6,
+    CONCURRENCY_LIMIT_REPLY = 7,
+    GLOBAL_INTERVENTION_KNOWLEDGE = 8,
+    TASK_FLOW_REPLY = 9,
+    TASK_FLOW_ANSWER = 10,
+    SEARCH_ENGINE_REPLY = 11,
+    KNOWLEDGE_POLISHED_REPLY = 12,
+    IMAGE_UNDERSTANDING_REPLY = 13,
+    REALTIME_DOCUMENT_REPLY = 14,
+    CLARIFICATION_CONFIRMATION_REPLY = 15,
+    WORKFLOW_REPLY = 16,
+    WORKFLOW_EXECUTION_END = 17,
+    AGENT_REPLY = 18,
+    MULTI_INTENT_REPLY = 19
+}
+interface Knowledge {
+    id: string;
+    type: number;
+    seg_id?: string;
+}
+interface TaskFlow {
+    task_flow_name: string;
+    task_flow_id: string;
+    query_rewrite: string;
+    hit_intent: string;
+    slot_info: Record<string, any>;
+    api_response: Record<string, any>;
+    type: number;
+}
+interface WorkFlow {
+    workflow_name: string;
+    workflow_id: string;
+    workflow_run_id: string;
+    option_cards: string[];
+    current_node: CurrentNode;
+    outputs: Array<string>;
+}
+declare enum CurrentNodeStatus {
+    Pending = 0,
+    Running = 1,
+    Succeeded = 2,
+    Failed = 3
+}
+interface CurrentNode {
+    NodeID: string;
+    NodeType: number;
+    NodeName: string;
+    Status: CurrentNodeStatus;
+    Input: string;
+    Output: string;
+    TaskOutput: string;
+    FailMessage: string;
+    CostMilliSeconds: string;
+    Reply: string;
+    BelongNodeID: string;
+    StatisticInfo: StatisticInfo;
+}
+interface StatisticInfo {
+    ModelName: string;
+    FirstTokenCost: number;
+    TotalCost: number;
+    InputTokens: number;
+    OutputTokens: number;
+    TotalTokens: number;
+}
+interface QuoteInfo {
+    index: number;
+    position: number;
+}
+interface TokenStatEvent {
+    session_id: string;
+    request_id: string;
+    record_id: string;
+    status_summary: "processing" | "success" | "failed";
+    status_summary_title: string;
+    elapsed: number;
+    token_count: number;
+    procedures: TokenStatProcedure[];
+}
+interface TokenStatProcedure {
+    name: string;
+    title: string;
+    status: "processing" | "success" | "failed";
+    input_count: number;
+    output_count: number;
+    count: number;
+}
+interface ReferenceEvent {
+    record_id: string;
+    references: Reference[];
+}
+interface Reference {
+    id: string | number;
+    type: number;
+    url?: string;
+    name: string;
+    doc_id: number;
+    doc_biz_id: number;
+    doc_name: string;
+    qa_biz_id: string;
+}
+interface ErrorInfo {
+    code: number;
+    message: string;
+}
+interface ThoughtEvent {
+    elapsed: number;
+    is_workflow: boolean;
+    procedures: ThoughtProcedure[];
+    record_id: string;
+    request_id: string;
+    session_id: string;
+    trace_id: string;
+    workflow_name: string;
+}
+interface ThoughtProcedure {
+    debugging: Debugging;
+    index: number;
+    name: string;
+    title: string;
+    status: "processing" | "success" | "failed";
+    icon: string;
+    switch: string;
+    workflow_name: string;
+    plugin_type: number;
+    elapsed: number;
+}
+interface Debugging {
+    content: string;
+}
 
+declare class AdpAgentError extends Error {
+    code?: string;
+    constructor(message: string, code?: string);
+}
 declare class AdpAgent extends AbstractAgent {
-    private adpConfig;
     private reqAppClient;
     private reqLkeClient;
+    protected adpConfig: AdpConfig;
     constructor(config: AgentConfig & {
         adpConfig: AdpConfig;
     });
+    generateRequestBody({ message, fileInfos, runId, threadId, forwardedProps, }: {
+        message: string;
+        fileInfos: FileInfo[];
+        runId: string;
+        threadId: string;
+        forwardedProps: Record<string, string>;
+    }): AdpChatRequest;
     run(input: RunAgentInput): Observable<{
         type: EventType;
         timestamp?: number | undefined;
@@ -79,4 +271,4 @@ declare class AdpAgent extends AbstractAgent {
     private _run;
 }
 
-export { AdpAgent };
+export { AdpAgent, AdpAgentError, type AdpChatRequest, type AdpChunk, type AdpConfig, type CurrentNode, CurrentNodeStatus, type Debugging, type ErrorInfo, type FileInfo, type Knowledge, type QuoteInfo, type Reference, type ReferenceEvent, type ReplyEvent, ReplyMethod, type StatisticInfo, type TaskFlow, type ThoughtEvent, type ThoughtProcedure, type TokenStatEvent, type TokenStatProcedure, type WorkFlow };

package/dist/index.d.ts

@@ -54,7 +54,11 @@ interface AdpChatRequest {
     [key: string]: any;
 }
 type AdpConfig = {
-    request?: Partial<AdpChatRequest>;
+    request?: {
+        baseUrl?: string;
+        endpoint?: string;
+        body?: Partial<AdpChatRequest>;
+    };
     historyCount?: number;
     appKey?: string;
     credential?: {
@@ -63,14 +67,202 @@ type AdpConfig = {
         token?: string;
     };
 };
+type AdpChunk = {
+    type: "reply";
+    payload: ReplyEvent;
+    message_id: string;
+} | {
+    type: "thought";
+    payload: ThoughtEvent;
+    message_id: string;
+} | {
+    type: "token_stat";
+    payload: TokenStatEvent;
+    message_id: string;
+} | {
+    type: "reference";
+    payload: ReferenceEvent;
+    message_id: string;
+} | {
+    type: "error";
+    error: ErrorInfo;
+};
+interface ReplyEvent {
+    request_id: string;
+    content: string;
+    file_infos: FileInfo[];
+    record_id: string;
+    related_record_id: string;
+    session_id: string;
+    is_from_self: boolean;
+    can_rating: boolean;
+    timestamp: number;
+    is_final: boolean;
+    is_evil: boolean;
+    is_llm_generated: boolean;
+    reply_method: ReplyMethod;
+    knowledge?: Knowledge[];
+    option_cards?: string[];
+    custom_params?: string[];
+    task_flow?: TaskFlow;
+    work_flow?: WorkFlow;
+    quote_infos?: QuoteInfo[];
+}
+declare enum ReplyMethod {
+    LLM_REPLY = 1,
+    UNKNOWN_QUESTION_REPLY = 2,
+    REJECT_QUESTION_REPLY = 3,
+    SENSITIVE_REPLY = 4,
+    ADOPTED_QA_PRIORITY_REPLY = 5,
+    WELCOME_REPLY = 6,
+    CONCURRENCY_LIMIT_REPLY = 7,
+    GLOBAL_INTERVENTION_KNOWLEDGE = 8,
+    TASK_FLOW_REPLY = 9,
+    TASK_FLOW_ANSWER = 10,
+    SEARCH_ENGINE_REPLY = 11,
+    KNOWLEDGE_POLISHED_REPLY = 12,
+    IMAGE_UNDERSTANDING_REPLY = 13,
+    REALTIME_DOCUMENT_REPLY = 14,
+    CLARIFICATION_CONFIRMATION_REPLY = 15,
+    WORKFLOW_REPLY = 16,
+    WORKFLOW_EXECUTION_END = 17,
+    AGENT_REPLY = 18,
+    MULTI_INTENT_REPLY = 19
+}
+interface Knowledge {
+    id: string;
+    type: number;
+    seg_id?: string;
+}
+interface TaskFlow {
+    task_flow_name: string;
+    task_flow_id: string;
+    query_rewrite: string;
+    hit_intent: string;
+    slot_info: Record<string, any>;
+    api_response: Record<string, any>;
+    type: number;
+}
+interface WorkFlow {
+    workflow_name: string;
+    workflow_id: string;
+    workflow_run_id: string;
+    option_cards: string[];
+    current_node: CurrentNode;
+    outputs: Array<string>;
+}
+declare enum CurrentNodeStatus {
+    Pending = 0,
+    Running = 1,
+    Succeeded = 2,
+    Failed = 3
+}
+interface CurrentNode {
+    NodeID: string;
+    NodeType: number;
+    NodeName: string;
+    Status: CurrentNodeStatus;
+    Input: string;
+    Output: string;
+    TaskOutput: string;
+    FailMessage: string;
+    CostMilliSeconds: string;
+    Reply: string;
+    BelongNodeID: string;
+    StatisticInfo: StatisticInfo;
+}
+interface StatisticInfo {
+    ModelName: string;
+    FirstTokenCost: number;
+    TotalCost: number;
+    InputTokens: number;
+    OutputTokens: number;
+    TotalTokens: number;
+}
+interface QuoteInfo {
+    index: number;
+    position: number;
+}
+interface TokenStatEvent {
+    session_id: string;
+    request_id: string;
+    record_id: string;
+    status_summary: "processing" | "success" | "failed";
+    status_summary_title: string;
+    elapsed: number;
+    token_count: number;
+    procedures: TokenStatProcedure[];
+}
+interface TokenStatProcedure {
+    name: string;
+    title: string;
+    status: "processing" | "success" | "failed";
+    input_count: number;
+    output_count: number;
+    count: number;
+}
+interface ReferenceEvent {
+    record_id: string;
+    references: Reference[];
+}
+interface Reference {
+    id: string | number;
+    type: number;
+    url?: string;
+    name: string;
+    doc_id: number;
+    doc_biz_id: number;
+    doc_name: string;
+    qa_biz_id: string;
+}
+interface ErrorInfo {
+    code: number;
+    message: string;
+}
+interface ThoughtEvent {
+    elapsed: number;
+    is_workflow: boolean;
+    procedures: ThoughtProcedure[];
+    record_id: string;
+    request_id: string;
+    session_id: string;
+    trace_id: string;
+    workflow_name: string;
+}
+interface ThoughtProcedure {
+    debugging: Debugging;
+    index: number;
+    name: string;
+    title: string;
+    status: "processing" | "success" | "failed";
+    icon: string;
+    switch: string;
+    workflow_name: string;
+    plugin_type: number;
+    elapsed: number;
+}
+interface Debugging {
+    content: string;
+}
 
+declare class AdpAgentError extends Error {
+    code?: string;
+    constructor(message: string, code?: string);
+}
 declare class AdpAgent extends AbstractAgent {
-    private adpConfig;
     private reqAppClient;
     private reqLkeClient;
+    protected adpConfig: AdpConfig;
     constructor(config: AgentConfig & {
         adpConfig: AdpConfig;
     });
+    generateRequestBody({ message, fileInfos, runId, threadId, forwardedProps, }: {
+        message: string;
+        fileInfos: FileInfo[];
+        runId: string;
+        threadId: string;
+        forwardedProps: Record<string, string>;
+    }): AdpChatRequest;
     run(input: RunAgentInput): Observable<{
         type: EventType;
         timestamp?: number | undefined;
@@ -79,4 +271,4 @@ declare class AdpAgent extends AbstractAgent {
     private _run;
 }
 
-export { AdpAgent };
+export { AdpAgent, AdpAgentError, type AdpChatRequest, type AdpChunk, type AdpConfig, type CurrentNode, CurrentNodeStatus, type Debugging, type ErrorInfo, type FileInfo, type Knowledge, type QuoteInfo, type Reference, type ReferenceEvent, type ReplyEvent, ReplyMethod, type StatisticInfo, type TaskFlow, type ThoughtEvent, type ThoughtProcedure, type TokenStatEvent, type TokenStatProcedure, type WorkFlow };