Vecto TypeScript Client

Welcome to the Vecto TypeScript Client! This client provides convenient access to the Vecto API.

Installation

npm install @xpressai/vecto-client

For the token, sign up for your access here.

Local Testing

Ensure that you have Node 18+ installed and tsc. Clone this directory then run

export TEST_MANAGEMENT_ACCESS_TOKEN="your token" &&
export TEST_VECTOR_SPACE_ID="your vs id" &&
npm test

Sample Usage

Indexing

const api = new IndexApi(config);

const textDataParams: IndexDataRequest = {
    vectorSpaceId: 'your-vector-space-id',
    modality: 'TEXT',
    attributes: ['attr1', 'attr2'],
    input: [new Blob(['sample'])], 
};

await api.indexData(textDataParams);

Lookup

const api = new LookupApi(config);

const textParams: LookupRequest = {
    vectorSpaceId: 'your-vector-space-id',
    modality: 'TEXT',
    topK: 3,
    query: 'sample', 
};

const results = await api.lookup(textParams);

Documentation

For detailed documentation of the methods and models, refer to our official documentation.

Developers Discord

Have any questions or need support? Feel free to chat with the devs at our Discord!

Support

For issues with the Client, please raise a GitHub issue. For issues related to the API or other inquiries, please contact Vecto support.