README.md

The official TypeScript SDK for turbopuffer.

To install,

npm i @turbopuffer/turbopuffer

Usage:

// Make a new client
// Connections are pooled for the lifetime of the client
// We recommend creating a single instance and reusing it for all calls
const tpuf = new Turbopuffer({
  apiKey: process.env.TURBOPUFFER_API_KEY as string,
  // see https://turbopuffer.com/docs/regions for available regions
  baseUrl: "https://gcp-us-east4.turbopuffer.com",
});

// Instantiate an object to work with a namespace
const ns = tpuf.namespace("readme");

await ns.write({
  upsert_rows: [
    {
      id: 1,
      vector: [1, 2],
      foo: "bar",
      numbers: [1, 2, 3],
    },
    {
      id: 2,
      vector: [3, 4],
      foo: "baz",
      numbers: [2, 3, 4],
    },
  ],
  distance_metric: "cosine_distance",
});

const results = await ns.query({
  vector: [1, 1],
  filters: ["numbers", "In", [2, 4]],
});

// results:
// [
//   { id: 2, dist: 0.010050535 },
//   { id: 1, dist: 0.051316738 },
// ]

To run the tests,

npm run test

To publish a new version,

1. Bump version in package.json
2. npm install to update package-lock.json
3. npm publish --access public
4. git tag vX.Y.Z
5. git push origin vX.Y.Z