vellum-ai v0.5.2
Vellum Node Library
The Vellum Node.js library provides access to the Vellum API from JavaScript/TypeScript.
API Docs
You can find Vellum's complete API docs at docs.vellum.ai.
Installation
npm install --save vellum-ai
# or
yarn add vellum-ai
Usage
import { VellumClient } from 'vellum-ai';
const vellum = new VellumClient({
apiKey: 'VELLUM_API_KEY',
});
await vellum.generate({
deploymentName: 'my-deployment',
requests: [{ inputValues: { question: 'Could I please get a refund' } }],
});
Uploading documents
Documents can be uploaded to Vellum via either the UI or this API. Once uploaded and indexed, Vellum's Search allows you to perform semantic searches against them.
import * as fs from 'fs';
await vellum.documents.upload(fs.createReadStream('/path/to/your/file.txt'), {
addToIndexNames: ['<your-index-name>'],
externalId: '<your-external-id>',
label: 'Human-friendly label for your document',
keywords: [],
});
Beta status
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributing
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
4 days ago
17 days ago
17 days ago
17 days ago
17 days ago
17 days ago
19 days ago
22 days ago
23 days ago
23 days ago
25 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
7 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
5 months ago
6 months ago
8 months ago
8 months ago
8 months ago
10 months ago
7 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
8 months ago
12 months ago
8 months ago
11 months ago
8 months ago
10 months ago
10 months ago
10 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
9 months ago
12 months ago
9 months ago
9 months ago
9 months ago
9 months ago
12 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago