类class io.agentscope.runtime.app legacy

AgentApp

public class AgentApp

源码Source io/agentscope/runtime/app/AgentApp.java:81–616

智能体应用，承载智能体的部署、调度与服务化运行。位于 io.agentscope.runtime.app 包。核心成员包括 endpointPath、host、port、stream、responseType、deployManager。

AgentApp class represents an application that runs as an agent.

This class serves as the server startup entry point for starting Spring Boot Server, assembling configuration and components (Controller/Endpoint, etc.), and initializing Runner (which proxies AgentAdapter).

Key responsibilities:

Initialize Runner with AgentAdapter
Start Spring Boot Server via DeployManager
Manage application lifecycle
Configure endpoints and protocols

Usage example:

`AgentAdapter adapter = new AgentScopeAgentAdapter(...);
AgentApp app = new AgentApp(adapter);
app.deployManager(localDeployManager);
app.run("0.0.0.0", 8090);
`

嵌套类摘要Nested Class Summary

类Class	类型Kind	说明Description
`EndpointInfo`	类class	端点信息，承载智能体的部署、调度与服务化运行。 Endpoint information.
`ComponentProvider`	接口interface	定义 Component 提供者契约的接口。 An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents.
`StateServiceProvider`	接口interface	定义状态服务提供者契约的接口。 An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents.
`SessionHistoryServiceProvider`	接口interface	定义会话历史服务提供者契约的接口。 An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents.
`MemoryServiceProvider`	接口interface	定义记忆服务提供者契约的接口。 An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents.
`SandboxServiceProvider`	接口interface	定义沙箱服务提供者契约的接口。 An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents.
`AgentHandlerProvider`	接口interface	定义智能体处理器提供者契约的接口。 An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents.
`ServiceComponentManager`	类class	服务 Component 管理器，承载智能体的部署、调度与服务化运行。 A class in io.agentscope.runtime.app that deploys, schedules and serves agents.

构造器摘要Constructor Summary

构造器Constructor	说明Description
`public` `AgentApp(String[] args)`	初始化 `AgentApp` 实例。 Constructor with command line arguments
`public` `AgentApp(AgentHandler adapter)`	初始化 `AgentApp` 实例。 Constructor with AgentAdapter and Celery configuration.

方法摘要Method Summary

方法Method	说明Description
`public` `AgentApp endpointPath(String endpointPath)`	设置端点路径用于智能体服务。 Set the endpoint path for the agent service.
`public` `AgentApp host(String host)`	设置该参数。 Set the host address to bind to.
`public` `AgentApp port(int port)`	设置该参数。 Set the port number to serve on.
`public` `AgentApp stream(boolean stream)`	设置流。 Set whether to enable streaming responses.
`public` `AgentApp responseType(String responseType)`	设置响应类型。 Set the response type.
`public` `AgentApp deployManager(DeployManager deployManager)`	设置DeployManager 到使用用于部署。 Set the DeployManager to use for deployment.
`public` `AgentApp cors(Consumer<CorsRegistry> corsConfigurer)`	设置该参数。 Configure Cross-Origin Resource Sharing (CORS).
`public synchronized` `AgentApp buildRunner()` synchronized	构建运行器。 Build the Runner instance by proxying the AgentAdapter.
`public` `Runner getRunner()`	获取运行器实例。 Get the Runner instance.
`public` `AgentApp query(String framework, Function<Map<String, Object>, Object> handler)`	执行查询相关操作。 Register a query handler with optional framework type.
`public` `AgentApp query(java.util.function.Function<Map<String, Object>, Object> handler)`	设置查询。 Register a query handler with default framework type ("agentscope").
`public void run()`	执行运行相关操作。 Run the application by starting the Spring Boot Server.
`public void run(int port)`	设置运行。 Performs the run operation.
`public void run(String host, int port)`	执行运行相关操作。 Run the application with specified host and port.
`public` `AgentApp endpoint(String path, List<String> methods, Function<Map<String, Object>, Object> handler)`	执行端点相关操作。 Register custom endpoint.
`public String getEndpointPath()`	获取端点路径。 Returns the endpoint path.
`public void setEndpointPath(String endpointPath)`	设置端点路径。 Sets the endpoint path.
`public String getHost()`	获取 `getHost`。 Returns the host.
`public int getPort()`	获取 `getPort`。 Returns the port.
`public String getResponseType()`	获取响应类型。 Returns the response type.
`public void setResponseType(String responseType)`	设置响应类型。 Sets the response type.
`public boolean isStream()`	判断是否流。 Returns whether the stream.
`public void setStream(boolean stream)`	设置流。 Sets the stream.
`public List<EndpointInfo> getCustomEndpoints()`	获取 `getCustomEndpoints`。 Returns the custom endpoints.
`protected int port(Object value, int defaultValue)`	执行 `port` 方法。 Performs the port operation.

