@agentscope-ai/agentscope 0.0.2

package/dist/base-Cwi4bjze.d.ts

@@ -0,0 +1,127 @@
+import { z } from 'zod';
+import { J as JSONSerializableObject, T as ToolSchema, a as ToolChoice } from './index-CAxQAkiP.js';
+import { T as TextBlock, b as ToolCallBlock, a as ThinkingBlock, D as DataBlock } from './block-VsnHrllL.js';
+import { F as FormatterBase } from './base-BoIps2RL.js';
+import { M as Msg } from './message-CzLeTlua.js';
+
+/**
+ * The usage structure for chat models.
+ */
+interface ChatUsage {
+    type: 'chat_usage';
+    inputTokens: number;
+    outputTokens: number;
+    time: number;
+    metadata?: Record<string, JSONSerializableObject>;
+}
+
+interface ChatResponse {
+    type: 'chat';
+    id: string;
+    createdAt: string;
+    content: Array<TextBlock | ToolCallBlock | ThinkingBlock | DataBlock>;
+    usage?: ChatUsage;
+    structuredContent?: Record<string, JSONSerializableObject>;
+    metadata?: Record<string, JSONSerializableObject>;
+}
+interface StructuredResponse {
+    type: 'structured';
+    id: string;
+    createdAt: string;
+    content: Record<string, JSONSerializableObject>;
+    usage?: ChatUsage;
+    metadata?: Record<string, JSONSerializableObject>;
+}
+
+interface ChatModelOptions {
+    modelName: string;
+    stream?: boolean;
+    maxRetries?: number;
+    fallbackModelName?: string;
+    formatter?: FormatterBase;
+}
+interface ChatModelCallOptions {
+    messages: Msg[];
+    tools?: ToolSchema[];
+    toolChoice?: ToolChoice;
+    [key: string]: unknown;
+}
+interface ChatModelCallStructuredOptions {
+    messages: Msg[];
+    schema: z.ZodObject;
+}
+interface ChatModelRequestOptions<T> {
+    messages: T[];
+    tools?: ToolSchema[];
+    toolChoice?: ToolChoice;
+    [key: string]: unknown;
+}
+/**
+ * The base class for chat models.
+ */
+declare abstract class ChatModelBase {
+    modelName: string;
+    stream: boolean;
+    maxRetries: number;
+    fallbackModelName?: string;
+    formatter?: FormatterBase;
+    /**
+     * Initializes a new instance of the ChatModelBase class.
+     *
+     * @param options - The chat model options, including model name, streaming option, max retries, fallback
+     *  model name, and formatter.
+     *
+     * @param options.modelName
+     * @param options.stream
+     * @param options.maxRetries
+     * @param options.fallbackModelName
+     * @param options.formatter
+     */
+    protected constructor({ modelName, stream, maxRetries, fallbackModelName, formatter, }: ChatModelOptions);
+    /**
+     * Calls the chat model with the given messages.
+     * This is the main method to interact with the model.
+     *
+     * @param options - The chat model call options.
+     * @returns A promise that resolves to the model's response.
+     */
+    call(options: ChatModelCallOptions): Promise<ChatResponse | AsyncGenerator<ChatResponse>>;
+    /**
+     * Abstract method to call the underlying API with the given parameters.
+     */
+    protected abstract _callAPI(modelName: string, options: ChatModelRequestOptions<unknown>): Promise<ChatResponse | AsyncGenerator<ChatResponse>>;
+    /**
+     * Format the AgentScope tool choice parameter to the expected API format.
+     *
+     * @param toolChoice - The tool choice option.
+     * @returns The formatted tool choice.
+     */
+    abstract _formatToolChoice(toolChoice: ToolChoice): unknown;
+    /**
+     * A heuristic method to count the number of the tokens
+     * Note the multimodal content is ignored in the token counting
+     * @param options
+     * @param options.messages
+     * @param options.tools
+     * @returns The estimated number of tokens in the input messages and tools.
+     */
+    countTokens(options: {
+        messages: Msg[];
+        tools?: ToolSchema[];
+    }): Promise<number>;
+    /**
+     * Format the tool schemas to the expected API format.
+     * @param tools
+     * @returns The formatted tool schemas.
+     */
+    abstract _formatToolSchemas(tools: ToolSchema[]): unknown[];
+    /**
+     * A default implementation of the structured call method. For those supporting structured output, the model should
+     * override this method.
+     * @param options
+     * @returns The structured response from the model, which should conform to the provided Zod schema.
+     */
+    callStructured(options: ChatModelCallStructuredOptions): Promise<StructuredResponse>;
+}
+
+export { ChatModelBase as C, type ChatUsage as a, type ChatResponse as b, type ChatModelOptions as c, type ChatModelRequestOptions as d };

