Skip to content

Commit 7dd3f76

Browse files
committed
add ontology for TIS
1 parent ccd6221 commit 7dd3f76

9 files changed

Lines changed: 170 additions & 218 deletions

File tree

requirment/generate-chatbi-doc.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
需要帮我写一篇TIS基于本体语义层GraphRAG的ChatBI智能问数实现方案,文章需要包括如下部分:
2+
1. 为什么提供chatBI智能问数的功能?主要是由于开发了本体语义层,光有一个本体没有实际价值,为了让本体模型有具体的使用场景,所以开发了ChatBI功能。还需要强调一下TIS ChatBI是开源的,一站式开箱即用的特点。
3+
2. ChatBI架构流程介绍,组件交代清晰,如:本体、基于neo4j实现的GraphRAG,MCP服务端,TIS的数据集成。通过ChatBI从用户提出问题,到最终生成结果,如何将之前提到的各个功能组件串接在一起的。
4+
3. 使用GraphRAG实现ChatBI比传统的chatBI智能问数的优势,特别介绍下本体中Glossary和Link Type在ChatBI中发挥的重要作用。
5+
4. 介绍TIS ChatBI比开源领域其他产品的比较,优势是什么,要让用户直观感受到TIS的ChatBI的优势。
6+
5. TIS ChatBI实际操作说明
7+
1. 从数据库中导出Object Type 到本体域中
8+
2. 自动创建语义层,以前这一步是一个需要细致且繁琐的工作,TIS中提供了通过大模型自动生成语义层资源的功能,大大提供了配置效率,后期用户只需要对生成的配置稍事修剪即可。
9+
3. 创建ChatBI Skill 技能,简要说明一下在EnableChatBI中各个配置对ChatBI最终结果的影响作用是什么。
10+
4. 到TIS后台通过/Users/mozhenghua/j2ee_solution/project/tis-console/src/base/ontology.chat-bi.query.component.ts 进行查询。也可以通过MCP服务/Users/mozhenghua/j2ee_solution/project/tis-solr/tis-console/src/main/java/com/qlangtech/tis/mcp/tools/ChatBITool.java到OpenClaw或者hermes 中与进行ChatBI交互,好处是还能利用到专业agent中其他功能价值,例如:定时任务、专业渲染组件对结果集渲染。
11+
5. 在后台查看ChatBI的/Users/mozhenghua/j2ee_solution/project/tis-solr/tis-plugin/src/main/java/com/qlangtech/tis/plugin/ontology/chatbi/TraceStep.java执行日志,可以明确了解ChatBI执行过程中执行的逻辑,可以有针对性地调整本体结构或者修改EnableChatBI中的配置,以提高ChatBI的准确率。
12+
6. 使用测试集测试结果说明,使用falcon的一个数据子集 /Users/mozhenghua/j2ee_solution/project/tis-solr/design/chat-bi/falcon/tool/doris_init_db_14.sql 进行测试,构建一个说明通过该测试集合测试获得了一个比较高的准确性
13+
6. 对以上的总结
14+
15+
以上是文章的大纲,文章路径:/opt/misc/tis-docs2/docs/example/chat-bi/index.mdx
16+
17+
具体要求:
18+
1. 该文章是给初次接触TIS的数据集从业人员看的,文章内容不要涉及过于具体的技术细节,文章中不要出现具体的代码脚本,以通俗易懂的科普风格
19+
2. _category_.json 中的内容帮助编辑一下,"position": 属性是文档所在上下文优先级
20+
3. 编写完以上内容后更新一下 /opt/misc/tis-docs2 项目的相关SEO内容
21+
4. 有需要配图的地方请预留位置,用文字加以说明配图内容
22+
5. 有关TIS 本体的内容请查阅 ontology memory
23+
6. 说明中如需要添加超链接,请按照如下方式添加:
24+
1. 在文档头部添加: import Link from '/src/components/Link';
25+
2. 在文档内部添加链接标签,例如: <Link href={require("./plugin-develop-detail.mdx")}>插件开发说明</Link>
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# 核心需求
2+
本需求是为这次版本开发中开发的ontology(本体)语意层中各个功能模块编写说明文档,生成的文档存放在/opt/misc/tis-docs2 工程中。
3+
4+
所有关于本体的说明文档存放在:/opt/misc/tis-docs2/docs/guide/ontology 目录下
5+
6+
# 编写 ontology 文档
7+
8+
以下是ontology 目录树结构说明,mdx文件旁边有 文件的作用说明,需要您帮我把文件内部的内容补全
9+
10+
文档目录结构说明
11+
12+
├── _category_.json
13+
├── index.mdx 本体在TIS的作用,功能说明,意义 ,可参考: /Users/mozhenghua/Downloads/www.palantir.com_docs_foundry_ontologies_ontologies-overview_.png
14+
├── link-type
15+
│   ├── _category_.json
16+
│   └── create-link-type.mdx 创建 link type功能说明,需要按照步骤说明,步骤1: 基本设置:/Users/mozhenghua/j2ee_solution/project/plugins/tis-ontology-plugin/src/main/java/com/qlangtech/tis/plugin/ontology/impl/linker/RelationshipTypeSetter.java
17+
步骤2: 可设置三种不同类型的link 1.RelationshipTypeObjectTypeForeignKeys 2.RelationshipTypeJoinTableDataset 3.RelationshipTypeBackingObjectType 需要说明三种类型的区别
18+
│   └── edit-link-type.mdx 编辑 Link Type功能说明
19+
│   └── index.mdx ,link type 的功能作用说明,内容可参考:/Users/mozhenghua/Downloads/www.palantir.com_docs_foundry_object-link-types_link-types-overview_.png
20+
├── object-type
21+
│   ├── _category_.json
22+
│   ├── create-object.mdx, 创建object Type的说明文档 可参考:/Users/mozhenghua/Downloads/www.palantir.com_docs_foundry_object-link-create-object-type.png
23+
│   ├── edit-object.mdx, 编辑 Object Type的说明文档
24+
│   └── index.mdx ,Object Type的说明,内容可参考:/Users/mozhenghua/Downloads/www.palantir.com_docs_foundry_object-link-object-type.png
25+
├── properties
26+
│   ├── _category_.json
27+
│   ├── add-property.mdx , 添加 Property 的说明,参考 /Users/mozhenghua/j2ee_solution/project/plugins/tis-ontology-plugin/src/main/java/com/qlangtech/tis/plugin/ontology/impl/objtype/DefaultOntologyProperty.java
28+
│   ├── derived-property.mdx 参考 /Users/mozhenghua/j2ee_solution/project/plugins/tis-ontology-plugin/src/main/java/com/qlangtech/tis/plugin/ontology/impl/role/MeasureRole.java,/Users/mozhenghua/Downloads/www.palantir.com_docs_foundry_object-link-types_derived_properties.png
29+
│   ├── index.mdx 本体Object Type的的Property属性说明,参考:/Users/mozhenghua/Downloads/www.palantir.com_docs_foundry_object-link-Properties.png
30+
│   ├── physical-expression.mdx 关于 /Users/mozhenghua/j2ee_solution/project/tis-solr/tis-plugin/src/main/java/com/qlangtech/tis/plugin/ontology/OntologyProperty.java:L73 physicalExpression 属性功能,使用场景说明
31+
│   ├── role-type.mdx DefaultOntologyProperty.java:L79 roleType 的说明 功能及使用场景说明
32+
│   ├── setting-shared-object.mdx,说明如何将一个属性与已经存在的Shared Object进行关联
33+
│   └── setting-value-type.mdx ,说明如何将一个属性与已经存在的Value Type进行关联
34+
├── shared-property
35+
│   ├── _category_.json
36+
│   ├── edit-shared-property.mdx,创建、编辑Shared Property 进行说明
37+
│   └── index.mdx ,对Shared Property 进行说明,参考:/Users/mozhenghua/Downloads/www.palantir.com_docs_foundry_object-link-types_shared-property-overview.png
38+
└── value-type
39+
├── _category_.json
40+
├── edit-value-type.mdx ,创建、编辑 Vale Type进行说明
41+
└── index.mdx ,对value type进行说明,参考:/Users/mozhenghua/Downloads/www.palantir.com_docs_foundry_object-link-types_value-types-overview.png
42+
43+
要求:
44+
1. 以上提供的截图都是从palantir 官网的截图,内容是英文的,你撰写的文档需要是**中文**的,palantir官网中关于本体中的对象的介绍可能与TIS中的实现方式有不一致的地方,所有内容必须以TIS现有实现的内容版本为准,不能有夸大虚假的内容。行文风格、内容可以借鉴palantir截图内容。
45+
2. _category_.json 中的内容帮助编辑一下,"position": 属性是文档所在上下文优先级
46+
3. 编写完以上内容后更新一下 /opt/misc/tis-docs2 项目的相关SEO内容
47+
4. 有需要配图的地方请预留位置,用文字加以说明配图内容
48+
5. 有关TIS 本体的内容请查阅 ontology memory
49+
6. 说明中如需要添加超链接,请按照如下方式添加:
50+
1. 在文档头部添加: import Link from '/src/components/Link';
51+
2. 在文档内部添加链接标签,例如: <Link href={require("./plugin-develop-detail.mdx")}>插件开发说明</Link>

tis-ontology-plugin/STREAMING_DESERIALIZATION_SUMMARY.md

Lines changed: 0 additions & 179 deletions
This file was deleted.

0 commit comments

Comments
 (0)