quickstart.md 2.1 KB
快速开始
文档维护规范
- 先改文档，再动代码 - 新功能或重大修改需先完成文档更新、并完成审阅后，再进行代码实现
- 文档分层，链接代码 - 关键实现需标注代码文件路径；格式：
module/file.py:function_name - 简洁快照，日志分离 - 只记录已确认的使用方式
概述
本指南帮助你快速开始使用 Gateway。
内部 Agent（同设备，我们的框架）
特点
- 和 Gateway 运行在同一台机器
- 使用我们的 Agent 框架
- 直接调用 Core 层的 Python 接口
使用方式
# 直接导入 Core 层模块
from gateway.core.conversations import ConversationManager
# 创建管理器
manager = ConversationManager()
# 查询对话列表
conversations = manager.list_conversations()
# 获取消息历史
messages = manager.get_messages(conversation_id)
# 发送消息
manager.send_message(conversation_id, text="Hello!")
外部 Agent（其他设备/其他框架）
特点
- 运行在不同机器
- 或使用其他 Agent 框架
- 通过 HTTP API + Client SDK 接入
安装
pip install gateway-client
使用方式
# 使用 Client SDK
from gateway.client.python import GatewayClient
# 创建客户端
client = GatewayClient("http://gateway-host:8000")
# 查询对话列表
conversations = client.list_conversations()
# 获取消息历史
messages = client.get_messages(conversation_id)
# 发送消息
client.send_message(conversation_id, text="Hello!")
下一步
- 内部 Agent 集成指南：详细的内部 Agent 集成步骤
- 外部 Agent 集成指南：详细的外部 Agent 集成步骤
- 个人助理配置：配置个人助理型 Agent
- 数字员工配置：配置数字员工型 Agent