npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@add-context/pinecone-client

v1.0.4

Published

Pinecone.io client powered by fetch

Downloads

7

Readme

Pinecone.io Client

Build Status npm version

A fetch based client for the Pinecone.io vector database with excellent TypeScript support.

Highlights

  • Support for all vector operation endpoints
  • Fully typed metadata with TypeScript generics
  • Automatically remove null metadata values (Pinecone doesn't nulls)
  • Supports modern fetch based runtimes (Cloudlflare workers, Deno, etc)
  • In-editor documentation with IntelliSense/TS server
  • Tiny package size. Less than 5kb gzipped
  • Full e2e test coverage

Example Usage

import { PineconeClient } from 'pinecone-client';

// Specify the type of your metadata
type Metadata = { size: number, tags?: string[] | null };

// Instantiate a client
const pinecone = new PineconeClient<Metadata>({ namespace: 'test' });

// Upsert vectors with metadata.
await pinecone.upsert({
  vectors: [
    { id: '1', values: [1, 2, 3], metadata: { size: 3, tags: ['a', 'b', 'c'] } },
    { id: '2', values: [4, 5, 6], metadata: { size: 10, tags: null } },
  ],
});

// Query vectors with metadata filters.
const { matches } = await pinecone.query({
  topK: 2,
  id: '2',
  filter: { size: { $lt: 20 } },
  includeMetadata: true,
});

// typeof matches = {
//   id: string;
//   score: number;
//   metadata: Metadata;
// }[];

Install

Installation depends on runtime support for the Fetch API.

With Fetch

Runtime examples: Deno, Node v18+, Cloudflare Workers, browsers

npm install pinecone-client
import { PineconeClient } from 'pinecone-client';

const pinecone = new PineconeClient({ /* ... */ });

Without Fetch

For runtimes like Node.js v17 and below that don't support fetch, you will need to polyfill fetch. I suggest using cross-fetch.

npm install pinecone-client cross-fetch
import 'cross-fetch/polyfill';
import { PineconeClient } from 'pinecone-client';

const pinecone = new PineconeClient({ /* ... */ });

Setup

Once installed, you need to create an instance of the PineconeClient class to make API calls.

import { PineconeClient } from 'pinecone-client';

// A type representing your metadata
type Metadata = {};

const pinecone = new PineconeClient<Metadata>({
  apiKey: '<your api key>',
  baseUrl: '<your index url>'
  namespace: 'testing',
});

Both apiKey and baseUrl are optional and will be read from the following environment variables:

  • process.env.PINECONE_API_KEY
  • process.env.PINECONE_BASE_URL

API

The client supports all of the vector operations from the Pinecone API using the same method names and parameters. It also supports creating and deleting indexes.

For detailed documentation with links to the Pinecone docs, see the source code.

Supported methods:

  • pinecone.delete()
  • pinecone.describeIndexStats()
  • pinecone.fetch()
  • pinecone.query()
  • pinecone.update()
  • pinecone.upsert()
  • pinecone.createIndex()
  • pinecone.deleteIndex()

You can also find more example usage in the e2e tests.