agentscope.server.servicer module

Server of distributed agent

class agentscope.server.servicer.AgentServerServicer(stop_event: Event, host: str = 'localhost', port: int | None = None, server_id: str | None = None, studio_url: str | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 7200)[source]

Bases: RpcAgentServicer

A Servicer for RPC Agent Server (formerly RpcServerSideWrapper)

__init__(stop_event: Event, host: str = 'localhost', port: int | None = None, server_id: str | None = None, studio_url: str | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 7200)[source]

Init the AgentServerServicer.

Parameters:

  • stop_event (Event) – Event to stop the server.

  • host (str, defaults to “localhost”) – Hostname of the rpc agent server.

  • port (int, defaults to None) – Port of the rpc agent server.

  • server_id (str, defaults to None) – Server id of the rpc agent server.

  • studio_url (str, defaults to None) – URL of the AgentScope Studio.

  • max_pool_size (int, defaults to 8192) – The max number of agent reply messages that the server can accommodate. Note that the oldest message will be deleted after exceeding the pool size.

  • max_timeout_seconds (int, defaults to 7200) – Maximum time for reply messages to be cached in the server. Note that expired messages will be deleted.

get_task_id() → int[source]

Get the auto-increment task id. Each reply call will get a unique task id.

agent_exists(agent_id: str) → bool[source]

Check whether the agent exists.

Parameters:

agent_id (str) – the agent id.

Returns:

whether the agent exists.

Return type:

bool

get_agent(agent_id: str) → AgentBase[source]

Get the agent by agent id.

Parameters:

agent_id (str) – the agent id.

Returns:

the agent.

Return type:

AgentBase

is_alive(request: Empty, context: ServicerContext) → GeneralResponse[source]

Check whether the server is alive.

stop(request: Empty, context: ServicerContext) → GeneralResponse[source]

Stop the server.

create_agent(request: CreateAgentRequest, context: ServicerContext) → GeneralResponse[source]

Create a new agent on the server.

delete_agent(request: StringMsg, context: ServicerContext) → GeneralResponse[source]

Delete agents from the server.

Parameters:

  • request (StringMsg) – The value field is the agent_id of the

  • deleted. (agents to be)

clone_agent(request: StringMsg, context: ServicerContext) → GeneralResponse[source]

Clone a new agent instance from the origin instance.

Parameters:

  • request (StringMsg) – The value field is the agent_id of the

  • cloned. (agent to be)

Returns:

The agent_id of generated agent. Empty if clone failed.

Return type:

GeneralResponse

delete_all_agents(request: Empty, context: ServicerContext) → GeneralResponse[source]

clear all agent on the server

call_agent_func(request: RpcMsg, context: ServicerContext) → GeneralResponse[source]

Call the specific servicer function.

update_placeholder(request: UpdatePlaceholderRequest, context: ServicerContext) → GeneralResponse[source]

Update the value of a placeholder.

get_agent_list(request: Empty, context: ServicerContext) → GeneralResponse[source]

Get id of all agents on the server as a list.

get_server_info(request: Empty, context: ServicerContext) → GeneralResponse[source]

Get the agent server resource usage information.

set_model_configs(request: StringMsg, context: ServicerContext) → GeneralResponse[source]

Set the model configs of the agent server.

get_agent_memory(request: StringMsg, context: ServicerContext) → StringMsg[source]

Get the memory of a specific agent.

download_file(request: StringMsg, context: ServicerContext) → Any[source]

Download file from local path.