​

Requirements

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

​

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 Go 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 install the latest version of the Go SDK, add a dependency to the current module:

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

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

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

To check your SDK version, run the following command:

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

​

Upgrade

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

go get -u github.com/pinecone-io/go-pinecone/v4/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/v4/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)
    }
}