构造器详情Constructor Detail

AgentApp

public AgentApp(String[] args)

初始化 AgentApp 实例。

Constructor with command line arguments

参数Parameters

名称Name	类型Type	说明Description
`args`	String[]	参数（类型 `String[]`）。Command line arguments

源码Source io/agentscope/runtime/app/AgentApp.java:115–174

AgentApp

public AgentApp(AgentHandler adapter)

初始化 AgentApp 实例。

Constructor with AgentAdapter and Celery configuration.

参数Parameters

名称Name	类型Type	说明Description
`adapter`	AgentHandler	AgentAdapter 实例到使用。the AgentAdapter instance to use

源码Source io/agentscope/runtime/app/AgentApp.java:244–253

方法详情Method Detail

endpointPath

public AgentApp endpointPath(String endpointPath)

设置端点路径用于智能体服务。

Set the endpoint path for the agent service.

参数Parameters

名称Name	类型Type	说明Description
`endpointPath`	String	端点路径（类型 `String`）。the endpoint path (default: "/process")

返回Returns AgentApp

返回AgentApp。this AgentApp instance for method chaining

源码Source io/agentscope/runtime/app/AgentApp.java:261–264

host

public AgentApp host(String host)

设置该参数。

Set the host address to bind to.

参数Parameters

名称Name	类型Type	说明Description
`host`	String	host（类型 `String`）。the host address (default: "0.0.0.0")

返回Returns AgentApp

返回AgentApp。this AgentApp instance for method chaining

源码Source io/agentscope/runtime/app/AgentApp.java:272–275

port

public AgentApp port(int port)

设置该参数。

Set the port number to serve on.

参数Parameters

名称Name	类型Type	说明Description
`port`	int	port（类型 `int`）。the port number (default: 8090)

返回Returns AgentApp

返回AgentApp。this AgentApp instance for method chaining

源码Source io/agentscope/runtime/app/AgentApp.java:283–286

stream

public AgentApp stream(boolean stream)

设置流。

Set whether to enable streaming responses.

参数Parameters

名称Name	类型Type	说明Description
`stream`	boolean	流（类型 `boolean`）。true to enable streaming (default: true)

返回Returns AgentApp

返回AgentApp。this AgentApp instance for method chaining

源码Source io/agentscope/runtime/app/AgentApp.java:294–297

responseType

public AgentApp responseType(String responseType)

设置响应类型。

Set the response type.

参数Parameters

名称Name	类型Type	说明Description
`responseType`	String	响应类型:"SSE","JSON",或"文本"(默认:"SSE")。the response type: "sse", "json", or "text" (default: "sse")

返回Returns AgentApp

返回AgentApp。this AgentApp instance for method chaining

源码Source io/agentscope/runtime/app/AgentApp.java:305–308

deployManager

public AgentApp deployManager(DeployManager deployManager)

设置DeployManager 到使用用于部署。

Set the DeployManager to use for deployment.

参数Parameters

名称Name	类型Type	说明Description
`deployManager`	DeployManager	DeployManager 实例。the DeployManager instance

返回Returns AgentApp

返回AgentApp。this AgentApp instance for method chaining

源码Source io/agentscope/runtime/app/AgentApp.java:316–319

cors

public AgentApp cors(Consumer<CorsRegistry> corsConfigurer)

设置该参数。

Configure Cross-Origin Resource Sharing (CORS).

参数Parameters

名称Name	类型Type	说明Description
`corsConfigurer`	Consumer<CorsRegistry>	cors Configurer（类型 `Consumer`）。consumer to customize `CorsRegistry`

返回Returns AgentApp

返回AgentApp。this AgentApp instance for method chaining

