Skip to content

Commit 846f963

Browse files
committed
feat: update chart generation docs
1 parent 9c1df04 commit 846f963

File tree

7 files changed

+19
-5
lines changed

7 files changed

+19
-5
lines changed

docs/assets/api/en/dataQuery.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ The dataQuery function is a powerful data aggregation tool. It takes three param
77
## Supported Models:
88
- GPT-3.5
99
- GPT-4
10+
- [skylark2-pro](https://www.volcengine.com/product/yunque)
1011

1112
## Interface Parameters:
1213

docs/assets/api/en/generateChart.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The generateChart function is used for intelligent chart generation.
88
- GPT-3.5
99
- GPT-4
1010
- [skylark2-pro](https://www.volcengine.com/product/yunque)
11+
- [chart-advisor](../guide/Basic_tutorial/Chart_Advisor)
1112

1213
## Interface Parameters:
1314

@@ -65,6 +66,9 @@ const { spec, time } = await vmind.generateChart(userPrompt, fieldInfo, dataset,
6566
- The generateChart method will pass the userPrompt and fieldInfo to the large language model for chart generation, but the detailed data in the dataset will not be passed.
6667
- In the process of generating the chart, VMind will first use the large language model, according to the userPrompt and fieldInfo, to recommend a suitable chart type. Then, it will map the fields in the fieldInfo to the x-axis, y-axis, color, size and other visual channels of the chart.
6768
- VMind will add an entrance animation to the generated chart by default, so it will also return the duration of the chart animation time. If you want to turn off the chart animation, you can set spec.animation to false.
69+
- When the model type is set to chart-advisor, it will not call a large language model to generate charts. The results generated will include multiple types of charts. For details, please refer to [Rule-based Chart Generation](../guide/Basic_Tutorial/Chart_Advisor).
6870

6971
## Related Tutorials
70-
[Intelligent Chart Generation](../guide/Basic_Tutorial/Chart_Generation)
72+
- [Intelligent Chart Generation](../guide/Basic_Tutorial/Chart_Generation)
73+
- [Rule-based Chart Generation](../guide/Basic_Tutorial/Chart_Advisor)
74+

docs/assets/api/zh/dataQuery.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ dataQuery函数是一个强大的数据聚合工具,它接收三个参数:
66
## 支持模型:
77
- GPT-3.5
88
- GPT-4
9+
- [skylark2-pro](https://www.volcengine.com/product/yunque)
910

1011
## 接口参数:
1112

docs/assets/api/zh/generateChart.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ generateChart函数用于图表智能生成。
88
- GPT-3.5
99
- GPT-4
1010
- [skylark2-pro](https://www.volcengine.com/product/yunque)
11+
- [chart-advisor](../guide/Basic_tutorial/Chart_Advisor)
1112

1213
## 接口参数:
1314

@@ -65,6 +66,8 @@ const { spec, time } = await vmind.generateChart(userPrompt, fieldInfo, dataset,
6566
- generateChart方法会将userPrompt和fieldInfo传递给大语言模型用于生成图表,但是dataset中的详细数据并不会被传递。
6667
- 在生成图表的过程中,VMind首先会利用大语言模型,根据userPrompt和fieldInfo,推荐一个适合的图表类型。然后,它会将fieldInfo中的字段映射到图表的x轴、y轴、颜色、尺寸等视觉通道上。
6768
- VMind默认会为生成的图表添加入场动画,因此它还会返回图表动画的时长time。如果你想关闭图表动画,可以将spec.animation设为false。
69+
- 当设定模型类型为chart-advisor时,将不需调用大型语言模型生成图表,产生的结果将包括多种图表,详情可参见[基于规则的图表生成](../guide/Basic_Tutorial/Chart_Advisor)
6870

6971
## 相关教程
70-
[图表智能生成](../guide/Basic_Tutorial/Chart_Generation)
72+
- [图表智能生成](../guide/Basic_Tutorial/Chart_Generation)
73+
- [基于规则的图表生成](../guide/Basic_Tutorial/Chart_Advisor)

docs/assets/guide/en/Basic_Tutorial/Data_Aggregation.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Data Aggregation
2-
📢 Note: Currently, the data aggregation feature only supports GPT series models, and we are working hard to integrate more models.
32

43
## Overview of Data Aggregation
54
When we use chart libraries like VChart to draw bar charts, line charts, etc., if the dataset used has not been aggregated, it may have a negative impact on the visualization effect.

docs/assets/guide/menu.json

+8-1
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,13 @@
8080
"en": "Intelligent Chart Generation"
8181
}
8282
},
83+
{
84+
"path": "Chart_Advisor",
85+
"title": {
86+
"zh": "基于规则的图表生成",
87+
"en": "Rule-based Chart Generation"
88+
}
89+
},
8390
{
8491
"path": "Custom_Request",
8592
"title": {
@@ -90,4 +97,4 @@
9097
]
9198
}
9299
]
93-
}
100+
}

docs/assets/guide/zh/Basic_Tutorial/Data_Aggregation.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# 数据聚合
2-
📢 注意:目前数据聚合功能仅支持GPT系列模型,我们正在努力接入更多模型。
32

43
## 数据聚合概述
54
当我们使用VChart等图表库来绘制柱状图、折线图等图表时,如果使用的数据集dataset并未经过聚合处理,可能会对可视化效果产生不良影响。

0 commit comments

Comments
 (0)