AS AgentScopeAPI 手册 / API Reference

StudioClient

public class StudioClient
源码Source io/agentscope/core/studio/StudioClient.java:50–246

Studio 客户端,封装与远端服务的连接和调用。位于 io.agentscope.core.studio 包。核心成员包括 registerRun、pushMessage、requestUserInput、shutdown、StudioClient。

HTTP client for communicating with AgentScope Studio.

This client handles HTTP requests to Studio's REST API endpoints using OkHttp. It provides methods for registering runs, pushing messages, and requesting user input. All operations are reactive and return Mono types for integration with Project Reactor.

The client includes automatic retry logic for failed requests (configurable via StudioConfig).

构造器摘要Constructor Summary

构造器Constructor说明Description
public StudioClient(StudioConfig config)
初始化 `StudioClient` 实例。
Creates a new Studio HTTP client.

方法摘要Method Summary

方法Method说明Description
public Mono<Void> registerRun()
注册运行。
Registers a new run with Studio.
public Mono<Void> pushMessage(Msg msg)
设置推送消息。
Pushes a message to Studio for visualization.
public Mono<String> requestUserInput(String agentId, String agentName, Object structuredSchema)
执行请求用户输入相关操作。
Requests user input from Studio web interface.
public void shutdown()
关闭资源并释放连接。
Shuts down the HTTP client and releases resources.

构造器详情Constructor Detail

StudioClient

public StudioClient(StudioConfig config)

初始化 StudioClient 实例。

Creates a new Studio HTTP client.

参数Parameters
名称Name类型Type说明Description
configStudioConfig配置对象(类型 `StudioConfig`)。Configuration for Studio connection
源码Source io/agentscope/core/studio/StudioClient.java:67–77

方法详情Method Detail

registerRun

public Mono<Void> registerRun()

注册运行。

Registers a new run with Studio.

返回Returns Mono<Void>
返回Mono。A Mono that completes when registration succeeds
源码Source io/agentscope/core/studio/StudioClient.java:89–121

pushMessage

public Mono<Void> pushMessage(Msg msg)

设置推送消息。

Pushes a message to Studio for visualization.

参数Parameters
名称Name类型Type说明Description
msgMsg消息到推送。The message to push
返回Returns Mono<Void>
返回Mono。A Mono that completes when the message is successfully pushed
源码Source io/agentscope/core/studio/StudioClient.java:134–166

requestUserInput

public Mono<String> requestUserInput(String agentId, String agentName, Object structuredSchema)

执行请求用户输入相关操作。

Requests user input from Studio web interface.

参数Parameters
名称Name类型Type说明Description
agentIdString智能体标识(类型 `String`)。ID of the agent requesting input
agentNameString智能体名称(类型 `String`)。Name of the agent requesting input
structuredSchemaObject用于结构化输入的可选 JSON 模式。Optional JSON schema for structured input
返回Returns Mono<String>
返回Mono。A Mono containing the request ID (used to match WebSocket response)
源码Source io/agentscope/core/studio/StudioClient.java:181–214

shutdown

public void shutdown()

关闭资源并释放连接。

Shuts down the HTTP client and releases resources.

源码Source io/agentscope/core/studio/StudioClient.java:219–222
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.