https://github.com/tryagi/pinecone

Pinecone is a fully-fledged C# library for the Pinecone vector database. It aims to provide identical functionality to the official Python and Rust libraries. This is fork of Pinecone.NET.
https://github.com/tryagi/pinecone

client csharp database dotnet embedding embeddings langchain-dotnet net6 net7 pinecone sdk vector vector-database

Last synced: 2 months ago
JSON representation

Pinecone is a fully-fledged C# library for the Pinecone vector database. It aims to provide identical functionality to the official Python and Rust libraries. This is fork of Pinecone.NET.

• Host: GitHub
• URL: https://github.com/tryagi/pinecone
• Owner: tryAGI
• License: mit
• Created: 2023-08-14T05:28:51.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-17T04:51:15.000Z (5 months ago)
• Last Synced: 2024-09-17T07:46:14.943Z (5 months ago)
• Topics: client, csharp, database, dotnet, embedding, embeddings, langchain-dotnet, net6, net7, pinecone, sdk, vector, vector-database
• Language: C#
• Homepage: https://github.com/neon-sunset/Pinecone.NET
• Size: 217 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pinecone

[![Nuget package](https://img.shields.io/nuget/vpre/tryAGI.Pinecone)](https://www.nuget.org/packages/tryAGI.Pinecone/)

[![dotnet](https://github.com/tryAGI/Pinecone/actions/workflows/dotnet.yml/badge.svg?branch=main)](https://github.com/tryAGI/Pinecone/actions/workflows/dotnet.yml)

[![License: MIT](https://img.shields.io/github/license/tryAGI/Pinecone)](https://github.com/tryAGI/Pinecone/blob/main/LICENSE.txt)

[![Discord](https://img.shields.io/discord/1115206893015662663?label=Discord&logo=discord&logoColor=white&color=d82679)](https://discord.gg/Ca2xhfBf3v)

Pinecone is a fully-fledged C# library for the Pinecone vector database. 

It aims to provide identical functionality to the official Python and Rust libraries.  

This is a fork of [this project](https://github.com/neon-sunset/Pinecone.NET) with netstandard2.0/net framework support.

## Features

- Standard Index operations

- gRPC and REST transports for vector operations

- Sparse-dense vectors

- Efficient vector serialization

- Metadata support

- NativeAOT compatibility

## Usage

Working with indexes

```csharp

using Pinecone;

// Initialize the client with your API key and environment

var apiKey = "your-api-key";

var environment = "your-environment"; // for example us-east4-gcp

using var pinecone = new PineconeClient(apiKey, environment);

// List all indexes

var indexes = await pinecone.ListIndexes();

// Create a new index if it doesn't exist

var indexName = "myIndex";

if (!indexes.Contains(indexName))

{

    await pinecone.CreateIndex(indexName, 1536, Metric.Cosine);

}

// Get an index by name

using var index = await pinecone.GetIndex(indexName);

// Configure an index

await pinecone.ConfigureIndex(indexName, replicas: 2, podType: "p2");

// Delete an index

await pinecone.DeleteIndex(indexName);

```

Working with vectors

```csharp

// Assuming you have an instance of `index`

// Create and upsert vectors

var vectors = new[]

{

    new Vector

    {

        Id = "vector1",

        Values = new float[] { 0.1f, 0.2f, 0.3f },

        Metadata = new MetadataMap

        {

            ["genre"] = "horror",

            ["duration"] = 120

        }

    }

};

await index.Upsert(vectors);

// Fetch vectors by IDs

var fetched = await index.Fetch(new[] { "vector1" });

// Query scored vectors by ID

var scored = await index.Query("vector1", topK: 10);

// Query scored vectors by a new, previously unseen vector

var vector = new[] { 0.1f, 0.2f, 0.3f, ... };

var scored = await index.Query(vector, topK: 10);

// Query scored vectors by ID with metadata filter

var filter = new MetadataMap

{

    ["genre"] = new MetadataMap

    {

        ["$in"] = new MetadataValue[] { "documentary", "action" }

    }

};

var scored = await index.Query("birds", topK: 10, filter);

// Delete vectors by vector IDs

await index.Delete(new[] { "vector1" });

// Delete vectors by metadata filter

await index.Delete(new MetadataMap

{

  ["genre"] = new MetadataMap

  {

     ["$in"] = new MetadataValue[] { "documentary", "action" }

  }

});

// Delete all vectors in the index

await index.DeleteAll();

```

Working with Collections

```csharp

using Pinecone;

// Assuming you have an instance of `PineconeClient` named `pinecone`

  

// List all collections

var collections = await pinecone.ListCollections();

// Create a new collection

await pinecone.CreateCollection("myCollection", "myIndex");

// Describe a collection

var details = await pinecone.DescribeCollection("myCollection");

// Delete a collection

await pinecone.DeleteCollection("myCollection");

```

## Contributing

Contributions are welcome! Feel free open an issue or a PR.

## Support

Priority place for bugs: https://github.com/tryAGI/Pinecone/issues  

Priority place for ideas and general questions: https://github.com/tryAGI/Pinecone/discussions  

Discord: https://discord.gg/Ca2xhfBf3v