Load Sample Dataset

async function loadSampleDataset(
    name?: string,                      // default: 'quickstart-75k'
    options?: LoadSampleDatasetOptions,
): Promise<SampleDataset>

import { loadSampleDataset } from 'cyborgdb';

const dataset = await loadSampleDataset();

import { Client, loadSampleDataset, type FilterExpression, type QueryResultItem } from 'cyborgdb';

const client = new Client({ baseUrl: 'http://localhost:8000', apiKey: 'your-api-key' });
const indexKey = Client.generateKey();

// Downloads on first use; cached afterwards on Node.js
const dataset = await loadSampleDataset();
console.log(dataset.name, dataset.count, dataset.dimension, dataset.metric);
// Output: quickstart-75k 75000 128 euclidean

const index = await client.createIndex({
    indexName: 'demo',
    indexKey,
    dimension: dataset.dimension,
    metric: dataset.metric as 'euclidean',
});

await index.upsert({ items: dataset.items });

// Similarity search with a bundled query vector
const response = await index.query({ queryVectors: dataset.sampleQueries[0], topK: 5 });
console.log((response.results as QueryResultItem[]).length);
// Output: 5

// A curated metadata filter
const example = dataset.exampleFilters[0];
console.log(example.name, example.filter);
// Output: Equality filter (string field) { string: 'string_0' }
const filtered = await index.query({
    queryVectors: dataset.sampleQueries[0],
    filters: example.filter as FilterExpression,
});