# @xpressai/vecto-client

> Docs •

Latest version **0.0.10** (published 2023-11-15) · 0 weekly downloads

## Install

```sh
npm install @xpressai/vecto-client
pnpm add @xpressai/vecto-client
yarn add @xpressai/vecto-client
bun add @xpressai/vecto-client
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; has provenance.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.10 |
| Published | 2023-11-15 |
| First published | 2023-10-23 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 286.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 0 |
| Maintainers | mfa-x-ai, dot_treo, wmeddie |

## Links

- npm: https://www.npmjs.com/package/@xpressai/vecto-client
- Repository: https://github.com/XpressAI/vecto-typescript-client
- Homepage: https://github.com/XpressAI/vecto-typescript-client#readme
- Issues: https://github.com/XpressAI/vecto-typescript-client/issues
- npm.io page: https://npm.io/package/@xpressai/vecto-client

## Recent versions

- 0.0.10 (latest) — 2023-11-15
- 0.0.9 — 2023-11-15
- 0.0.8 — 2023-11-02
- 0.0.7 — 2023-10-24
- 0.0.5 — 2023-10-23
- 0.0.4 — 2023-10-23
- 0.0.1 — 2023-10-23

## README

<p align="center">
<a href="https://www.vecto.ai/">
<img src="https://user-images.githubusercontent.com/68586800/192857099-499146bb-5570-4702-a88f-bb4582e940c0.png" width="300"/>
</a>
</p>
<p align="center">
  <a href="https://docs.vecto.ai/">Docs</a> •
  <a href="https://www.xpress.ai/blog/">Blog</a> •
  <a href="https://discord.com/invite/wtYbXvPPfD">Discord</a> •
  <a href="https://github.com/XpressAI/vecto-tutorials">Tutorials</a>
</p>

<br>

# 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](https://www.vecto.ai/contactus).

## 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](https://docs.vecto.ai/).

## Developers Discord
Have any questions or need support? Feel free to chat with the devs at our [Discord](https://discord.com/invite/wtYbXvPPfD)!

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

---
_Source: https://npm.io/package/@xpressai/vecto-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._