test-wuying-agentbay-sdk 0.13.0-beta.20251210135226 → 0.13.0-beta.20251210170519

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -3128,18 +3128,31 @@ declare function newContextSync(contextId: string, path: string, policy?: SyncPo
3128
3128
  * Result of task execution.
3129
3129
  */
3130
3130
  interface ExecutionResult extends ApiResponse {
3131
- success: boolean;
3132
- errorMessage: string;
3133
3131
  taskId: string;
3134
3132
  taskStatus: string;
3133
+ taskResult: string;
3135
3134
  }
3136
3135
  /**
3137
3136
  * Result of query operations.
3138
3137
  */
3139
3138
  interface QueryResult extends ApiResponse {
3139
+ taskStatus: string;
3140
+ taskAction: string;
3141
+ taskProduct: string;
3142
+ }
3143
+ /**
3144
+ * Result of agent initialization.
3145
+ */
3146
+ interface InitializationResult extends ApiResponse {
3140
3147
  success: boolean;
3141
- output: string;
3142
- errorMessage: string;
3148
+ }
3149
+ /**
3150
+ * Options for Agent initialization.
3151
+
3152
+ */
3153
+ interface AgentOptions {
3154
+ use_vision: boolean;
3155
+ output_schema: '';
3143
3156
  }
3144
3157
  /**
3145
3158
  * Result of an MCP tool call.
@@ -3159,12 +3172,12 @@ interface McpSession {
3159
3172
  callMcpTool(toolName: string, args: any): Promise<McpToolResult>;
3160
3173
  }
3161
3174
  /**
3162
- * An Agent to manipulate applications to complete specific tasks.
3175
+ * An Agent to perform tasks on the computer.
3163
3176
  */
3164
- declare class Agent {
3177
+ declare class ComputerUseAgent {
3165
3178
  private session;
3166
3179
  /**
3167
- * Initialize an Agent object.
3180
+ * Initialize an Computer Agent object.
3168
3181
  *
3169
3182
  * @param session - The Session instance that this Agent belongs to.
3170
3183
  */
@@ -3174,16 +3187,17 @@ declare class Agent {
3174
3187
  *
3175
3188
  * @param task - Task description in human language.
3176
3189
  * @param maxTryTimes - Maximum number of retry attempts.
3177
- * @returns ExecutionResult containing success status, task output, and error message if any.
3190
+ * @returns ExecutionResult containing success status, task output, and error
3191
+ * message if any.
3178
3192
  *
3179
3193
  * @example
3180
3194
  * ```typescript
3181
3195
  * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3182
3196
  * const result = await agentBay.create({ imageId: 'windows_latest' });
3183
3197
  * if (result.success) {
3184
- * const taskResult = await result.session.agent.executeTask('Open notepad', 10);
3185
- * console.log(`Task status: ${taskResult.taskStatus}`);
3186
- * await result.session.delete();
3198
+ * const taskResult = await result.session.agent.computer.executeTask('Open
3199
+ * notepad', 10); console.log(`Task status: ${taskResult.taskStatus}`); await
3200
+ * result.session.delete();
3187
3201
  * }
3188
3202
  * ```
3189
3203
  */
@@ -3199,27 +3213,125 @@ declare class Agent {
3199
3213
  * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3200
3214
  * const result = await agentBay.create({ imageId: 'windows_latest' });
3201
3215
  * if (result.success) {
3202
- * const taskResult = await result.session.agent.executeTask('Open calculator', 10);
3203
- * const statusResult = await result.session.agent.getTaskStatus(taskResult.taskId);
3204
- * console.log(`Status: ${JSON.parse(statusResult.output).status}`);
3216
+ * const taskResult = await result.session.agent.computer.executeTask('Open
3217
+ * calculator', 10); const statusResult = await
3218
+ * result.session.agent.computer.getTaskStatus(taskResult.taskId);
3219
+ * console.log(`Status:
3220
+ * ${JSON.parse(statusResult.output).status}`); await result.session.delete();
3221
+ * }
3222
+ * ```
3223
+ */
3224
+ getTaskStatus(taskId: string): Promise<QueryResult>;
3225
+ /**
3226
+ * Terminate a task with a specified task ID.
3227
+ *
3228
+ * @param taskId - The ID of the running task.
3229
+ * @returns ExecutionResult containing success status, task output, and
3230
+ * error message if any.
3231
+ *
3232
+ * @example
3233
+ * ```typescript
3234
+ * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3235
+ * const result = await agentBay.create({ imageId: 'windows_latest' });
3236
+ * if (result.success) {
3237
+ * const taskResult = await
3238
+ * result.session.agent.computer.executeTask('Open notepad', 5); const
3239
+ * terminateResult = await
3240
+ * result.session.agent.computer.terminateTask(taskResult.taskId);
3241
+ * console.log(`Terminated: ${terminateResult.taskStatus}`);
3205
3242
  * await result.session.delete();
3206
3243
  * }
3207
3244
  * ```
3208
3245
  */
3246
+ terminateTask(taskId: string): Promise<ExecutionResult>;
3247
+ }
3248
+ declare class BrowserUseAgent {
3249
+ private session;
3250
+ /**
3251
+ * Initialize an Browser Agent object.
3252
+ * @description Browser Use Agent is in BETA ⚠️ .
3253
+ *
3254
+ * @param session - The Session instance that this Agent belongs to.
3255
+ */
3256
+ constructor(session: McpSession);
3257
+ /**
3258
+ * Initialize the browser agent with specific options.
3259
+ * @param options - agent initialization options
3260
+ * @returns InitializationResult containing success status, task output,
3261
+ * and error message if any.
3262
+ *
3263
+ * @example
3264
+ * ```typescript
3265
+ * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3266
+ * const result = await agentBay.create({ imageId: 'linux_latest' });
3267
+ * if (result.success) {
3268
+ * options:AgentOptions = new AgentOptions(use_vision=False,
3269
+ * output_schema=""); const initResult = await
3270
+ * result.session.agent.browser.initialize(options); console.log(`Initialize
3271
+ * success: ${initResult.success}`); await result.session.delete();
3272
+ * }
3273
+ * ```
3274
+ */
3275
+ initialize(options: AgentOptions): Promise<InitializationResult>;
3276
+ /**
3277
+ * Execute a specific task described in human language.
3278
+ *
3279
+ * @param task - Task description in human language.
3280
+ * @param maxTryTimes - Maximum number of retry attempts.
3281
+ * @returns ExecutionResult containing success status, task output, and
3282
+ * error message if any.
3283
+ *
3284
+ * @example
3285
+ * ```typescript
3286
+ * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3287
+ * const result = await agentBay.create({ imageId: 'linux_latest' });
3288
+ * if (result.success) {
3289
+ * const taskResult = await
3290
+ * result.session.agent.browser.executeTask('Navigate to baidu and query the
3291
+ * weather of Shanghai', 10); console.log(`Task status:
3292
+ * ${taskResult.taskStatus}`); await result.session.delete();
3293
+ * }
3294
+ * ```
3295
+ */
3296
+ executeTask(task: string, maxTryTimes: number): Promise<ExecutionResult>;
3297
+ /**
3298
+ * Get the status of the task with the given task ID.
3299
+ *
3300
+ * @param taskId - Task ID
3301
+ * @returns QueryResult containing the task status
3302
+ *
3303
+ * @example
3304
+ * ```typescript
3305
+ * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3306
+ * const result = await agentBay.create({ imageId: 'windows_latest' });
3307
+ * if (result.success) {
3308
+ * const taskResult = await
3309
+ * result.session.agent.browser.executeTask(Navigate to baidu and query the
3310
+ * weather of Shanghai, 10); const statusResult = await
3311
+ * result.session.agent.browser.getTaskStatus(taskResult.taskId);
3312
+ * console.log(`Status:
3313
+ * ${JSON.parse(statusResult.output).status}`); await
3314
+ * result.session.delete();
3315
+ * }
3316
+ * ```
3317
+ */
3209
3318
  getTaskStatus(taskId: string): Promise<QueryResult>;
3210
3319
  /**
3211
3320
  * Terminate a task with a specified task ID.
3212
3321
  *
3213
3322
  * @param taskId - The ID of the running task.
3214
- * @returns ExecutionResult containing success status, task output, and error message if any.
3323
+ * @returns ExecutionResult containing success status, task output, and
3324
+ * error message if any.
3215
3325
  *
3216
3326
  * @example
3217
3327
  * ```typescript
3218
3328
  * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3219
3329
  * const result = await agentBay.create({ imageId: 'windows_latest' });
3220
3330
  * if (result.success) {
3221
- * const taskResult = await result.session.agent.executeTask('Open notepad', 5);
3222
- * const terminateResult = await result.session.agent.terminateTask(taskResult.taskId);
3331
+ * const taskResult = await
3332
+ * result.session.agent.browser.executeTask(Navigate to baidu and query the
3333
+ * weather of Shanghai, 10); const terminateResult = await
3334
+ * result.session.agent.browser.terminateTask(taskResult.taskId);
3223
3335
  * console.log(`Terminated: ${terminateResult.taskStatus}`);
3224
3336
  * await result.session.delete();
3225
3337
  * }
@@ -3227,6 +3339,28 @@ declare class Agent {
3227
3339
  */
3228
3340
  terminateTask(taskId: string): Promise<ExecutionResult>;
3229
3341
  }
3342
+ /**
3343
+ * An Agent to manipulate applications to complete specific tasks.
3344
+ * According to the use scenary, The agent can a browser use agent which is
3345
+ * specialized for browser automation tasks, The agent also can be a computer
3346
+ * use agent which is specialized for multiple applications automation tasks.
3347
+ */
3348
+ declare class Agent {
3349
+ /**
3350
+ * An instance of Computer Use Agent.
3351
+ */
3352
+ computer: ComputerUseAgent;
3353
+ /**
3354
+ * An instance of Browser Use Agent.
3355
+ */
3356
+ browser: BrowserUseAgent;
3357
+ /**
3358
+ * Initialize an Agent object.
3359
+ *
3360
+ * @param session - The Session instance that this Agent belongs to.
3361
+ */
3362
+ constructor(session: McpSession);
3363
+ }
3230
3364
 
3231
3365
  interface ActOptions {
3232
3366
  action: string;
@@ -7110,4 +7244,4 @@ declare function logWarn(message: string, ...args: any[]): void;
7110
7244
  */
7111
7245
  declare function logError(message: string, error?: any): void;
7112
7246
 
7113
- export { APIError, APP_BLACKLIST_TEMPLATE, APP_WHITELIST_TEMPLATE, type ActOptions, ActResult, Agent, AgentBay, AgentBayError, type ApiResponse, type ApiResponseWithData, type AppManagerRule, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, type BWList, type Brand, Browser, BrowserAgent, BrowserContext, BrowserError, type BrowserFingerprint, BrowserFingerprintContext, BrowserFingerprintGenerator, type BrowserOption, BrowserOptionClass, type BrowserProxy, BrowserProxyClass, type BrowserScreen, type BrowserViewport, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, ClearContextRequest, ClearContextResponse, ClearContextResponseBody, Client, Code, Command, Computer, type Config, Context, type ContextInfoResult, ContextManager, ContextService, type ContextStatusData, type ContextStatusItem, ContextSync, type ContextSyncResult, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, type CreateSessionParams, type CreateSessionParamsConfig, DeleteContextFileRequest, DeleteContextFileResponse, DeleteContextFileResponseBody, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DeletePolicy, type DeleteResult, DescribeContextFilesRequest, DescribeContextFilesResponse, DescribeContextFilesResponseBody, type DirectoryEntry, type DownloadPolicy, DownloadStrategy, type ExecutionResult, Extension, ExtensionOption, ExtensionsService, type ExtraConfigs, type ExtraProperties, type ExtractOptions, type ExtractPolicy, ExtractPolicyClass, type FileChangeEvent, FileChangeEventHelper, type FileChangeResult, FileChangeResultHelper, FileError, type FileInfo, FileSystem, type Fingerprint, FingerprintFormat, GetAdbLinkRequest, GetAdbLinkResponse, GetAdbLinkResponseBody, GetAdbLinkResponseBodyData, GetCdpLinkRequest, GetCdpLinkResponse, GetCdpLinkResponseBody, GetCdpLinkResponseBodyData, GetContextFileDownloadUrlRequest, GetContextFileDownloadUrlResponse, GetContextFileDownloadUrlResponseBody, GetContextFileUploadUrlRequest, GetContextFileUploadUrlResponse, GetContextFileUploadUrlResponseBody, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, GetSessionRequest, GetSessionResponse, GetSessionResponseBody, GetSessionResponseBodyData, HIDE_NAVIGATION_BAR_TEMPLATE, IS_RELEASE, InitBrowserRequest, InitBrowserResponse, InitBrowserResponseBody, InitBrowserResponseBodyData, Lifecycle, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, type LogLevel, type LoggerConfig, MOBILE_COMMAND_TEMPLATES, type MappingPolicy, type McpSession, type McpToolResult, Mobile, type MobileExtraConfig, type MobileSimulateConfig, MobileSimulateMode, MobileSimulateService, type MobileSimulateUploadResult, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, type NavigatorFingerprint, type ObserveOptions, ObserveResult, Oss, OssError, PauseSessionAsyncRequest, PauseSessionAsyncResponse, PauseSessionAsyncResponseBody, type QueryResult, RESOLUTION_LOCK_TEMPLATE, type RecyclePolicy, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, ResumeSessionAsyncRequest, ResumeSessionAsyncResponse, ResumeSessionAsyncResponseBody, SHOW_NAVIGATION_BAR_TEMPLATE, type ScreenFingerprint, Session, SessionError, type SessionInterface, type SessionListResult, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, type SyncCallback, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, type SyncPolicy, SyncPolicyImpl, UNINSTALL_BLACKLIST_TEMPLATE, UploadMode, type UploadPolicy, UploadStrategy, type UserAgentData, VERSION, type VideoCard, type WhiteList, WhiteListValidator, createListSessionParams, extraConfigsFromJSON, extraConfigsToJSON, extractRequestId, getLogLevel, getMobileCommandTemplate, hasMobileCommandTemplate, log, logDebug, logError, logInfo, logWarn, newContextManager, newContextSync, newCreateSessionParams, newDeletePolicy, newDownloadPolicy, newExtractPolicy, newMappingPolicy, newRecyclePolicy, newSyncPolicy, newSyncPolicyWithDefaults, newUploadPolicy, replaceTemplatePlaceholders, setLogLevel, setupLogger, validateAppManagerRule, validateExtraConfigs, validateMobileExtraConfig, validateMobileSimulateConfig };
7247
+ export { APIError, APP_BLACKLIST_TEMPLATE, APP_WHITELIST_TEMPLATE, type ActOptions, ActResult, Agent, AgentBay, AgentBayError, type AgentOptions, type ApiResponse, type ApiResponseWithData, type AppManagerRule, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, type BWList, type Brand, Browser, BrowserAgent, BrowserContext, BrowserError, type BrowserFingerprint, BrowserFingerprintContext, BrowserFingerprintGenerator, type BrowserOption, BrowserOptionClass, type BrowserProxy, BrowserProxyClass, type BrowserScreen, BrowserUseAgent, type BrowserViewport, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, ClearContextRequest, ClearContextResponse, ClearContextResponseBody, Client, Code, Command, Computer, ComputerUseAgent, type Config, Context, type ContextInfoResult, ContextManager, ContextService, type ContextStatusData, type ContextStatusItem, ContextSync, type ContextSyncResult, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, type CreateSessionParams, type CreateSessionParamsConfig, DeleteContextFileRequest, DeleteContextFileResponse, DeleteContextFileResponseBody, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DeletePolicy, type DeleteResult, DescribeContextFilesRequest, DescribeContextFilesResponse, DescribeContextFilesResponseBody, type DirectoryEntry, type DownloadPolicy, DownloadStrategy, type ExecutionResult, Extension, ExtensionOption, ExtensionsService, type ExtraConfigs, type ExtraProperties, type ExtractOptions, type ExtractPolicy, ExtractPolicyClass, type FileChangeEvent, FileChangeEventHelper, type FileChangeResult, FileChangeResultHelper, FileError, type FileInfo, FileSystem, type Fingerprint, FingerprintFormat, GetAdbLinkRequest, GetAdbLinkResponse, GetAdbLinkResponseBody, GetAdbLinkResponseBodyData, GetCdpLinkRequest, GetCdpLinkResponse, GetCdpLinkResponseBody, GetCdpLinkResponseBodyData, GetContextFileDownloadUrlRequest, GetContextFileDownloadUrlResponse, GetContextFileDownloadUrlResponseBody, GetContextFileUploadUrlRequest, GetContextFileUploadUrlResponse, GetContextFileUploadUrlResponseBody, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, GetSessionRequest, GetSessionResponse, GetSessionResponseBody, GetSessionResponseBodyData, HIDE_NAVIGATION_BAR_TEMPLATE, IS_RELEASE, InitBrowserRequest, InitBrowserResponse, InitBrowserResponseBody, InitBrowserResponseBodyData, type InitializationResult, Lifecycle, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, type LogLevel, type LoggerConfig, MOBILE_COMMAND_TEMPLATES, type MappingPolicy, type McpSession, type McpToolResult, Mobile, type MobileExtraConfig, type MobileSimulateConfig, MobileSimulateMode, MobileSimulateService, type MobileSimulateUploadResult, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, type NavigatorFingerprint, type ObserveOptions, ObserveResult, Oss, OssError, PauseSessionAsyncRequest, PauseSessionAsyncResponse, PauseSessionAsyncResponseBody, type QueryResult, RESOLUTION_LOCK_TEMPLATE, type RecyclePolicy, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, ResumeSessionAsyncRequest, ResumeSessionAsyncResponse, ResumeSessionAsyncResponseBody, SHOW_NAVIGATION_BAR_TEMPLATE, type ScreenFingerprint, Session, SessionError, type SessionInterface, type SessionListResult, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, type SyncCallback, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, type SyncPolicy, SyncPolicyImpl, UNINSTALL_BLACKLIST_TEMPLATE, UploadMode, type UploadPolicy, UploadStrategy, type UserAgentData, VERSION, type VideoCard, type WhiteList, WhiteListValidator, createListSessionParams, extraConfigsFromJSON, extraConfigsToJSON, extractRequestId, getLogLevel, getMobileCommandTemplate, hasMobileCommandTemplate, log, logDebug, logError, logInfo, logWarn, newContextManager, newContextSync, newCreateSessionParams, newDeletePolicy, newDownloadPolicy, newExtractPolicy, newMappingPolicy, newRecyclePolicy, newSyncPolicy, newSyncPolicyWithDefaults, newUploadPolicy, replaceTemplatePlaceholders, setLogLevel, setupLogger, validateAppManagerRule, validateExtraConfigs, validateMobileExtraConfig, validateMobileSimulateConfig };
package/dist/index.d.ts CHANGED
@@ -3128,18 +3128,31 @@ declare function newContextSync(contextId: string, path: string, policy?: SyncPo
3128
3128
  * Result of task execution.
3129
3129
  */
3130
3130
  interface ExecutionResult extends ApiResponse {
3131
- success: boolean;
3132
- errorMessage: string;
3133
3131
  taskId: string;
3134
3132
  taskStatus: string;
3133
+ taskResult: string;
3135
3134
  }
3136
3135
  /**
3137
3136
  * Result of query operations.
3138
3137
  */
3139
3138
  interface QueryResult extends ApiResponse {
3139
+ taskStatus: string;
3140
+ taskAction: string;
3141
+ taskProduct: string;
3142
+ }
3143
+ /**
3144
+ * Result of agent initialization.
3145
+ */
3146
+ interface InitializationResult extends ApiResponse {
3140
3147
  success: boolean;
3141
- output: string;
3142
- errorMessage: string;
3148
+ }
3149
+ /**
3150
+ * Options for Agent initialization.
3151
+
3152
+ */
3153
+ interface AgentOptions {
3154
+ use_vision: boolean;
3155
+ output_schema: '';
3143
3156
  }
3144
3157
  /**
3145
3158
  * Result of an MCP tool call.
@@ -3159,12 +3172,12 @@ interface McpSession {
3159
3172
  callMcpTool(toolName: string, args: any): Promise<McpToolResult>;
3160
3173
  }
3161
3174
  /**
3162
- * An Agent to manipulate applications to complete specific tasks.
3175
+ * An Agent to perform tasks on the computer.
3163
3176
  */
3164
- declare class Agent {
3177
+ declare class ComputerUseAgent {
3165
3178
  private session;
3166
3179
  /**
3167
- * Initialize an Agent object.
3180
+ * Initialize an Computer Agent object.
3168
3181
  *
3169
3182
  * @param session - The Session instance that this Agent belongs to.
3170
3183
  */
@@ -3174,16 +3187,17 @@ declare class Agent {
3174
3187
  *
3175
3188
  * @param task - Task description in human language.
3176
3189
  * @param maxTryTimes - Maximum number of retry attempts.
3177
- * @returns ExecutionResult containing success status, task output, and error message if any.
3190
+ * @returns ExecutionResult containing success status, task output, and error
3191
+ * message if any.
3178
3192
  *
3179
3193
  * @example
3180
3194
  * ```typescript
3181
3195
  * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3182
3196
  * const result = await agentBay.create({ imageId: 'windows_latest' });
3183
3197
  * if (result.success) {
3184
- * const taskResult = await result.session.agent.executeTask('Open notepad', 10);
3185
- * console.log(`Task status: ${taskResult.taskStatus}`);
3186
- * await result.session.delete();
3198
+ * const taskResult = await result.session.agent.computer.executeTask('Open
3199
+ * notepad', 10); console.log(`Task status: ${taskResult.taskStatus}`); await
3200
+ * result.session.delete();
3187
3201
  * }
3188
3202
  * ```
3189
3203
  */
@@ -3199,27 +3213,125 @@ declare class Agent {
3199
3213
  * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3200
3214
  * const result = await agentBay.create({ imageId: 'windows_latest' });
3201
3215
  * if (result.success) {
3202
- * const taskResult = await result.session.agent.executeTask('Open calculator', 10);
3203
- * const statusResult = await result.session.agent.getTaskStatus(taskResult.taskId);
3204
- * console.log(`Status: ${JSON.parse(statusResult.output).status}`);
3216
+ * const taskResult = await result.session.agent.computer.executeTask('Open
3217
+ * calculator', 10); const statusResult = await
3218
+ * result.session.agent.computer.getTaskStatus(taskResult.taskId);
3219
+ * console.log(`Status:
3220
+ * ${JSON.parse(statusResult.output).status}`); await result.session.delete();
3221
+ * }
3222
+ * ```
3223
+ */
3224
+ getTaskStatus(taskId: string): Promise<QueryResult>;
3225
+ /**
3226
+ * Terminate a task with a specified task ID.
3227
+ *
3228
+ * @param taskId - The ID of the running task.
3229
+ * @returns ExecutionResult containing success status, task output, and
3230
+ * error message if any.
3231
+ *
3232
+ * @example
3233
+ * ```typescript
3234
+ * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3235
+ * const result = await agentBay.create({ imageId: 'windows_latest' });
3236
+ * if (result.success) {
3237
+ * const taskResult = await
3238
+ * result.session.agent.computer.executeTask('Open notepad', 5); const
3239
+ * terminateResult = await
3240
+ * result.session.agent.computer.terminateTask(taskResult.taskId);
3241
+ * console.log(`Terminated: ${terminateResult.taskStatus}`);
3205
3242
  * await result.session.delete();
3206
3243
  * }
3207
3244
  * ```
3208
3245
  */
3246
+ terminateTask(taskId: string): Promise<ExecutionResult>;
3247
+ }
3248
+ declare class BrowserUseAgent {
3249
+ private session;
3250
+ /**
3251
+ * Initialize an Browser Agent object.
3252
+ * @description Browser Use Agent is in BETA ⚠️ .
3253
+ *
3254
+ * @param session - The Session instance that this Agent belongs to.
3255
+ */
3256
+ constructor(session: McpSession);
3257
+ /**
3258
+ * Initialize the browser agent with specific options.
3259
+ * @param options - agent initialization options
3260
+ * @returns InitializationResult containing success status, task output,
3261
+ * and error message if any.
3262
+ *
3263
+ * @example
3264
+ * ```typescript
3265
+ * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3266
+ * const result = await agentBay.create({ imageId: 'linux_latest' });
3267
+ * if (result.success) {
3268
+ * options:AgentOptions = new AgentOptions(use_vision=False,
3269
+ * output_schema=""); const initResult = await
3270
+ * result.session.agent.browser.initialize(options); console.log(`Initialize
3271
+ * success: ${initResult.success}`); await result.session.delete();
3272
+ * }
3273
+ * ```
3274
+ */
3275
+ initialize(options: AgentOptions): Promise<InitializationResult>;
3276
+ /**
3277
+ * Execute a specific task described in human language.
3278
+ *
3279
+ * @param task - Task description in human language.
3280
+ * @param maxTryTimes - Maximum number of retry attempts.
3281
+ * @returns ExecutionResult containing success status, task output, and
3282
+ * error message if any.
3283
+ *
3284
+ * @example
3285
+ * ```typescript
3286
+ * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3287
+ * const result = await agentBay.create({ imageId: 'linux_latest' });
3288
+ * if (result.success) {
3289
+ * const taskResult = await
3290
+ * result.session.agent.browser.executeTask('Navigate to baidu and query the
3291
+ * weather of Shanghai', 10); console.log(`Task status:
3292
+ * ${taskResult.taskStatus}`); await result.session.delete();
3293
+ * }
3294
+ * ```
3295
+ */
3296
+ executeTask(task: string, maxTryTimes: number): Promise<ExecutionResult>;
3297
+ /**
3298
+ * Get the status of the task with the given task ID.
3299
+ *
3300
+ * @param taskId - Task ID
3301
+ * @returns QueryResult containing the task status
3302
+ *
3303
+ * @example
3304
+ * ```typescript
3305
+ * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3306
+ * const result = await agentBay.create({ imageId: 'windows_latest' });
3307
+ * if (result.success) {
3308
+ * const taskResult = await
3309
+ * result.session.agent.browser.executeTask(Navigate to baidu and query the
3310
+ * weather of Shanghai, 10); const statusResult = await
3311
+ * result.session.agent.browser.getTaskStatus(taskResult.taskId);
3312
+ * console.log(`Status:
3313
+ * ${JSON.parse(statusResult.output).status}`); await
3314
+ * result.session.delete();
3315
+ * }
3316
+ * ```
3317
+ */
3209
3318
  getTaskStatus(taskId: string): Promise<QueryResult>;
3210
3319
  /**
3211
3320
  * Terminate a task with a specified task ID.
3212
3321
  *
3213
3322
  * @param taskId - The ID of the running task.
3214
- * @returns ExecutionResult containing success status, task output, and error message if any.
3323
+ * @returns ExecutionResult containing success status, task output, and
3324
+ * error message if any.
3215
3325
  *
3216
3326
  * @example
3217
3327
  * ```typescript
3218
3328
  * const agentBay = new AgentBay({ apiKey: 'your_api_key' });
3219
3329
  * const result = await agentBay.create({ imageId: 'windows_latest' });
3220
3330
  * if (result.success) {
3221
- * const taskResult = await result.session.agent.executeTask('Open notepad', 5);
3222
- * const terminateResult = await result.session.agent.terminateTask(taskResult.taskId);
3331
+ * const taskResult = await
3332
+ * result.session.agent.browser.executeTask(Navigate to baidu and query the
3333
+ * weather of Shanghai, 10); const terminateResult = await
3334
+ * result.session.agent.browser.terminateTask(taskResult.taskId);
3223
3335
  * console.log(`Terminated: ${terminateResult.taskStatus}`);
3224
3336
  * await result.session.delete();
3225
3337
  * }
@@ -3227,6 +3339,28 @@ declare class Agent {
3227
3339
  */
3228
3340
  terminateTask(taskId: string): Promise<ExecutionResult>;
3229
3341
  }
3342
+ /**
3343
+ * An Agent to manipulate applications to complete specific tasks.
3344
+ * According to the use scenary, The agent can a browser use agent which is
3345
+ * specialized for browser automation tasks, The agent also can be a computer
3346
+ * use agent which is specialized for multiple applications automation tasks.
3347
+ */
3348
+ declare class Agent {
3349
+ /**
3350
+ * An instance of Computer Use Agent.
3351
+ */
3352
+ computer: ComputerUseAgent;
3353
+ /**
3354
+ * An instance of Browser Use Agent.
3355
+ */
3356
+ browser: BrowserUseAgent;
3357
+ /**
3358
+ * Initialize an Agent object.
3359
+ *
3360
+ * @param session - The Session instance that this Agent belongs to.
3361
+ */
3362
+ constructor(session: McpSession);
3363
+ }
3230
3364
 
3231
3365
  interface ActOptions {
3232
3366
  action: string;
@@ -7110,4 +7244,4 @@ declare function logWarn(message: string, ...args: any[]): void;
7110
7244
  */
7111
7245
  declare function logError(message: string, error?: any): void;
7112
7246
 
7113
- export { APIError, APP_BLACKLIST_TEMPLATE, APP_WHITELIST_TEMPLATE, type ActOptions, ActResult, Agent, AgentBay, AgentBayError, type ApiResponse, type ApiResponseWithData, type AppManagerRule, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, type BWList, type Brand, Browser, BrowserAgent, BrowserContext, BrowserError, type BrowserFingerprint, BrowserFingerprintContext, BrowserFingerprintGenerator, type BrowserOption, BrowserOptionClass, type BrowserProxy, BrowserProxyClass, type BrowserScreen, type BrowserViewport, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, ClearContextRequest, ClearContextResponse, ClearContextResponseBody, Client, Code, Command, Computer, type Config, Context, type ContextInfoResult, ContextManager, ContextService, type ContextStatusData, type ContextStatusItem, ContextSync, type ContextSyncResult, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, type CreateSessionParams, type CreateSessionParamsConfig, DeleteContextFileRequest, DeleteContextFileResponse, DeleteContextFileResponseBody, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DeletePolicy, type DeleteResult, DescribeContextFilesRequest, DescribeContextFilesResponse, DescribeContextFilesResponseBody, type DirectoryEntry, type DownloadPolicy, DownloadStrategy, type ExecutionResult, Extension, ExtensionOption, ExtensionsService, type ExtraConfigs, type ExtraProperties, type ExtractOptions, type ExtractPolicy, ExtractPolicyClass, type FileChangeEvent, FileChangeEventHelper, type FileChangeResult, FileChangeResultHelper, FileError, type FileInfo, FileSystem, type Fingerprint, FingerprintFormat, GetAdbLinkRequest, GetAdbLinkResponse, GetAdbLinkResponseBody, GetAdbLinkResponseBodyData, GetCdpLinkRequest, GetCdpLinkResponse, GetCdpLinkResponseBody, GetCdpLinkResponseBodyData, GetContextFileDownloadUrlRequest, GetContextFileDownloadUrlResponse, GetContextFileDownloadUrlResponseBody, GetContextFileUploadUrlRequest, GetContextFileUploadUrlResponse, GetContextFileUploadUrlResponseBody, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, GetSessionRequest, GetSessionResponse, GetSessionResponseBody, GetSessionResponseBodyData, HIDE_NAVIGATION_BAR_TEMPLATE, IS_RELEASE, InitBrowserRequest, InitBrowserResponse, InitBrowserResponseBody, InitBrowserResponseBodyData, Lifecycle, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, type LogLevel, type LoggerConfig, MOBILE_COMMAND_TEMPLATES, type MappingPolicy, type McpSession, type McpToolResult, Mobile, type MobileExtraConfig, type MobileSimulateConfig, MobileSimulateMode, MobileSimulateService, type MobileSimulateUploadResult, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, type NavigatorFingerprint, type ObserveOptions, ObserveResult, Oss, OssError, PauseSessionAsyncRequest, PauseSessionAsyncResponse, PauseSessionAsyncResponseBody, type QueryResult, RESOLUTION_LOCK_TEMPLATE, type RecyclePolicy, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, ResumeSessionAsyncRequest, ResumeSessionAsyncResponse, ResumeSessionAsyncResponseBody, SHOW_NAVIGATION_BAR_TEMPLATE, type ScreenFingerprint, Session, SessionError, type SessionInterface, type SessionListResult, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, type SyncCallback, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, type SyncPolicy, SyncPolicyImpl, UNINSTALL_BLACKLIST_TEMPLATE, UploadMode, type UploadPolicy, UploadStrategy, type UserAgentData, VERSION, type VideoCard, type WhiteList, WhiteListValidator, createListSessionParams, extraConfigsFromJSON, extraConfigsToJSON, extractRequestId, getLogLevel, getMobileCommandTemplate, hasMobileCommandTemplate, log, logDebug, logError, logInfo, logWarn, newContextManager, newContextSync, newCreateSessionParams, newDeletePolicy, newDownloadPolicy, newExtractPolicy, newMappingPolicy, newRecyclePolicy, newSyncPolicy, newSyncPolicyWithDefaults, newUploadPolicy, replaceTemplatePlaceholders, setLogLevel, setupLogger, validateAppManagerRule, validateExtraConfigs, validateMobileExtraConfig, validateMobileSimulateConfig };
7247
+ export { APIError, APP_BLACKLIST_TEMPLATE, APP_WHITELIST_TEMPLATE, type ActOptions, ActResult, Agent, AgentBay, AgentBayError, type AgentOptions, type ApiResponse, type ApiResponseWithData, type AppManagerRule, ApplyMqttTokenRequest, ApplyMqttTokenResponse, ApplyMqttTokenResponseBody, ApplyMqttTokenResponseBodyData, AuthenticationError, type BWList, type Brand, Browser, BrowserAgent, BrowserContext, BrowserError, type BrowserFingerprint, BrowserFingerprintContext, BrowserFingerprintGenerator, type BrowserOption, BrowserOptionClass, type BrowserProxy, BrowserProxyClass, type BrowserScreen, BrowserUseAgent, type BrowserViewport, CallMcpToolRequest, CallMcpToolResponse, CallMcpToolResponseBody, ClearContextRequest, ClearContextResponse, ClearContextResponseBody, Client, Code, Command, Computer, ComputerUseAgent, type Config, Context, type ContextInfoResult, ContextManager, ContextService, type ContextStatusData, type ContextStatusItem, ContextSync, type ContextSyncResult, CreateMcpSessionRequest, CreateMcpSessionRequestPersistenceDataList, CreateMcpSessionResponse, CreateMcpSessionResponseBody, CreateMcpSessionResponseBodyData, CreateMcpSessionShrinkRequest, type CreateSessionParams, type CreateSessionParamsConfig, DeleteContextFileRequest, DeleteContextFileResponse, DeleteContextFileResponseBody, DeleteContextRequest, DeleteContextResponse, DeleteContextResponseBody, type DeletePolicy, type DeleteResult, DescribeContextFilesRequest, DescribeContextFilesResponse, DescribeContextFilesResponseBody, type DirectoryEntry, type DownloadPolicy, DownloadStrategy, type ExecutionResult, Extension, ExtensionOption, ExtensionsService, type ExtraConfigs, type ExtraProperties, type ExtractOptions, type ExtractPolicy, ExtractPolicyClass, type FileChangeEvent, FileChangeEventHelper, type FileChangeResult, FileChangeResultHelper, FileError, type FileInfo, FileSystem, type Fingerprint, FingerprintFormat, GetAdbLinkRequest, GetAdbLinkResponse, GetAdbLinkResponseBody, GetAdbLinkResponseBodyData, GetCdpLinkRequest, GetCdpLinkResponse, GetCdpLinkResponseBody, GetCdpLinkResponseBodyData, GetContextFileDownloadUrlRequest, GetContextFileDownloadUrlResponse, GetContextFileDownloadUrlResponseBody, GetContextFileUploadUrlRequest, GetContextFileUploadUrlResponse, GetContextFileUploadUrlResponseBody, GetContextInfoRequest, GetContextInfoResponse, GetContextInfoResponseBody, GetContextInfoResponseBodyData, GetContextRequest, GetContextResponse, GetContextResponseBody, GetContextResponseBodyData, GetLabelRequest, GetLabelResponse, GetLabelResponseBody, GetLabelResponseBodyData, GetLinkRequest, GetLinkResponse, GetLinkResponseBody, GetLinkResponseBodyData, GetMcpResourceRequest, GetMcpResourceResponse, GetMcpResourceResponseBody, GetMcpResourceResponseBodyData, GetMcpResourceResponseBodyDataDesktopInfo, GetSessionRequest, GetSessionResponse, GetSessionResponseBody, GetSessionResponseBodyData, HIDE_NAVIGATION_BAR_TEMPLATE, IS_RELEASE, InitBrowserRequest, InitBrowserResponse, InitBrowserResponseBody, InitBrowserResponseBodyData, type InitializationResult, Lifecycle, ListContextsRequest, ListContextsResponse, ListContextsResponseBody, ListContextsResponseBodyData, ListMcpToolsRequest, ListMcpToolsResponse, ListMcpToolsResponseBody, type ListSessionParams, ListSessionRequest, ListSessionResponse, ListSessionResponseBody, ListSessionResponseBodyData, type LogLevel, type LoggerConfig, MOBILE_COMMAND_TEMPLATES, type MappingPolicy, type McpSession, type McpToolResult, Mobile, type MobileExtraConfig, type MobileSimulateConfig, MobileSimulateMode, MobileSimulateService, type MobileSimulateUploadResult, ModifyContextRequest, ModifyContextResponse, ModifyContextResponseBody, type NavigatorFingerprint, type ObserveOptions, ObserveResult, Oss, OssError, PauseSessionAsyncRequest, PauseSessionAsyncResponse, PauseSessionAsyncResponseBody, type QueryResult, RESOLUTION_LOCK_TEMPLATE, type RecyclePolicy, ReleaseMcpSessionRequest, ReleaseMcpSessionResponse, ReleaseMcpSessionResponseBody, ResumeSessionAsyncRequest, ResumeSessionAsyncResponse, ResumeSessionAsyncResponseBody, SHOW_NAVIGATION_BAR_TEMPLATE, type ScreenFingerprint, Session, SessionError, type SessionInterface, type SessionListResult, SetLabelRequest, SetLabelResponse, SetLabelResponseBody, type SyncCallback, SyncContextRequest, SyncContextResponse, SyncContextResponseBody, type SyncPolicy, SyncPolicyImpl, UNINSTALL_BLACKLIST_TEMPLATE, UploadMode, type UploadPolicy, UploadStrategy, type UserAgentData, VERSION, type VideoCard, type WhiteList, WhiteListValidator, createListSessionParams, extraConfigsFromJSON, extraConfigsToJSON, extractRequestId, getLogLevel, getMobileCommandTemplate, hasMobileCommandTemplate, log, logDebug, logError, logInfo, logWarn, newContextManager, newContextSync, newCreateSessionParams, newDeletePolicy, newDownloadPolicy, newExtractPolicy, newMappingPolicy, newRecyclePolicy, newSyncPolicy, newSyncPolicyWithDefaults, newUploadPolicy, replaceTemplatePlaceholders, setLogLevel, setupLogger, validateAppManagerRule, validateExtraConfigs, validateMobileExtraConfig, validateMobileSimulateConfig };