@agentscope-ai/agentscope 0.0.2 → 0.0.3

package/src/event/index.ts

@@ -1,19 +1,20 @@
 import { ToolCallBlock, ToolResultBlock } from '../message';
+import { PermissionRule } from '../permission';
 
 export enum EventType {
-    RUN_STARTED = 'RUN_STARTED',
-    RUN_FINISHED = 'RUN_FINISHED',
+    REPLY_START = 'REPLY_START',
+    REPLY_END = 'REPLY_END',
 
-    MODEL_CALL_STARTED = 'MODEL_CALL_STARTED',
-    MODEL_CALL_ENDED = 'MODEL_CALL_ENDED',
+    MODEL_CALL_START = 'MODEL_CALL_START',
+    MODEL_CALL_END = 'MODEL_CALL_END',
 
     TEXT_BLOCK_START = 'TEXT_BLOCK_START',
     TEXT_BLOCK_DELTA = 'TEXT_BLOCK_DELTA',
     TEXT_BLOCK_END = 'TEXT_BLOCK_END',
 
-    BINARY_BLOCK_START = 'BINARY_BLOCK_START',
-    BINARY_BLOCK_DELTA = 'BINARY_BLOCK_DELTA',
-    BINARY_BLOCK_END = 'BINARY_BLOCK_END',
+    DATA_BLOCK_START = 'DATA_BLOCK_START',
+    DATA_BLOCK_DELTA = 'DATA_BLOCK_DELTA',
+    DATA_BLOCK_END = 'DATA_BLOCK_END',
 
     THINKING_BLOCK_START = 'THINKING_BLOCK_START',
     THINKING_BLOCK_DELTA = 'THINKING_BLOCK_DELTA',
@@ -25,7 +26,7 @@ export enum EventType {
 
     TOOL_RESULT_START = 'TOOL_RESULT_START',
     TOOL_RESULT_TEXT_DELTA = 'TOOL_RESULT_TEXT_DELTA',
-    TOOL_RESULT_BINARY_DELTA = 'TOOL_RESULT_BINARY_DELTA',
+    TOOL_RESULT_DATA_DELTA = 'TOOL_RESULT_DATA_DELTA',
     TOOL_RESULT_END = 'TOOL_RESULT_END',
 
     EXCEED_MAX_ITERS = 'EXCEED_MAX_ITERS',
@@ -39,202 +40,199 @@ export enum EventType {
 
 export interface EventBase {
     id: string;
-    createdAt: string;
+    created_at: string;
 }
 
-export interface RunStartedEvent extends EventBase {
-    type: EventType.RUN_STARTED;
-    sessionId: string;
-    replyId: string;
-
-    // Extra fields for AG-UI protocol
+export interface ReplyStartEvent extends EventBase {
+    type: EventType.REPLY_START;
+    session_id: string;
+    reply_id: string;
     name: string;
     role: 'user' | 'assistant' | 'system';
 }
 
-export interface RunFinishedEvent extends EventBase {
-    type: EventType.RUN_FINISHED;
-    sessionId: string;
-    replyId: string;
+export interface ReplyEndEvent extends EventBase {
+    type: EventType.REPLY_END;
+    session_id: string;
+    reply_id: string;
 }
 
-export interface ModelCallStartedEvent extends EventBase {
-    type: EventType.MODEL_CALL_STARTED;
-    replyId: string;
-    modelName: string;
+export interface ModelCallStartEvent extends EventBase {
+    type: EventType.MODEL_CALL_START;
+    reply_id: string;
+    model_name: string;
 }
 
-export interface ModelCallEndedEvent extends EventBase {
-    type: EventType.MODEL_CALL_ENDED;
-    replyId: string;
-    inputTokens: number;
-    outputTokens: number;
+export interface ModelCallEndEvent extends EventBase {
+    type: EventType.MODEL_CALL_END;
+    reply_id: string;
+    input_tokens: number;
+    output_tokens: number;
 }
 
 export interface TextBlockStartEvent extends EventBase {
     type: EventType.TEXT_BLOCK_START;
-    blockId: string;
-    replyId: string;
+    block_id: string;
+    reply_id: string;
 }
 
 export interface TextBlockDeltaEvent extends EventBase {
     type: EventType.TEXT_BLOCK_DELTA;
-    replyId: string;
-    blockId: string;
+    reply_id: string;
+    block_id: string;
     delta: string;
 }
 
 export interface TextBlockEndEvent extends EventBase {
     type: EventType.TEXT_BLOCK_END;
-    replyId: string;
-    blockId: string;
+    reply_id: string;
+    block_id: string;
 }
 
-export interface BinaryBlockStartEvent extends EventBase {
-    type: EventType.BINARY_BLOCK_START;
-    replyId: string;
-    blockId: string;
-    mediaType: string;
+export interface DataBlockStartEvent extends EventBase {
+    type: EventType.DATA_BLOCK_START;
+    reply_id: string;
+    block_id: string;
+    media_type: string;
 }
 
-export interface BinaryBlockDeltaEvent extends EventBase {
-    type: EventType.BINARY_BLOCK_DELTA;
-    replyId: string;
-    blockId: string;
+export interface DataBlockDeltaEvent extends EventBase {
+    type: EventType.DATA_BLOCK_DELTA;
+    reply_id: string;
+    block_id: string;
     data: string;
-    mediaType: string;
+    media_type: string;
 }
 
-export interface BinaryBlockEndEvent extends EventBase {
-    type: EventType.BINARY_BLOCK_END;
-    replyId: string;
-    blockId: string;
+export interface DataBlockEndEvent extends EventBase {
+    type: EventType.DATA_BLOCK_END;
+    reply_id: string;
+    block_id: string;
 }
 
 export interface ThinkingBlockStartEvent extends EventBase {
     type: EventType.THINKING_BLOCK_START;
-    replyId: string;
-    blockId: string;
+    reply_id: string;
+    block_id: string;
 }
 
 export interface ThinkingBlockDeltaEvent extends EventBase {
     type: EventType.THINKING_BLOCK_DELTA;
-    replyId: string;
-    blockId: string;
+    reply_id: string;
+    block_id: string;
     delta: string;
 }
 
 export interface ThinkingBlockEndEvent extends EventBase {
     type: EventType.THINKING_BLOCK_END;
-    replyId: string;
-    blockId: string;
+    reply_id: string;
+    block_id: string;
 }
 
 export interface ToolCallStartEvent extends EventBase {
     type: EventType.TOOL_CALL_START;
-    replyId: string;
-    toolCallId: string;
-    toolCallName: string;
+    reply_id: string;
+    tool_call_id: string;
+    tool_call_name: string;
 }
 
 export interface ToolCallDeltaEvent extends EventBase {
     type: EventType.TOOL_CALL_DELTA;
-    replyId: string;
-    toolCallId: string;
+    reply_id: string;
+    tool_call_id: string;
     delta: string;
 }
 
 export interface ToolCallEndEvent extends EventBase {
     type: EventType.TOOL_CALL_END;
-    replyId: string;
-    toolCallId: string;
+    reply_id: string;
+    tool_call_id: string;
 }
 
 export interface ToolResultStartEvent extends EventBase {
     type: EventType.TOOL_RESULT_START;
-    replyId: string;
-    toolCallId: string;
-    toolCallName: string;
+    reply_id: string;
+    tool_call_id: string;
+    tool_call_name: string;
 }
 
 export interface ToolResultTextDeltaEvent extends EventBase {
     type: EventType.TOOL_RESULT_TEXT_DELTA;
-    replyId: string;
-    toolCallId: string;
+    reply_id: string;
+    tool_call_id: string;
+    block_id: string;
     delta: string;
 }
 
-export interface ToolResultBinaryDeltaEvent extends EventBase {
-    type: EventType.TOOL_RESULT_BINARY_DELTA;
-    replyId: string;
-    toolCallId: string;
-    mediaType: string;
+export interface ToolResultDataDeltaEvent extends EventBase {
+    type: EventType.TOOL_RESULT_DATA_DELTA;
+    reply_id: string;
+    tool_call_id: string;
+    block_id: string;
+    media_type: string;
     data?: string;
     url?: string;
 }
 
 export interface ToolResultEndEvent extends EventBase {
     type: EventType.TOOL_RESULT_END;
-    replyId: string;
-    toolCallId: string;
+    reply_id: string;
+    tool_call_id: string;
     state: ToolResultBlock['state'];
 }
 
 export interface ExceedMaxItersEvent extends EventBase {
     type: EventType.EXCEED_MAX_ITERS;
-
-    replyId: string;
-    agentId: string;
+    reply_id: string;
     name: string;
 }
 
 export interface RequireUserConfirmEvent extends EventBase {
     type: EventType.REQUIRE_USER_CONFIRM;
-
-    replyId: string;
-    toolCalls: ToolCallBlock[];
+    reply_id: string;
+    tool_calls: ToolCallBlock[];
 }
 
 export interface RequireExternalExecutionEvent extends EventBase {
     type: EventType.REQUIRE_EXTERNAL_EXECUTION;
+    reply_id: string;
+    tool_calls: ToolCallBlock[];
+}
 
-    replyId: string;
-    toolCalls: ToolCallBlock[];
+export interface ConfirmResult {
+    confirmed: boolean;
+    tool_call: ToolCallBlock;
+    rules?: PermissionRule[] | null;
 }
 
 export interface UserConfirmResultEvent extends EventBase {
     type: EventType.USER_CONFIRM_RESULT;
-
-    replyId: string;
-    confirmResults: {
-        confirmed: boolean;
-        toolCall: ToolCallBlock;
-    }[];
+    reply_id: string;
+    confirm_results: ConfirmResult[];
 }
 
 export interface ExternalExecutionResultEvent extends EventBase {
     type: EventType.EXTERNAL_EXECUTION_RESULT;
-
-    replyId: string;
-    executionResults: ToolResultBlock[];
+    reply_id: string;
+    execution_results: ToolResultBlock[];
 }
 
 export type AgentEvent =
     // The control events for the whole run
-    | RunStartedEvent
-    | RunFinishedEvent
+    | ReplyStartEvent
+    | ReplyEndEvent
     | ExceedMaxItersEvent
     | RequireUserConfirmEvent
     | RequireExternalExecutionEvent
-    | ModelCallStartedEvent
-    | ModelCallEndedEvent
+    | ModelCallStartEvent
+    | ModelCallEndEvent
     // The data events for different block types
     | TextBlockStartEvent
     | TextBlockDeltaEvent
     | TextBlockEndEvent
-    | BinaryBlockStartEvent
-    | BinaryBlockDeltaEvent
-    | BinaryBlockEndEvent
+    | DataBlockStartEvent
+    | DataBlockDeltaEvent
+    | DataBlockEndEvent
     | ThinkingBlockStartEvent
     | ThinkingBlockDeltaEvent
     | ThinkingBlockEndEvent
@@ -243,7 +241,7 @@ export type AgentEvent =
     | ToolCallEndEvent
     | ToolResultStartEvent
     | ToolResultTextDeltaEvent
-    | ToolResultBinaryDeltaEvent
+    | ToolResultDataDeltaEvent
     | ToolResultEndEvent
     // The events from the external execution or user confirmation
     | UserConfirmResultEvent

package/src/formatter/base.ts

@@ -39,10 +39,10 @@ export abstract class FormatterBase {
                     textualOutput.push(block.text);
                     break;
                 default:
-                    const type = block.source.mediaType.split('/')[0];
+                    const type = block.source.media_type.split('/')[0];
                     if (type !== 'image' && type !== 'audio' && type !== 'video') {
                         console.log(
-                            `Unsupported media type '${block.source.mediaType}' in tool output. Only image, audio and video are supported.`
+                            `Unsupported media type '${block.source.media_type}' in tool output. Only image, audio and video are supported.`
                         );
                         break;
                     }
@@ -79,7 +79,7 @@ export abstract class FormatterBase {
         // Attach prefix and suffix system-info tags if there are promoted blocks
         const promotedBlocks: (TextBlock | DataBlock)[] = [];
         promotedData.forEach(({ id, block }) => {
-            const type = block.source.mediaType.split('/')[0];
+            const type = block.source.media_type.split('/')[0];
             promotedBlocks.push({
                 id: crypto.randomUUID(),
                 type: 'text',

package/src/formatter/dashscope-chat-formatter.test.ts

@@ -157,7 +157,7 @@ describe('DashScopeChatFormatter', () => {
                         source: {
                             type: 'url',
                             url: 'https://example.com/image.png',
-                            mediaType: 'image/png',
+                            media_type: 'image/png',
                         },
                     },
                 ],
@@ -180,7 +180,7 @@ describe('DashScopeChatFormatter', () => {
                     {
                         id: crypto.randomUUID(),
                         type: 'data',
-                        source: { type: 'base64', data: 'xxx', mediaType: 'audio/mp3' },
+                        source: { type: 'base64', data: 'xxx', media_type: 'audio/mp3' },
                     },
                     {
                         id: crypto.randomUUID(),
@@ -188,7 +188,7 @@ describe('DashScopeChatFormatter', () => {
                         source: {
                             type: 'url',
                             url: 'file:///local/path/to/video.mp4',
-                            mediaType: 'video/mp4',
+                            media_type: 'video/mp4',
                         },
                     },
                     {
@@ -197,7 +197,7 @@ describe('DashScopeChatFormatter', () => {
                         source: {
                             type: 'url',
                             url: 'file:///C:/local/path/to/image.jpg',
-                            mediaType: 'image/jpg',
+                            media_type: 'image/jpg',
                         },
                     },
                 ],
@@ -276,19 +276,19 @@ describe('DashScopeChatFormatter', () => {
                                 source: {
                                     type: 'url',
                                     url: 'https://example.com/image1.png',
-                                    mediaType: 'image/png',
+                                    media_type: 'image/png',
                                 },
                             },
                             { id: crypto.randomUUID(), type: 'text', text: 'content 2' },
                             {
                                 id: crypto.randomUUID(),
                                 type: 'data',
-                                source: { type: 'base64', data: 'xxx', mediaType: 'image/png' },
+                                source: { type: 'base64', data: 'xxx', media_type: 'image/png' },
                             },
                             {
                                 id: crypto.randomUUID(),
                                 type: 'data',
-                                source: { type: 'base64', data: 'yyy', mediaType: 'audio/mp3' },
+                                source: { type: 'base64', data: 'yyy', media_type: 'audio/mp3' },
                             },
                             {
                                 id: crypto.randomUUID(),
@@ -296,7 +296,7 @@ describe('DashScopeChatFormatter', () => {
                                 source: {
                                     type: 'url',
                                     url: '/local/path/to/video1.mp4',
-                                    mediaType: 'video/mp4',
+                                    media_type: 'video/mp4',
                                 },
                             },
                         ],

package/src/formatter/dashscope-chat-formatter.ts

@@ -141,11 +141,11 @@ export class DashScopeChatFormatter extends FormatterBase {
      * @returns An object representing the formatted multimodal content.
      */
     _formatMultimodalBlock(block: DataBlock) {
-        const type = block.source.mediaType.split('/')[0];
+        const type = block.source.media_type.split('/')[0];
 
         if (!['image', 'audio', 'video'].includes(type)) {
             console.log(
-                `Skip unsupported media type ${block.source.mediaType} in DashScopeChatFormatter. Only image, audio and video are supported.`
+                `Skip unsupported media type ${block.source.media_type} in DashScopeChatFormatter. Only image, audio and video are supported.`
             );
             return [];
         }
@@ -156,7 +156,7 @@ export class DashScopeChatFormatter extends FormatterBase {
 
         return [
             {
-                [type]: `data:${block.source.mediaType};base64,${block.source.data}`,
+                [type]: `data:${block.source.media_type};base64,${block.source.data}`,
             },
         ];
     }

package/src/formatter/openai-chat-formatter.test.ts

@@ -133,13 +133,13 @@ describe('OpenAIChatFormatter', () => {
                         source: {
                             type: 'url',
                             url: 'https://example.com/image.png',
-                            mediaType: 'image/png',
+                            media_type: 'image/png',
                         },
                     },
                     {
                         id: crypto.randomUUID(),
                         type: 'data',
-                        source: { type: 'base64', data: 'xxx', mediaType: 'audio/mp3' },
+                        source: { type: 'base64', data: 'xxx', media_type: 'audio/mp3' },
                     },
                 ],
                 role: 'user',
@@ -153,7 +153,7 @@ describe('OpenAIChatFormatter', () => {
                         source: {
                             type: 'base64',
                             data: 'assistant-audio',
-                            mediaType: 'audio/mp3',
+                            media_type: 'audio/mp3',
                         },
                     },
                 ],
@@ -204,7 +204,7 @@ describe('OpenAIChatFormatter', () => {
                             { type: 'text', text: 'content 1', id: crypto.randomUUID() },
                             {
                                 type: 'data',
-                                source: { type: 'base64', data: 'img64', mediaType: 'image/png' },
+                                source: { type: 'base64', data: 'img64', media_type: 'image/png' },
                                 id: crypto.randomUUID(),
                             },
                         ],

package/src/formatter/openai-chat-formatter.ts

@@ -156,7 +156,7 @@ export class OpenAIChatFormatter extends FormatterBase {
         block: DataBlock;
         role: Msg['role'];
     }): Promise<Record<string, unknown>[]> {
-        const type = block.source.mediaType.split('/')[0];
+        const type = block.source.media_type.split('/')[0];
         if (type === 'image') {
             return [
                 {
@@ -182,7 +182,7 @@ export class OpenAIChatFormatter extends FormatterBase {
         }
 
         console.log(
-            `Skip unsupported media type ${block.source.mediaType} in OpenAIChatFormatter. Only image and audio are supported.`
+            `Skip unsupported media type ${block.source.media_type} in OpenAIChatFormatter. Only image and audio are supported.`
         );
         return [];
     }
@@ -194,7 +194,7 @@ export class OpenAIChatFormatter extends FormatterBase {
      */
     protected async _toOpenAIImageURL(block: DataBlock): Promise<string> {
         if (block.source.type === 'base64') {
-            return `data:${block.source.mediaType};base64,${block.source.data}`;
+            return `data:${block.source.media_type};base64,${block.source.data}`;
         }
 
         const sourceUrl = block.source.url;
@@ -219,7 +219,7 @@ export class OpenAIChatFormatter extends FormatterBase {
         }
 
         const file = await readFile(localPath);
-        const mime = block.source.mediaType || `image/${ext.slice(1)}`;
+        const mime = block.source.media_type || `image/${ext.slice(1)}`;
         return `data:${mime};base64,${file.toString('base64')}`;
     }
 
@@ -239,10 +239,10 @@ export class OpenAIChatFormatter extends FormatterBase {
         ]);
 
         if (block.source.type === 'base64') {
-            const format = supportedMediaTypes.get(block.source.mediaType);
+            const format = supportedMediaTypes.get(block.source.media_type);
             if (!format) {
                 throw new TypeError(
-                    `Unsupported audio media type: ${block.source.mediaType}, only audio/wav and audio/mp3 are supported.`
+                    `Unsupported audio media type: ${block.source.media_type}, only audio/wav and audio/mp3 are supported.`
                 );
             }
             return { data: block.source.data, format };

package/src/mcp/base.ts

@@ -87,7 +87,7 @@ export class MCPTool implements Tool {
                     content.push({
                         id: crypto.randomUUID(),
                         type: 'data',
-                        source: { type: 'base64', mediaType: item.mimeType, data: item.data },
+                        source: { type: 'base64', media_type: item.mimeType, data: item.data },
                     });
                 } else {
                     console.warn(

package/src/message/block.ts

@@ -35,13 +35,13 @@ export interface ToolResultBlock {
 export interface Base64Source {
     type: 'base64';
     data: string;
-    mediaType: string;
+    media_type: string;
 }
 
 export interface URLSource {
     type: 'url';
     url: string;
-    mediaType: string;
+    media_type: string;
 }
 
 export interface DataBlock {

package/src/message/index.ts

@@ -1,4 +1,12 @@
-export { Msg, createMsg, getTextContent, getContentBlocks } from './message';
+export {
+    Msg,
+    createMsg,
+    UserMsg,
+    AssistantMsg,
+    SystemMsg,
+    getTextContent,
+    getContentBlocks,
+} from './message';
 export {
     TextBlock,
     ThinkingBlock,

package/src/message/message.test.ts

@@ -13,7 +13,7 @@ describe('Message', () => {
         ]);
         expect(msg.role).toBe('user');
         expect(msg.metadata).toEqual({});
-        expect(msg.timestamp).toBeDefined();
+        expect(msg.created_at).toBeDefined();
         expect(msg.id).toBeDefined();
         expect(getTextContent(msg)).toBe('Hello, world!');