.NET SDK

​

Requirements

To use this Python .NET SDK, ensure that your project is targeting one of the following:

• .NET Standard 2.0+
• .NET Core 3.0+
• .NET Framework 4.6.2+
• .NET 6.0+

​

SDK versions

SDK versions are pinned to specific API versions. When a new API version is released, a new version of the SDK is also released.

The mappings between API versions and .NET SDK versions are as follows:

When a new stable API version is released, you should upgrade your SDK to the latest version to ensure compatibility with the latest API changes.

​

Install

To add the latest version of the .NET SDK to your project, run the following command:

dotnet add package Pinecone.Client 

To add a specific version of the .NET SDK to your project, run the following command:

dotnet add package Pinecone.Client --version <version>

To check your SDK version, run the following command:

dotnet list package

​

Upgrade

If you are already using Pinecone.Client in your project, upgrade to the latest version as follows:

dotnet add package Pinecone.Client 

​

Initialize

Once installed, you can import the SDK and then use an API key to initialize a client instance:

using Pinecone;

var pinecone = new PineconeClient("YOUR_API_KEY");

​

Proxy configuration

If your network setup requires you to interact with Pinecone through a proxy, configure the HTTP client as follows:

using System.Net;
using Pinecone;

var pinecone = new PineconeClient("PINECONE_API_KEY", new ClientOptions
{
    HttpClient = new HttpClient(new HttpClientHandler
    {
        Proxy = new WebProxy("PROXY_HOST:PROXY_PORT")
    })
});

If you’re building your HTTP client using the HTTP client factory, use the ConfigurePrimaryHttpMessageHandler method to configure the proxy:

   .ConfigurePrimaryHttpMessageHandler(() => new HttpClientHandler
       {
           Proxy = new WebProxy("PROXY_HOST:PROXY_PORT")
       });