How to Reference VMind in Your Project

In the How to Get VMind section, we introduced how to get VMind. This section will introduce how to reference VMind under these acquisition methods one by one.

Using cdn

After we get the VMind file from cdn, we can add it to the <script> tag in the HTML file:

** Note: When introducing VMind in the cdn way, you need to pay attention to the reference method of VMind:**

const vmind = new VMind.default({
url,
model,
headers: {
'api-key': apiKey
}
});

<!-- Introduce VMind -->
<script src="https://unpkg.com/@visactor/vmind/build/index.min.js"></script>

<script>
const vmind = new VMind.default({
url,
model,
headers: {
'api-key': apiKey
}
});
const { spec } = await vmind.generateChart(userInput, fieldInfo, dataset);
</script>

Using npm

After we install @visactor/vmind into the project through npm, we can use it in the following way:

import VMind, { Model } from '@visactor/vmind'

const vmind = new VMind({
url, //default is https://api.openai.com/v1/chat/completions
model: Model.GPT3_5,
headers: {
'api-key': apiKey //Your LLM API Key
}
})