You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Alias now supports rapid startup based on [AgentScope-runtime](https://github.com/agentscope-ai/agentscope-runtime/), providing an out-of-the-box WebUI (powered by the AgentScope Runtime WebUI).
376
+
Alias is now fully compatible with [AgentScope Runtime](https://github.com/agentscope-ai/agentscope-runtime/), enabling you to quickly deploy Alias as a standardized backend service. Once launched, you can easily invoke Alias capabilities via the accompanying AgentScope Runtime API.
377
377
378
378
#### 1. Prerequisites
379
379
380
-
***Sandbox & API Keys**: Please refer to the previous sections [🐳 Sandbox Setup](#-sandbox-setup-optional) and [🔑 API Keys Configuration](#-api-keys-configuration) to complete the basic environment setup.
381
-
***Configure Environment Variables**: Copy the example environment file from the project root:
380
+
***Sandbox & API Keys**: Please refer to the previous sections [🐳 Sandbox Setup (Optional)](#-sandbox-setup-optional) and [🔑 API Keys Configuration](#-api-keys-configuration) to complete the basic environment setup.
381
+
***Environment Variables**: Copy the example environment file from the project root:
382
382
```bash
383
383
cp .env.example .env
384
384
```
@@ -387,69 +387,67 @@ Alias now supports rapid startup based on [AgentScope-runtime](https://github.co
387
387
docker run -d -p 6379:6379 --name alias-redis redis:7-alpine
388
388
```
389
389
390
-
#### 2. Installation and Sandbox Startup
390
+
#### 2. Installation & Sandbox Launch
391
391
392
-
Install the package in editable mode from the project root. This will automatically install the `alias_agent_runtime`command-line tool:
392
+
Install the package in editable mode from the project root. This will automatically install the `alias_agent_runtime`CLI tool:
393
393
```bash
394
394
pip install -e .
395
395
```
396
396
397
-
To ensure features like code execution and file operations work correctly, start the sandbox server in a separate terminal:
397
+
To ensure proper code execution and file operations, start the sandbox server in a separate terminal:
##### Option A: Using the Command Line Interface (Recommended)
404
+
You can choose to start the service via the CLI or Python code, depending on your use case.
405
405
406
-
Use the `alias_agent_runtime`command to launch both the backend service and the WebUI with a single command:
406
+
##### Option A: Using CLI (Recommended)
407
+
Use the `alias_agent_runtime`command to launch the backend service with one click:
407
408
408
409
```bash
409
-
alias_agent_runtime --host 127.0.0.1 --port 8090 --chat-mode general --web-ui
410
+
alias_agent_runtime --host 127.0.0.1 --port 8090 --chat-mode general
410
411
```
411
412
412
413
**Parameter Descriptions**:
413
-
*`--host` / `--port`: Specifies the host address and portfor the service (default port is 8090).
414
-
*`--chat-mode`: Sets the operational mode. Available options: `general`, `dr`, `browser`, `ds`, `finance` (defaults to`general`).
415
-
*`--web-ui`: Enables the AgentScope Runtime WebUI. If this flag is omitted, the WebUI will not be started.
414
+
*`--host` / `--port`: Specify the service address and port (default port is 8090).
415
+
*`--chat-mode`: Set the running mode. Options: `general`, `dr`, `browser`, `ds`, `finance` (default:`general`).
416
+
*`--web-ui`: (Optional) Enable AgentScope Runtime WebUIfor a visual interaction interface. Skip this if you only need the API.
416
417
417
-
>**Note**: When launching with `--web-ui`for the first time, the system will automatically install necessary frontend dependencies. This process may take a few minutes; please be patient.
418
+
>**Note**: When enabling `--web-ui`for the first time, the system will automatically install necessary frontend dependencies. This may take a few minutes.
418
419
419
-
##### Option B: Programmatic Usage (Recommended for Developers)
420
-
421
-
If you prefer to integrate or customize the startup logic within your Python code, you can use `AliasRunner`in conjunction with `AgentApp` as shown below:
420
+
##### Option B: Using Python Code (Recommended for Developers)
421
+
If you wish to integrate or customize the launch logic within Python, you can use `AliasRunner` and `AgentApp` as shown below:
422
422
423
423
```python
424
424
from agentscope_runtime.engine.app import AgentApp
425
425
from alias.server.runtime.runner.alias_runner import AliasRunner
#Set web_ui=True to enable the visual debugging interface
442
+
agent_app.run(host="127.0.0.1", port=8090)
443
443
```
444
444
445
-
#### 4. Access the Application
446
-
447
-
Once the service is running, you can interact with Alias via the following addresses:
445
+
#### 4. Accessing the Application
448
446
449
-
***Frontend Interface**: `http://localhost:5173`
450
-
***Runtime API Service**: `http://localhost:8090/process`
447
+
Once the service is running, you can access Alias via:
451
448
452
-
Through the WebUI, you can intuitively track the agent's reasoning process, tool invocation traces, and other execution details.
449
+
***Runtime API Access**: Send standard HTTP POST requests to `http://localhost:8090/process`. This is the primary method for integrating Alias into third-party frontends or backend workflows.
450
+
***Visual Monitoring (Optional)**: If started with the `--web-ui` flag, visit `http://localhost:5173`. This interface allows developers to observe the agent's reasoning process, tool execution traces, and other debugging information.
Alias 现在支持基于[AgentScope-runtime](https://github.com/agentscope-ai/agentscope-runtime/) 快速启动,并提供开箱即用的 WebUI 交互界面(基于AgentScope Runtime 的 WebUI)。
376
+
Alias 现已适配[AgentScope Runtime](https://github.com/agentscope-ai/agentscope-runtime/),您可以利用 AgentScope Runtime 将 Alias 快速部署为标准后端服务。启动后,通过配套的 AgentScope Runtime API 即可轻松调用 Alias 所提供的服务。
0 commit comments