📝 docs(tsl): restructure agent-facing reference
Rework TSL syntax, catalog, modules, and routing docs around deterministic agent lookup and generation. Split large catalog pages into focused function fact pages, remove obsolete pending/verified/unavailable paths, and update consistency tests for the new structure.
This commit is contained in:
+41
-31
@@ -1,44 +1,54 @@
|
||||
# Modules Index
|
||||
# 模块入口
|
||||
|
||||
文档类型：检索页
|
||||
文档类型：模块决策路由页
|
||||
是否可直接用于生成代码：否
|
||||
遇到不确定时跳转到：[tsbacktesting.md](tsbacktesting.md)、[tsl_python_interop.md](tsl_python_interop.md)、[../finance/index.md](../finance/index.md)、项目自身文档、`scripts/*` 入口脚本、CI 配置
|
||||
遇到不确定时：[pytsl_api.md](pytsl_api.md)、[tsbacktesting.md](tsbacktesting.md)、[wechat_message.md](wechat_message.md)、[../reference/catalog/datawarehouse.md](../reference/catalog/datawarehouse.md)、项目自身文档、`scripts/*` 入口脚本、CI 配置
|
||||
|
||||
这里处理“现成模块、外部集成和互操作”，不处理基础语法教学，也不替代金融业务主线。
|
||||
本页只负责把“现成模块、外部集成和模块 API”任务路由到正确事实页。目标页是模块 API 事实页时，智能体可以继续使用该页的签名、参数表、返回值和代码骨架；本页自身不生成代码。
|
||||
|
||||
模块摘要页只负责确认能力边界和选路，不负责给出项目账户体系、真实接口名、部署方式、权限模型或脚本入口的真值。
|
||||
## 智能体模块路由规则
|
||||
|
||||
## Agent Modules 路由规则
|
||||
- 先判断任务是否属于模块 API、业务流程、通用语法、通用函数库或项目执行上下文。
|
||||
- 命中下面“决策顺序”中的一行后，先进入对应页面，不继续向下泛化。
|
||||
- 真实账号、密码、服务地址、部署入口、脚本入口、权限模型和项目私有字段必须来自项目上下文。
|
||||
- 不要发明模块专属 API 参数、项目账号来源、部署路径、服务节点、模板字段、证券池或策略信号。
|
||||
|
||||
- 先判断任务是在问模块能力、业务流程、语法规则还是项目真实接入参数。
|
||||
- modules 只给集成边界和选路；真实账号、部署入口、权限模型和接口细节必须回项目文档。
|
||||
- 不要发明模块专属 API 参数、项目账号来源、部署路径或脚本入口。
|
||||
## 决策顺序
|
||||
|
||||
## If / Then 路由
|
||||
| 顺序 | 用户任务特征 | 先读哪里 | 命中后动作 |
|
||||
| ---- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------- |
|
||||
| 1 | 询问真实账号、密码、服务地址、配置文件、部署入口、脚本入口、CI、权限模型 | 项目自身文档、`scripts/*`、CI 配置 | 退出通用模块层，不从模块页猜项目事实 |
|
||||
| 2 | 用 Python 执行 TSL、调用服务器 TSL 函数、查行情、批量取数、异步取数 | [pytsl_api.md](pytsl_api.md) | 使用 pyTSL 类、函数、参数和返回结构 |
|
||||
| 3 | 发送微信通知、微信告警、微信模板消息、查询微信消息发送状态 | [wechat_message.md](wechat_message.md) | 使用微信消息接口、模板字段和展示规则 |
|
||||
| 4 | 写策略回测框架、组合回测、读取回测资产/持仓/交易/绩效结果 | [tsbacktesting.md](tsbacktesting.md) | 使用 `TSBackTesting` 对象模型、成员变量和查询接口 |
|
||||
| 5 | 查询行情、财务、板块、选股等金融函数 | [../reference/catalog/datawarehouse.md](../reference/catalog/datawarehouse.md) | 使用数据仓库函数事实 |
|
||||
| 6 | 询问 TSL 语言语法怎么写 | [../syntax/index.md](../syntax/index.md) | 回到语法主线 |
|
||||
| 7 | 查询通用函数库函数签名、参数或返回值 | [../reference/index.md](../reference/index.md) | 回到函数库检索入口 |
|
||||
|
||||
- If 问题在问“策略回测框架怎么组织、怎么取结果”，then 先读 [tsbacktesting.md](tsbacktesting.md)。
|
||||
- If 问题在问“TSL 和 Python 怎样双向调用或嵌入”，then 先读 [tsl_python_interop.md](tsl_python_interop.md)。
|
||||
- If 问题在问“微信消息怎样发送、查询状态”，then 先读 [wechat_message.md](wechat_message.md)。
|
||||
- If 问题在问“官方 Python SDK / pyTSL 客户端怎么用”，then 先读 [pytsl_api.md](pytsl_api.md)。
|
||||
- If 问题在问模块的真实接入参数、账号来源、部署依赖、权限模型或脚本入口，then 这已经不是模块能力识别；优先回项目自身文档、`scripts/*` 入口脚本、CI 配置，必要时再把对应模块页当边界说明。
|
||||
## 模块页职责
|
||||
|
||||
## Tie-Break
|
||||
| 模块页 | 负责回答 | 不负责回答 |
|
||||
| -------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------- |
|
||||
| [pytsl_api.md](pytsl_api.md) | Python SDK 的类、函数、参数、返回结构、同步/异步/批量调用选择 | 真实凭证、服务地址、权限范围、业务字段口径 |
|
||||
| [wechat_message.md](wechat_message.md) | 微信发送接口、异步状态查询、模板字段、首屏/详情展示规则 | 真实 `userid`、`username`、授权关系、项目封装函数 |
|
||||
| [tsbacktesting.md](tsbacktesting.md) | `TSBackTesting` 子类骨架、组合类别、交易字段、成员变量、查询接口 | 策略信号、证券池、资金参数、费用口径、真实行情来源 |
|
||||
|
||||
- If 主问题是业务流程、选股逻辑或回测指标组织，then 先回 [../finance/index.md](../finance/index.md)。
|
||||
- If 主问题是现成模块或集成能力，then 先留在 `modules/`；语法只作辅证。
|
||||
- If 主问题已经落到 TSL 通用函数库签名或通用语法参数细节，then 再回 [../reference/index.md](../reference/index.md) 或对应语法页。
|
||||
- If 主问题已经落到模块专属 API / SDK 参数细节，then 先回对应模块页，并以该页指向的官方文档、项目文档或调用侧文档为准。
|
||||
- If 主问题已经落到真实接入参数、账号来源、部署依赖、权限模型或执行入口，then 退出模块摘要层，直接转项目依赖确认。
|
||||
## 冲突处理
|
||||
|
||||
- Python 执行一段 TSL 或调用服务器函数时，先读 [pytsl_api.md](pytsl_api.md)；TSL 代码本身再按 [../syntax/index.md](../syntax/index.md) 或 [../reference/catalog/datawarehouse.md](../reference/catalog/datawarehouse.md) 补充。
|
||||
- Python 调用回测脚本时，先读 [pytsl_api.md](pytsl_api.md) 确认执行方式，再读 [tsbacktesting.md](tsbacktesting.md) 确认回测框架写法。
|
||||
- 回测框架、交易字段和结果接口优先读 [tsbacktesting.md](tsbacktesting.md)；策略信号、证券池、费用口径等项目事实必须来自用户需求或项目实际接口。
|
||||
- 微信通知内容来自业务结果时，先用业务页确定内容，再用 [wechat_message.md](wechat_message.md) 组织模板字段。
|
||||
- 模块页和项目文档冲突时，以项目文档的账号、部署、权限和入口为准；模块页只保留通用 API 事实。
|
||||
|
||||
## 最短跳转
|
||||
|
||||
| 当前任务 | 先读哪里 |
|
||||
| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| 我要看回测框架 | [tsbacktesting.md](tsbacktesting.md) |
|
||||
| 我要看 Python 互操作 | [tsl_python_interop.md](tsl_python_interop.md) |
|
||||
| 我要看微信消息推送 | [wechat_message.md](wechat_message.md) |
|
||||
| 我要看 Python API | [pytsl_api.md](pytsl_api.md) |
|
||||
| 我要确认模块的真实接入参数 / 账号来源 / 部署依赖 / 脚本入口 | 项目自身文档、`scripts/*` 入口脚本、CI 配置；当前项目已补齐时再看 [../toolchain.md](../toolchain.md) |
|
||||
| 我要回到业务主线 | [../finance/index.md](../finance/index.md) |
|
||||
| 我要回到语法主线 | [../syntax/index.md](../syntax/index.md) |
|
||||
| 我要查函数库 | [../reference/index.md](../reference/index.md) |
|
||||
| 任务 | 先读哪里 |
|
||||
| ------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| 我要用 Python 调 TSL / 查行情 / 批量取数 | [pytsl_api.md](pytsl_api.md) |
|
||||
| 我要发微信通知 / 告警 / 查询状态 | [wechat_message.md](wechat_message.md) |
|
||||
| 我要写 `TSBackTesting` 回测框架 | [tsbacktesting.md](tsbacktesting.md) |
|
||||
| 我要查行情 / 财务 / 板块 / 选股函数 | [../reference/catalog/datawarehouse.md](../reference/catalog/datawarehouse.md) |
|
||||
| 我要确认 TSL 语法 | [../syntax/index.md](../syntax/index.md) |
|
||||
| 我要查通用函数库 | [../reference/index.md](../reference/index.md) |
|
||||
| 我要确认真实账号 / 服务地址 / 部署入口 / 脚本入口 | 项目自身文档、`scripts/*`、CI 配置 |
|
||||
|
||||
Reference in New Issue
Block a user