源码Source io/agentscope/runtime/app/AgentApp.java:335–338

buildRunner

public synchronized AgentApp buildRunner()

synchronized

构建运行器。

Build the Runner instance by proxying the AgentAdapter.

返回Returns AgentApp

返回AgentApp。this AgentApp instance for method chaining

源码Source io/agentscope/runtime/app/AgentApp.java:347–353

getRunner

public Runner getRunner()

获取运行器实例。

Get the Runner instance.

返回Returns Runner

返回运行器。the Runner instance, or null if not built yet

源码Source io/agentscope/runtime/app/AgentApp.java:360–362

query

public AgentApp query(String framework, Function<Map<String, Object>, Object> handler)

执行查询相关操作。

参数Parameters

名称Name	类型Type	说明Description
`framework`	String	framework（类型 `String`）。the framework type (must be one of: agentscope, saa, langchain4j)
`handler`	Function<Map<String, Object>, Object>	处理器（类型 `Function , Object>`）。the query handler function that takes a request map and returns a response

返回Returns AgentApp

返回AgentApp。this AgentApp instance for method chaining

抛出Throws

IllegalArgumentException 可能抛出 `IllegalArgumentException`。if framework type is not supported

源码Source io/agentscope/runtime/app/AgentApp.java:386–400

query

public AgentApp query(java.util.function.Function<Map<String, Object>, Object> handler)

设置查询。

参数Parameters

名称Name	类型Type	说明Description
`handler`	java.util.function.Function<Map<String, Object>, Object>	查询处理器函数。the query handler function

返回Returns AgentApp

返回AgentApp。this AgentApp instance for method chaining

源码Source io/agentscope/runtime/app/AgentApp.java:408–410

run

public void run()

执行运行相关操作。

Run the application by starting the Spring Boot Server.

返回Returns

无返回值。a CompletableFuture that completes when the server is running

抛出Throws

IllegalStateException 当if DeployManager是不设置时抛出 `IllegalStateException`。if DeployManager is not set

源码Source io/agentscope/runtime/app/AgentApp.java:424–426

run

public void run(int port)

设置运行。

Performs the run operation.

参数Parameters

名称Name	类型Type	说明Description
`port`	int	port（类型 `int`）。The port.

源码Source io/agentscope/runtime/app/AgentApp.java:428–430

run

public void run(String host, int port)

执行运行相关操作。

Run the application with specified host and port.

参数Parameters

名称Name	类型Type	说明Description
`host`	String	host（类型 `String`）。the host address to bind to
`port`	int	port（类型 `int`）。the port number to serve on

返回Returns

无返回值。a CompletableFuture that completes when the server is running

抛出Throws

IllegalStateException 当if DeployManager是不设置时抛出 `IllegalStateException`。if DeployManager is not set

源码Source io/agentscope/runtime/app/AgentApp.java:440–457

endpoint

public AgentApp endpoint(String path, List<String> methods, Function<Map<String, Object>, Object> handler)

执行端点相关操作。

参数Parameters

名称Name	类型Type	说明Description
`path`	String	路径（类型 `String`）。The path.
`methods`	List<String>	methods（类型 `List`）。The methods.
`handler`	Function<Map<String, Object>, Object>	处理器（类型 `Function , Object>`）。The handler.

返回Returns AgentApp

返回AgentApp。Returns agent app.

源码Source io/agentscope/runtime/app/AgentApp.java:462–474

getEndpointPath

public String getEndpointPath()

获取端点路径。

Returns the endpoint path.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/runtime/app/AgentApp.java:477–479

setEndpointPath

public void setEndpointPath(String endpointPath)

设置端点路径。

Sets the endpoint path.

参数Parameters

名称Name	类型Type	说明Description
`endpointPath`	String	端点路径（类型 `String`）。The endpoint path.

源码Source io/agentscope/runtime/app/AgentApp.java:481–483

getHost

public String getHost()

获取 getHost。

Returns the host.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/runtime/app/AgentApp.java:485–487

getPort

public int getPort()

获取 getPort。

Returns the port.

返回Returns int

返回数值结果。Returns a numeric result.

源码Source io/agentscope/runtime/app/AgentApp.java:489–491

getResponseType

public String getResponseType()

获取响应类型。

