mirrors/VChart
1
0
Fork 0
mirror of https://github.com/VisActor/VChart synced 2024-11-22 17:26:19 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

feat: update readme

Browse Source
This commit is contained in:
da730 2023-11-14 23:28:27 +08:00
parent a3be14e2cc
commit b48f34c941
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
packages/vmind/README.md
View File

@ -6,12 +6,12 @@ English | [简体中文](readme-zh.md)
</div>
`@visactor/vmind` is an intelligent chart component based on large models provided by [VisActor](https://www.visactor.io/), including dialog-based chart generation and editing capabilities. It provides a natural language interaction interface, allowing you to easily create chart narrative works with `@visactor/VMind` with just one sentence, and edit them through continuous dialogue, greatly improving your efficiency in creating data visualization works.
`@visactor/vmind` is an intelligent chart component based on LLM provided by [VisActor](https://www.visactor.io/), including dialog-based chart generation and editing capabilities. It provides a natural language interaction interface, allowing you to easily create chart narrative works with `@visactor/VMind` with just one sentence, and edit them through continuous dialogue, greatly improving your efficiency in creating data visualization works.
The main features of `@visactor/vmind` include:
- **Easy to use**: Just provide the data you want to display and a sentence describing the information you want to display, and `@visactor/vmind` will automatically generate the chart for you. Based on the existing chart, describe the modifications you want to make to the chart in one sentence, and `@visactor/VMind` will help you achieve the desired effect.
- **Strong scalability**: The components of `@visactor/VMind` can be easily extended and customized, and new functions and features can be added as needed. By default, the OpenAI GPT model is used, and you can easily replace it with any text large model.
- **Strong scalability**: The components of `@visactor/VMind` can be easily extended and customized, and new functions and features can be added as needed. By default, the OpenAI GPT model is used, and you can easily replace it with any LLM service.
- **Easy narrative**: Based on the powerful chart narrative ability of `@visactor/vchart`, `@visactor/VMind` supports the generation of various types of charts, including line charts, bar charts, pie charts, etc., and can also generate dynamic bar charts and other dynamic charts, making it easy for you to narrate data. More chart types are being added. You can also use the dialog-based editing function to easily modify chart styles and animation effects, making it easy for you to create narratives.
- **One-click export**: `@visactor/VMind` comes with a chart export module, and you can export the created chart narrative as a video or GIF for display.
@ -73,14 +73,14 @@ const vmind = new VMind(openAIKey); //Pass in your openAI key
const { spec, time } = await vmind.generateChart(csv, describe); //Intelligent chart generation, pass in your csv format data and chart description, and return the chart spec and chart animation duration
```
#### Customizing Large Model Call Method
#### Customizing LLM Request Method
Pass parameters when initializing the VMind object:
```typescript
import VMind from '@visactor/vmind';
const vmind = new VMind(openAIKey:string, params:{
url?: string;//URL of the large model service
url?: string;//URL of the LLM service
/** gpt request header, which has higher priority */
headers?: Record<string, string> ;//request headers
method?: string;//request method POST GET
@ -90,8 +90,8 @@ temperature?: number;//recommended to set to 0
})
```
Specify your large model service url in url (default is https://api.openai.com/v1/chat/completions)
In subsequent calls, VMind will use the parameters in params to request the large model service url.
Specify your LLM service url in url (default is https://api.openai.com/v1/chat/completions)
In subsequent calls, VMind will use the parameters in params to request the LLM service url.
#### Chart export