See the Go SDK documentation for full installation instructions and usage examples.

To make a feature request or report an issue, please file an issue.

​
Requirements

The Pinecone Go SDK requires a Go version with modules support.

​
Install

To install the latest version of the Go SDK, add a dependency to the current module:

go get github.com/pinecone-io/go-pinecone/v3/pinecone

To install a specific version of the Go SDK, run the following command:

go get github.com/pinecone-io/go-pinecone/v3/pinecone@<version>

To check your SDK version, run the following command:

go list -u -m all | grep go-pinecone

​
Upgrade

Before updgrading to v3.0.0, update all relevant code to account for the breaking changes explained here.

If you already have the Go SDK, upgrade to the latest version as follows:

go get -u github.com/pinecone-io/go-pinecone/v3/pinecone@latest

​
Initialize

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

package main

import (
    "context"
    "log"

    "github.com/pinecone-io/go-pinecone/v3/pinecone"
)

func main() {
    ctx := context.Background()

    pc, err := pinecone.NewClient(pinecone.NewClientParams{
        ApiKey: "YOUR_API_KEY",
    })
    if err != nil {
        log.Fatalf("Failed to create Client: %v", err)
    }
}

Was this page helpful?

Java SDK.NET SDK