Returns the response type.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/runtime/app/AgentApp.java:493–495

setResponseType

public void setResponseType(String responseType)

设置响应类型。

Sets the response type.

参数Parameters

名称Name	类型Type	说明Description
`responseType`	String	响应类型（类型 `String`）。The response type.

源码Source io/agentscope/runtime/app/AgentApp.java:497–499

isStream

public boolean isStream()

判断是否流。

Returns whether the stream.

返回Returns boolean

返回布尔值，表示判断结果。Returns a boolean result.

源码Source io/agentscope/runtime/app/AgentApp.java:501–503

setStream

public void setStream(boolean stream)

设置流。

Sets the stream.

参数Parameters

名称Name	类型Type	说明Description
`stream`	boolean	流（类型 `boolean`）。The stream.

源码Source io/agentscope/runtime/app/AgentApp.java:505–507

getCustomEndpoints

public List<EndpointInfo> getCustomEndpoints()

获取 getCustomEndpoints。

Returns the custom endpoints.

返回Returns List<EndpointInfo>

返回列出。Returns list.

源码Source io/agentscope/runtime/app/AgentApp.java:509–511

port

protected int port(Object value, int defaultValue)

执行 port 方法。

Performs the port operation.

参数Parameters

名称Name	类型Type	说明Description
`value`	Object	值（类型 `Object`）。The value.
`defaultValue`	int	默认值（类型 `int`）。The default value.

返回Returns int

返回数值结果。Returns a numeric result.

源码Source io/agentscope/runtime/app/AgentApp.java:527–533

嵌套类详情Nested Class Detail

EndpointInfo

public static class EndpointInfo

端点信息，承载智能体的部署、调度与服务化运行。位于 io.agentscope.runtime.app 包。核心成员包括 path、handler、methods。

Endpoint information.

ComponentProvider

public interface ComponentProvider<T>

定义 Component 提供者契约的接口。位于 io.agentscope.runtime.app 包。核心成员包括 get。

An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents. Declared in io.agentscope.runtime.app.

StateServiceProvider

@FunctionalInterface public interface StateServiceProvider extends ComponentProvider<StateService>

定义状态服务提供者契约的接口。位于 io.agentscope.runtime.app 包，实现 ComponentProvider<StateService>。核心成员包括 get。

An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents. Declared in io.agentscope.runtime.app. Implements ComponentProvider.

SessionHistoryServiceProvider

@FunctionalInterface public interface SessionHistoryServiceProvider extends ComponentProvider<SessionHistoryService>

定义会话历史服务提供者契约的接口。位于 io.agentscope.runtime.app 包，实现 ComponentProvider<SessionHistoryService>。核心成员包括 get。

An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents. Declared in io.agentscope.runtime.app. Implements ComponentProvider.

MemoryServiceProvider

@FunctionalInterface public interface MemoryServiceProvider extends ComponentProvider<MemoryService>

定义记忆服务提供者契约的接口。位于 io.agentscope.runtime.app 包，实现 ComponentProvider<MemoryService>。核心成员包括 get。

An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents. Declared in io.agentscope.runtime.app. Implements ComponentProvider.

SandboxServiceProvider

@FunctionalInterface public interface SandboxServiceProvider extends ComponentProvider<SandboxService>

定义沙箱服务提供者契约的接口。位于 io.agentscope.runtime.app 包，实现 ComponentProvider<SandboxService>。核心成员包括 get。

An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents. Declared in io.agentscope.runtime.app. Implements ComponentProvider.

AgentHandlerProvider

@FunctionalInterface public interface AgentHandlerProvider

定义智能体处理器提供者契约的接口。位于 io.agentscope.runtime.app 包。核心成员包括 get。

An interface in io.agentscope.runtime.app that defines the contract for components that deploys, schedules and serves agents. Declared in io.agentscope.runtime.app.

ServiceComponentManager

public static class ServiceComponentManager

服务 Component 管理器，承载智能体的部署、调度与服务化运行。位于 io.agentscope.runtime.app 包。核心成员包括 getStateService、setStateService、getSessionHistoryService、setSessionHistoryService、getMemoryService、setMemoryService。

A class in io.agentscope.runtime.app that deploys, schedules and serves agents. Declared in io.agentscope.runtime.app.