agentscope.rpc package

Submodules

• agentscope.rpc.rpc_agent_client module
  • RpcAgentClient
    • RpcAgentClient.__init__()
    • RpcAgentClient.call_agent_func()
    • RpcAgentClient.is_alive()
    • RpcAgentClient.stop()
    • RpcAgentClient.create_agent()
    • RpcAgentClient.delete_agent()
    • RpcAgentClient.delete_all_agent()
    • RpcAgentClient.clone_agent()
    • RpcAgentClient.update_placeholder()
    • RpcAgentClient.get_agent_list()
    • RpcAgentClient.get_server_info()
    • RpcAgentClient.set_model_configs()
    • RpcAgentClient.get_agent_memory()
    • RpcAgentClient.download_file()
  • ResponseStub
    • ResponseStub.__init__()
    • ResponseStub.set_response()
    • ResponseStub.get_response()
  • call_in_thread()
• agentscope.rpc.rpc_agent_pb2 module
• agentscope.rpc.rpc_agent_pb2_grpc module
  • RpcAgentStub
    • RpcAgentStub.__init__()
  • RpcAgentServicer
    • RpcAgentServicer.is_alive()
    • RpcAgentServicer.stop()
    • RpcAgentServicer.create_agent()
    • RpcAgentServicer.delete_agent()
    • RpcAgentServicer.delete_all_agents()
    • RpcAgentServicer.clone_agent()
    • RpcAgentServicer.get_agent_list()
    • RpcAgentServicer.get_server_info()
    • RpcAgentServicer.set_model_configs()
    • RpcAgentServicer.get_agent_memory()
    • RpcAgentServicer.call_agent_func()
    • RpcAgentServicer.update_placeholder()
    • RpcAgentServicer.download_file()
  • add_RpcAgentServicer_to_server()
  • RpcAgent
    • RpcAgent.is_alive()
    • RpcAgent.stop()
    • RpcAgent.create_agent()
    • RpcAgent.delete_agent()
    • RpcAgent.delete_all_agents()
    • RpcAgent.clone_agent()
    • RpcAgent.get_agent_list()
    • RpcAgent.get_server_info()
    • RpcAgent.set_model_configs()
    • RpcAgent.get_agent_memory()
    • RpcAgent.call_agent_func()
    • RpcAgent.update_placeholder()
    • RpcAgent.download_file()

Module contents

Import all rpc related modules in the package.

class agentscope.rpc.RpcAgentClient(host: str, port: int, agent_id: str | None = None)

Bases: object

A client of Rpc agent server

__init__(host: str, port: int, agent_id: str | None = None) → None

Init a rpc agent client

Parameters:

• host (str) – The hostname of the rpc agent server which the

• connected. (is)

• port (int) – The port of the rpc agent server which the client

• connected.

• agent_id (str) – The agent id of the agent being called.

• None. (Defaults to)

call_agent_func(func_name: str, value: str | None = None, timeout: int = 300) → str

Call the specific function of an agent running on the server.

Parameters:

• func_name (str) – The name of the function being called.

• value (str, optional) – The serialized function input value.

• None. (Defaults to)

• timeout (int, optional) – The timeout for the RPC call in seconds.

• 300. (Defaults to)

Returns:

serialized return data.

Return type:

str

is_alive() → bool

Check if the agent server is alive.

Returns:

Indicate whether the server is alive.

Return type:

bool

stop() → None

Stop the agent server.

create_agent(agent_configs: dict, agent_id: str | None = None) → bool

Create a new agent for this client.

Parameters:

• agent_configs (dict) – Init configs of the agent, generated by

• _AgentMeta.

• agent_id (str) – agent_id of the created agent.

Returns:

Indicate whether the creation is successful

Return type:

bool

delete_agent(agent_id: str | None = None) → bool

Delete agents with the specific agent_id.

Parameters:

agent_id (str) – id of the agent to be deleted.

Returns:

Indicate whether the deletion is successful

Return type:

bool

delete_all_agent() → bool

Delete all agents on the server.

clone_agent(agent_id: str) → str | None

Clone a new agent instance from the origin instance.

Parameters:

agent_id (str) – The agent_id of the agent to be cloned.

Returns:

The agent_id of the generated agent.

Return type:

str

update_placeholder(task_id: int) → str

Update the placeholder value.

Parameters:

task_id (int) – task_id of the PlaceholderMessage.

Returns:

Whether the update is successful. str: Serialized message value.

Return type:

bool

get_agent_list() → Sequence[dict]

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

Returns:

list of agent summary information.

Return type:

Sequence[str]

get_server_info() → dict

Get the agent server resource usage information.

set_model_configs(model_configs: dict | list[dict]) → bool

Set the model configs of the server.

get_agent_memory(agent_id: str) → list[Msg] | Msg

Get the memory usage of the specific agent.

download_file(path: str) → str

Download a file from a remote server to the local machine.

Args: path (str): The path of the file to be downloaded. Note that

it is the path on the remote server.

Returns:

The path of the downloaded file. Note that it is the path on the local machine.

Return type:

str

class agentscope.rpc.ResponseStub

Bases: object

A stub used to save the response of a rpc call in a sub-thread.

__init__() → None

set_response(response: str) → None

Set the message.

get_response() → str

Get the message.

class agentscope.rpc.RpcMsg

Bases: Message, Message

DESCRIPTOR = <google._upb._message.Descriptor object>

class agentscope.rpc.RpcAgentServicer

Bases: object

Servicer for rpc agent server

is_alive(request, context)

check server is alive

stop(request, context)

stop the server

create_agent(request, context)

create a new agent on the server

delete_agent(request, context)

delete agent from the server

delete_all_agents(request, context)

clear all agent on the server

clone_agent(request, context)

clone an agent with specific agent_id

get_agent_list(request, context)

get id of all agents on the server as a list

get_server_info(request, context)

get the resource utilization information of the server

set_model_configs(request, context)

update the model configs in the server

get_agent_memory(request, context)

get memory of a specific agent

call_agent_func(request, context)

call funcs of agent running on the server

update_placeholder(request, context)

update value of PlaceholderMessage

download_file(request, context)

file transfer

class agentscope.rpc.RpcAgentStub(channel)

Bases: object

Servicer for rpc agent server

__init__(channel)

Constructor.

Parameters:

channel – A grpc.Channel.

agentscope.rpc.call_in_thread(client: RpcAgentClient, value: str, func_name: str) → ResponseStub

Call rpc function in a sub-thread.

Parameters:

• client (RpcAgentClient) – The rpc client.

• value (str) – The value of the request.

• func_name (str) – The name of the function being called.

Returns:

A stub to get the response.

Return type:

ResponseStub

agentscope.rpc.add_RpcAgentServicer_to_server(servicer, server)