readme

README.md

@@ -1,25 +1,75 @@
+---
+title: ODR Demo - Async SSE Chat Interface
+emoji: 🤖
+colorFrom: blue
+colorTo: purple
+sdk: gradio
+sdk_version: "4.0.0"
+app_file: app.py
+pinned: false
+license: mit
+short_description: 一个演示项目，包含异步 SSE（服务器发送事件）接口请求功能，支持实时流式聊天体验
+tags:
+- chatbot
+- sse
+- streaming
+- real-time
+- gradio
+- async
+suggested_hardware: cpu-basic
+hf_oauth: false
+disable_embedding: false
+---
+
 # ODR Demo
 
-A demonstration project containing async SSE (Server-Sent Events) interface request functionality.
+一个演示项目，包含异步 SSE（服务器发送事件）接口请求功能，支持实时流式聊天体验。
+
+## 🌟 特性
+
+- 异步 SSE 流式请求
+- 支持自定义参数（深度思考模式、调试模式等）
+- 返回异步迭代器进行实时数据处理
+- 支持原始数据和解析 JSON 数据模式
+- 结构化事件解析，包含 `event` 和 `data` 字段
+- 正确的 SSE 事件类型检测和处理
+- 实时 Markdown 渲染和可折叠工具调用显示
+
+## 🚀 快速开始
+
+这个应用部署在 Hugging Face Spaces 上，你可以直接访问 Web 界面进行交互：
 
-## Features
+1. 在输入框中输入你的英文问题
+2. 点击 "Run" 按钮开始处理
+3. 观察实时的 Agent 和工具调用过程
+4. 可以随时点击 "Stop" 按钮停止处理
 
-- Async SSE streaming requests
-- Support for custom parameters (deep thinking mode, debug mode, etc.)
-- Returns async iterator for real-time data processing
-- Supports both raw data and parsed JSON data modes
-- Structured event parsing with `event` and `data` fields
-- Proper SSE event type detection and handling
+## 📦 本地安装
 
-## Install Dependencies
+如果你想在本地运行此项目：
 
 ```bash
-pip install -r requirements.txt
+# 克隆项目
+git clone <repository-url>
+cd odr-demo
+
+# 创建虚拟环境
+python -m venv venv
+source venv/bin/activate  # 在 Windows 上使用: venv\Scripts\activate
+
+# 安装依赖
+pip install gradio aiohttp
+
+# 设置环境变量
+export API_ENDPOINT="your-api-endpoint-here"
+
+# 运行应用
+python app.py
 ```
 
-## Usage
+## 💻 基本用法
 
-### Basic Usage (Raw SSE Events)
+### 原始 SSE 事件
 
 ```python
 import asyncio
@@ -37,7 +87,7 @@ async def main():
 asyncio.run(main())
 ```
 
-### Using Parsed Data (JSON Parsed)
+### 解析后的数据
 
 ```python
 import asyncio
@@ -55,7 +105,7 @@ async def main():
 asyncio.run(main())
 ```
 
-### Using Class Methods (More Control)
+### 使用类方法（更多控制）
 
 ```python
 import asyncio
@@ -66,9 +116,9 @@ async def main():
     
     async for event_data in client.stream_chat(
         query="Explain deep learning",
-        deep_thinking_mode=True,  # Enable deep thinking
-        debug=True,              # Enable debug mode
-        chat_id="my_custom_id"   # Custom chat ID
+        deep_thinking_mode=True,  # 启用深度思考
+        debug=True,              # 启用调试模式
+        chat_id="my_custom_id"   # 自定义聊天 ID
     ):
         event_type = event_data.get('event', 'unknown')
         data_content = event_data.get('data', '')
@@ -78,37 +128,42 @@ async def main():
 asyncio.run(main())
 ```
 
-## Run Examples
+## ⚙️ API 参数
 