package/dist/base-DYlBMCy_.d.mts

@@ -0,0 +1,127 @@
+import { z } from 'zod';
+import { J as JSONSerializableObject, T as ToolSchema, a as ToolChoice } from './index-CAxQAkiP.mjs';
+import { T as TextBlock, b as ToolCallBlock, a as ThinkingBlock, D as DataBlock } from './block-VsnHrllL.mjs';
+import { F as FormatterBase } from './base-BOx3UzOl.mjs';
+import { M as Msg } from './message-CkN21KaY.mjs';
+
+/**
+ * The usage structure for chat models.
+ */
+interface ChatUsage {
+    type: 'chat_usage';
+    inputTokens: number;
+    outputTokens: number;
+    time: number;
+    metadata?: Record<string, JSONSerializableObject>;
+}
+
+interface ChatResponse {
+    type: 'chat';
+    id: string;
+    createdAt: string;
+    content: Array<TextBlock | ToolCallBlock | ThinkingBlock | DataBlock>;
+    usage?: ChatUsage;
+    structuredContent?: Record<string, JSONSerializableObject>;
+    metadata?: Record<string, JSONSerializableObject>;
+}
+interface StructuredResponse {
+    type: 'structured';
+    id: string;
+    createdAt: string;
+    content: Record<string, JSONSerializableObject>;
+    usage?: ChatUsage;
+    metadata?: Record<string, JSONSerializableObject>;
+}
+
+interface ChatModelOptions {
+    modelName: string;
+    stream?: boolean;
+    maxRetries?: number;
+    fallbackModelName?: string;
+    formatter?: FormatterBase;
+}
+interface ChatModelCallOptions {
+    messages: Msg[];
+    tools?: ToolSchema[];
+    toolChoice?: ToolChoice;
+    [key: string]: unknown;
+}
+interface ChatModelCallStructuredOptions {
+    messages: Msg[];
+    schema: z.ZodObject;
+}
+interface ChatModelRequestOptions<T> {
+    messages: T[];
+    tools?: ToolSchema[];
+    toolChoice?: ToolChoice;
+    [key: string]: unknown;
+}
+/**
+ * The base class for chat models.
+ */
+declare abstract class ChatModelBase {
+    modelName: string;
+    stream: boolean;
+    maxRetries: number;
+    fallbackModelName?: string;
+    formatter?: FormatterBase;
+    /**
+     * Initializes a new instance of the ChatModelBase class.
+     *
+     * @param options - The chat model options, including model name, streaming option, max retries, fallback
+     *  model name, and formatter.
+     *
+     * @param options.modelName
+     * @param options.stream
+     * @param options.maxRetries
+     * @param options.fallbackModelName
+     * @param options.formatter
+     */
+    protected constructor({ modelName, stream, maxRetries, fallbackModelName, formatter, }: ChatModelOptions);
+    /**
+     * Calls the chat model with the given messages.
+     * This is the main method to interact with the model.
+     *
+     * @param options - The chat model call options.
+     * @returns A promise that resolves to the model's response.
+     */
+    call(options: ChatModelCallOptions): Promise<ChatResponse | AsyncGenerator<ChatResponse>>;
+    /**
+     * Abstract method to call the underlying API with the given parameters.
+     */
+    protected abstract _callAPI(modelName: string, options: ChatModelRequestOptions<unknown>): Promise<ChatResponse | AsyncGenerator<ChatResponse>>;
+    /**
+     * Format the AgentScope tool choice parameter to the expected API format.
+     *
+     * @param toolChoice - The tool choice option.
+     * @returns The formatted tool choice.
+     */
+    abstract _formatToolChoice(toolChoice: ToolChoice): unknown;
+    /**
+     * A heuristic method to count the number of the tokens
+     * Note the multimodal content is ignored in the token counting
+     * @param options
+     * @param options.messages
+     * @param options.tools
+     * @returns The estimated number of tokens in the input messages and tools.
+     */
+    countTokens(options: {
+        messages: Msg[];
+        tools?: ToolSchema[];
+    }): Promise<number>;
+    /**
+     * Format the tool schemas to the expected API format.
+     * @param tools
+     * @returns The formatted tool schemas.
+     */
+    abstract _formatToolSchemas(tools: ToolSchema[]): unknown[];
+    /**
+     * A default implementation of the structured call method. For those supporting structured output, the model should
+     * override this method.
+     * @param options
+     * @returns The structured response from the model, which should conform to the provided Zod schema.
+     */
+    callStructured(options: ChatModelCallStructuredOptions): Promise<StructuredResponse>;
+}
+
+export { ChatModelBase as C, type ChatUsage as a, type ChatResponse as b, type ChatModelOptions as c, type ChatModelRequestOptions as d };

