Skip to content

Commit

Permalink
feat(v2): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
666haiwen committed Feb 19, 2025
1 parent be5a10e commit 68fe7f4
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
3 changes: 1 addition & 2 deletions docs/assets/api/en/text2Chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ The text2Chart function is used to call the LLM to complete two tasks: data extr
- GPT models
- Doubao models
- DeepSeek models
- [chart-advisor](../guide/Basic_Tutorial/Chart_Advisor)
- Any other models

## Chart Type List
Expand Down Expand Up @@ -114,7 +113,7 @@ interface GenerateChartResult {
- cell (Record<string, string | string[]>): Field mapping in the chart, describing how fields in the dataset are mapped to various visual channels of the chart
- usage (any): Total LLM token consumption
- time (number): Duration information of the chart animation, can be used for exporting GIFs and videos
- chartAdvistorRes(Array): This result is the chart recommendation result deduced based on the current data and field information through VMind's built-in rules, generated as a fallback when the model is set to `Model.CHART_ADVISOR` or when the user's large model settings are incorrect. See: [Rule-Based Chart Generation](../guide/Basic_Tutorial/Chart_Advisor)
- chartAdvistorRes(Array): This result is the chart recommendation result deduced based on the current data and field information through VMind's built-in rules, generated as a fallback when some wrong happens in LLM. See: [Rule-Based Chart Generation](../guide/Basic_Tutorial/Chart_Advisor)

# Usage Example
[Data Extraction - Generate Chart from Text in One Step](../guide/Basic_Tutorial/Data_Extraction)
3 changes: 1 addition & 2 deletions docs/assets/api/zh/text2Chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ text2Chart函数用于调用LLM完成数据提取,图表智能生成两个任
- GPT模型
- 豆包模型
- DeepSeek模型
- [chart-advisor](../guide/Basic_Tutorial/Chart_Advisor)
- 其他任意模型

## 图表类型列表
Expand Down Expand Up @@ -114,7 +113,7 @@ interface GenerateChartResult {
- cell (Record<string, string | string[]>): 图表中的字段映射,描述数据集中的字段如何映射到图表的各个视觉通道上
- usage (any): LLM token总消耗
- time (number): 图表动画的时长信息,可用于导出GIF和视频
- chartAdvistorRes(Array): 该结果是根据当前数据和字段信息,通过VMind的内置规则推导得到的图表推荐结果,在设置模型为`Model.CHART_ADVISOR`或者用户的大模型设置有误,无法获取结果时兜底产生。详见:[基于规则的图表生成](../guide/Basic_Tutorial/Chart_Advisor)
- chartAdvistorRes(Array): 该结果是根据当前数据和字段信息,通过VMind的内置规则推导得到的图表推荐结果,在大模型生成图表过程有误时兜底产生。详见:[基于规则的图表生成](../guide/Basic_Tutorial/Chart_Advisor)

# 使用实例
[数据提取——从文本一步生成图表](../guide/Basic_Tutorial/Data_Extraction)

0 comments on commit 68fe7f4

Please sign in to comment.