playbook/docs/tsl/modules/index.md

55 lines
6.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 模块入口
文档类型:模块决策路由页
是否可直接用于生成代码:否
遇到不确定时:[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 事实页时,智能体可以继续使用该页的签名、参数表、返回值和代码骨架;本页自身不生成代码。
## 智能体模块路由规则
- 先判断任务是否属于模块 API、业务流程、通用语法、通用函数库或项目执行上下文。
- 命中下面“决策顺序”中的一行后,先进入对应页面,不继续向下泛化。
- 真实账号、密码、服务地址、部署入口、脚本入口、权限模型和项目私有字段必须来自项目上下文。
- 不要发明模块专属 API 参数、项目账号来源、部署路径、服务节点、模板字段、证券池或策略信号。
## 决策顺序
| 顺序 | 用户任务特征 | 先读哪里 | 命中后动作 |
| ---- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------- |
| 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) | 回到函数库检索入口 |
## 模块页职责
| 模块页 | 负责回答 | 不负责回答 |
| -------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------- |
| [pytsl_api.md](pytsl_api.md) | Python SDK 的类、函数、参数、返回结构、同步/异步/批量调用选择 | 真实凭证、服务地址、权限范围、业务字段口径 |
| [wechat_message.md](wechat_message.md) | 微信发送接口、异步状态查询、模板字段、首屏/详情展示规则 | 真实 `userid`、`username`、授权关系、项目封装函数 |
| [tsbacktesting.md](tsbacktesting.md) | `TSBackTesting` 子类骨架、组合类别、交易字段、成员变量、查询接口 | 策略信号、证券池、资金参数、费用口径、真实行情来源 |
## 冲突处理
- 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 事实。
## 最短跳转
| 任务 | 先读哪里 |
| ------------------------------------------------- | ------------------------------------------------------------------------------ |
| 我要用 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 配置 |