Source code for agentscope.utils.logging_utils
+ Source code for agentscope.logging
# -*- coding: utf-8 -*-
"""Logging utilities."""
import json
import os
import sys
-from typing import Optional, Literal, Union, Any
+from typing import Optional, Literal, Any
from loguru import logger
-from agentscope.web.studio.utils import (
+from agentscope.studio._client import _studio_client
+from agentscope.web.gradio.utils import (
generate_image_from_name,
send_msg,
get_reset_msg,
@@ -170,20 +171,25 @@ Source code for agentscope.utils.logging_utils
# add chat function for logger
def _chat(
- message: Union[str, dict],
+ message: dict,
*args: Any,
disable_studio: bool = False,
**kwargs: Any,
) -> None:
- """Log a chat message with the format of"<speaker>: <content>".
+ """
+ Log a chat message with the format of"<speaker>: <content>". If the
+ running instance is registered in the studio, the message will be sent
+ and display in the studio.
Args:
- message (`Union[str, dict]`):
- The message to be logged. If it is a string, it will be logged
- directly. If it's a dict, it should have "name"(or "role") and
- "content" keys, and the message will be logged as "<name/role>:
- <content>".
+ message (`dict`):
+ The message to be logged as "<name/role>: <content>", which must
+ be an object of Msg class.
"""
+ # Push message to studio if it is active
+ if _studio_client.active:
+ _studio_client.push_message(message)
+
# Save message into chat file, add default to ignore not serializable
# objects
logger.log(
@@ -245,7 +251,7 @@
Source code for agentscope.utils.logging_utils
-[docs]
+[docs]
def log_studio(message: dict, uid: str, **kwargs: Any) -> None:
"""Send chat message to studio.
@@ -318,7 +324,7 @@
Source code for agentscope.utils.logging_utils
-[docs]
+[docs]
def setup_logger(
path_log: Optional[str] = None,
level: LOG_LEVEL = "INFO",
diff --git a/en/_modules/agentscope/message.html b/en/_modules/agentscope/message.html
index d6ff18efa..442e2dac1 100644
--- a/en/_modules/agentscope/message.html
+++ b/en/_modules/agentscope/message.html
@@ -161,10 +161,7 @@
Source code for agentscope.message
self.content = content
self.role = role
- if url:
- self.url = url
- else:
- self.url = None
+ self.url = url
self.update(kwargs)
@@ -381,7 +378,7 @@ Source code for agentscope.message
[docs]
-class PlaceholderMessage(MessageBase):
+class PlaceholderMessage(Msg):
"""A placeholder for the return message of RpcAgent."""
PLACEHOLDER_ATTRS = {
diff --git a/en/_modules/agentscope/server/launcher.html b/en/_modules/agentscope/server/launcher.html
index 51fd9d673..52501dea2 100644
--- a/en/_modules/agentscope/server/launcher.html
+++ b/en/_modules/agentscope/server/launcher.html
@@ -101,11 +101,12 @@ Source code for agentscope.server.launcher
# -*- coding: utf-8 -*-
""" Server of distributed agent"""
import os
-from multiprocessing import Process, Event, Pipe
-from multiprocessing.synchronize import Event as EventClass
import asyncio
import signal
import argparse
+import time
+from multiprocessing import Process, Event, Pipe
+from multiprocessing.synchronize import Event as EventClass
from typing import Type
from concurrent import futures
from loguru import logger
@@ -123,14 +124,10 @@ Source code for agentscope.server.launcher
import_error,
"distribute",
)
-
import agentscope
from agentscope.server.servicer import AgentServerServicer
from agentscope.agents.agent import AgentBase
-from agentscope.utils.tools import (
- _get_timestamp,
- check_port,
-)
+from agentscope.utils.tools import check_port, generate_id_from_seed
def _setup_agent_server(
@@ -144,6 +141,7 @@ Source code for agentscope.server.launcher
local_mode: bool = True,
max_pool_size: int = 8192,
max_timeout_seconds: int = 1800,
+ studio_url: str = None,
custom_agents: list = None,
) -> None:
"""Setup agent server.
@@ -156,7 +154,7 @@ Source code for agentscope.server.launcher
server_id (`str`):
The id of the server.
init_settings (`dict`, defaults to `None`):
- Init settings for agentscope.init.
+ Init settings for _init_server.
start_event (`EventClass`, defaults to `None`):
An Event instance used to determine whether the child process
has been started.
@@ -171,6 +169,8 @@ Source code for agentscope.server.launcher
Max number of agent replies that the server can accommodate.
max_timeout_seconds (`int`, defaults to `1800`):
Timeout for agent replies.
+ studio_url (`str`, defaults to `None`):
+ URL of the AgentScope Studio.
custom_agents (`list`, defaults to `None`):
A list of custom agent classes that are not in `agentscope.agents`.
"""
@@ -186,6 +186,7 @@ Source code for agentscope.server.launcher
local_mode=local_mode,
max_pool_size=max_pool_size,
max_timeout_seconds=max_timeout_seconds,
+ studio_url=studio_url,
custom_agents=custom_agents,
),
)
@@ -202,6 +203,7 @@ Source code for agentscope.server.launcher
local_mode: bool = True,
max_pool_size: int = 8192,
max_timeout_seconds: int = 1800,
+ studio_url: str = None,
custom_agents: list = None,
) -> None:
"""Setup agent server in an async way.
@@ -214,7 +216,7 @@ Source code for agentscope.server.launcher
server_id (`str`):
The id of the server.
init_settings (`dict`, defaults to `None`):
- Init settings for agentscope.init.
+ Init settings for _init_server.
start_event (`EventClass`, defaults to `None`):
An Event instance used to determine whether the child process
has been started.
@@ -233,6 +235,8 @@ Source code for agentscope.server.launcher
max_timeout_seconds (`int`, defaults to `1800`):
Maximum time for reply messages to be cached in the server.
Note that expired messages will be deleted.
+ studio_url (`str`, defaults to `None`):
+ URL of the AgentScope Studio.
custom_agents (`list`, defaults to `None`):
A list of custom agent classes that are not in `agentscope.agents`.
"""
@@ -243,6 +247,8 @@ Source code for agentscope.server.launcher
servicer = AgentServerServicer(
host=host,
port=port,
+ server_id=server_id,
+ studio_url=studio_url,
max_pool_size=max_pool_size,
max_timeout_seconds=max_timeout_seconds,
)
@@ -320,6 +326,7 @@ Source code for agentscope.server.launcher
local_mode: bool = False,
custom_agents: list = None,
server_id: str = None,
+ studio_url: str = None,
agent_class: Type[AgentBase] = None,
agent_args: tuple = (),
agent_kwargs: dict = None,
@@ -347,6 +354,8 @@ Source code for agentscope.server.launcher
server_id (`str`, defaults to `None`):
The id of the agent server. If not specified, a random id
will be generated.
+ studio_url (`Optional[str]`, defaults to `None`):
+ The url of the agentscope studio.
agent_class (`Type[AgentBase]`, deprecated):
The AgentBase subclass encapsulated by this wrapper.
agent_args (`tuple`, deprecated): The args tuple used to
@@ -364,8 +373,11 @@ Source code for agentscope.server.launcher
self.parent_con = None
self.custom_agents = custom_agents
self.server_id = (
- self.generate_server_id() if server_id is None else server_id
+ RpcAgentServerLauncher.generate_server_id(self.host, self.port)
+ if server_id is None
+ else server_id
)
+ self.studio_url = studio_url
if (
agent_class is not None
or len(agent_args) > 0
@@ -379,9 +391,10 @@ Source code for agentscope.server.launcher
[docs]
- def generate_server_id(self) -> str:
+ @classmethod
+ def generate_server_id(cls, host: str, port: int) -> str:
"""Generate server id"""
- return f"{self.host}:{self.port}-{_get_timestamp('%y%m%d-%H:%M:%S')}"
+ return generate_id_from_seed(f"{host}:{port}:{time.time()}", length=8)
def _launch_in_main(self) -> None:
@@ -398,6 +411,7 @@ Source code for agentscope.server.launcher
max_timeout_seconds=self.max_timeout_seconds,
local_mode=self.local_mode,
custom_agents=self.custom_agents,
+ studio_url=self.studio_url,
),
)
@@ -421,6 +435,7 @@ Source code for agentscope.server.launcher
"max_pool_size": self.max_pool_size,
"max_timeout_seconds": self.max_timeout_seconds,
"local_mode": self.local_mode,
+ "studio_url": self.studio_url,
"custom_agents": self.custom_agents,
},
)
@@ -540,7 +555,7 @@ Source code for agentscope.server.launcher
type=bool,
default=False,
help=(
- "If `True`, only listen to requests from 'localhost', otherwise, "
+ "if `True`, only listen to requests from 'localhost', otherwise, "
"listen to requests from all hosts."
),
)
@@ -549,21 +564,51 @@ Source code for agentscope.server.launcher
type=str,
help="path to the model config json file",
)
+ parser.add_argument(
+ "--server-id",
+ type=str,
+ default=None,
+ help="id of the server, used to register to the studio, generated"
+ " randomly if not specified.",
+ )
+ parser.add_argument(
+ "--studio-url",
+ type=str,
+ default=None,
+ help="the url of agentscope studio",
+ )
+ parser.add_argument(
+ "--no-log",
+ action="store_true",
+ help="whether to disable log",
+ )
+ parser.add_argument(
+ "--save-api-invoke",
+ action="store_true",
+ help="whether to save api invoke",
+ )
+ parser.add_argument(
+ "--use-monitor",
+ action="store_true",
+ help="whether to use monitor",
+ )
args = parser.parse_args()
agentscope.init(
project="agent_server",
name=f"server_{args.host}:{args.port}",
- runtime_id=_get_timestamp(
- "server_{}_{}_%y%m%d-%H%M%S",
- ).format(args.host, args.port),
+ save_log=not args.no_log,
+ save_api_invoke=args.save_api_invoke,
model_configs=args.model_config_path,
+ use_monitor=args.use_monitor,
)
launcher = RpcAgentServerLauncher(
host=args.host,
port=args.port,
+ server_id=args.server_id,
max_pool_size=args.max_pool_size,
max_timeout_seconds=args.max_timeout_seconds,
local_mode=args.local_mode,
+ studio_url=args.studio_url,
)
launcher.launch(in_subprocess=False)
launcher.wait_until_terminate()
diff --git a/en/_modules/agentscope/server/servicer.html b/en/_modules/agentscope/server/servicer.html
index a3f237b7b..78131eb5d 100644
--- a/en/_modules/agentscope/server/servicer.html
+++ b/en/_modules/agentscope/server/servicer.html
@@ -106,6 +106,7 @@ Source code for agentscope.server.servicer
import traceback
from concurrent import futures
from loguru import logger
+import requests
try:
import dill
@@ -125,7 +126,10 @@ Source code for agentscope.server.servicer
"distribute",
)
+from .._runtime import _runtime
+from ..studio._client import _studio_client
from ..agents.agent import AgentBase
+from ..exception import StudioRegisterError
from ..rpc.rpc_agent_pb2_grpc import RpcAgentServicer
from ..message import (
Msg,
@@ -134,6 +138,24 @@ Source code for agentscope.server.servicer
)
+def _register_to_studio(
+ studio_url: str,
+ server_id: str,
+ host: str,
+ port: int,
+) -> None:
+ """Register a server to studio."""
+ url = f"{studio_url}/api/servers/register"
+ resp = requests.post(
+ url,
+ json={"server_id": server_id, "host": host, "port": port},
+ timeout=10, # todo: configurable timeout
+ )
+ if resp.status_code != 200:
+ logger.error(f"Failed to register server: {resp.text}")
+ raise StudioRegisterError(f"Failed to register server: {resp.text}")
+
+
[docs]
class AgentServerServicer(RpcAgentServicer):
@@ -145,6 +167,8 @@ Source code for agentscope.server.servicer
self,
host: str = "localhost",
port: int = None,
+ server_id: str = None,
+ studio_url: str = None,
max_pool_size: int = 8192,
max_timeout_seconds: int = 1800,
):
@@ -155,6 +179,10 @@ Source code for agentscope.server.servicer
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
@@ -165,6 +193,17 @@ Source code for agentscope.server.servicer
"""
self.host = host
self.port = port
+ self.server_id = server_id
+ self.studio_url = studio_url
+ if studio_url is not None:
+ _register_to_studio(
+ studio_url=studio_url,
+ server_id=server_id,
+ host=host,
+ port=port,
+ )
+ _studio_client.initialize(_runtime.runtime_id, studio_url)
+
self.result_pool = ExpiringDict(
max_len=max_pool_size,
max_age_seconds=max_timeout_seconds,
diff --git a/en/_modules/agentscope/studio/_app.html b/en/_modules/agentscope/studio/_app.html
new file mode 100644
index 000000000..050637734
--- /dev/null
+++ b/en/_modules/agentscope/studio/_app.html
@@ -0,0 +1,833 @@
+
+
+
+
+
+
+ agentscope.studio._app — AgentScope documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Module code
+ - agentscope.studio._app
+ -
+
+
+
+
+
+
+
+ Source code for agentscope.studio._app
+# -*- coding: utf-8 -*-
+"""The Web Server of the AgentScope Studio."""
+import json
+import os
+import re
+import subprocess
+import tempfile
+import threading
+import traceback
+from datetime import datetime
+from typing import Tuple, Union, Any, Optional
+from pathlib import Path
+
+from flask import (
+ Flask,
+ request,
+ jsonify,
+ render_template,
+ Response,
+ abort,
+ send_file,
+)
+from flask_cors import CORS
+from flask_sqlalchemy import SQLAlchemy
+from flask_socketio import SocketIO, join_room, leave_room
+
+from agentscope._runtime import _runtime
+from agentscope.constants import _DEFAULT_SUBDIR_CODE, _DEFAULT_SUBDIR_INVOKE
+from agentscope.utils.tools import _is_process_alive
+
+_app = Flask(__name__)
+
+# Set the cache directory
+_cache_dir = str(Path.home() / ".cache" / "agentscope-studio")
+os.makedirs(_cache_dir, exist_ok=True)
+_app.config[
+ "SQLALCHEMY_DATABASE_URI"
+] = f"sqlite:////{_cache_dir}/agentscope.db"
+_db = SQLAlchemy(_app)
+
+_socketio = SocketIO(_app)
+
+# This will enable CORS for all routes
+CORS(_app)
+
+_RUNS_DIRS = []
+
+
+class _UserInputRequestQueue:
+ """A queue to store the user input requests."""
+
+ _requests = {}
+ """The user input requests in the queue."""
+
+ @classmethod
+ def add_request(cls, run_id: str, agent_id: str, data: dict) -> None:
+ """Add a new user input request into queue.
+
+ Args:
+ run_id (`str`):
+ The id of the runtime instance.
+ agent_id (`str`):
+ The id of the agent that requires user input.
+ data (`dict`):
+ The data of the user input request.
+ """
+ if run_id not in cls._requests:
+ cls._requests[run_id] = {agent_id: data}
+ else:
+ # We ensure that the agent_id is unique here
+ cls._requests[run_id][agent_id] = data
+
+ @classmethod
+ def fetch_a_request(cls, run_id: str) -> Optional[dict]:
+ """Fetch a user input request from the queue.
+
+ Args:
+ run_id (`str`):
+ The id of the runtime instance.
+ """
+ if run_id in cls._requests and len(cls._requests[run_id]) > 0:
+ # Fetch the oldest request
+ agent_id = list(cls._requests[run_id].keys())[0]
+ return cls._requests[run_id][agent_id]
+ else:
+ return None
+
+ @classmethod
+ def close_a_request(cls, run_id: str, agent_id: str) -> None:
+ """Close a user input request in the queue.
+
+ Args:
+ run_id (`str`):
+ The id of the runtime instance.
+ agent_id (`str`):
+ The id of the agent that requires user input.
+ """
+ if run_id in cls._requests:
+ cls._requests[run_id].pop(agent_id)
+
+
+class _RunTable(_db.Model): # type: ignore[name-defined]
+ """Runtime object."""
+
+ run_id = _db.Column(_db.String, primary_key=True)
+ project = _db.Column(_db.String)
+ name = _db.Column(_db.String)
+ timestamp = _db.Column(_db.String)
+ run_dir = _db.Column(_db.String)
+ pid = _db.Column(_db.Integer)
+ status = _db.Column(_db.String, default="finished")
+
+
+class _ServerTable(_db.Model): # type: ignore[name-defined]
+ """Server object."""
+
+ id = _db.Column(_db.String, primary_key=True)
+ host = _db.Column(_db.String)
+ port = _db.Column(_db.Integer)
+ create_time = _db.Column(_db.DateTime, default=datetime.now)
+
+
+class _MessageTable(_db.Model): # type: ignore[name-defined]
+ """Message object."""
+
+ id = _db.Column(_db.Integer, primary_key=True)
+ run_id = _db.Column(
+ _db.String,
+ _db.ForeignKey("run_table.run_id"),
+ nullable=False,
+ )
+ name = _db.Column(_db.String)
+ role = _db.Column(_db.String)
+ content = _db.Column(_db.String)
+ url = _db.Column(_db.String)
+ meta = _db.Column(_db.String)
+ timestamp = _db.Column(_db.String)
+
+
+def _get_all_runs_from_dir() -> dict:
+ """Get all runs from the directory."""
+ global _RUNS_DIRS
+ runtime_configs_from_dir = {}
+ if _RUNS_DIRS is not None:
+ for runs_dir in set(_RUNS_DIRS):
+ for runtime_dir in os.listdir(runs_dir):
+ path_runtime = os.path.join(runs_dir, runtime_dir)
+ path_config = os.path.join(path_runtime, ".config")
+ if os.path.exists(path_config):
+ with open(path_config, "r", encoding="utf-8") as file:
+ runtime_config = json.load(file)
+
+ # Default status is finished
+ # Note: this is only for local runtime instances
+ if "pid" in runtime_config and _is_process_alive(
+ runtime_config["pid"],
+ runtime_config["timestamp"],
+ ):
+ runtime_config["status"] = "running"
+ else:
+ runtime_config["status"] = "finished"
+
+ if "run_dir" not in runtime_config:
+ runtime_config["run_dir"] = path_runtime
+
+ if "id" in runtime_config:
+ runtime_config["run_id"] = runtime_config["id"]
+ del runtime_config["id"]
+
+ runtime_id = runtime_config.get("run_id")
+ runtime_configs_from_dir[runtime_id] = runtime_config
+
+ return runtime_configs_from_dir
+
+
+def _remove_file_paths(error_trace: str) -> str:
+ """
+ Remove the real traceback when exception happens.
+ """
+ path_regex = re.compile(r'File "(.*?)(?=agentscope|app\.py)')
+ cleaned_trace = re.sub(path_regex, 'File "[hidden]/', error_trace)
+
+ return cleaned_trace
+
+
+def _convert_to_py( # type: ignore[no-untyped-def]
+ content: str,
+ **kwargs,
+) -> Tuple:
+ """
+ Convert json config to python code.
+ """
+ from agentscope.web.workstation.workflow_dag import build_dag
+
+ try:
+ cfg = json.loads(content)
+ return "True", build_dag(cfg).compile(**kwargs)
+ except Exception as e:
+ return "False", _remove_file_paths(
+ f"Error: {e}\n\n" f"Traceback:\n" f"{traceback.format_exc()}",
+ )
+
+
+@_app.route("/workstation")
+def _workstation() -> str:
+ """Render the workstation page."""
+ return render_template("workstation.html")
+
+
+@_app.route("/api/runs/register", methods=["POST"])
+def _register_run() -> Response:
+ """Registers a running instance of an agentscope application."""
+
+ # Extract the input data from the request
+ data = request.json
+ run_id = data.get("run_id")
+
+ # check if the run_id is already in the database
+ if _RunTable.query.filter_by(run_id=run_id).first():
+ abort(400, f"RUN_ID {run_id} already exists")
+
+ # Add into the database
+ _db.session.add(
+ _RunTable(
+ run_id=run_id,
+ project=data.get("project"),
+ name=data.get("name"),
+ timestamp=data.get("timestamp"),
+ run_dir=data.get("run_dir"),
+ pid=data.get("pid"),
+ status="running",
+ ),
+ )
+ _db.session.commit()
+
+ return jsonify(status="ok")
+
+
+@_app.route("/api/servers/register", methods=["POST"])
+def _register_server() -> Response:
+ """
+ Registers an agent server.
+ """
+ data = request.json
+ server_id = data.get("server_id")
+ host = data.get("host")
+ port = data.get("port")
+
+ if _ServerTable.query.filter_by(id=server_id).first():
+ _app.logger.error(f"Server id {server_id} already exists.")
+ abort(400, f"run_id [{server_id}] already exists")
+
+ _db.session.add(
+ _ServerTable(
+ id=server_id,
+ host=host,
+ port=port,
+ ),
+ )
+ _db.session.commit()
+
+ _app.logger.info(f"Register server id {server_id}")
+ return jsonify(status="ok")
+
+
+@_app.route("/api/messages/push", methods=["POST"])
+def _push_message() -> Response:
+ """Receive a message from the agentscope application, and display it on
+ the web UI."""
+ _app.logger.debug("Flask: receive push_message")
+ data = request.json
+
+ run_id = data["run_id"]
+ name = data["name"]
+ role = data["role"]
+ content = data["content"]
+ metadata = data["metadata"]
+ timestamp = data["timestamp"]
+ url = data["url"]
+
+ try:
+ new_message = _MessageTable(
+ run_id=run_id,
+ name=name,
+ role=role,
+ content=content,
+ # Before storing into the database, we need to convert the url into
+ # a string
+ meta=json.dumps(metadata),
+ url=json.dumps(url),
+ timestamp=timestamp,
+ )
+ _db.session.add(new_message)
+ _db.session.commit()
+ except Exception as e:
+ abort(400, "Fail to put message with error: " + str(e))
+
+ data = {
+ "run_id": run_id,
+ "name": name,
+ "role": role,
+ "content": content,
+ "url": url,
+ "metadata": metadata,
+ "timestamp": timestamp,
+ }
+
+ _socketio.emit(
+ "display_message",
+ data,
+ room=run_id,
+ )
+ _app.logger.debug("Flask: send display_message")
+ return jsonify(status="ok")
+
+
+@_app.route("/api/messages/run/<run_id>", methods=["GET"])
+def _get_messages(run_id: str) -> Response:
+ """Get the history messages of specific run_id."""
+ # From registered runtime instances
+ if len(_RunTable.query.filter_by(run_id=run_id).all()) > 0:
+ messages = _MessageTable.query.filter_by(run_id=run_id).all()
+ msgs = [
+ {
+ "name": message.name,
+ "role": message.role,
+ "content": message.content,
+ "url": json.loads(message.url),
+ "metadata": json.loads(message.meta),
+ "timestamp": message.timestamp,
+ }
+ for message in messages
+ ]
+ return jsonify(msgs)
+
+ # From the local file
+ run_dir = request.args.get("run_dir", default=None, type=str)
+
+ # Search the run_dir from the registered runtime instances if not provided
+ if run_dir is None:
+ runtime_configs_from_dir = _get_all_runs_from_dir()
+ if run_id in runtime_configs_from_dir:
+ run_dir = runtime_configs_from_dir[run_id]["run_dir"]
+
+ # Load the messages from the local file
+ path_messages = os.path.join(run_dir, "logging.chat")
+ if run_dir is None or not os.path.exists(path_messages):
+ return jsonify([])
+ else:
+ with open(path_messages, "r", encoding="utf-8") as file:
+ msgs = [json.loads(_) for _ in file.readlines()]
+ return jsonify(msgs)
+
+
+@_app.route("/api/runs/get/<run_id>", methods=["GET"])
+def _get_run(run_id: str) -> Response:
+ """Get a specific run's detail."""
+ run = _RunTable.query.filter_by(run_id=run_id).first()
+ if not run:
+ abort(400, f"run_id [{run_id}] not exists")
+ return jsonify(
+ {
+ "run_id": run.run_id,
+ "project": run.project,
+ "name": run.name,
+ "timestamp": run.timestamp,
+ "run_dir": run.run_dir,
+ "pid": run.pid,
+ "status": run.status,
+ },
+ )
+
+
+@_app.route("/api/runs/all", methods=["GET"])
+def _get_all_runs() -> Response:
+ """Get all runs."""
+ # Update the status of the registered runtimes
+ # Note: this is only for the applications running on the local machine
+ for run in _RunTable.query.filter(
+ _RunTable.status.in_(["running", "waiting"]),
+ ).all():
+ if not _is_process_alive(run.pid, run.timestamp):
+ _RunTable.query.filter_by(run_id=run.run_id).update(
+ {"status": "finished"},
+ )
+ _db.session.commit()
+
+ # From web connection
+ runtime_configs_from_register = {
+ _.run_id: {
+ "run_id": _.run_id,
+ "project": _.project,
+ "name": _.name,
+ "timestamp": _.timestamp,
+ "run_dir": _.run_dir,
+ "pid": _.pid,
+ "status": _.status,
+ }
+ for _ in _RunTable.query.all()
+ }
+
+ # From directory
+ runtime_configs_from_dir = _get_all_runs_from_dir()
+
+ # Remove duplicates between two sources
+ clean_runtimes = {
+ **runtime_configs_from_dir,
+ **runtime_configs_from_register,
+ }
+
+ runs = list(clean_runtimes.values())
+
+ return jsonify(runs)
+
+
+@_app.route("/api/invocation", methods=["GET"])
+def _get_invocations() -> Response:
+ """Get all API invocations in a run instance."""
+ run_dir = request.args.get("run_dir")
+ path_invocations = os.path.join(run_dir, _DEFAULT_SUBDIR_INVOKE)
+
+ invocations = []
+ if os.path.exists(path_invocations):
+ for filename in os.listdir(path_invocations):
+ with open(
+ os.path.join(path_invocations, filename),
+ "r",
+ encoding="utf-8",
+ ) as file:
+ invocations.append(json.load(file))
+ return jsonify(invocations)
+
+
+@_app.route("/api/code", methods=["GET"])
+def _get_code() -> Response:
+ """Get the python code from the run directory."""
+ run_dir = request.args.get("run_dir")
+
+ dir_code = os.path.join(run_dir, _DEFAULT_SUBDIR_CODE)
+
+ codes = {}
+ if os.path.exists(dir_code):
+ for filename in os.listdir(dir_code):
+ with open(
+ os.path.join(dir_code, filename),
+ "r",
+ encoding="utf-8",
+ ) as file:
+ codes[filename] = "".join(file.readlines())
+ return jsonify(codes)
+
+
+@_app.route("/api/file", methods=["GET"])
+def _get_file() -> Any:
+ """Get the local file via the url."""
+ file_path = request.args.get("path", None)
+
+ if file_path is not None:
+ try:
+ file = send_file(file_path)
+ return file
+ except FileNotFoundError:
+ return jsonify({"error": "File not found."})
+ return jsonify({"error": "File not found."})
+
+
+@_app.route("/convert-to-py", methods=["POST"])
+def _convert_config_to_py() -> Response:
+ """
+ Convert json config to python code and send back.
+ """
+ content = request.json.get("data")
+ status, py_code = _convert_to_py(content)
+ return jsonify(py_code=py_code, is_success=status)
+
+
+def _cleanup_process(proc: subprocess.Popen) -> None:
+ """Clean up the process for running application started by workstation."""
+ proc.wait()
+ _app.logger.debug(f"The process with pid {proc.pid} is closed")
+
+
+@_app.route("/convert-to-py-and-run", methods=["POST"])
+def _convert_config_to_py_and_run() -> Response:
+ """
+ Convert json config to python code and run.
+ """
+ content = request.json.get("data")
+ studio_url = request.url_root.rstrip("/")
+ run_id = _runtime.generate_new_runtime_id()
+ status, py_code = _convert_to_py(
+ content,
+ runtime_id=run_id,
+ studio_url=studio_url,
+ )
+
+ if status == "True":
+ try:
+ with tempfile.NamedTemporaryFile(
+ delete=False,
+ suffix=".py",
+ mode="w+t",
+ ) as tmp:
+ tmp.write(py_code)
+ tmp.flush()
+ proc = subprocess.Popen( # pylint: disable=R1732
+ ["python", tmp.name],
+ )
+ threading.Thread(target=_cleanup_process, args=(proc,)).start()
+ except Exception as e:
+ status, py_code = "False", _remove_file_paths(
+ f"Error: {e}\n\n" f"Traceback:\n" f"{traceback.format_exc()}",
+ )
+ return jsonify(py_code=py_code, is_success=status, run_id=run_id)
+
+
+@_app.route("/read-examples", methods=["POST"])
+def _read_examples() -> Response:
+ """
+ Read tutorial examples from local file.
+ """
+ lang = request.json.get("lang")
+ file_index = request.json.get("data")
+
+ if not os.path.exists(
+ os.path.join(
+ _app.root_path,
+ "static",
+ "workstation_templates",
+ f"{lang}{file_index}.json",
+ ),
+ ):
+ lang = "en"
+
+ with open(
+ os.path.join(
+ _app.root_path,
+ "static",
+ "workstation_templates",
+ f"{lang}{file_index}.json",
+ ),
+ "r",
+ encoding="utf-8",
+ ) as jf:
+ data = json.load(jf)
+ return jsonify(json=data)
+
+
+@_app.route("/")
+def _home() -> str:
+ """Render the home page."""
+ return render_template("index.html")
+
+
+@_socketio.on("request_user_input")
+def _request_user_input(data: dict) -> None:
+ """Request user input"""
+ _app.logger.debug("Flask: receive request_user_input")
+
+ run_id = data["run_id"]
+ agent_id = data["agent_id"]
+
+ # Change the status into waiting
+ _db.session.query(_RunTable).filter_by(run_id=run_id).update(
+ {"status": "waiting"},
+ )
+ _db.session.commit()
+
+ # Record into the queue
+ _UserInputRequestQueue.add_request(run_id, agent_id, data)
+
+ # Ask for user input from the web ui
+ _socketio.emit(
+ "enable_user_input",
+ data,
+ room=run_id,
+ )
+
+ _app.logger.debug("Flask: send enable_user_input")
+
+
+@_socketio.on("user_input_ready")
+def _user_input_ready(data: dict) -> None:
+ """Get user input and send to the agent"""
+ _app.logger.debug(f"Flask: receive user_input_ready: {data}")
+
+ run_id = data["run_id"]
+ agent_id = data["agent_id"]
+ content = data["content"]
+ url = data["url"]
+
+ _db.session.query(_RunTable).filter_by(run_id=run_id).update(
+ {"status": "running"},
+ )
+ _db.session.commit()
+
+ # Return to AgentScope application
+ _socketio.emit(
+ "fetch_user_input",
+ {
+ "agent_id": agent_id,
+ "name": data["name"],
+ "run_id": run_id,
+ "content": content,
+ "url": None if url in ["", []] else url,
+ },
+ room=run_id,
+ )
+
+ # Close the request in the queue
+ _UserInputRequestQueue.close_a_request(run_id, agent_id)
+
+ # Fetch a new user input request for this run_id if exists
+ new_request = _UserInputRequestQueue.fetch_a_request(run_id)
+ if new_request is not None:
+ _socketio.emit(
+ "enable_user_input",
+ new_request,
+ room=run_id,
+ )
+
+ _app.logger.debug("Flask: send fetch_user_input")
+
+
+@_socketio.on("connect")
+def _on_connect() -> None:
+ """Execute when a client is connected."""
+ _app.logger.info("New client connected")
+
+
+@_socketio.on("disconnect")
+def _on_disconnect() -> None:
+ """Execute when a client is disconnected."""
+ _app.logger.info("Client disconnected")
+
+
+@_socketio.on("join")
+def _on_join(data: dict) -> None:
+ """Join a websocket room"""
+ run_id = data["run_id"]
+ join_room(run_id)
+
+ new_request = _UserInputRequestQueue.fetch_a_request(run_id)
+ if new_request is not None:
+ _socketio.emit(
+ "enable_user_input",
+ new_request,
+ room=run_id,
+ )
+
+
+@_socketio.on("leave")
+def _on_leave(data: dict) -> None:
+ """Leave a websocket room"""
+ run_id = data["run_id"]
+ leave_room(run_id)
+
+
+
+[docs]
+def init(
+ host: str = "127.0.0.1",
+ port: int = 5000,
+ run_dirs: Optional[Union[str, list[str]]] = None,
+ debug: bool = False,
+) -> None:
+ """Start the AgentScope Studio web UI with the given configurations.
+
+ Args:
+ host (str, optional):
+ The host of the web UI. Defaults to "127.0.0.1"
+ port (int, optional):
+ The port of the web UI. Defaults to 5000.
+ run_dirs (`Optional[Union[str, list[str]]]`, defaults to `None`):
+ The directories to search for the history of runtime instances.
+ debug (`bool`, optional):
+ Whether to enable the debug mode. Defaults to False.
+ """
+
+ # Set the history directories
+ if isinstance(run_dirs, str):
+ run_dirs = [run_dirs]
+
+ global _RUNS_DIRS
+ _RUNS_DIRS = run_dirs
+
+ # Create the cache directory
+ with _app.app_context():
+ _db.create_all()
+
+ if debug:
+ _app.logger.setLevel("DEBUG")
+ else:
+ _app.logger.setLevel("INFO")
+
+ _socketio.run(
+ _app,
+ host=host,
+ port=port,
+ debug=debug,
+ allow_unsafe_werkzeug=True,
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/en/_modules/agentscope/utils/monitor.html b/en/_modules/agentscope/utils/monitor.html
index 7e4663f38..54adedc52 100644
--- a/en/_modules/agentscope/utils/monitor.html
+++ b/en/_modules/agentscope/utils/monitor.html
@@ -566,7 +566,7 @@ Source code for agentscope.utils.monitor
self.db_path = db_path
self.table_name = table_name
self._create_monitor_table(drop_exists)
- logger.info(
+ logger.debug(
f"SqliteMonitor initialization completed at [{self.db_path}]",
)
@@ -597,8 +597,8 @@ Source code for agentscope.utils.monitor
END;
""",
)
- logger.info(f"Init [{self.table_name}] as the monitor table")
- logger.info(
+ logger.debug(f"Init [{self.table_name}] as the monitor table")
+ logger.debug(
f"Init [{self.table_name}_quota_exceeded] as the monitor trigger",
)
diff --git a/en/_modules/agentscope/utils/tools.html b/en/_modules/agentscope/utils/tools.html
index 5596dd960..e7ea61023 100644
--- a/en/_modules/agentscope/utils/tools.html
+++ b/en/_modules/agentscope/utils/tools.html
@@ -107,12 +107,13 @@ Source code for agentscope.utils.tools
import secrets
import string
import socket
+import hashlib
+import random
from typing import Any, Literal, List, Optional
from urllib.parse import urlparse
-
+import psutil
import requests
-from loguru import logger
def _get_timestamp(
@@ -143,9 +144,7 @@ Source code for agentscope.utils.tools
if "content" in item:
clean_dict["content"] = _convert_to_str(item["content"])
else:
- logger.warning(
- f"Message {item} doesn't have `content` field for " f"OpenAI API.",
- )
+ raise ValueError("The content of the message is missing.")
return clean_dict
@@ -194,17 +193,10 @@ Source code for agentscope.utils.tools
"""
if port is None:
new_port = find_available_port()
- logger.warning(
- "agent server port is not provided, automatically select "
- f"[{new_port}] as the port number.",
- )
return new_port
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
if s.connect_ex(("localhost", port)) == 0:
new_port = find_available_port()
- logger.warning(
- f"Port [{port}] is occupied, use [{new_port}] instead",
- )
return new_port
return port
@@ -329,7 +321,7 @@ Source code for agentscope.utils.tools
file.write(chunk)
return True
else:
- logger.warning(
+ raise RuntimeError(
f"Failed to download file from {url} (status code: "
f"{response.status_code}). Retry {n_retry}/{max_retries}.",
)
@@ -353,6 +345,28 @@ Source code for agentscope.utils.tools
return "".join(secrets.choice(characters) for i in range(length))
+
+[docs]
+def generate_id_from_seed(seed: str, length: int = 8) -> str:
+ """Generate random id from seed str.
+
+ Args:
+ seed (`str`): seed string.
+ length (`int`): generated id length.
+ """
+ hasher = hashlib.sha256()
+ hasher.update(seed.encode("utf-8"))
+ hash_digest = hasher.hexdigest()
+
+ random.seed(hash_digest)
+ id_chars = [
+ random.choice(string.ascii_letters + string.digits)
+ for _ in range(length)
+ ]
+ return "".join(id_chars)
+
+
+
def _is_json_serializable(obj: Any) -> bool:
"""Check if the given object is json serializable."""
try:
@@ -490,6 +504,70 @@ Source code for agentscope.utils.tools
)
raise ImportError(err_msg)
+
+
+def _get_process_creation_time() -> datetime.datetime:
+ """Get the creation time of the process."""
+ pid = os.getpid()
+ # Find the process by pid
+ current_process = psutil.Process(pid)
+ # Obtain the process creation time
+ create_time = current_process.create_time()
+ # Change the timestamp to a readable format
+ return datetime.datetime.fromtimestamp(create_time)
+
+
+def _is_process_alive(
+ pid: int,
+ create_time_str: str,
+ create_time_format: str = "%Y-%m-%d %H:%M:%S",
+ tolerance_seconds: int = 10,
+) -> bool:
+ """Check if the process is alive by comparing the actual creation time of
+ the process with the given creation time.
+
+ Args:
+ pid (`int`):
+ The process id.
+ create_time_str (`str`):
+ The given creation time string.
+ create_time_format (`str`, defaults to `"%Y-%m-%d %H:%M:%S"`):
+ The format of the given creation time string.
+ tolerance_seconds (`int`, defaults to `10`):
+ The tolerance seconds for comparing the actual creation time with
+ the given creation time.
+
+ Returns:
+ `bool`: True if the process is alive, False otherwise.
+ """
+ try:
+ # Try to create a process object by pid
+ proc = psutil.Process(pid)
+ # Obtain the actual creation time of the process
+ actual_create_time_timestamp = proc.create_time()
+
+ # Convert the given creation time string to a datetime object
+ given_create_time_datetime = datetime.datetime.strptime(
+ create_time_str,
+ create_time_format,
+ )
+
+ # Calculate the time difference between the actual creation time and
+ time_difference = abs(
+ actual_create_time_timestamp
+ - given_create_time_datetime.timestamp(),
+ )
+
+ # Compare the actual creation time with the given creation time
+ if time_difference <= tolerance_seconds:
+ return True
+
+ except (psutil.NoSuchProcess, psutil.AccessDenied, psutil.ZombieProcess):
+ # If the process is not found, access is denied, or the process is a
+ # zombie process, return False
+ return False
+
+ return False
diff --git a/en/_modules/agentscope/web/_app.html b/en/_modules/agentscope/web/_app.html
deleted file mode 100644
index ad1a4df30..000000000
--- a/en/_modules/agentscope/web/_app.html
+++ /dev/null
@@ -1,255 +0,0 @@
-
-
-
-
-
-
- agentscope.web._app — AgentScope documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - Module code
- - agentscope.web._app
- -
-
-
-
-
-
-
-
- Source code for agentscope.web._app
-# -*- coding: utf-8 -*-
-"""The main entry point of the web UI."""
-import json
-import os
-
-from flask import Flask, jsonify, render_template, Response
-from flask_cors import CORS
-from flask_socketio import SocketIO
-
-app = Flask(__name__)
-socketio = SocketIO(app)
-CORS(app) # This will enable CORS for all routes
-
-
-PATH_SAVE = ""
-
-
-@app.route("/getProjects", methods=["GET"])
-def get_projects() -> Response:
- """Get all the projects in the runs directory."""
- cfgs = []
- for run_dir in os.listdir(PATH_SAVE):
- print(run_dir)
- path_cfg = os.path.join(PATH_SAVE, run_dir, ".config")
- if os.path.exists(path_cfg):
- with open(path_cfg, "r", encoding="utf-8") as file:
- cfg = json.load(file)
- cfg["dir"] = run_dir
- cfgs.append(cfg)
-
- # Filter the same projects
- project_names = list({_["project"] for _ in cfgs})
-
- return jsonify(
- {
- "names": project_names,
- "runs": cfgs,
- },
- )
-
-
-@app.route("/")
-def home() -> str:
- """Render the home page."""
- return render_template("home.html")
-
-
-@app.route("/run/<run_dir>")
-def run_detail(run_dir: str) -> str:
- """Render the run detail page."""
- path_run = os.path.join(PATH_SAVE, run_dir)
-
- # Find the logging and chat file by suffix
- path_log = os.path.join(path_run, "logging.log")
- path_dialog = os.path.join(path_run, "logging.chat")
-
- if os.path.exists(path_log):
- with open(path_log, "r", encoding="utf-8") as file:
- logging_content = ["".join(file.readlines())]
- else:
- logging_content = None
-
- if os.path.exists(path_dialog):
- with open(path_dialog, "r", encoding="utf-8") as file:
- dialog_content = file.readlines()
- dialog_content = [json.loads(_) for _ in dialog_content]
- else:
- dialog_content = []
-
- path_cfg = os.path.join(PATH_SAVE, run_dir, ".config")
- if os.path.exists(path_cfg):
- with open(path_cfg, "r", encoding="utf-8") as file:
- cfg = json.load(file)
- else:
- cfg = {
- "project": "-",
- "name": "-",
- "id": "-",
- "timestamp": "-",
- }
-
- logging_and_dialog = {
- "config": cfg,
- "logging": logging_content,
- "dialog": dialog_content,
- }
-
- return render_template("run.html", runInfo=logging_and_dialog)
-
-
-@socketio.on("connect")
-def on_connect() -> None:
- """Execute when a client is connected."""
- print("Client connected")
-
-
-@socketio.on("disconnect")
-def on_disconnect() -> None:
- """Execute when a client is disconnected."""
- print("Client disconnected")
-
-
-
-[docs]
-def init(
- path_save: str,
- host: str = "127.0.0.1",
- port: int = 5000,
- debug: bool = False,
-) -> None:
- """Start the web UI."""
- global PATH_SAVE
-
- if not os.path.exists(path_save):
- raise FileNotFoundError(f"The path {path_save} does not exist.")
-
- PATH_SAVE = path_save
- socketio.run(
- app,
- host=host,
- port=port,
- debug=debug,
- allow_unsafe_werkzeug=True,
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/en/_modules/agentscope/web/studio/studio.html b/en/_modules/agentscope/web/gradio/studio.html
similarity index 96%
rename from en/_modules/agentscope/web/studio/studio.html
rename to en/_modules/agentscope/web/gradio/studio.html
index 1debdfde5..5d86fe955 100644
--- a/en/_modules/agentscope/web/studio/studio.html
+++ b/en/_modules/agentscope/web/gradio/studio.html
@@ -4,7 +4,7 @@
- agentscope.web.studio.studio — AgentScope documentation
+ agentscope.web.gradio.studio — AgentScope documentation
@@ -45,8 +45,8 @@
AgentScope Tutorial
@@ -88,7 +88,7 @@
- Module code
- - agentscope.web.studio.studio
+ - agentscope.web.gradio.studio
-
@@ -97,7 +97,7 @@
- Source code for agentscope.web.studio.studio
+ Source code for agentscope.web.gradio.studio
# -*- coding: utf-8 -*-
"""run web ui"""
import argparse
@@ -119,7 +119,7 @@ Source code for agentscope.web.studio.studio
except ImportError:
mgr = None
-from agentscope.web.studio.utils import (
+from agentscope.web.gradio.utils import (
send_player_input,
get_chat_msg,
SYS_MSG_PREFIX,
@@ -132,14 +132,14 @@ Source code for agentscope.web.studio.studio
thread_local_data,
cycle_dots,
)
-from agentscope.web.studio.constants import _SPEAK
+from agentscope.web.gradio.constants import _SPEAK
MAX_NUM_DISPLAY_MSG = 20
FAIL_COUNT_DOWN = 30
-[docs]
+[docs]
def init_uid_list() -> list:
"""Initialize an empty list for storing user IDs."""
return []
@@ -152,7 +152,7 @@ Source code for agentscope.web.studio.studio
-[docs]
+[docs]
def reset_glb_var(uid: str) -> None:
"""Reset global variables for a given user ID."""
global glb_history_dict
@@ -163,7 +163,7 @@ Source code for agentscope.web.studio.studio
-[docs]
+[docs]
def get_chat(uid: str) -> list[list]:
"""Retrieve chat messages for a given user ID."""
uid = check_uuid(uid)
@@ -201,7 +201,7 @@ Source code for agentscope.web.studio.studio
-[docs]
+[docs]
def send_audio(audio_term: str, uid: str) -> None:
"""Convert audio input to text and send as a chat message."""
uid = check_uuid(uid)
@@ -214,7 +214,7 @@ Source code for agentscope.web.studio.studio
-[docs]
+[docs]
def send_image(image_term: str, uid: str) -> None:
"""Send an image as a chat message."""
uid = check_uuid(uid)
@@ -227,7 +227,7 @@ Source code for agentscope.web.studio.studio
-[docs]
+[docs]
def send_message(msg: str, uid: str) -> str:
"""Send a generic message to the player."""
uid = check_uuid(uid)
@@ -239,7 +239,7 @@ Source code for agentscope.web.studio.studio
-[docs]
+[docs]
def fn_choice(data: gr.EventData, uid: str) -> None:
"""Handle a selection event from the chatbot interface."""
uid = check_uuid(uid)
@@ -249,7 +249,7 @@ Source code for agentscope.web.studio.studio
-[docs]
+[docs]
def import_function_from_path(
module_path: str,
function_name: str,
@@ -300,7 +300,7 @@ Source code for agentscope.web.studio.studio
# pylint: disable=too-many-statements
-[docs]
+[docs]
def run_app() -> None:
"""Entry point for the web UI application."""
assert gr is not None, "Please install [full] version of AgentScope."
diff --git a/en/_modules/agentscope/web/studio/utils.html b/en/_modules/agentscope/web/gradio/utils.html
similarity index 94%
rename from en/_modules/agentscope/web/studio/utils.html
rename to en/_modules/agentscope/web/gradio/utils.html
index a129cef9c..8cd78043f 100644
--- a/en/_modules/agentscope/web/studio/utils.html
+++ b/en/_modules/agentscope/web/gradio/utils.html
@@ -4,7 +4,7 @@
- agentscope.web.studio.utils — AgentScope documentation
+ agentscope.web.gradio.utils — AgentScope documentation
@@ -45,8 +45,8 @@
AgentScope Tutorial
@@ -88,7 +88,7 @@
- Module code
- - agentscope.web.studio.utils
+ - agentscope.web.gradio.utils
-
@@ -97,7 +97,7 @@
- Source code for agentscope.web.studio.utils
+ Source code for agentscope.web.gradio.utils
# -*- coding: utf-8 -*-
"""web ui utils"""
import os
@@ -118,7 +118,7 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
def init_uid_queues() -> dict:
"""Initializes and returns a dictionary of user-specific queues."""
return {
@@ -133,7 +133,7 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
def send_msg(
msg: str,
is_player: bool = False,
@@ -175,7 +175,7 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
def get_chat_msg(uid: Optional[str] = None) -> list:
"""Retrieves the next chat message from the queue, if available."""
global glb_uid_dict
@@ -189,7 +189,7 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
def send_player_input(msg: str, uid: Optional[str] = None) -> None:
"""Sends player input to the web UI."""
global glb_uid_dict
@@ -199,7 +199,7 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
def get_player_input(
timeout: Optional[int] = None,
uid: Optional[str] = None,
@@ -223,7 +223,7 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
def send_reset_msg(uid: Optional[str] = None) -> None:
"""Sends a reset message to the web UI."""
uid = check_uuid(uid)
@@ -235,7 +235,7 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
def get_reset_msg(uid: Optional[str] = None) -> None:
"""Retrieves a reset message from the queue, if available."""
global glb_uid_dict
@@ -249,14 +249,14 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
class ResetException(Exception):
"""Custom exception to signal a reset action in the application."""
-[docs]
+[docs]
def check_uuid(uid: Optional[str]) -> str:
"""Checks whether a UUID is provided or generates a default one."""
if not uid or uid == "":
@@ -270,7 +270,7 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
def generate_image_from_name(name: str) -> str:
"""Generates an image based on the hash of the given name."""
from agentscope.file_manager import file_manager
@@ -303,7 +303,7 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
def audio2text(audio_path: str) -> str:
"""Converts audio file at the given path to text using ASR."""
# dashscope.api_key = ""
@@ -321,7 +321,7 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
def cycle_dots(text: str, num_dots: int = 3) -> str:
"""display thinking dots before agent reply"""
current_dots = len(text) - len(text.rstrip("."))
@@ -333,7 +333,7 @@ Source code for agentscope.web.studio.utils
-[docs]
+[docs]
def user_input(
prefix: str = "User input: ",
timeout: Optional[int] = None,
diff --git a/en/_modules/agentscope/web/workstation/workflow_dag.html b/en/_modules/agentscope/web/workstation/workflow_dag.html
index 08e85c945..11a05a5da 100644
--- a/en/_modules/agentscope/web/workstation/workflow_dag.html
+++ b/en/_modules/agentscope/web/workstation/workflow_dag.html
@@ -116,7 +116,10 @@ Source code for agentscope.web.workstation.workflow_dag
WorkflowNodeType,
DEFAULT_FLOW_VAR,
)
-from agentscope.web.workstation.workflow_utils import is_callable_expression
+from agentscope.web.workstation.workflow_utils import (
+ is_callable_expression,
+ kwarg_converter,
+)
try:
import networkx as nx
@@ -170,7 +173,7 @@ Source code for agentscope.web.workstation.workflow_dag
]
self.inits = [
- """agentscope.init(logger_level="DEBUG")""",
+ 'agentscope.init(logger_level="DEBUG")',
f"{DEFAULT_FLOW_VAR} = None",
]
@@ -217,7 +220,11 @@ Source code for agentscope.web.workstation.workflow_dag
[docs]
- def compile(self, compiled_filename: str = "") -> str:
+ def compile( # type: ignore[no-untyped-def]
+ self,
+ compiled_filename: str = "",
+ **kwargs,
+ ) -> str:
"""Compile DAG to a runnable python code"""
def format_python_code(code: str) -> str:
@@ -229,6 +236,10 @@ Source code for agentscope.web.workstation.workflow_dag
except Exception:
return code
+ self.inits[
+ 0
+ ] = f'agentscope.init(logger_level="DEBUG", {kwarg_converter(kwargs)})'
+
sorted_nodes = list(nx.topological_sort(self))
sorted_nodes = [
node_id
diff --git a/en/_modules/index.html b/en/_modules/index.html
index 5786df19c..01af70705 100644
--- a/en/_modules/index.html
+++ b/en/_modules/index.html
@@ -108,6 +108,7 @@ All modules for which code is available
agentscope.agents.user_agent
agentscope.constants
agentscope.exception
+agentscope.logging
agentscope.memory.memory
agentscope.memory.temporary_memory
agentscope.message
@@ -154,14 +155,13 @@ All modules for which code is available
agentscope.service.web.download
agentscope.service.web.search
agentscope.service.web.web_digest
-agentscope.utils.common
-agentscope.utils.logging_utils
+agentscope.studio._app
+agentscope.utils.common
agentscope.utils.monitor
agentscope.utils.token_utils
agentscope.utils.tools
-agentscope.web._app
-agentscope.web.studio.studio
-agentscope.web.studio.utils
+agentscope.web.gradio.studio
+agentscope.web.gradio.utils
agentscope.web.workstation.workflow
agentscope.web.workstation.workflow_dag
agentscope.web.workstation.workflow_node
diff --git a/en/_sources/agentscope.logging.rst.txt b/en/_sources/agentscope.logging.rst.txt
new file mode 100644
index 000000000..de42846fb
--- /dev/null
+++ b/en/_sources/agentscope.logging.rst.txt
@@ -0,0 +1,6 @@
+agentscope.logging
+==================
+.. automodule:: agentscope.logging
+ :members:
+ :undoc-members:
+ :show-inheritance:
\ No newline at end of file
diff --git a/en/_sources/agentscope.studio.rst.txt b/en/_sources/agentscope.studio.rst.txt
new file mode 100644
index 000000000..a20b3a6eb
--- /dev/null
+++ b/en/_sources/agentscope.studio.rst.txt
@@ -0,0 +1,7 @@
+agentscope.studio
+=================
+
+.. automodule:: agentscope.studio
+ :members:
+ :undoc-members:
+ :show-inheritance:
\ No newline at end of file
diff --git a/en/_sources/agentscope.utils.logging_utils.rst.txt b/en/_sources/agentscope.utils.logging_utils.rst.txt
deleted file mode 100644
index 54032346f..000000000
--- a/en/_sources/agentscope.utils.logging_utils.rst.txt
+++ /dev/null
@@ -1,6 +0,0 @@
-agentscope.utils.logging_utils
-==============================
-.. automodule:: agentscope.utils.logging_utils
- :members:
- :undoc-members:
- :show-inheritance:
\ No newline at end of file
diff --git a/zh_CN/_sources/agentscope.web.studio.constants.rst.txt b/en/_sources/agentscope.web.gradio.constants.rst.txt
similarity index 51%
rename from zh_CN/_sources/agentscope.web.studio.constants.rst.txt
rename to en/_sources/agentscope.web.gradio.constants.rst.txt
index 1ff763320..c22fc374d 100644
--- a/zh_CN/_sources/agentscope.web.studio.constants.rst.txt
+++ b/en/_sources/agentscope.web.gradio.constants.rst.txt
@@ -1,6 +1,6 @@
-agentscope.web.studio.constants
+agentscope.web.gradio.constants
===============================
-.. automodule:: agentscope.web.studio.constants
+.. automodule:: agentscope.web.gradio.constants
:members:
:undoc-members:
:show-inheritance:
\ No newline at end of file
diff --git a/zh_CN/_sources/agentscope.web.studio.rst.txt b/en/_sources/agentscope.web.gradio.rst.txt
similarity index 55%
rename from zh_CN/_sources/agentscope.web.studio.rst.txt
rename to en/_sources/agentscope.web.gradio.rst.txt
index ea9c4f348..34ac95dcb 100644
--- a/zh_CN/_sources/agentscope.web.studio.rst.txt
+++ b/en/_sources/agentscope.web.gradio.rst.txt
@@ -1,7 +1,7 @@
-agentscope.web.studio
+agentscope.web.gradio
=====================
-.. automodule:: agentscope.web.studio
+.. automodule:: agentscope.web.gradio
:members:
:undoc-members:
:show-inheritance:
\ No newline at end of file
diff --git a/zh_CN/_sources/agentscope.web.studio.studio.rst.txt b/en/_sources/agentscope.web.gradio.studio.rst.txt
similarity index 52%
rename from zh_CN/_sources/agentscope.web.studio.studio.rst.txt
rename to en/_sources/agentscope.web.gradio.studio.rst.txt
index a2b5805cc..25fd302f2 100644
--- a/zh_CN/_sources/agentscope.web.studio.studio.rst.txt
+++ b/en/_sources/agentscope.web.gradio.studio.rst.txt
@@ -1,6 +1,6 @@
-agentscope.web.studio.studio
+agentscope.web.gradio.studio
============================
-.. automodule:: agentscope.web.studio.studio
+.. automodule:: agentscope.web.gradio.studio
:members:
:undoc-members:
:show-inheritance:
\ No newline at end of file
diff --git a/en/_sources/agentscope.web.studio.utils.rst.txt b/en/_sources/agentscope.web.gradio.utils.rst.txt
similarity index 52%
rename from en/_sources/agentscope.web.studio.utils.rst.txt
rename to en/_sources/agentscope.web.gradio.utils.rst.txt
index c9be22c7d..4b3b912db 100644
--- a/en/_sources/agentscope.web.studio.utils.rst.txt
+++ b/en/_sources/agentscope.web.gradio.utils.rst.txt
@@ -1,6 +1,6 @@
-agentscope.web.studio.utils
+agentscope.web.gradio.utils
===========================
-.. automodule:: agentscope.web.studio.utils
+.. automodule:: agentscope.web.gradio.utils
:members:
:undoc-members:
:show-inheritance:
\ No newline at end of file
diff --git a/en/agentscope.agents.agent.html b/en/agentscope.agents.agent.html
index 75c8d49a3..9c741002a 100644
--- a/en/agentscope.agents.agent.html
+++ b/en/agentscope.agents.agent.html
@@ -260,8 +260,16 @@
-
-speak(content: str | dict) → None[source]
-Speak out the content generated by the agent.
+speak(content: str | Msg) → None[source]
+Speak out the message generated by the agent. If a string is given,
+a Msg object will be created with the string as the content.
+
+- Parameters:
+content (Union[str, Msg]) – The content of the message to be spoken out. If a string is
+given, a Msg object will be created with the agent’s name, role
+as “assistant”, and the given string as the content.
+
diff --git a/en/agentscope.agents.html b/en/agentscope.agents.html
index 63e3a7f92..f31c02f3d 100644
--- a/en/agentscope.agents.html
+++ b/en/agentscope.agents.html
@@ -247,8 +247,16 @@
-
-speak(content: str | dict) → None[source]
-Speak out the content generated by the agent.
+speak(content: str | Msg) → None[source]
+Speak out the message generated by the agent. If a string is given,
+a Msg object will be created with the string as the content.
+
+- Parameters:
+content (Union[str, Msg]) – The content of the message to be spoken out. If a string is
+given, a Msg object will be created with the agent’s name, role
+as “assistant”, and the given string as the content.
+
@@ -536,7 +544,7 @@
-
-reply(x: dict | None = None, required_keys: list[str] | str | None = None, timeout: int | None = None) → dict[source]
+reply(x: dict | None = None, required_keys: str | list[str] | None = None, timeout: int | None = None) → dict[source]
Processes the input provided by the user and stores it in memory,
potentially formatting it with additional provided details.
The method prompts the user for input, then optionally prompts for
@@ -567,8 +575,16 @@
-
-speak(content: str | dict) → None[source]
-Speak the content to the audience.
+speak(content: str | Msg) → None[source]
+Speak out the message generated by the agent. If a string is given,
+a Msg object will be created with the string as the content.
+
+- Parameters:
+content (Union[str, Msg]) – The content of the message to be spoken out. If a string is
+given, a Msg object will be created with the agent’s name, role
+as “user”, and the given string as the content.
+
diff --git a/en/agentscope.agents.user_agent.html b/en/agentscope.agents.user_agent.html
index e0fd29953..40d5c5909 100644
--- a/en/agentscope.agents.user_agent.html
+++ b/en/agentscope.agents.user_agent.html
@@ -123,7 +123,7 @@
-
-reply(x: dict | None = None, required_keys: list[str] | str | None = None, timeout: int | None = None) → dict[source]
+reply(x: dict | None = None, required_keys: str | list[str] | None = None, timeout: int | None = None) → dict[source]
Processes the input provided by the user and stores it in memory,
potentially formatting it with additional provided details.
The method prompts the user for input, then optionally prompts for
@@ -154,8 +154,16 @@
-
-speak(content: str | dict) → None[source]
-Speak the content to the audience.
+speak(content: str | Msg) → None[source]
+Speak out the message generated by the agent. If a string is given,
+a Msg object will be created with the string as the content.
+
+- Parameters:
+content (Union[str, Msg]) – The content of the message to be spoken out. If a string is
+given, a Msg object will be created with the agent’s name, role
+as “user”, and the given string as the content.
+
diff --git a/en/agentscope.exception.html b/en/agentscope.exception.html
index 362742a9e..582bd7e6b 100644
--- a/en/agentscope.exception.html
+++ b/en/agentscope.exception.html
@@ -76,6 +76,8 @@
FunctionNotFoundErrorArgumentNotFoundErrorArgumentTypeErrorStudioErrorStudioRegisterErroragentscope.pipelines
@@ -237,6 +239,26 @@
The exception class for argument type error.
+
+-
+exception agentscope.exception.StudioError(message: str)[source]
+Bases: Exception
+The base class for exception raising during interaction with agentscope
+studio.
+
+
+
+
+
+-
+exception agentscope.exception.StudioRegisterError(message: str)[source]
+Bases: StudioError
+The exception class for error when registering to agentscope studio.
+
+
diff --git a/en/agentscope.html b/en/agentscope.html
index 477049f3c..ad00fa068 100644
--- a/en/agentscope.html
+++ b/en/agentscope.html
@@ -107,7 +107,7 @@
Import all modules in the package.
-
-agentscope.init(model_configs: dict | str | list | None = None, project: str | None = None, name: str | None = None, save_dir: str = './runs', save_log: bool = True, save_code: bool = True, save_api_invoke: bool = False, use_monitor: bool = True, logger_level: Literal['TRACE', 'DEBUG', 'INFO', 'SUCCESS', 'WARNING', 'ERROR', 'CRITICAL'] = 'INFO', runtime_id: str | None = None, agent_configs: dict | str | list | None = None) → Sequence[AgentBase][source]
+agentscope.init(model_configs: dict | str | list | None = None, project: str | None = None, name: str | None = None, save_dir: str = './runs', save_log: bool = True, save_code: bool = True, save_api_invoke: bool = False, use_monitor: bool = True, logger_level: Literal['TRACE', 'DEBUG', 'INFO', 'SUCCESS', 'WARNING', 'ERROR', 'CRITICAL'] = 'INFO', runtime_id: str | None = None, agent_configs: dict | str | list | None = None, studio_url: str | None = None) → Sequence[AgentBase][source]
A unified entry to initialize the package, including model configs,
runtime names, saving directories and logging settings.
@@ -132,6 +132,7 @@
which can be loaded by json.loads(). One agent config should
cover the required arguments to initialize a specific agent
object, otherwise the default values will be used.
+
studio_url (Optional[str], defaults to None) – The url of the agentscope studio.
diff --git a/en/agentscope.utils.logging_utils.html b/en/agentscope.logging.html
similarity index 60%
rename from en/agentscope.utils.logging_utils.html
rename to en/agentscope.logging.html
index 2f8aedeb4..dfa96bc03 100644
--- a/en/agentscope.utils.logging_utils.html
+++ b/en/agentscope.logging.html
@@ -5,7 +5,7 @@
- agentscope.utils.logging_utils — AgentScope documentation
+ agentscope.logging — AgentScope documentation
@@ -44,8 +44,8 @@
AgentScope Tutorial
@@ -86,9 +86,9 @@
- agentscope.utils.logging_utils
+ - agentscope.logging
-
- View page source
+ View page source
@@ -96,12 +96,12 @@
-
-agentscope.utils.logging_utils
+
+agentscope.logging
Logging utilities.
--
-agentscope.utils.logging_utils.log_studio(message: dict, uid: str, **kwargs: Any) → None[source]
+-
+agentscope.logging.log_studio(message: dict, uid: str, **kwargs: Any) → None[source]
Send chat message to studio.
- Parameters:
@@ -116,8 +116,8 @@
--
-agentscope.utils.logging_utils.setup_logger(path_log: str | None = None, level: Literal['TRACE', 'DEBUG', 'INFO', 'SUCCESS', 'WARNING', 'ERROR', 'CRITICAL'] = 'INFO') → None[source]
+-
+agentscope.logging.setup_logger(path_log: str | None = None, level: Literal['TRACE', 'DEBUG', 'INFO', 'SUCCESS', 'WARNING', 'ERROR', 'CRITICAL'] = 'INFO') → None[source]
Setup loguru.logger and redirect stderr to logging.
- Parameters:
diff --git a/en/agentscope.message.html b/en/agentscope.message.html
index e9b6be9e4..3af1cec6b 100644
--- a/en/agentscope.message.html
+++ b/en/agentscope.message.html
@@ -314,7 +314,7 @@
-
class agentscope.message.PlaceholderMessage(name: str, content: Any, url: Sequence[str] | str | None = None, timestamp: str | None = None, host: str | None = None, port: int | None = None, task_id: int | None = None, client: RpcAgentClient | None = None, x: dict | None = None, **kwargs: Any)[source]
-Bases: MessageBase
+Bases: Msg
A placeholder for the return message of RpcAgent.
-
diff --git a/en/agentscope.server.html b/en/agentscope.server.html
index 5693cedfb..ccaf72e47 100644
--- a/en/agentscope.server.html
+++ b/en/agentscope.server.html
@@ -108,12 +108,12 @@
Import all server related modules in the package.
-
-class agentscope.server.RpcAgentServerLauncher(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800, local_mode: bool = False, custom_agents: list | None = None, server_id: str | None = None, agent_class: Type[AgentBase] | None = None, agent_args: tuple = (), agent_kwargs: dict | None = None)[source]
+class agentscope.server.RpcAgentServerLauncher(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800, local_mode: bool = False, custom_agents: list | None = None, server_id: str | None = None, studio_url: str | None = None, agent_class: Type[AgentBase] | None = None, agent_args: tuple = (), agent_kwargs: dict | None = None)[source]
Bases: object
The launcher of AgentServer.
-
-__init__(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800, local_mode: bool = False, custom_agents: list | None = None, server_id: str | None = None, agent_class: Type[AgentBase] | None = None, agent_args: tuple = (), agent_kwargs: dict | None = None) → None[source]
+__init__(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800, local_mode: bool = False, custom_agents: list | None = None, server_id: str | None = None, studio_url: str | None = None, agent_class: Type[AgentBase] | None = None, agent_args: tuple = (), agent_kwargs: dict | None = None) → None[source]
Init a launcher of agent server.
- Parameters:
@@ -131,6 +131,7 @@
agentscope.agents.
server_id (str, defaults to None) – The id of the agent server. If not specified, a random id
will be generated.
studio_url (Optional[str], defaults to None) – The url of the agentscope studio.
agent_class (Type[AgentBase], deprecated) – The AgentBase subclass encapsulated by this wrapper.
agent_args (tuple, deprecated) – The args tuple used to
initialize the agent_class.
-
-generate_server_id() → str[source]
+classmethod generate_server_id(host: str, port: int) → str[source]
Generate server id
@@ -176,18 +177,20 @@
-
-class agentscope.server.AgentServerServicer(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800)[source]
+class agentscope.server.AgentServerServicer(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 = 1800)[source]
Bases: RpcAgentServicer
A Servicer for RPC Agent Server (formerly RpcServerSideWrapper)
-
-__init__(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800)[source]
+__init__(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 = 1800)[source]
Init the AgentServerServicer.
- Parameters:
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.
Server of distributed agent
-
-class agentscope.server.launcher.RpcAgentServerLauncher(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800, local_mode: bool = False, custom_agents: list | None = None, server_id: str | None = None, agent_class: Type[AgentBase] | None = None, agent_args: tuple = (), agent_kwargs: dict | None = None)[source]
+class agentscope.server.launcher.RpcAgentServerLauncher(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800, local_mode: bool = False, custom_agents: list | None = None, server_id: str | None = None, studio_url: str | None = None, agent_class: Type[AgentBase] | None = None, agent_args: tuple = (), agent_kwargs: dict | None = None)[source]
Bases: object
The launcher of AgentServer.
-
-__init__(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800, local_mode: bool = False, custom_agents: list | None = None, server_id: str | None = None, agent_class: Type[AgentBase] | None = None, agent_args: tuple = (), agent_kwargs: dict | None = None) → None[source]
+__init__(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800, local_mode: bool = False, custom_agents: list | None = None, server_id: str | None = None, studio_url: str | None = None, agent_class: Type[AgentBase] | None = None, agent_args: tuple = (), agent_kwargs: dict | None = None) → None[source]
Init a launcher of agent server.
- Parameters:
@@ -124,6 +124,7 @@
agentscope.agents.
server_id (str, defaults to None) – The id of the agent server. If not specified, a random id
will be generated.
studio_url (Optional[str], defaults to None) – The url of the agentscope studio.
agent_class (Type[AgentBase], deprecated) – The AgentBase subclass encapsulated by this wrapper.
agent_args (tuple, deprecated) – The args tuple used to
initialize the agent_class.
-
-generate_server_id() → str[source]
+classmethod generate_server_id(host: str, port: int) → str[source]
Generate server id
diff --git a/en/agentscope.server.servicer.html b/en/agentscope.server.servicer.html
index 155022359..e2274b9df 100644
--- a/en/agentscope.server.servicer.html
+++ b/en/agentscope.server.servicer.html
@@ -101,18 +101,20 @@
Server of distributed agent
-
-class agentscope.server.servicer.AgentServerServicer(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800)[source]
+class agentscope.server.servicer.AgentServerServicer(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 = 1800)[source]
Bases: RpcAgentServicer
A Servicer for RPC Agent Server (formerly RpcServerSideWrapper)
-
-__init__(host: str = 'localhost', port: int | None = None, max_pool_size: int = 8192, max_timeout_seconds: int = 1800)[source]
+__init__(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 = 1800)[source]
Init the AgentServerServicer.
- Parameters:
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.
agentscope.studio — AgentScope documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - agentscope.studio
+ -
+ View page source
+
+
+
+
+
+
+
+
+agentscope.studio
+Import the entry point of AgentScope Studio.
+
+-
+agentscope.studio.init(host: str = '127.0.0.1', port: int = 5000, run_dirs: str | list[str] | None = None, debug: bool = False) → None[source]
+Start the AgentScope Studio web UI with the given configurations.
+
+- Parameters:
+
+host (str, optional) – The host of the web UI. Defaults to “127.0.0.1”
port (int, optional) – The port of the web UI. Defaults to 5000.
run_dirs (Optional[Union[str, list[str]]], defaults to None) – The directories to search for the history of runtime instances.
debug (bool, optional) – Whether to enable the debug mode. Defaults to False.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/en/agentscope.utils.html b/en/agentscope.utils.html
index fdf5b746b..935dc4159 100644
--- a/en/agentscope.utils.html
+++ b/en/agentscope.utils.html
@@ -71,7 +71,6 @@
- agentscope.web
- agentscope.prompt
- agentscope.utils
-setup_logger()MonitorBaseQuotaExceededErrorMonitorFactory
agentscope.utils
Import modules in utils package.
-
--
-agentscope.utils.setup_logger(path_log: str | None = None, level: Literal['TRACE', 'DEBUG', 'INFO', 'SUCCESS', 'WARNING', 'ERROR', 'CRITICAL'] = 'INFO') → None[source]
-Setup loguru.logger and redirect stderr to logging.
-
-- Parameters:
-
-path_log (str, defaults to “”) – The directory of log files.
level (str, defaults to “INFO”) – The logging level, which is one of the following: “TRACE”,
-“DEBUG”, “INFO”, “SUCCESS”, “WARNING”, “ERROR”,
-“CRITICAL”.
-
-
-
+
+-
+agentscope.utils.tools.generate_id_from_seed(seed: str, length: int = 8) → str[source]
+Generate random id from seed str.
+
+- Parameters:
+
+seed (str) – seed string.
length (int) – generated id length.
+
+
+
-
agentscope.utils.tools.reform_dialogue(input_msgs: list[dict]) → list[dict][source]
diff --git a/en/agentscope.web.studio.constants.html b/en/agentscope.web.gradio.constants.html
similarity index 90%
rename from en/agentscope.web.studio.constants.html
rename to en/agentscope.web.gradio.constants.html
index c683d7adf..3965778bc 100644
--- a/en/agentscope.web.studio.constants.html
+++ b/en/agentscope.web.gradio.constants.html
@@ -5,7 +5,7 @@
- agentscope.web.studio.constants — AgentScope documentation
+ agentscope.web.gradio.constants — AgentScope documentation
@@ -44,8 +44,8 @@
AgentScope Tutorial
@@ -86,9 +86,9 @@
- agentscope.web.studio.constants
+ - agentscope.web.gradio.constants
-
- View page source
+ View page source
@@ -96,8 +96,8 @@
-
-agentscope.web.studio.constants
+
+agentscope.web.gradio.constants
Some constants used in the AS studio
diff --git a/en/agentscope.web.studio.html b/en/agentscope.web.gradio.html
similarity index 91%
rename from en/agentscope.web.studio.html
rename to en/agentscope.web.gradio.html
index acb5a9471..c6b7c7e9d 100644
--- a/en/agentscope.web.studio.html
+++ b/en/agentscope.web.gradio.html
@@ -5,7 +5,7 @@
- agentscope.web.studio — AgentScope documentation
+ agentscope.web.gradio — AgentScope documentation
@@ -44,8 +44,8 @@
AgentScope Tutorial
@@ -86,9 +86,9 @@
- agentscope.web.studio
+ - agentscope.web.gradio
-
- View page source
+ View page source
@@ -96,8 +96,8 @@
-
-agentscope.web.studio
+
+agentscope.web.gradio
diff --git a/en/agentscope.web.studio.studio.html b/en/agentscope.web.gradio.studio.html
similarity index 82%
rename from en/agentscope.web.studio.studio.html
rename to en/agentscope.web.gradio.studio.html
index 45fde49ac..0973bda21 100644
--- a/en/agentscope.web.studio.studio.html
+++ b/en/agentscope.web.gradio.studio.html
@@ -5,7 +5,7 @@
- agentscope.web.studio.studio — AgentScope documentation
+ agentscope.web.gradio.studio — AgentScope documentation
@@ -44,8 +44,8 @@
AgentScope Tutorial
@@ -86,9 +86,9 @@
- agentscope.web.studio.studio
+ - agentscope.web.gradio.studio
-
- View page source
+ View page source
@@ -96,60 +96,60 @@
-
-agentscope.web.studio.studio
+
+agentscope.web.gradio.studio
run web ui
--
-agentscope.web.studio.studio.init_uid_list() → list[source]
+-
+agentscope.web.gradio.studio.init_uid_list() → list[source]
Initialize an empty list for storing user IDs.
--
-agentscope.web.studio.studio.reset_glb_var(uid: str) → None[source]
+-
+agentscope.web.gradio.studio.reset_glb_var(uid: str) → None[source]
Reset global variables for a given user ID.
--
-agentscope.web.studio.studio.get_chat(uid: str) → list[list][source]
+-
+agentscope.web.gradio.studio.get_chat(uid: str) → list[list][source]
Retrieve chat messages for a given user ID.
--
-agentscope.web.studio.studio.send_audio(audio_term: str, uid: str) → None[source]
+-
+agentscope.web.gradio.studio.send_audio(audio_term: str, uid: str) → None[source]
Convert audio input to text and send as a chat message.
--
-agentscope.web.studio.studio.send_image(image_term: str, uid: str) → None[source]
+-
+agentscope.web.gradio.studio.send_image(image_term: str, uid: str) → None[source]
Send an image as a chat message.
--
-agentscope.web.studio.studio.send_message(msg: str, uid: str) → str[source]
+-
+agentscope.web.gradio.studio.send_message(msg: str, uid: str) → str[source]
Send a generic message to the player.
--
-agentscope.web.studio.studio.fn_choice(data: EventData, uid: str) → None[source]
+-
+agentscope.web.gradio.studio.fn_choice(data: EventData, uid: str) → None[source]
Handle a selection event from the chatbot interface.
--
-agentscope.web.studio.studio.import_function_from_path(module_path: str, function_name: str, module_name: str | None = None) → Callable[source]
+-
+agentscope.web.gradio.studio.import_function_from_path(module_path: str, function_name: str, module_name: str | None = None) → Callable[source]
Import a function from the given module path.
--
-agentscope.web.studio.studio.run_app() → None[source]
+-
+agentscope.web.gradio.studio.run_app() → None[source]
Entry point for the web UI application.
diff --git a/en/agentscope.web.studio.utils.html b/en/agentscope.web.gradio.utils.html
similarity index 84%
rename from en/agentscope.web.studio.utils.html
rename to en/agentscope.web.gradio.utils.html
index e091fc218..f6fec1b1e 100644
--- a/en/agentscope.web.studio.utils.html
+++ b/en/agentscope.web.gradio.utils.html
@@ -5,7 +5,7 @@
- agentscope.web.studio.utils — AgentScope documentation
+ agentscope.web.gradio.utils — AgentScope documentation
@@ -44,8 +44,8 @@
AgentScope Tutorial
@@ -86,9 +86,9 @@
- agentscope.web.studio.utils
+ - agentscope.web.gradio.utils
-
- View page source
+ View page source
@@ -96,85 +96,85 @@
-
-agentscope.web.studio.utils
+
+agentscope.web.gradio.utils
web ui utils
--
-agentscope.web.studio.utils.init_uid_queues() → dict[source]
+-
+agentscope.web.gradio.utils.init_uid_queues() → dict[source]
Initializes and returns a dictionary of user-specific queues.
--
-agentscope.web.studio.utils.send_msg(msg: str, is_player: bool = False, role: str | None = None, uid: str | None = None, flushing: bool = False, avatar: str | None = None, msg_id: str | None = None) → None[source]
+-
+agentscope.web.gradio.utils.send_msg(msg: str, is_player: bool = False, role: str | None = None, uid: str | None = None, flushing: bool = False, avatar: str | None = None, msg_id: str | None = None) → None[source]
Sends a message to the web UI.
--
-agentscope.web.studio.utils.get_chat_msg(uid: str | None = None) → list[source]
+-
+agentscope.web.gradio.utils.get_chat_msg(uid: str | None = None) → list[source]
Retrieves the next chat message from the queue, if available.
--
-agentscope.web.studio.utils.send_player_input(msg: str, uid: str | None = None) → None[source]
+-
+agentscope.web.gradio.utils.send_player_input(msg: str, uid: str | None = None) → None[source]
Sends player input to the web UI.
--
-agentscope.web.studio.utils.get_player_input(timeout: int | None = None, uid: str | None = None) → str[source]
+-
+agentscope.web.gradio.utils.get_player_input(timeout: int | None = None, uid: str | None = None) → str[source]
Gets player input from the web UI or command line.
--
-agentscope.web.studio.utils.send_reset_msg(uid: str | None = None) → None[source]
+-
+agentscope.web.gradio.utils.send_reset_msg(uid: str | None = None) → None[source]
Sends a reset message to the web UI.
--
-agentscope.web.studio.utils.get_reset_msg(uid: str | None = None) → None[source]
+-
+agentscope.web.gradio.utils.get_reset_msg(uid: str | None = None) → None[source]
Retrieves a reset message from the queue, if available.
--
-exception agentscope.web.studio.utils.ResetException[source]
+-
+exception agentscope.web.gradio.utils.ResetException[source]
Bases: Exception
Custom exception to signal a reset action in the application.
--
-agentscope.web.studio.utils.check_uuid(uid: str | None) → str[source]
+-
+agentscope.web.gradio.utils.check_uuid(uid: str | None) → str[source]
Checks whether a UUID is provided or generates a default one.
--
-agentscope.web.studio.utils.generate_image_from_name(name: str) → str[source]
+-
+agentscope.web.gradio.utils.generate_image_from_name(name: str) → str[source]
Generates an image based on the hash of the given name.
--
-agentscope.web.studio.utils.audio2text(audio_path: str) → str[source]
+-
+agentscope.web.gradio.utils.audio2text(audio_path: str) → str[source]
Converts audio file at the given path to text using ASR.
--
-agentscope.web.studio.utils.cycle_dots(text: str, num_dots: int = 3) → str[source]
+-
+agentscope.web.gradio.utils.cycle_dots(text: str, num_dots: int = 3) → str[source]
display thinking dots before agent reply
--
-agentscope.web.studio.utils.user_input(prefix: str = 'User input: ', timeout: int | None = None) → str[source]
+-
+agentscope.web.gradio.utils.user_input(prefix: str = 'User input: ', timeout: int | None = None) → str[source]
get user input
diff --git a/en/agentscope.web.html b/en/agentscope.web.html
index 4ab192d42..64ca2792a 100644
--- a/en/agentscope.web.html
+++ b/en/agentscope.web.html
@@ -69,10 +69,7 @@
agentscope.service
agentscope.rpc
agentscope.server
-agentscope.web
-init()
-
+agentscope.web
agentscope.prompt
agentscope.utils
@@ -103,13 +100,6 @@
agentscope.web
-Import all modules in the web ui package.
-
-
diff --git a/en/agentscope.web.workstation.workflow_dag.html b/en/agentscope.web.workstation.workflow_dag.html
index 3aede2b5c..bc1f3f2db 100644
--- a/en/agentscope.web.workstation.workflow_dag.html
+++ b/en/agentscope.web.workstation.workflow_dag.html
@@ -149,7 +149,7 @@
-
-compile(compiled_filename: str = '') → str[source]
+compile(compiled_filename: str = '', **kwargs) → str[source]
Compile DAG to a runnable python code
diff --git a/en/genindex.html b/en/genindex.html
index 277c08540..65e8a051f 100644
--- a/en/genindex.html
+++ b/en/genindex.html
@@ -164,6 +164,8 @@ _
(agentscope.exception.FunctionCallError method)
(agentscope.exception.ResponseParsingError method)
+
+ (agentscope.exception.StudioError method)
(agentscope.exception.TagNotFoundError method)
@@ -493,6 +495,13 @@ A
- module
+
+
+
+ agentscope.logging
+
+
+ - module
@@ -684,6 +693,8 @@ A
module
+
+
-
agentscope.rpc.rpc_agent_pb2
@@ -691,8 +702,6 @@
A
- module
-
-
agentscope.rpc.rpc_agent_pb2_grpc
@@ -904,24 +913,24 @@
A
- agentscope.utils
+ agentscope.studio
- agentscope.utils.common
+ agentscope.utils
- agentscope.utils.logging_utils
+ agentscope.utils.common
@@ -953,31 +962,31 @@ A
- agentscope.web.studio
+ agentscope.web.gradio
- agentscope.web.studio.constants
+ agentscope.web.gradio.constants
- agentscope.web.studio.studio
+ agentscope.web.gradio.studio
- agentscope.web.studio.utils
+ agentscope.web.gradio.utils
@@ -1039,7 +1048,7 @@ A
ASDiGraph (class in agentscope.web.workstation.workflow_dag)
- audio2text() (in module agentscope.web.studio.utils)
+ audio2text() (in module agentscope.web.gradio.utils)
C
check_port() (in module agentscope.utils.tools)
- check_uuid() (in module agentscope.web.studio.utils)
+ check_uuid() (in module agentscope.web.gradio.utils)
clear() (agentscope.memory.memory.MemoryBase method)
@@ -1287,7 +1296,7 @@ C
create_tempdir() (in module agentscope.utils.common)
- cycle_dots() (in module agentscope.web.studio.utils)
+ cycle_dots() (in module agentscope.web.gradio.utils)
@@ -1509,7 +1518,7 @@ F
(agentscope.utils.MonitorFactory class method)
- fn_choice() (in module agentscope.web.studio.studio)
+ fn_choice() (in module agentscope.web.gradio.studio)
ForLoopPipeline (class in agentscope.pipelines)
@@ -1637,12 +1646,14 @@ G
(agentscope.agents.AgentBase class method)
- generate_image_from_name() (in module agentscope.web.studio.utils)
+ generate_id_from_seed() (in module agentscope.utils.tools)
- generate_server_id() (agentscope.server.launcher.RpcAgentServerLauncher method)
+ generate_image_from_name() (in module agentscope.web.gradio.utils)
+
+ generate_server_id() (agentscope.server.launcher.RpcAgentServerLauncher class method)
generation_method (agentscope.models.gemini_model.GeminiChatWrapper attribute)
@@ -1669,9 +1680,9 @@ G
get_all_agents() (in module agentscope.web.workstation.workflow_node)
- get_chat() (in module agentscope.web.studio.studio)
+ get_chat() (in module agentscope.web.gradio.studio)
- get_chat_msg() (in module agentscope.web.studio.utils)
+ get_chat_msg() (in module agentscope.web.gradio.utils)
get_current_directory() (in module agentscope.service)
@@ -1729,7 +1740,7 @@ G
get_openai_max_length() (in module agentscope.utils.token_utils)
- get_player_input() (in module agentscope.web.studio.utils)
+ get_player_input() (in module agentscope.web.gradio.utils)
get_quota() (agentscope.utils.monitor.DummyMonitor method)
@@ -1741,7 +1752,7 @@ G
(agentscope.utils.MonitorBase method)
- get_reset_msg() (in module agentscope.web.studio.utils)
+ get_reset_msg() (in module agentscope.web.gradio.utils)
get_response() (agentscope.rpc.ResponseStub method)
@@ -1819,19 +1830,19 @@ I
- - import_function_from_path() (in module agentscope.web.studio.studio)
+
- import_function_from_path() (in module agentscope.web.gradio.studio)
- ImportErrorReporter (class in agentscope.utils.tools)
- init() (in module agentscope)
- - init_uid_list() (in module agentscope.web.studio.studio)
+
- init_uid_list() (in module agentscope.web.gradio.studio)
- - init_uid_queues() (in module agentscope.web.studio.utils)
+
- init_uid_queues() (in module agentscope.web.gradio.utils)
- is_callable_expression() (in module agentscope.web.workstation.workflow_utils)
@@ -1959,7 +1970,7 @@ L
LOCAL_ATTRS (agentscope.message.PlaceholderMessage attribute)
- log_studio() (in module agentscope.utils.logging_utils)
+ log_studio() (in module agentscope.logging)
M
agentscope.exception
agentscope.file_manager
+
+ agentscope.logging
agentscope.memory
@@ -2286,12 +2299,12 @@ M
agentscope.service.web.search
agentscope.service.web.web_digest
+
+ agentscope.studio
agentscope.utils
agentscope.utils.common
-
- agentscope.utils.logging_utils
agentscope.utils.monitor
@@ -2301,13 +2314,13 @@ M
agentscope.web
- agentscope.web.studio
+ agentscope.web.gradio
- agentscope.web.studio.constants
+ agentscope.web.gradio.constants
- agentscope.web.studio.studio
+ agentscope.web.gradio.studio
- agentscope.web.studio.utils
+ agentscope.web.gradio.utils
agentscope.web.workstation
@@ -2788,9 +2801,9 @@ R
(agentscope.agents.AgentBase method)
- reset_glb_var() (in module agentscope.web.studio.studio)
+ reset_glb_var() (in module agentscope.web.gradio.studio)
- ResetException
+ ResetException
ResponseFormat (class in agentscope.constants)
@@ -2858,7 +2871,7 @@ R
run() (agentscope.web.workstation.workflow_dag.ASDiGraph method)
- run_app() (in module agentscope.web.studio.studio)
+ run_app() (in module agentscope.web.gradio.studio)
@@ -2868,17 +2881,17 @@ S
- sanitize_node_data() (in module agentscope.web.workstation.workflow_dag)
- - send_audio() (in module agentscope.web.studio.studio)
+
- send_audio() (in module agentscope.web.gradio.studio)
- - send_image() (in module agentscope.web.studio.studio)
+
- send_image() (in module agentscope.web.gradio.studio)
- - send_message() (in module agentscope.web.studio.studio)
+
- send_message() (in module agentscope.web.gradio.studio)
- - send_msg() (in module agentscope.web.studio.utils)
+
- send_msg() (in module agentscope.web.gradio.utils)
- - send_player_input() (in module agentscope.web.studio.utils)
+
- send_player_input() (in module agentscope.web.gradio.utils)
- - send_reset_msg() (in module agentscope.web.studio.utils)
+
- send_reset_msg() (in module agentscope.web.gradio.utils)
- SequentialPipeline (class in agentscope.pipelines)
@@ -2964,12 +2977,8 @@
S
- (agentscope.rpc.rpc_agent_client.ResponseStub method)
- setup_logger() (in module agentscope.utils)
-
-
ShrinkPolicy (class in agentscope.constants)
shutdown() (agentscope.server.launcher.RpcAgentServerLauncher method)
@@ -3013,6 +3022,10 @@ S
STRING (agentscope.prompt.PromptType attribute)
+
+ StudioError
+
+ StudioRegisterError
substrings_in_vision_models_names (agentscope.models.openai_model.OpenAIChatWrapper attribute)
@@ -3202,7 +3215,7 @@ U
url (agentscope.message.Msg attribute)
- user_input() (in module agentscope.web.studio.utils)
+ user_input() (in module agentscope.web.gradio.utils)
UserAgent (class in agentscope.agents)
diff --git a/en/objects.inv b/en/objects.inv
index 921ee0656..963389d4d 100644
Binary files a/en/objects.inv and b/en/objects.inv differ
diff --git a/en/py-modindex.html b/en/py-modindex.html
index 84f974d99..88bb0c8cb 100644
--- a/en/py-modindex.html
+++ b/en/py-modindex.html
@@ -176,6 +176,11 @@ Python Module Index
agentscope.file_manager
+
+
+ agentscope.logging
+
@@ -469,17 +474,17 @@ Python Module Index
- agentscope.utils
+ agentscope.studio
- agentscope.utils.common
+ agentscope.utils
- agentscope.utils.logging_utils
+ agentscope.utils.common
Python Module Index
- agentscope.web.studio
+ agentscope.web.gradio
- agentscope.web.studio.constants
+ agentscope.web.gradio.constants
- agentscope.web.studio.studio
+ agentscope.web.gradio.studio
- agentscope.web.studio.utils
+ agentscope.web.gradio.utils
agentscope._init 源代码
from .agents import AgentBase
from ._runtime import _runtime
from .file_manager import file_manager
-from .utils.logging_utils import LOG_LEVEL, setup_logger
+from .logging import LOG_LEVEL, setup_logger
from .utils.monitor import MonitorFactory
from .models import read_model_configs
from .constants import _DEFAULT_DIR
from .constants import _DEFAULT_LOG_LEVEL
+from .studio._client import _studio_client
# init setting
_INIT_SETTINGS = {}
@@ -133,6 +134,7 @@ agentscope._init 源代码
logger_level: LOG_LEVEL = _DEFAULT_LOG_LEVEL,
runtime_id: Optional[str] = None,
agent_configs: Optional[Union[str, list, dict]] = None,
+ studio_url: Optional[str] = None,
) -> Sequence[AgentBase]:
"""A unified entry to initialize the package, including model configs,
runtime names, saving directories and logging settings.
@@ -168,6 +170,8 @@ agentscope._init 源代码
which can be loaded by json.loads(). One agent config should
cover the required arguments to initialize a specific agent
object, otherwise the default values will be used.
+ studio_url (`Optional[str]`, defaults to `None`):
+ The url of the agentscope studio.
"""
init_process(
model_configs=model_configs,
@@ -179,17 +183,19 @@ agentscope._init 源代码
save_log=save_log,
use_monitor=use_monitor,
logger_level=logger_level,
+ studio_url=studio_url,
)
# save init settings for subprocess
_INIT_SETTINGS["model_configs"] = model_configs
- _INIT_SETTINGS["project"] = project
- _INIT_SETTINGS["name"] = name
+ _INIT_SETTINGS["project"] = _runtime.project
+ _INIT_SETTINGS["name"] = _runtime.name
_INIT_SETTINGS["runtime_id"] = _runtime.runtime_id
_INIT_SETTINGS["save_dir"] = save_dir
_INIT_SETTINGS["save_api_invoke"] = save_api_invoke
_INIT_SETTINGS["save_log"] = save_log
_INIT_SETTINGS["logger_level"] = logger_level
+ _INIT_SETTINGS["use_monitor"] = use_monitor
# Save code if needed
if save_code:
@@ -232,6 +238,7 @@ agentscope._init 源代码
save_log: bool = False,
use_monitor: bool = True,
logger_level: LOG_LEVEL = _DEFAULT_LOG_LEVEL,
+ studio_url: Optional[str] = None,
) -> None:
"""An entry to initialize the package in a process.
@@ -257,12 +264,16 @@ agentscope._init 源代码
Whether to activate the monitor.
logger_level (`LOG_LEVEL`, defaults to `"INFO"`):
The logging level of logger.
+ studio_url (`Optional[str]`, defaults to `None`):
+ The url of the agentscope studio.
"""
# Init the runtime
if project is not None:
_runtime.project = project
+
if name is not None:
_runtime.name = name
+
if runtime_id is not None:
_runtime.runtime_id = runtime_id
@@ -282,6 +293,19 @@ agentscope._init 源代码
db_path=file_manager.path_db,
impl_type="sqlite" if use_monitor else "dummy",
)
+
+ # Init studio client, which will push messages to web ui and fetch user
+ # inputs from web ui
+ if studio_url is not None:
+ _studio_client.initialize(_runtime.runtime_id, studio_url)
+ # Register in AgentScope Studio
+ _studio_client.register_running_instance(
+ project=_runtime.project,
+ name=_runtime.name,
+ timestamp=_runtime.timestamp,
+ run_dir=file_manager.dir_root,
+ pid=os.getpid(),
+ )
diff --git a/zh_CN/_modules/agentscope/agents/agent.html b/zh_CN/_modules/agentscope/agents/agent.html
index 8042b5c29..f7ced5db9 100644
--- a/zh_CN/_modules/agentscope/agents/agent.html
+++ b/zh_CN/_modules/agentscope/agents/agent.html
@@ -113,6 +113,7 @@ agentscope.agents.agent 源代码
from loguru import logger
from agentscope.agents.operator import Operator
+from agentscope.message import Msg
from agentscope.models import load_model_by_config_name
from agentscope.memory import TemporaryMemory
@@ -436,10 +437,33 @@ agentscope.agents.agent 源代码
[文档]
def speak(
self,
- content: Union[str, dict],
+ content: Union[str, Msg],
) -> None:
- """Speak out the content generated by the agent."""
- logger.chat(content)
+ """
+ Speak out the message generated by the agent. If a string is given,
+ a Msg object will be created with the string as the content.
+
+ Args:
+ content (`Union[str, Msg]`):
+ The content of the message to be spoken out. If a string is
+ given, a Msg object will be created with the agent's name, role
+ as "assistant", and the given string as the content.
+ """
+ if isinstance(content, str):
+ msg = Msg(
+ name=self.name,
+ content=content,
+ role="assistant",
+ )
+ elif isinstance(content, Msg):
+ msg = content
+ else:
+ raise TypeError(
+ "From version 0.0.5, the speak method only accepts str or Msg "
+ f"object, got {type(content)} instead.",
+ )
+
+ logger.chat(msg)
diff --git a/zh_CN/_modules/agentscope/agents/rpc_agent.html b/zh_CN/_modules/agentscope/agents/rpc_agent.html
index 54d7308eb..995a91be1 100644
--- a/zh_CN/_modules/agentscope/agents/rpc_agent.html
+++ b/zh_CN/_modules/agentscope/agents/rpc_agent.html
@@ -110,6 +110,7 @@ agentscope.agents.rpc_agent 源代码
)
from agentscope.rpc import RpcAgentClient
from agentscope.server.launcher import RpcAgentServerLauncher
+from agentscope.studio._client import _studio_client
@@ -175,6 +176,9 @@ agentscope.agents.rpc_agent 源代码
launch_server = port is None
if launch_server:
self.host = "localhost"
+ studio_url = None
+ if _studio_client.active:
+ studio_url = _studio_client.studio_url
self.server_launcher = RpcAgentServerLauncher(
host=self.host,
port=port,
@@ -182,6 +186,7 @@ agentscope.agents.rpc_agent 源代码
max_timeout_seconds=max_timeout_seconds,
local_mode=local_mode,
custom_agents=[agent_class],
+ studio_url=studio_url,
)
if not lazy_launch:
self._launch_server()
diff --git a/zh_CN/_modules/agentscope/agents/user_agent.html b/zh_CN/_modules/agentscope/agents/user_agent.html
index 96892d9b4..4a0f46b04 100644
--- a/zh_CN/_modules/agentscope/agents/user_agent.html
+++ b/zh_CN/_modules/agentscope/agents/user_agent.html
@@ -107,8 +107,9 @@ agentscope.agents.user_agent 源代码
from loguru import logger
from agentscope.agents import AgentBase
+from agentscope.studio._client import _studio_client
from agentscope.message import Msg
-from agentscope.web.studio.utils import user_input
+from agentscope.web.gradio.utils import user_input
@@ -173,25 +174,41 @@ agentscope.agents.user_agent 源代码
if self.memory:
self.memory.add(x)
- # TODO: To avoid order confusion, because `input` print much quicker
- # than logger.chat
- time.sleep(0.5)
- content = user_input(timeout=timeout)
-
- kwargs = {}
- if required_keys is not None:
- if isinstance(required_keys, str):
- required_keys = [required_keys]
-
- for key in required_keys:
- kwargs[key] = input(f"{key}: ")
-
- # Input url of file, image, video, audio or website
- url = None
- if self.require_url:
- url = input("URL (or Enter to skip): ")
- if url == "":
- url = None
+ if _studio_client.active:
+ logger.info(
+ f"Waiting for input from:\n\n"
+ f" * {_studio_client.get_run_detail_page_url()}\n",
+ )
+ raw_input = _studio_client.get_user_input(
+ agent_id=self.agent_id,
+ name=self.name,
+ require_url=self.require_url,
+ required_keys=required_keys,
+ )
+
+ print("Python: receive ", raw_input)
+ content = raw_input["content"]
+ url = raw_input["url"]
+ kwargs = {}
+ else:
+ # TODO: To avoid order confusion, because `input` print much
+ # quicker than logger.chat
+ time.sleep(0.5)
+ content = user_input(timeout=timeout)
+ kwargs = {}
+ if required_keys is not None:
+ if isinstance(required_keys, str):
+ required_keys = [required_keys]
+
+ for key in required_keys:
+ kwargs[key] = input(f"{key}: ")
+
+ # Input url of file, image, video, audio or website
+ url = None
+ if self.require_url:
+ url = input("URL (or Enter to skip): ")
+ if url == "":
+ url = None
# Add additional keys
msg = Msg(
@@ -215,10 +232,35 @@ agentscope.agents.user_agent 源代码
[文档]
def speak(
self,
- content: Union[str, dict],
+ content: Union[str, Msg],
) -> None:
- """Speak the content to the audience."""
- logger.chat(content, disable_studio=True)
+ """
+ Speak out the message generated by the agent. If a string is given,
+ a Msg object will be created with the string as the content.
+
+ Args:
+ content (`Union[str, Msg]`):
+ The content of the message to be spoken out. If a string is
+ given, a Msg object will be created with the agent's name, role
+ as "user", and the given string as the content.
+
+ """
+ if isinstance(content, str):
+ msg = Msg(
+ name=self.name,
+ content=content,
+ role="assistant",
+ )
+ _studio_client.push_message(msg)
+ elif isinstance(content, Msg):
+ msg = content
+ else:
+ raise TypeError(
+ "From version 0.0.5, the speak method only accepts str or Msg "
+ f"object, got {type(content)} instead.",
+ )
+
+ logger.chat(msg)
diff --git a/zh_CN/_modules/agentscope/exception.html b/zh_CN/_modules/agentscope/exception.html
index 6cb4a4d1d..a0e11137d 100644
--- a/zh_CN/_modules/agentscope/exception.html
+++ b/zh_CN/_modules/agentscope/exception.html
@@ -239,6 +239,30 @@ agentscope.exception 源代码
class ArgumentTypeError(FunctionCallError):
"""The exception class for argument type error."""
+
+
+
+[文档]
+class StudioError(Exception):
+ """The base class for exception raising during interaction with agentscope
+ studio."""
+
+
+
+
+ def __str__(self) -> str:
+ return f"{self.__class__.__name__}: {self.message}"
+
+
+
+
+[文档]
+class StudioRegisterError(StudioError):
+ """The exception class for error when registering to agentscope studio."""
+
diff --git a/zh_CN/_modules/agentscope/utils/logging_utils.html b/zh_CN/_modules/agentscope/logging.html
similarity index 90%
rename from zh_CN/_modules/agentscope/utils/logging_utils.html
rename to zh_CN/_modules/agentscope/logging.html
index 62d9b666c..1743fe0c7 100644
--- a/zh_CN/_modules/agentscope/utils/logging_utils.html
+++ b/zh_CN/_modules/agentscope/logging.html
@@ -1,30 +1,30 @@
-
+
- agentscope.utils.logging_utils — AgentScope 文档
-
-
-
+ agentscope.logging — AgentScope 文档
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
+
+
+
@@ -35,43 +35,43 @@
-
+
AgentScope
-
AgentScope 教程
AgentScope API 文档
-- agentscope
-- agentscope.message
-- agentscope.models
-- agentscope.agents
-- agentscope.memory
-- agentscope.parsers
-- agentscope.exception
-- agentscope.pipelines
-- agentscope.service
-- agentscope.rpc
-- agentscope.server
-- agentscope.web
-- agentscope.prompt
-- agentscope.utils
+- agentscope
+- agentscope.message
+- agentscope.models
+- agentscope.agents
+- agentscope.memory
+- agentscope.parsers
+- agentscope.exception
+- agentscope.pipelines
+- agentscope.service
+- agentscope.rpc
+- agentscope.server
+- agentscope.web
+- agentscope.prompt
+- agentscope.utils
@@ -80,16 +80,16 @@
@@ -98,17 +98,18 @@
- agentscope.utils.logging_utils 源代码
+ agentscope.logging 源代码
# -*- coding: utf-8 -*-
"""Logging utilities."""
import json
import os
import sys
-from typing import Optional, Literal, Union, Any
+from typing import Optional, Literal, Any
from loguru import logger
-from agentscope.web.studio.utils import (
+from agentscope.studio._client import _studio_client
+from agentscope.web.gradio.utils import (
generate_image_from_name,
send_msg,
get_reset_msg,
@@ -171,20 +172,25 @@ agentscope.utils.logging_utils 源代码
# add chat function for logger
def _chat(
- message: Union[str, dict],
+ message: dict,
*args: Any,
disable_studio: bool = False,
**kwargs: Any,
) -> None:
- """Log a chat message with the format of"<speaker>: <content>".
+ """
+ Log a chat message with the format of"<speaker>: <content>". If the
+ running instance is registered in the studio, the message will be sent
+ and display in the studio.
Args:
- message (`Union[str, dict]`):
- The message to be logged. If it is a string, it will be logged
- directly. If it's a dict, it should have "name"(or "role") and
- "content" keys, and the message will be logged as "<name/role>:
- <content>".
+ message (`dict`):
+ The message to be logged as "<name/role>: <content>", which must
+ be an object of Msg class.
"""
+ # Push message to studio if it is active
+ if _studio_client.active:
+ _studio_client.push_message(message)
+
# Save message into chat file, add default to ignore not serializable
# objects
logger.log(
@@ -246,7 +252,7 @@ agentscope.utils.logging_utils 源代码
-[文档]
+[文档]
def log_studio(message: dict, uid: str, **kwargs: Any) -> None:
"""Send chat message to studio.
@@ -319,7 +325,7 @@ agentscope.utils.logging_utils 源代码
-[文档]
+[文档]
def setup_logger(
path_log: Optional[str] = None,
level: LOG_LEVEL = "INFO",
diff --git a/zh_CN/_modules/agentscope/message.html b/zh_CN/_modules/agentscope/message.html
index 35b0f7cce..4a97cf386 100644
--- a/zh_CN/_modules/agentscope/message.html
+++ b/zh_CN/_modules/agentscope/message.html
@@ -162,10 +162,7 @@ agentscope.message 源代码
self.content = content
self.role = role
- if url:
- self.url = url
- else:
- self.url = None
+ self.url = url
self.update(kwargs)
@@ -382,7 +379,7 @@ agentscope.message 源代码
[文档]
-class PlaceholderMessage(MessageBase):
+class PlaceholderMessage(Msg):
"""A placeholder for the return message of RpcAgent."""
PLACEHOLDER_ATTRS = {
diff --git a/zh_CN/_modules/agentscope/server/launcher.html b/zh_CN/_modules/agentscope/server/launcher.html
index 36de7aa12..60436fd80 100644
--- a/zh_CN/_modules/agentscope/server/launcher.html
+++ b/zh_CN/_modules/agentscope/server/launcher.html
@@ -102,11 +102,12 @@ agentscope.server.launcher 源代码
# -*- coding: utf-8 -*-
""" Server of distributed agent"""
import os
-from multiprocessing import Process, Event, Pipe
-from multiprocessing.synchronize import Event as EventClass
import asyncio
import signal
import argparse
+import time
+from multiprocessing import Process, Event, Pipe
+from multiprocessing.synchronize import Event as EventClass
from typing import Type
from concurrent import futures
from loguru import logger
@@ -124,14 +125,10 @@ agentscope.server.launcher 源代码
import_error,
"distribute",
)
-
import agentscope
from agentscope.server.servicer import AgentServerServicer
from agentscope.agents.agent import AgentBase
-from agentscope.utils.tools import (
- _get_timestamp,
- check_port,
-)
+from agentscope.utils.tools import check_port, generate_id_from_seed
def _setup_agent_server(
@@ -145,6 +142,7 @@ agentscope.server.launcher 源代码
local_mode: bool = True,
max_pool_size: int = 8192,
max_timeout_seconds: int = 1800,
+ studio_url: str = None,
custom_agents: list = None,
) -> None:
"""Setup agent server.
@@ -157,7 +155,7 @@ agentscope.server.launcher 源代码
server_id (`str`):
The id of the server.
init_settings (`dict`, defaults to `None`):
- Init settings for agentscope.init.
+ Init settings for _init_server.
start_event (`EventClass`, defaults to `None`):
An Event instance used to determine whether the child process
has been started.
@@ -172,6 +170,8 @@ agentscope.server.launcher 源代码
Max number of agent replies that the server can accommodate.
max_timeout_seconds (`int`, defaults to `1800`):
Timeout for agent replies.
+ studio_url (`str`, defaults to `None`):
+ URL of the AgentScope Studio.
custom_agents (`list`, defaults to `None`):
A list of custom agent classes that are not in `agentscope.agents`.
"""
@@ -187,6 +187,7 @@ agentscope.server.launcher 源代码
local_mode=local_mode,
max_pool_size=max_pool_size,
max_timeout_seconds=max_timeout_seconds,
+ studio_url=studio_url,
custom_agents=custom_agents,
),
)
@@ -203,6 +204,7 @@ agentscope.server.launcher 源代码
local_mode: bool = True,
max_pool_size: int = 8192,
max_timeout_seconds: int = 1800,
+ studio_url: str = None,
custom_agents: list = None,
) -> None:
"""Setup agent server in an async way.
@@ -215,7 +217,7 @@ agentscope.server.launcher 源代码
server_id (`str`):
The id of the server.
init_settings (`dict`, defaults to `None`):
- Init settings for agentscope.init.
+ Init settings for _init_server.
start_event (`EventClass`, defaults to `None`):
An Event instance used to determine whether the child process
has been started.
@@ -234,6 +236,8 @@ agentscope.server.launcher 源代码
max_timeout_seconds (`int`, defaults to `1800`):
Maximum time for reply messages to be cached in the server.
Note that expired messages will be deleted.
+ studio_url (`str`, defaults to `None`):
+ URL of the AgentScope Studio.
custom_agents (`list`, defaults to `None`):
A list of custom agent classes that are not in `agentscope.agents`.
"""
@@ -244,6 +248,8 @@ agentscope.server.launcher 源代码
servicer = AgentServerServicer(
host=host,
port=port,
+ server_id=server_id,
+ studio_url=studio_url,
max_pool_size=max_pool_size,
max_timeout_seconds=max_timeout_seconds,
)
@@ -321,6 +327,7 @@ agentscope.server.launcher 源代码
local_mode: bool = False,
custom_agents: list = None,
server_id: str = None,
+ studio_url: str = None,
agent_class: Type[AgentBase] = None,
agent_args: tuple = (),
agent_kwargs: dict = None,
@@ -348,6 +355,8 @@ agentscope.server.launcher 源代码
server_id (`str`, defaults to `None`):
The id of the agent server. If not specified, a random id
will be generated.
+ studio_url (`Optional[str]`, defaults to `None`):
+ The url of the agentscope studio.
agent_class (`Type[AgentBase]`, deprecated):
The AgentBase subclass encapsulated by this wrapper.
agent_args (`tuple`, deprecated): The args tuple used to
@@ -365,8 +374,11 @@ agentscope.server.launcher 源代码
self.parent_con = None
self.custom_agents = custom_agents
self.server_id = (
- self.generate_server_id() if server_id is None else server_id
+ RpcAgentServerLauncher.generate_server_id(self.host, self.port)
+ if server_id is None
+ else server_id
)
+ self.studio_url = studio_url
if (
agent_class is not None
or len(agent_args) > 0
@@ -380,9 +392,10 @@ agentscope.server.launcher 源代码
[文档]
- def generate_server_id(self) -> str:
+ @classmethod
+ def generate_server_id(cls, host: str, port: int) -> str:
"""Generate server id"""
- return f"{self.host}:{self.port}-{_get_timestamp('%y%m%d-%H:%M:%S')}"
+ return generate_id_from_seed(f"{host}:{port}:{time.time()}", length=8)
def _launch_in_main(self) -> None:
@@ -399,6 +412,7 @@ agentscope.server.launcher 源代码
max_timeout_seconds=self.max_timeout_seconds,
local_mode=self.local_mode,
custom_agents=self.custom_agents,
+ studio_url=self.studio_url,
),
)
@@ -422,6 +436,7 @@ agentscope.server.launcher 源代码
"max_pool_size": self.max_pool_size,
"max_timeout_seconds": self.max_timeout_seconds,
"local_mode": self.local_mode,
+ "studio_url": self.studio_url,
"custom_agents": self.custom_agents,
},
)
@@ -541,7 +556,7 @@ agentscope.server.launcher 源代码
type=bool,
default=False,
help=(
- "If `True`, only listen to requests from 'localhost', otherwise, "
+ "if `True`, only listen to requests from 'localhost', otherwise, "
"listen to requests from all hosts."
),
)
@@ -550,21 +565,51 @@ agentscope.server.launcher 源代码
type=str,
help="path to the model config json file",
)
+ parser.add_argument(
+ "--server-id",
+ type=str,
+ default=None,
+ help="id of the server, used to register to the studio, generated"
+ " randomly if not specified.",
+ )
+ parser.add_argument(
+ "--studio-url",
+ type=str,
+ default=None,
+ help="the url of agentscope studio",
+ )
+ parser.add_argument(
+ "--no-log",
+ action="store_true",
+ help="whether to disable log",
+ )
+ parser.add_argument(
+ "--save-api-invoke",
+ action="store_true",
+ help="whether to save api invoke",
+ )
+ parser.add_argument(
+ "--use-monitor",
+ action="store_true",
+ help="whether to use monitor",
+ )
args = parser.parse_args()
agentscope.init(
project="agent_server",
name=f"server_{args.host}:{args.port}",
- runtime_id=_get_timestamp(
- "server_{}_{}_%y%m%d-%H%M%S",
- ).format(args.host, args.port),
+ save_log=not args.no_log,
+ save_api_invoke=args.save_api_invoke,
model_configs=args.model_config_path,
+ use_monitor=args.use_monitor,
)
launcher = RpcAgentServerLauncher(
host=args.host,
port=args.port,
+ server_id=args.server_id,
max_pool_size=args.max_pool_size,
max_timeout_seconds=args.max_timeout_seconds,
local_mode=args.local_mode,
+ studio_url=args.studio_url,
)
launcher.launch(in_subprocess=False)
launcher.wait_until_terminate()
diff --git a/zh_CN/_modules/agentscope/server/servicer.html b/zh_CN/_modules/agentscope/server/servicer.html
index a113fa7da..ebd3e013f 100644
--- a/zh_CN/_modules/agentscope/server/servicer.html
+++ b/zh_CN/_modules/agentscope/server/servicer.html
@@ -107,6 +107,7 @@ agentscope.server.servicer 源代码
import traceback
from concurrent import futures
from loguru import logger
+import requests
try:
import dill
@@ -126,7 +127,10 @@ agentscope.server.servicer 源代码
"distribute",
)
+from .._runtime import _runtime
+from ..studio._client import _studio_client
from ..agents.agent import AgentBase
+from ..exception import StudioRegisterError
from ..rpc.rpc_agent_pb2_grpc import RpcAgentServicer
from ..message import (
Msg,
@@ -135,6 +139,24 @@ agentscope.server.servicer 源代码
)
+def _register_to_studio(
+ studio_url: str,
+ server_id: str,
+ host: str,
+ port: int,
+) -> None:
+ """Register a server to studio."""
+ url = f"{studio_url}/api/servers/register"
+ resp = requests.post(
+ url,
+ json={"server_id": server_id, "host": host, "port": port},
+ timeout=10, # todo: configurable timeout
+ )
+ if resp.status_code != 200:
+ logger.error(f"Failed to register server: {resp.text}")
+ raise StudioRegisterError(f"Failed to register server: {resp.text}")
+
+
[文档]
class AgentServerServicer(RpcAgentServicer):
@@ -146,6 +168,8 @@ agentscope.server.servicer 源代码
self,
host: str = "localhost",
port: int = None,
+ server_id: str = None,
+ studio_url: str = None,
max_pool_size: int = 8192,
max_timeout_seconds: int = 1800,
):
@@ -156,6 +180,10 @@ agentscope.server.servicer 源代码
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
@@ -166,6 +194,17 @@ agentscope.server.servicer 源代码
"""
self.host = host
self.port = port
+ self.server_id = server_id
+ self.studio_url = studio_url
+ if studio_url is not None:
+ _register_to_studio(
+ studio_url=studio_url,
+ server_id=server_id,
+ host=host,
+ port=port,
+ )
+ _studio_client.initialize(_runtime.runtime_id, studio_url)
+
self.result_pool = ExpiringDict(
max_len=max_pool_size,
max_age_seconds=max_timeout_seconds,
diff --git a/zh_CN/_modules/agentscope/studio/_app.html b/zh_CN/_modules/agentscope/studio/_app.html
new file mode 100644
index 000000000..51d0e055e
--- /dev/null
+++ b/zh_CN/_modules/agentscope/studio/_app.html
@@ -0,0 +1,834 @@
+
+
+
+
+
+
+ agentscope.studio._app — AgentScope 文档
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - 模块代码
+ - agentscope.studio._app
+ -
+
+
+
+
+
+
+
+ agentscope.studio._app 源代码
+# -*- coding: utf-8 -*-
+"""The Web Server of the AgentScope Studio."""
+import json
+import os
+import re
+import subprocess
+import tempfile
+import threading
+import traceback
+from datetime import datetime
+from typing import Tuple, Union, Any, Optional
+from pathlib import Path
+
+from flask import (
+ Flask,
+ request,
+ jsonify,
+ render_template,
+ Response,
+ abort,
+ send_file,
+)
+from flask_cors import CORS
+from flask_sqlalchemy import SQLAlchemy
+from flask_socketio import SocketIO, join_room, leave_room
+
+from agentscope._runtime import _runtime
+from agentscope.constants import _DEFAULT_SUBDIR_CODE, _DEFAULT_SUBDIR_INVOKE
+from agentscope.utils.tools import _is_process_alive
+
+_app = Flask(__name__)
+
+# Set the cache directory
+_cache_dir = str(Path.home() / ".cache" / "agentscope-studio")
+os.makedirs(_cache_dir, exist_ok=True)
+_app.config[
+ "SQLALCHEMY_DATABASE_URI"
+] = f"sqlite:////{_cache_dir}/agentscope.db"
+_db = SQLAlchemy(_app)
+
+_socketio = SocketIO(_app)
+
+# This will enable CORS for all routes
+CORS(_app)
+
+_RUNS_DIRS = []
+
+
+class _UserInputRequestQueue:
+ """A queue to store the user input requests."""
+
+ _requests = {}
+ """The user input requests in the queue."""
+
+ @classmethod
+ def add_request(cls, run_id: str, agent_id: str, data: dict) -> None:
+ """Add a new user input request into queue.
+
+ Args:
+ run_id (`str`):
+ The id of the runtime instance.
+ agent_id (`str`):
+ The id of the agent that requires user input.
+ data (`dict`):
+ The data of the user input request.
+ """
+ if run_id not in cls._requests:
+ cls._requests[run_id] = {agent_id: data}
+ else:
+ # We ensure that the agent_id is unique here
+ cls._requests[run_id][agent_id] = data
+
+ @classmethod
+ def fetch_a_request(cls, run_id: str) -> Optional[dict]:
+ """Fetch a user input request from the queue.
+
+ Args:
+ run_id (`str`):
+ The id of the runtime instance.
+ """
+ if run_id in cls._requests and len(cls._requests[run_id]) > 0:
+ # Fetch the oldest request
+ agent_id = list(cls._requests[run_id].keys())[0]
+ return cls._requests[run_id][agent_id]
+ else:
+ return None
+
+ @classmethod
+ def close_a_request(cls, run_id: str, agent_id: str) -> None:
+ """Close a user input request in the queue.
+
+ Args:
+ run_id (`str`):
+ The id of the runtime instance.
+ agent_id (`str`):
+ The id of the agent that requires user input.
+ """
+ if run_id in cls._requests:
+ cls._requests[run_id].pop(agent_id)
+
+
+class _RunTable(_db.Model): # type: ignore[name-defined]
+ """Runtime object."""
+
+ run_id = _db.Column(_db.String, primary_key=True)
+ project = _db.Column(_db.String)
+ name = _db.Column(_db.String)
+ timestamp = _db.Column(_db.String)
+ run_dir = _db.Column(_db.String)
+ pid = _db.Column(_db.Integer)
+ status = _db.Column(_db.String, default="finished")
+
+
+class _ServerTable(_db.Model): # type: ignore[name-defined]
+ """Server object."""
+
+ id = _db.Column(_db.String, primary_key=True)
+ host = _db.Column(_db.String)
+ port = _db.Column(_db.Integer)
+ create_time = _db.Column(_db.DateTime, default=datetime.now)
+
+
+class _MessageTable(_db.Model): # type: ignore[name-defined]
+ """Message object."""
+
+ id = _db.Column(_db.Integer, primary_key=True)
+ run_id = _db.Column(
+ _db.String,
+ _db.ForeignKey("run_table.run_id"),
+ nullable=False,
+ )
+ name = _db.Column(_db.String)
+ role = _db.Column(_db.String)
+ content = _db.Column(_db.String)
+ url = _db.Column(_db.String)
+ meta = _db.Column(_db.String)
+ timestamp = _db.Column(_db.String)
+
+
+def _get_all_runs_from_dir() -> dict:
+ """Get all runs from the directory."""
+ global _RUNS_DIRS
+ runtime_configs_from_dir = {}
+ if _RUNS_DIRS is not None:
+ for runs_dir in set(_RUNS_DIRS):
+ for runtime_dir in os.listdir(runs_dir):
+ path_runtime = os.path.join(runs_dir, runtime_dir)
+ path_config = os.path.join(path_runtime, ".config")
+ if os.path.exists(path_config):
+ with open(path_config, "r", encoding="utf-8") as file:
+ runtime_config = json.load(file)
+
+ # Default status is finished
+ # Note: this is only for local runtime instances
+ if "pid" in runtime_config and _is_process_alive(
+ runtime_config["pid"],
+ runtime_config["timestamp"],
+ ):
+ runtime_config["status"] = "running"
+ else:
+ runtime_config["status"] = "finished"
+
+ if "run_dir" not in runtime_config:
+ runtime_config["run_dir"] = path_runtime
+
+ if "id" in runtime_config:
+ runtime_config["run_id"] = runtime_config["id"]
+ del runtime_config["id"]
+
+ runtime_id = runtime_config.get("run_id")
+ runtime_configs_from_dir[runtime_id] = runtime_config
+
+ return runtime_configs_from_dir
+
+
+def _remove_file_paths(error_trace: str) -> str:
+ """
+ Remove the real traceback when exception happens.
+ """
+ path_regex = re.compile(r'File "(.*?)(?=agentscope|app\.py)')
+ cleaned_trace = re.sub(path_regex, 'File "[hidden]/', error_trace)
+
+ return cleaned_trace
+
+
+def _convert_to_py( # type: ignore[no-untyped-def]
+ content: str,
+ **kwargs,
+) -> Tuple:
+ """
+ Convert json config to python code.
+ """
+ from agentscope.web.workstation.workflow_dag import build_dag
+
+ try:
+ cfg = json.loads(content)
+ return "True", build_dag(cfg).compile(**kwargs)
+ except Exception as e:
+ return "False", _remove_file_paths(
+ f"Error: {e}\n\n" f"Traceback:\n" f"{traceback.format_exc()}",
+ )
+
+
+@_app.route("/workstation")
+def _workstation() -> str:
+ """Render the workstation page."""
+ return render_template("workstation.html")
+
+
+@_app.route("/api/runs/register", methods=["POST"])
+def _register_run() -> Response:
+ """Registers a running instance of an agentscope application."""
+
+ # Extract the input data from the request
+ data = request.json
+ run_id = data.get("run_id")
+
+ # check if the run_id is already in the database
+ if _RunTable.query.filter_by(run_id=run_id).first():
+ abort(400, f"RUN_ID {run_id} already exists")
+
+ # Add into the database
+ _db.session.add(
+ _RunTable(
+ run_id=run_id,
+ project=data.get("project"),
+ name=data.get("name"),
+ timestamp=data.get("timestamp"),
+ run_dir=data.get("run_dir"),
+ pid=data.get("pid"),
+ status="running",
+ ),
+ )
+ _db.session.commit()
+
+ return jsonify(status="ok")
+
+
+@_app.route("/api/servers/register", methods=["POST"])
+def _register_server() -> Response:
+ """
+ Registers an agent server.
+ """
+ data = request.json
+ server_id = data.get("server_id")
+ host = data.get("host")
+ port = data.get("port")
+
+ if _ServerTable.query.filter_by(id=server_id).first():
+ _app.logger.error(f"Server id {server_id} already exists.")
+ abort(400, f"run_id [{server_id}] already exists")
+
+ _db.session.add(
+ _ServerTable(
+ id=server_id,
+ host=host,
+ port=port,
+ ),
+ )
+ _db.session.commit()
+
+ _app.logger.info(f"Register server id {server_id}")
+ return jsonify(status="ok")
+
+
+@_app.route("/api/messages/push", methods=["POST"])
+def _push_message() -> Response:
+ """Receive a message from the agentscope application, and display it on
+ the web UI."""
+ _app.logger.debug("Flask: receive push_message")
+ data = request.json
+
+ run_id = data["run_id"]
+ name = data["name"]
+ role = data["role"]
+ content = data["content"]
+ metadata = data["metadata"]
+ timestamp = data["timestamp"]
+ url = data["url"]
+
+ try:
+ new_message = _MessageTable(
+ run_id=run_id,
+ name=name,
+ role=role,
+ content=content,
+ # Before storing into the database, we need to convert the url into
+ # a string
+ meta=json.dumps(metadata),
+ url=json.dumps(url),
+ timestamp=timestamp,
+ )
+ _db.session.add(new_message)
+ _db.session.commit()
+ except Exception as e:
+ abort(400, "Fail to put message with error: " + str(e))
+
+ data = {
+ "run_id": run_id,
+ "name": name,
+ "role": role,
+ "content": content,
+ "url": url,
+ "metadata": metadata,
+ "timestamp": timestamp,
+ }
+
+ _socketio.emit(
+ "display_message",
+ data,
+ room=run_id,
+ )
+ _app.logger.debug("Flask: send display_message")
+ return jsonify(status="ok")
+
+
+@_app.route("/api/messages/run/<run_id>", methods=["GET"])
+def _get_messages(run_id: str) -> Response:
+ """Get the history messages of specific run_id."""
+ # From registered runtime instances
+ if len(_RunTable.query.filter_by(run_id=run_id).all()) > 0:
+ messages = _MessageTable.query.filter_by(run_id=run_id).all()
+ msgs = [
+ {
+ "name": message.name,
+ "role": message.role,
+ "content": message.content,
+ "url": json.loads(message.url),
+ "metadata": json.loads(message.meta),
+ "timestamp": message.timestamp,
+ }
+ for message in messages
+ ]
+ return jsonify(msgs)
+
+ # From the local file
+ run_dir = request.args.get("run_dir", default=None, type=str)
+
+ # Search the run_dir from the registered runtime instances if not provided
+ if run_dir is None:
+ runtime_configs_from_dir = _get_all_runs_from_dir()
+ if run_id in runtime_configs_from_dir:
+ run_dir = runtime_configs_from_dir[run_id]["run_dir"]
+
+ # Load the messages from the local file
+ path_messages = os.path.join(run_dir, "logging.chat")
+ if run_dir is None or not os.path.exists(path_messages):
+ return jsonify([])
+ else:
+ with open(path_messages, "r", encoding="utf-8") as file:
+ msgs = [json.loads(_) for _ in file.readlines()]
+ return jsonify(msgs)
+
+
+@_app.route("/api/runs/get/<run_id>", methods=["GET"])
+def _get_run(run_id: str) -> Response:
+ """Get a specific run's detail."""
+ run = _RunTable.query.filter_by(run_id=run_id).first()
+ if not run:
+ abort(400, f"run_id [{run_id}] not exists")
+ return jsonify(
+ {
+ "run_id": run.run_id,
+ "project": run.project,
+ "name": run.name,
+ "timestamp": run.timestamp,
+ "run_dir": run.run_dir,
+ "pid": run.pid,
+ "status": run.status,
+ },
+ )
+
+
+@_app.route("/api/runs/all", methods=["GET"])
+def _get_all_runs() -> Response:
+ """Get all runs."""
+ # Update the status of the registered runtimes
+ # Note: this is only for the applications running on the local machine
+ for run in _RunTable.query.filter(
+ _RunTable.status.in_(["running", "waiting"]),
+ ).all():
+ if not _is_process_alive(run.pid, run.timestamp):
+ _RunTable.query.filter_by(run_id=run.run_id).update(
+ {"status": "finished"},
+ )
+ _db.session.commit()
+
+ # From web connection
+ runtime_configs_from_register = {
+ _.run_id: {
+ "run_id": _.run_id,
+ "project": _.project,
+ "name": _.name,
+ "timestamp": _.timestamp,
+ "run_dir": _.run_dir,
+ "pid": _.pid,
+ "status": _.status,
+ }
+ for _ in _RunTable.query.all()
+ }
+
+ # From directory
+ runtime_configs_from_dir = _get_all_runs_from_dir()
+
+ # Remove duplicates between two sources
+ clean_runtimes = {
+ **runtime_configs_from_dir,
+ **runtime_configs_from_register,
+ }
+
+ runs = list(clean_runtimes.values())
+
+ return jsonify(runs)
+
+
+@_app.route("/api/invocation", methods=["GET"])
+def _get_invocations() -> Response:
+ """Get all API invocations in a run instance."""
+ run_dir = request.args.get("run_dir")
+ path_invocations = os.path.join(run_dir, _DEFAULT_SUBDIR_INVOKE)
+
+ invocations = []
+ if os.path.exists(path_invocations):
+ for filename in os.listdir(path_invocations):
+ with open(
+ os.path.join(path_invocations, filename),
+ "r",
+ encoding="utf-8",
+ ) as file:
+ invocations.append(json.load(file))
+ return jsonify(invocations)
+
+
+@_app.route("/api/code", methods=["GET"])
+def _get_code() -> Response:
+ """Get the python code from the run directory."""
+ run_dir = request.args.get("run_dir")
+
+ dir_code = os.path.join(run_dir, _DEFAULT_SUBDIR_CODE)
+
+ codes = {}
+ if os.path.exists(dir_code):
+ for filename in os.listdir(dir_code):
+ with open(
+ os.path.join(dir_code, filename),
+ "r",
+ encoding="utf-8",
+ ) as file:
+ codes[filename] = "".join(file.readlines())
+ return jsonify(codes)
+
+
+@_app.route("/api/file", methods=["GET"])
+def _get_file() -> Any:
+ """Get the local file via the url."""
+ file_path = request.args.get("path", None)
+
+ if file_path is not None:
+ try:
+ file = send_file(file_path)
+ return file
+ except FileNotFoundError:
+ return jsonify({"error": "File not found."})
+ return jsonify({"error": "File not found."})
+
+
+@_app.route("/convert-to-py", methods=["POST"])
+def _convert_config_to_py() -> Response:
+ """
+ Convert json config to python code and send back.
+ """
+ content = request.json.get("data")
+ status, py_code = _convert_to_py(content)
+ return jsonify(py_code=py_code, is_success=status)
+
+
+def _cleanup_process(proc: subprocess.Popen) -> None:
+ """Clean up the process for running application started by workstation."""
+ proc.wait()
+ _app.logger.debug(f"The process with pid {proc.pid} is closed")
+
+
+@_app.route("/convert-to-py-and-run", methods=["POST"])
+def _convert_config_to_py_and_run() -> Response:
+ """
+ Convert json config to python code and run.
+ """
+ content = request.json.get("data")
+ studio_url = request.url_root.rstrip("/")
+ run_id = _runtime.generate_new_runtime_id()
+ status, py_code = _convert_to_py(
+ content,
+ runtime_id=run_id,
+ studio_url=studio_url,
+ )
+
+ if status == "True":
+ try:
+ with tempfile.NamedTemporaryFile(
+ delete=False,
+ suffix=".py",
+ mode="w+t",
+ ) as tmp:
+ tmp.write(py_code)
+ tmp.flush()
+ proc = subprocess.Popen( # pylint: disable=R1732
+ ["python", tmp.name],
+ )
+ threading.Thread(target=_cleanup_process, args=(proc,)).start()
+ except Exception as e:
+ status, py_code = "False", _remove_file_paths(
+ f"Error: {e}\n\n" f"Traceback:\n" f"{traceback.format_exc()}",
+ )
+ return jsonify(py_code=py_code, is_success=status, run_id=run_id)
+
+
+@_app.route("/read-examples", methods=["POST"])
+def _read_examples() -> Response:
+ """
+ Read tutorial examples from local file.
+ """
+ lang = request.json.get("lang")
+ file_index = request.json.get("data")
+
+ if not os.path.exists(
+ os.path.join(
+ _app.root_path,
+ "static",
+ "workstation_templates",
+ f"{lang}{file_index}.json",
+ ),
+ ):
+ lang = "en"
+
+ with open(
+ os.path.join(
+ _app.root_path,
+ "static",
+ "workstation_templates",
+ f"{lang}{file_index}.json",
+ ),
+ "r",
+ encoding="utf-8",
+ ) as jf:
+ data = json.load(jf)
+ return jsonify(json=data)
+
+
+@_app.route("/")
+def _home() -> str:
+ """Render the home page."""
+ return render_template("index.html")
+
+
+@_socketio.on("request_user_input")
+def _request_user_input(data: dict) -> None:
+ """Request user input"""
+ _app.logger.debug("Flask: receive request_user_input")
+
+ run_id = data["run_id"]
+ agent_id = data["agent_id"]
+
+ # Change the status into waiting
+ _db.session.query(_RunTable).filter_by(run_id=run_id).update(
+ {"status": "waiting"},
+ )
+ _db.session.commit()
+
+ # Record into the queue
+ _UserInputRequestQueue.add_request(run_id, agent_id, data)
+
+ # Ask for user input from the web ui
+ _socketio.emit(
+ "enable_user_input",
+ data,
+ room=run_id,
+ )
+
+ _app.logger.debug("Flask: send enable_user_input")
+
+
+@_socketio.on("user_input_ready")
+def _user_input_ready(data: dict) -> None:
+ """Get user input and send to the agent"""
+ _app.logger.debug(f"Flask: receive user_input_ready: {data}")
+
+ run_id = data["run_id"]
+ agent_id = data["agent_id"]
+ content = data["content"]
+ url = data["url"]
+
+ _db.session.query(_RunTable).filter_by(run_id=run_id).update(
+ {"status": "running"},
+ )
+ _db.session.commit()
+
+ # Return to AgentScope application
+ _socketio.emit(
+ "fetch_user_input",
+ {
+ "agent_id": agent_id,
+ "name": data["name"],
+ "run_id": run_id,
+ "content": content,
+ "url": None if url in ["", []] else url,
+ },
+ room=run_id,
+ )
+
+ # Close the request in the queue
+ _UserInputRequestQueue.close_a_request(run_id, agent_id)
+
+ # Fetch a new user input request for this run_id if exists
+ new_request = _UserInputRequestQueue.fetch_a_request(run_id)
+ if new_request is not None:
+ _socketio.emit(
+ "enable_user_input",
+ new_request,
+ room=run_id,
+ )
+
+ _app.logger.debug("Flask: send fetch_user_input")
+
+
+@_socketio.on("connect")
+def _on_connect() -> None:
+ """Execute when a client is connected."""
+ _app.logger.info("New client connected")
+
+
+@_socketio.on("disconnect")
+def _on_disconnect() -> None:
+ """Execute when a client is disconnected."""
+ _app.logger.info("Client disconnected")
+
+
+@_socketio.on("join")
+def _on_join(data: dict) -> None:
+ """Join a websocket room"""
+ run_id = data["run_id"]
+ join_room(run_id)
+
+ new_request = _UserInputRequestQueue.fetch_a_request(run_id)
+ if new_request is not None:
+ _socketio.emit(
+ "enable_user_input",
+ new_request,
+ room=run_id,
+ )
+
+
+@_socketio.on("leave")
+def _on_leave(data: dict) -> None:
+ """Leave a websocket room"""
+ run_id = data["run_id"]
+ leave_room(run_id)
+
+
+
+[文档]
+def init(
+ host: str = "127.0.0.1",
+ port: int = 5000,
+ run_dirs: Optional[Union[str, list[str]]] = None,
+ debug: bool = False,
+) -> None:
+ """Start the AgentScope Studio web UI with the given configurations.
+
+ Args:
+ host (str, optional):
+ The host of the web UI. Defaults to "127.0.0.1"
+ port (int, optional):
+ The port of the web UI. Defaults to 5000.
+ run_dirs (`Optional[Union[str, list[str]]]`, defaults to `None`):
+ The directories to search for the history of runtime instances.
+ debug (`bool`, optional):
+ Whether to enable the debug mode. Defaults to False.
+ """
+
+ # Set the history directories
+ if isinstance(run_dirs, str):
+ run_dirs = [run_dirs]
+
+ global _RUNS_DIRS
+ _RUNS_DIRS = run_dirs
+
+ # Create the cache directory
+ with _app.app_context():
+ _db.create_all()
+
+ if debug:
+ _app.logger.setLevel("DEBUG")
+ else:
+ _app.logger.setLevel("INFO")
+
+ _socketio.run(
+ _app,
+ host=host,
+ port=port,
+ debug=debug,
+ allow_unsafe_werkzeug=True,
+ )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/zh_CN/_modules/agentscope/utils/monitor.html b/zh_CN/_modules/agentscope/utils/monitor.html
index 4b6038668..146fe3a53 100644
--- a/zh_CN/_modules/agentscope/utils/monitor.html
+++ b/zh_CN/_modules/agentscope/utils/monitor.html
@@ -567,7 +567,7 @@ agentscope.utils.monitor 源代码
self.db_path = db_path
self.table_name = table_name
self._create_monitor_table(drop_exists)
- logger.info(
+ logger.debug(
f"SqliteMonitor initialization completed at [{self.db_path}]",
)
@@ -598,8 +598,8 @@ agentscope.utils.monitor 源代码
END;
""",
)
- logger.info(f"Init [{self.table_name}] as the monitor table")
- logger.info(
+ logger.debug(f"Init [{self.table_name}] as the monitor table")
+ logger.debug(
f"Init [{self.table_name}_quota_exceeded] as the monitor trigger",
)
diff --git a/zh_CN/_modules/agentscope/utils/tools.html b/zh_CN/_modules/agentscope/utils/tools.html
index 17fa9630b..dd354e969 100644
--- a/zh_CN/_modules/agentscope/utils/tools.html
+++ b/zh_CN/_modules/agentscope/utils/tools.html
@@ -108,12 +108,13 @@ agentscope.utils.tools 源代码
import secrets
import string
import socket
+import hashlib
+import random
from typing import Any, Literal, List, Optional
from urllib.parse import urlparse
-
+import psutil
import requests
-from loguru import logger
def _get_timestamp(
@@ -144,9 +145,7 @@ agentscope.utils.tools 源代码
if "content" in item:
clean_dict["content"] = _convert_to_str(item["content"])
else:
- logger.warning(
- f"Message {item} doesn't have `content` field for " f"OpenAI API.",
- )
+ raise ValueError("The content of the message is missing.")
return clean_dict
@@ -195,17 +194,10 @@ agentscope.utils.tools 源代码
"""
if port is None:
new_port = find_available_port()
- logger.warning(
- "agent server port is not provided, automatically select "
- f"[{new_port}] as the port number.",
- )
return new_port
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
if s.connect_ex(("localhost", port)) == 0:
new_port = find_available_port()
- logger.warning(
- f"Port [{port}] is occupied, use [{new_port}] instead",
- )
return new_port
return port
@@ -330,7 +322,7 @@ agentscope.utils.tools 源代码
file.write(chunk)
return True
else:
- logger.warning(
+ raise RuntimeError(
f"Failed to download file from {url} (status code: "
f"{response.status_code}). Retry {n_retry}/{max_retries}.",
)
@@ -354,6 +346,28 @@ agentscope.utils.tools 源代码
return "".join(secrets.choice(characters) for i in range(length))
+
+[文档]
+def generate_id_from_seed(seed: str, length: int = 8) -> str:
+ """Generate random id from seed str.
+
+ Args:
+ seed (`str`): seed string.
+ length (`int`): generated id length.
+ """
+ hasher = hashlib.sha256()
+ hasher.update(seed.encode("utf-8"))
+ hash_digest = hasher.hexdigest()
+
+ random.seed(hash_digest)
+ id_chars = [
+ random.choice(string.ascii_letters + string.digits)
+ for _ in range(length)
+ ]
+ return "".join(id_chars)
+
+
+
def _is_json_serializable(obj: Any) -> bool:
"""Check if the given object is json serializable."""
try:
@@ -491,6 +505,70 @@ agentscope.utils.tools 源代码
)
raise ImportError(err_msg)
+
+
+def _get_process_creation_time() -> datetime.datetime:
+ """Get the creation time of the process."""
+ pid = os.getpid()
+ # Find the process by pid
+ current_process = psutil.Process(pid)
+ # Obtain the process creation time
+ create_time = current_process.create_time()
+ # Change the timestamp to a readable format
+ return datetime.datetime.fromtimestamp(create_time)
+
+
+def _is_process_alive(
+ pid: int,
+ create_time_str: str,
+ create_time_format: str = "%Y-%m-%d %H:%M:%S",
+ tolerance_seconds: int = 10,
+) -> bool:
+ """Check if the process is alive by comparing the actual creation time of
+ the process with the given creation time.
+
+ Args:
+ pid (`int`):
+ The process id.
+ create_time_str (`str`):
+ The given creation time string.
+ create_time_format (`str`, defaults to `"%Y-%m-%d %H:%M:%S"`):
+ The format of the given creation time string.
+ tolerance_seconds (`int`, defaults to `10`):
+ The tolerance seconds for comparing the actual creation time with
+ the given creation time.
+
+ Returns:
+ `bool`: True if the process is alive, False otherwise.
+ """
+ try:
+ # Try to create a process object by pid
+ proc = psutil.Process(pid)
+ # Obtain the actual creation time of the process
+ actual_create_time_timestamp = proc.create_time()
+
+ # Convert the given creation time string to a datetime object
+ given_create_time_datetime = datetime.datetime.strptime(
+ create_time_str,
+ create_time_format,
+ )
+
+ # Calculate the time difference between the actual creation time and
+ time_difference = abs(
+ actual_create_time_timestamp
+ - given_create_time_datetime.timestamp(),
+ )
+
+ # Compare the actual creation time with the given creation time
+ if time_difference <= tolerance_seconds:
+ return True
+
+ except (psutil.NoSuchProcess, psutil.AccessDenied, psutil.ZombieProcess):
+ # If the process is not found, access is denied, or the process is a
+ # zombie process, return False
+ return False
+
+ return False
diff --git a/zh_CN/_modules/agentscope/web/_app.html b/zh_CN/_modules/agentscope/web/_app.html
deleted file mode 100644
index 25d45b434..000000000
--- a/zh_CN/_modules/agentscope/web/_app.html
+++ /dev/null
@@ -1,256 +0,0 @@
-
-
-
-
-
-
- agentscope.web._app — AgentScope 文档
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - 模块代码
- - agentscope.web._app
- -
-
-
-
-
-
-
-
- agentscope.web._app 源代码
-# -*- coding: utf-8 -*-
-"""The main entry point of the web UI."""
-import json
-import os
-
-from flask import Flask, jsonify, render_template, Response
-from flask_cors import CORS
-from flask_socketio import SocketIO
-
-app = Flask(__name__)
-socketio = SocketIO(app)
-CORS(app) # This will enable CORS for all routes
-
-
-PATH_SAVE = ""
-
-
-@app.route("/getProjects", methods=["GET"])
-def get_projects() -> Response:
- """Get all the projects in the runs directory."""
- cfgs = []
- for run_dir in os.listdir(PATH_SAVE):
- print(run_dir)
- path_cfg = os.path.join(PATH_SAVE, run_dir, ".config")
- if os.path.exists(path_cfg):
- with open(path_cfg, "r", encoding="utf-8") as file:
- cfg = json.load(file)
- cfg["dir"] = run_dir
- cfgs.append(cfg)
-
- # Filter the same projects
- project_names = list({_["project"] for _ in cfgs})
-
- return jsonify(
- {
- "names": project_names,
- "runs": cfgs,
- },
- )
-
-
-@app.route("/")
-def home() -> str:
- """Render the home page."""
- return render_template("home.html")
-
-
-@app.route("/run/<run_dir>")
-def run_detail(run_dir: str) -> str:
- """Render the run detail page."""
- path_run = os.path.join(PATH_SAVE, run_dir)
-
- # Find the logging and chat file by suffix
- path_log = os.path.join(path_run, "logging.log")
- path_dialog = os.path.join(path_run, "logging.chat")
-
- if os.path.exists(path_log):
- with open(path_log, "r", encoding="utf-8") as file:
- logging_content = ["".join(file.readlines())]
- else:
- logging_content = None
-
- if os.path.exists(path_dialog):
- with open(path_dialog, "r", encoding="utf-8") as file:
- dialog_content = file.readlines()
- dialog_content = [json.loads(_) for _ in dialog_content]
- else:
- dialog_content = []
-
- path_cfg = os.path.join(PATH_SAVE, run_dir, ".config")
- if os.path.exists(path_cfg):
- with open(path_cfg, "r", encoding="utf-8") as file:
- cfg = json.load(file)
- else:
- cfg = {
- "project": "-",
- "name": "-",
- "id": "-",
- "timestamp": "-",
- }
-
- logging_and_dialog = {
- "config": cfg,
- "logging": logging_content,
- "dialog": dialog_content,
- }
-
- return render_template("run.html", runInfo=logging_and_dialog)
-
-
-@socketio.on("connect")
-def on_connect() -> None:
- """Execute when a client is connected."""
- print("Client connected")
-
-
-@socketio.on("disconnect")
-def on_disconnect() -> None:
- """Execute when a client is disconnected."""
- print("Client disconnected")
-
-
-
-[文档]
-def init(
- path_save: str,
- host: str = "127.0.0.1",
- port: int = 5000,
- debug: bool = False,
-) -> None:
- """Start the web UI."""
- global PATH_SAVE
-
- if not os.path.exists(path_save):
- raise FileNotFoundError(f"The path {path_save} does not exist.")
-
- PATH_SAVE = path_save
- socketio.run(
- app,
- host=host,
- port=port,
- debug=debug,
- allow_unsafe_werkzeug=True,
- )
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/zh_CN/_modules/agentscope/web/studio/studio.html b/zh_CN/_modules/agentscope/web/gradio/studio.html
similarity index 96%
rename from zh_CN/_modules/agentscope/web/studio/studio.html
rename to zh_CN/_modules/agentscope/web/gradio/studio.html
index ad91c295b..7a18fbc71 100644
--- a/zh_CN/_modules/agentscope/web/studio/studio.html
+++ b/zh_CN/_modules/agentscope/web/gradio/studio.html
@@ -4,7 +4,7 @@
- agentscope.web.studio.studio — AgentScope 文档
+ agentscope.web.gradio.studio — AgentScope 文档
@@ -46,8 +46,8 @@
AgentScope 教程
@@ -89,7 +89,7 @@
- 模块代码
- - agentscope.web.studio.studio
+ - agentscope.web.gradio.studio
-
@@ -98,7 +98,7 @@
- agentscope.web.studio.studio 源代码
+ agentscope.web.gradio.studio 源代码
# -*- coding: utf-8 -*-
"""run web ui"""
import argparse
@@ -120,7 +120,7 @@ agentscope.web.studio.studio 源代码
except ImportError:
mgr = None
-from agentscope.web.studio.utils import (
+from agentscope.web.gradio.utils import (
send_player_input,
get_chat_msg,
SYS_MSG_PREFIX,
@@ -133,14 +133,14 @@ agentscope.web.studio.studio 源代码
thread_local_data,
cycle_dots,
)
-from agentscope.web.studio.constants import _SPEAK
+from agentscope.web.gradio.constants import _SPEAK
MAX_NUM_DISPLAY_MSG = 20
FAIL_COUNT_DOWN = 30
-[文档]
+[文档]
def init_uid_list() -> list:
"""Initialize an empty list for storing user IDs."""
return []
@@ -153,7 +153,7 @@ agentscope.web.studio.studio 源代码
-