package/dist/base-NX-knWOv.d.ts

@@ -0,0 +1,52 @@
+import { M as Msg } from './message-CzLeTlua.js';
+
+/**
+ * The complete agent state including both conversation context and metadata.
+ */
+interface AgentState {
+    /**
+     * The conversation context (message history).
+     */
+    context: Msg[];
+    /**
+     * Agent metadata (replyId, curIter, curSummary, etc.).
+     */
+    metadata: Record<string, unknown>;
+}
+/**
+ * The base storage class that responsible for
+ * - loading/saving agent context and state, and
+ * - offloading compressed context to external storage for agentic search if needed
+ */
+declare abstract class StorageBase {
+    /**
+     * Load the complete agent state including context and metadata.
+     * @param options.agentId - The agent identifier
+     * @returns The agent state with context and metadata
+     */
+    abstract loadAgentState(options?: {
+        agentId?: string;
+    }): Promise<AgentState>;
+    /**
+     * Save the complete agent state including context and metadata.
+     * @param options.agentId - The agent identifier
+     * @param options.context - The conversation context to save
+     * @param options.metadata - The agent metadata to save
+     */
+    abstract saveAgentState(options: {
+        agentId?: string;
+        context: Msg[];
+        metadata: Record<string, unknown>;
+    }): Promise<void>;
+    /**
+     * Offload the compressed context to external storage for agentic search if needed.
+     * @param _options.msgs
+     * @param _options
+     * @returns The identifier or URL of the offloaded context, or undefined if offloading is not implemented or not needed
+     */
+    offloadContext(_options: {
+        msgs: Msg[];
+    }): Promise<string | undefined>;
+}
+
+export { type AgentState as A, StorageBase as S };

package/dist/block-VsnHrllL.d.mts

@@ -0,0 +1,48 @@
+interface TextBlock {
+    type: 'text';
+    text: string;
+    id: string;
+}
+interface ThinkingBlock {
+    type: 'thinking';
+    thinking: string;
+    id: string;
+}
+interface HintBlock {
+    type: 'hint';
+    hint: string;
+    id: string;
+}
+interface ToolCallBlock {
+    type: 'tool_call';
+    name: string;
+    id: string;
+    input: string;
+    awaitUserConfirmation?: boolean;
+}
+interface ToolResultBlock {
+    type: 'tool_result';
+    id: string;
+    name: string;
+    output: string | (TextBlock | DataBlock)[];
+    state: 'success' | 'error' | 'interrupted' | 'running';
+}
+interface Base64Source {
+    type: 'base64';
+    data: string;
+    mediaType: string;
+}
+interface URLSource {
+    type: 'url';
+    url: string;
+    mediaType: string;
+}
+interface DataBlock {
+    type: 'data';
+    source: Base64Source | URLSource;
+    id: string;
+    name?: string;
+}
+type ContentBlock = TextBlock | ThinkingBlock | HintBlock | ToolCallBlock | ToolResultBlock | DataBlock;
+
+export type { Base64Source as B, ContentBlock as C, DataBlock as D, TextBlock as T, URLSource as U, ThinkingBlock as a, ToolCallBlock as b, ToolResultBlock as c };

package/dist/block-VsnHrllL.d.ts

@@ -0,0 +1,48 @@
+interface TextBlock {
+    type: 'text';
+    text: string;
+    id: string;
+}
+interface ThinkingBlock {
+    type: 'thinking';
+    thinking: string;
+    id: string;
+}
+interface HintBlock {
+    type: 'hint';
+    hint: string;
+    id: string;
+}
+interface ToolCallBlock {
+    type: 'tool_call';
+    name: string;
+    id: string;
+    input: string;
+    awaitUserConfirmation?: boolean;
+}
+interface ToolResultBlock {
+    type: 'tool_result';
+    id: string;
+    name: string;
+    output: string | (TextBlock | DataBlock)[];
+    state: 'success' | 'error' | 'interrupted' | 'running';
+}
+interface Base64Source {
+    type: 'base64';
+    data: string;
+    mediaType: string;
+}
+interface URLSource {
+    type: 'url';
+    url: string;
+    mediaType: string;
+}
+interface DataBlock {
+    type: 'data';
+    source: Base64Source | URLSource;
+    id: string;
+    name?: string;
+}
+type ContentBlock = TextBlock | ThinkingBlock | HintBlock | ToolCallBlock | ToolResultBlock | DataBlock;
+
+export type { Base64Source as B, ContentBlock as C, DataBlock as D, TextBlock as T, URLSource as U, ThinkingBlock as a, ToolCallBlock as b, ToolResultBlock as c };

