io.pinecone

Class PineconeClient

java.lang.Object

io.pinecone.PineconeClient

public final class PineconeClient
extends java.lang.Object

Top-level client for connecting and making calls to Pinecone services. One instance can be used to connect to multiple services and shared across threads.

Constructor Summary

Constructors

Constructor and Description
PineconeClient(PineconeClientConfig config) Create a new instance.

Method Summary

Modifier and Type	Method and Description
PineconeConnection	connect(PineconeConnectionConfig connectionConfig) Create a new connection to the Pinecone service or router specified in the config.
PineconeConnection	connect(java.lang.String indexName) Create a new connection to the specified Pinecone service or router.
PineconeConnection	connectWithUrl(java.lang.String connectionUrl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PineconeClient

public PineconeClient(PineconeClientConfig config)

Create a new instance. Throws PineconeValidationException if configuration is invalid.

Parameters:

config - User-level configuration for the client.

Method Detail

connect

public PineconeConnection connect(java.lang.String indexName)

Create a new connection to the specified Pinecone service or router. Throws PineconeValidationException if configuration is invalid.

Parameters:

indexName - The name of your pinecone Index.

Returns:

A PineconeConnection for the service or router.

connect

public PineconeConnection connect(PineconeConnectionConfig connectionConfig)

Create a new connection to the Pinecone service or router specified in the config. Throws PineconeValidationException if configuration is invalid.

Parameters:

connectionConfig - Config for the connection to be opened.

Returns:

A PineconeConnection for the service or router.

connectWithUrl

public PineconeConnection connectWithUrl(java.lang.String connectionUrl)