# turbopuffer-sdk

> TypeScript SDK for turbopuffer vector database API

Latest version **0.1.1** (published 2024-03-26) · 0 weekly downloads

## Install

```sh
npm install turbopuffer-sdk
pnpm add turbopuffer-sdk
yarn add turbopuffer-sdk
bun add turbopuffer-sdk
```

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2024-03-26 |
| First published | 2023-12-08 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 22.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Tommaso De Rossi, morse |
| Maintainers | xmorse |
| Keywords | turbopuffer, qdrant, typesense, pinecone, vectorize, vector database |

## Links

- npm: https://www.npmjs.com/package/turbopuffer-sdk
- Repository: https://github.com/holocron-hq/turbopuffer-sdk
- Homepage: https://github.com/holocron-hq/turbopuffer-sdk#readme
- Issues: https://github.com/holocron-hq/turbopuffer-sdk/issues
- npm.io page: https://npm.io/package/turbopuffer-sdk

## Dependencies (1)

- [pako](https://npm.io/package/pako.md) ^2.1.0

## Recent versions

- 0.1.1 (latest) — 2024-03-26
- 0.1.0 — 2024-03-26
- 0.0.2 — 2023-12-14
- 0.0.1 — 2023-12-08

## README

## Install

```
npm install turbopuffer-sdk
```

## Usage

```js
import { TurboPufferApiClientV1 } from 'turbopuffer-sdk'

const client = new TurboPufferApiClientV1({
    token: process.env.TURBOPUFFER_KEY,
})

const namespace = 'test'
const upsertRes = await client.upsertVectors({
    namespace,
    vectors: [{ id: 1, vector: [1, 2, 3], attributes: { hello: 'ciao' } }],
})

const vectors = await client.listAllVectors({ namespace })

const results = await puffer.queryVectors({
    namespace,
    distance_metric: 'cosine_distance',
    include_attributes,
    vector: [1, 2, 3],
})

const delRes = await client.deleteNamespace({ namespace })
```

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