-```bash
-python example_usage.py
-```
-
-## API Parameters
-
-- `query`: Required, user query content
-- `deep_thinking_mode`: Optional, whether to enable deep thinking mode, default False
-- `search_before_planning`: Optional, whether to search before planning, default False
-- `debug`: Optional, whether to enable debug mode, default False
-- `chat_id`: Optional, chat ID, will be auto-generated if not provided
+- `query`: 必需，用户查询内容
+- `deep_thinking_mode`: 可选，是否启用深度思考模式，默认 False
+- `search_before_planning`: 可选，是否在规划前搜索，默认 False
+- `debug`: 可选，是否启用调试模式，默认 False
+- `chat_id`: 可选，聊天 ID，如未提供将自动生成
 
-## Data Structure
+## 📊 数据结构
 
-All functions return an async iterator yielding dictionaries with the following structure:
+所有函数返回异步迭代器，产生以下结构的字典：
 
 ```python
 {
-    "event": "message",  # SSE event type (e.g., "message", "error", "data", etc.)
-    "data": "..."        # Event data content
+    "event": "message",  # SSE 事件类型（如 "message", "error", "data" 等）
+    "data": "..."        # 事件数据内容
 }
 ```
 
-- `request_sse_stream()`: Returns raw data where `data` field contains the original string
-- `request_sse_stream_parsed()`: Returns parsed data where `data` field contains JSON objects (when possible)
+- `request_sse_stream()`: 返回原始数据，`data` 字段包含原始字符串
+- `request_sse_stream_parsed()`: 返回解析后的数据，`data` 字段包含 JSON 对象（如果可能）
+
+## 📁 文件说明
+
+- `api.py`: 主要的 SSE 客户端实现
+- `app.py`: Gradio Web 应用程序
+- `utils.py`: 工具函数
+- `README.md`: 项目文档
+
+## 🎯 注意事项
+
+- 目前仅支持英文输入
+- 需要设置有效的 `API_ENDPOINT` 环境变量
+- 实时显示包括代理处理过程和工具调用详情
+- 支持错误处理和中断操作
 
-## File Description
+## 📄 许可证
 
-- `api.py`: Main SSE client implementation
-- `example_usage.py`: Usage examples
-- `requirements.txt`: Project dependencies
-- `app.py`: Gradio application (if exists)
+MIT License

requirements.txt

@@ -0,0 +1,70 @@
+aiofiles==23.2.1
+aiohappyeyeballs==2.6.1
+aiohttp==3.12.15
+aiosignal==1.4.0
+annotated-types==0.7.0
+anyio==4.10.0
+async-timeout==5.0.1
+attrs==25.3.0
+certifi==2025.8.3
+charset-normalizer==3.4.3
+click==8.1.8
+contourpy==1.3.0
+cycler==0.12.1
+exceptiongroup==1.3.0
+fastapi==0.116.1
+ffmpy==0.6.1
+filelock==3.19.1
+fonttools==4.59.1
+frozenlist==1.7.0
+fsspec==2025.7.0
+gradio==4.44.1
+gradio_client==1.3.0
+h11==0.16.0
+hf-xet==1.1.8
+httpcore==1.0.9
+httpx==0.28.1
+huggingface-hub==0.34.4
+idna==3.10
+importlib_resources==6.5.2
+Jinja2==3.1.6
+kiwisolver==1.4.7
+markdown-it-py==3.0.0
+MarkupSafe==2.1.5
+matplotlib==3.9.4
+mdurl==0.1.2
+multidict==6.6.4
+numpy==2.0.2
+orjson==3.11.2
+packaging==25.0
+pandas==2.3.2
+pillow==10.4.0
+propcache==0.3.2
+pydantic==2.11.7
+pydantic_core==2.33.2
+pydub==0.25.1
+Pygments==2.19.2
+pyparsing==3.2.3
+python-dateutil==2.9.0.post0
+python-multipart==0.0.20
+pytz==2025.2
+PyYAML==6.0.2
+requests==2.32.5
+rich==14.1.0
+ruff==0.12.10
+semantic-version==2.10.0
+shellingham==1.5.4
+six==1.17.0
+sniffio==1.3.1
+starlette==0.47.3
+tomlkit==0.12.0
+tqdm==4.67.1
+typer==0.16.1
+typing-inspection==0.4.1
+typing_extensions==4.15.0
+tzdata==2025.2
+urllib3==2.5.0
+uvicorn==0.35.0
+websockets==12.0
+yarl==1.20.1
+zipp==3.23.0