package/dist/event/index.d.mts

@@ -0,0 +1,181 @@
+import { b as ToolCallBlock, c as ToolResultBlock } from '../block-VsnHrllL.mjs';
+
+declare enum EventType {
+    RUN_STARTED = "RUN_STARTED",
+    RUN_FINISHED = "RUN_FINISHED",
+    MODEL_CALL_STARTED = "MODEL_CALL_STARTED",
+    MODEL_CALL_ENDED = "MODEL_CALL_ENDED",
+    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",
+    THINKING_BLOCK_START = "THINKING_BLOCK_START",
+    THINKING_BLOCK_DELTA = "THINKING_BLOCK_DELTA",
+    THINKING_BLOCK_END = "THINKING_BLOCK_END",
+    TOOL_CALL_START = "TOOL_CALL_START",
+    TOOL_CALL_DELTA = "TOOL_CALL_DELTA",
+    TOOL_CALL_END = "TOOL_CALL_END",
+    TOOL_RESULT_START = "TOOL_RESULT_START",
+    TOOL_RESULT_TEXT_DELTA = "TOOL_RESULT_TEXT_DELTA",
+    TOOL_RESULT_BINARY_DELTA = "TOOL_RESULT_BINARY_DELTA",
+    TOOL_RESULT_END = "TOOL_RESULT_END",
+    EXCEED_MAX_ITERS = "EXCEED_MAX_ITERS",
+    REQUIRE_USER_CONFIRM = "REQUIRE_USER_CONFIRM",
+    REQUIRE_EXTERNAL_EXECUTION = "REQUIRE_EXTERNAL_EXECUTION",
+    USER_CONFIRM_RESULT = "USER_CONFIRM_RESULT",
+    EXTERNAL_EXECUTION_RESULT = "EXTERNAL_EXECUTION_RESULT"
+}
+interface EventBase {
+    id: string;
+    createdAt: string;
+}
+interface RunStartedEvent extends EventBase {
+    type: EventType.RUN_STARTED;
+    sessionId: string;
+    replyId: string;
+    name: string;
+    role: 'user' | 'assistant' | 'system';
+}
+interface RunFinishedEvent extends EventBase {
+    type: EventType.RUN_FINISHED;
+    sessionId: string;
+    replyId: string;
+}
+interface ModelCallStartedEvent extends EventBase {
+    type: EventType.MODEL_CALL_STARTED;
+    replyId: string;
+    modelName: string;
+}
+interface ModelCallEndedEvent extends EventBase {
+    type: EventType.MODEL_CALL_ENDED;
+    replyId: string;
+    inputTokens: number;
+    outputTokens: number;
+}
+interface TextBlockStartEvent extends EventBase {
+    type: EventType.TEXT_BLOCK_START;
+    blockId: string;
+    replyId: string;
+}
+interface TextBlockDeltaEvent extends EventBase {
+    type: EventType.TEXT_BLOCK_DELTA;
+    replyId: string;
+    blockId: string;
+    delta: string;
+}
+interface TextBlockEndEvent extends EventBase {
+    type: EventType.TEXT_BLOCK_END;
+    replyId: string;
+    blockId: string;
+}
+interface BinaryBlockStartEvent extends EventBase {
+    type: EventType.BINARY_BLOCK_START;
+    replyId: string;
+    blockId: string;
+    mediaType: string;
+}
+interface BinaryBlockDeltaEvent extends EventBase {
+    type: EventType.BINARY_BLOCK_DELTA;
+    replyId: string;
+    blockId: string;
+    data: string;
+    mediaType: string;
+}
+interface BinaryBlockEndEvent extends EventBase {
+    type: EventType.BINARY_BLOCK_END;
+    replyId: string;
+    blockId: string;
+}
+interface ThinkingBlockStartEvent extends EventBase {
+    type: EventType.THINKING_BLOCK_START;
+    replyId: string;
+    blockId: string;
+}
+interface ThinkingBlockDeltaEvent extends EventBase {
+    type: EventType.THINKING_BLOCK_DELTA;
+    replyId: string;
+    blockId: string;
+    delta: string;
+}
+interface ThinkingBlockEndEvent extends EventBase {
+    type: EventType.THINKING_BLOCK_END;
+    replyId: string;
+    blockId: string;
+}
+interface ToolCallStartEvent extends EventBase {
+    type: EventType.TOOL_CALL_START;
+    replyId: string;
+    toolCallId: string;
+    toolCallName: string;
+}
+interface ToolCallDeltaEvent extends EventBase {
+    type: EventType.TOOL_CALL_DELTA;
+    replyId: string;
+    toolCallId: string;
+    delta: string;
+}
+interface ToolCallEndEvent extends EventBase {
+    type: EventType.TOOL_CALL_END;
+    replyId: string;
+    toolCallId: string;
+}
+interface ToolResultStartEvent extends EventBase {
+    type: EventType.TOOL_RESULT_START;
+    replyId: string;
+    toolCallId: string;
+    toolCallName: string;
+}
+interface ToolResultTextDeltaEvent extends EventBase {
+    type: EventType.TOOL_RESULT_TEXT_DELTA;
+    replyId: string;
+    toolCallId: string;
+    delta: string;
+}
+interface ToolResultBinaryDeltaEvent extends EventBase {
+    type: EventType.TOOL_RESULT_BINARY_DELTA;
+    replyId: string;
+    toolCallId: string;
+    mediaType: string;
+    data?: string;
+    url?: string;
+}
+interface ToolResultEndEvent extends EventBase {
+    type: EventType.TOOL_RESULT_END;
+    replyId: string;
+    toolCallId: string;
+    state: ToolResultBlock['state'];
+}
+interface ExceedMaxItersEvent extends EventBase {
+    type: EventType.EXCEED_MAX_ITERS;
+    replyId: string;
+    agentId: string;
+    name: string;
+}
+interface RequireUserConfirmEvent extends EventBase {
+    type: EventType.REQUIRE_USER_CONFIRM;
+    replyId: string;
+    toolCalls: ToolCallBlock[];
+}
+interface RequireExternalExecutionEvent extends EventBase {
+    type: EventType.REQUIRE_EXTERNAL_EXECUTION;
+    replyId: string;
+    toolCalls: ToolCallBlock[];
+}
+interface UserConfirmResultEvent extends EventBase {
+    type: EventType.USER_CONFIRM_RESULT;
+    replyId: string;
+    confirmResults: {
+        confirmed: boolean;
+        toolCall: ToolCallBlock;
+    }[];
+}
+interface ExternalExecutionResultEvent extends EventBase {
+    type: EventType.EXTERNAL_EXECUTION_RESULT;
+    replyId: string;
+    executionResults: ToolResultBlock[];
+}
+type AgentEvent = RunStartedEvent | RunFinishedEvent | ExceedMaxItersEvent | RequireUserConfirmEvent | RequireExternalExecutionEvent | ModelCallStartedEvent | ModelCallEndedEvent | TextBlockStartEvent | TextBlockDeltaEvent | TextBlockEndEvent | BinaryBlockStartEvent | BinaryBlockDeltaEvent | BinaryBlockEndEvent | ThinkingBlockStartEvent | ThinkingBlockDeltaEvent | ThinkingBlockEndEvent | ToolCallStartEvent | ToolCallDeltaEvent | ToolCallEndEvent | ToolResultStartEvent | ToolResultTextDeltaEvent | ToolResultBinaryDeltaEvent | ToolResultEndEvent | UserConfirmResultEvent | ExternalExecutionResultEvent;
+
+export { type AgentEvent, type BinaryBlockDeltaEvent, type BinaryBlockEndEvent, type BinaryBlockStartEvent, type EventBase, EventType, type ExceedMaxItersEvent, type ExternalExecutionResultEvent, type ModelCallEndedEvent, type ModelCallStartedEvent, type RequireExternalExecutionEvent, type RequireUserConfirmEvent, type RunFinishedEvent, type RunStartedEvent, type TextBlockDeltaEvent, type TextBlockEndEvent, type TextBlockStartEvent, type ThinkingBlockDeltaEvent, type ThinkingBlockEndEvent, type ThinkingBlockStartEvent, type ToolCallDeltaEvent, type ToolCallEndEvent, type ToolCallStartEvent, type ToolResultBinaryDeltaEvent, type ToolResultEndEvent, type ToolResultStartEvent, type ToolResultTextDeltaEvent, type UserConfirmResultEvent };