📝 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:
+43
-27
@@ -1,38 +1,54 @@
|
||||
# Reference Index
|
||||
# 函数查阅入口
|
||||
|
||||
文档类型：检索页
|
||||
是否可直接用于生成代码：否
|
||||
遇到不确定时跳转到：[catalog/index.md](catalog/index.md)、[../syntax/index.md](../syntax/index.md)、[../finance/index.md](../finance/index.md)
|
||||
文档类型：函数事实路由页
|
||||
是否可直接用于生成代码：是；进入 catalog 分类页后按函数事实条目生成调用
|
||||
遇到不确定时：先按本页“按任务跳转”和“模块目录”分流；语法问题看 [../syntax/index.md](../syntax/index.md)，模块集成看 [../modules/index.md](../modules/index.md)，项目业务接口看项目实际文档
|
||||
|
||||
这里是函数查阅层，不是默认通读入口。现在这一页本身就是函数总入口，不再要求先跳到额外的中转页。
|
||||
这里是函数查阅层，不是默认通读入口。它只回答两类问题：函数名属于哪个模块、带参数表的函数事实条目应该怎样传参。
|
||||
|
||||
reference 的目标是确认每个方法的参数类型，让 agent 写代码时知道该传什么。文档只保留 agent 生成代码需要的函数事实。
|
||||
语法写法回语法层，模块集成回模块层；真实业务字段、账户和项目接口回项目实际文档。
|
||||
|
||||
## Agent 函数使用规则
|
||||
## 智能体函数使用规则
|
||||
|
||||
- 只从 verified 函数页读取参数类型、返回值和调用约束。
|
||||
- catalog 只是候选函数索引，不能把 catalog 里的函数名直接当成可调用事实。
|
||||
- 函数没有进入 verified 函数页时，不要根据函数名猜参数，也不要生成调用代码。
|
||||
- 生成函数调用前，只从带完整参数表的函数事实条目读取签名、接收类型、返回值和调用约束。
|
||||
- catalog 使用推荐大小写展示函数名；函数名里的下划线和数字结构按条目标题保留。生成代码时以函数事实条目的函数名拼写为准。
|
||||
- 函数参数必须按正确类型传入；TSL 本身弱类型，不等于函数参数无类型。
|
||||
- 如果函数被记录为当前测试环境不支持，不要使用该函数生成代码。
|
||||
- 没在 catalog 正式条目里的函数，不要根据函数名猜调用；先回到对应业务文档、模块文档或项目代码确认来源。
|
||||
|
||||
## 检索策略
|
||||
## 智能体检索策略
|
||||
|
||||
1. 先看 [catalog/index.md](catalog/index.md) 的模块目录，确定候选大类。
|
||||
2. 进入对应模块页，在页内搜索具体候选函数名。
|
||||
3. 先看 [verified/index.md](verified/index.md)，再进入具体 verified 函数页读取参数类型、返回值和调用约束；当前核心函数页是 [verified/core.md](verified/core.md)。
|
||||
4. 如果候选函数没有进入 verified 函数页，不要生成调用代码。
|
||||
5. 当前测试环境不支持的方法见 [unavailable_methods.md](unavailable_methods.md)。
|
||||
6. 如果目录和定向检索都找不到函数，不要发明函数名，也不要默认它是 TSL 内建函数；回 [../syntax/index.md](../syntax/index.md)、[../finance/index.md](../finance/index.md)、[../modules/index.md](../modules/index.md) 或项目文档确认来源。
|
||||
1. 用户只描述能力时，先看本页“模块目录”，确定候选大类。
|
||||
2. catalog 分类页通常很大；进入分类页后先搜索函数名或能力关键词，不要默认通读整页。
|
||||
3. 只读取命中的函数条目、相邻分类标题和必要参数表；不要把同页其它函数混进当前调用。
|
||||
4. 函数名下方有完整参数表时，按该条目生成调用。
|
||||
5. 如果目录和定向检索都找不到函数，不要发明函数名，也不要默认它是 TSL 内建函数；回 [../syntax/index.md](../syntax/index.md)、[../modules/index.md](../modules/index.md) 或项目文档确认来源。
|
||||
|
||||
## 按任务跳转
|
||||
|
||||
| 当前任务 | 先读哪里 |
|
||||
| ------------------------ | ------------------------------------------------ |
|
||||
| 查函数库入口 | [catalog/index.md](catalog/index.md) |
|
||||
| 直接按模块查函数 | [catalog/index.md](catalog/index.md) |
|
||||
| 查可调用函数参数类型 | [verified/index.md](verified/index.md) |
|
||||
| 查当前测试环境不支持方法 | [unavailable_methods.md](unavailable_methods.md) |
|
||||
| 回到语法层 | [../syntax/index.md](../syntax/index.md) |
|
||||
| 回到金融层 | [../finance/index.md](../finance/index.md) |
|
||||
| 回到模块层 | [../modules/index.md](../modules/index.md) |
|
||||
| 任务 | 先读哪里 |
|
||||
| -------------------- | ---------------------------------------------------- |
|
||||
| 查函数库入口 | 本页“模块目录” |
|
||||
| 直接按模块查函数 | 本页“模块目录” |
|
||||
| 查可调用函数参数类型 | 带完整参数表的函数事实条目 |
|
||||
| 回到语法层 | [../syntax/index.md](../syntax/index.md) |
|
||||
| 查数据仓库金融函数 | [catalog/datawarehouse.md](catalog/datawarehouse.md) |
|
||||
| 回到模块层 | [../modules/index.md](../modules/index.md) |
|
||||
|
||||
## 模块目录
|
||||
|
||||
这里是函数模块目录。进入分类页后，按函数事实条目的参数表生成调用。
|
||||
|
||||
| 模块 | 分类页 | 范围 | 函数事实数 |
|
||||
| --------------------- | -------------------------------------------------------- | -------------------------------------------------------------------- | ---------- |
|
||||
| 基础函数 | [catalog/base.md](catalog/base.md) | 轻量入口；字符串、数组、日期时间、类型转换与常用基础能力详情在分类页 | 365 |
|
||||
| 数学函数 | [catalog/math.md](catalog/math.md) | 轻量入口；数值计算、统计分析、矩阵处理与数学算法详情在分类页 | 221 |
|
||||
| 数据仓库金融函数 | [catalog/datawarehouse.md](catalog/datawarehouse.md) | 轻量入口；行情、财务、板块、选股、时序统计和向导函数详情在分类页 | 414 |
|
||||
| 系统相关函数 | [catalog/system.md](catalog/system.md) | 轻量入口；数据类型、表达式调用、性能与运行时能力详情在分类页 | 60 |
|
||||
| Windows/.NET 专属函数 | [catalog/dotnet.md](catalog/dotnet.md) | Windows/.NET/COM 环境辅助函数和 COM/OLE 函数 | 12 |
|
||||
| 资源访问函数 | [catalog/resource.md](catalog/resource.md) | 轻量入口；文件、数据库、网络与外部资源访问详情在分类页 | 132 |
|
||||
| 天软平台服务函数 | [catalog/platform.md](catalog/platform.md) | 用户数据、板块维护、平台执行信息和授权用户共享函数入口 | 17 |
|
||||
| 客户端函数 | [catalog/client.md](catalog/client.md) | 客户端交互、界面控制与前端协作能力 | 2 |
|
||||
| 图形函数 | [catalog/graphics.md](catalog/graphics.md) | 轻量入口；图表、绘图与可视化相关函数详情在分类页 | 87 |
|
||||
| 压缩和解压函数 | [catalog/compression.md](catalog/compression.md) | 压缩、解压与归档能力 | 5 |
|
||||
| 信息摘要及编码 | [catalog/digest_encoding.md](catalog/digest_encoding.md) | 哈希、摘要、编码与转换能力 | 11 |
|
||||
| 第三方交互函数 | [catalog/third_party.md](catalog/third_party.md) | 第三方库与外部程序交互能力 | 7 |
|
||||
|
||||
Reference in New Issue
Block a user