Helper funcs.

NewClient creates and initializes a new instance of Client.

NewClientBase creates and initializes a new instance of Client with custom authentication headers.

Default distance metric, ideal for textual data.

Ideal for hybrid search.

Ideal for distance-based data (e.g.

Client holds the parameters for connecting to the Pinecone service.

Collection is a Pinecone [Collection object].

ConfigureIndexParams contains parameters for configuring an index.

CreateCollectionRequest holds the parameters for creating a new [Collection].

CreatePodIndexRequest holds the parameters for creating a new pods-based Index.

CreateServerlessIndexRequest holds the parameters for creating a new [Serverless] Index.

DescribeIndexStatsResponse holds the parameters for the DescribeIndexStatsResponse object, which is returned by the DescribeIndexStats method.

EmbedParameters contains model-specific parameters that can be used for generating embeddings.

EmbedRequest holds the parameters for generating embeddings for a list of input strings.

FetchVectorsResponse holds the parameters for the FetchVectorsResponse object, which is returned by the FetchVectors method.

Index is a Pinecone Index object.

IndexConnection holds the parameters for a Pinecone IndexConnection object.

IndexSpec is the infrastructure specification (pods vs serverless) of a Pinecone Index.

IndexStatus is the status of a Pinecone Index.

InferenceService is a struct which exposes methods for interacting with the Pinecone Inference API.

ListVectorsRequest holds the parameters for the ListVectorsRequest object, which is passed into the ListVectors method.

ListVectorsResponse holds the parameters for the ListVectorsResponse object, which is returned by the ListVectors method.

NamespaceSummary is a summary of stats for a Pinecone [namespace].

NewClientBaseParams holds the parameters for creating a new Client instance while passing custom authentication headers.

NewClientParams holds the parameters for creating a new Client instance while authenticating via an API key.

NewIndexConnParams holds the parameters for creating an IndexConnection to a Pinecone index.

PodSpec is the infrastructure specification of a pod-based Pinecone Index.

PodSpecMetadataConfig represents the metadata fields to be indexed when a Pinecone Index is created.

QueryByVectorIdRequest holds the parameters for the QueryByVectorIdRequest object, which is passed into the QueryByVectorId method.

QueryByVectorValuesRequest holds the parameters for the QueryByVectorValuesRequest object, which is passed into the QueryByVectorValues method.

QueryVectorsResponse holds the parameters for the QueryVectorsResponse object, which is returned by the QueryByVectorValues method.

ScoredVector is a vector with an associated similarity score calculated according to the distance metric of the Index.

ServerlessSpec is the infrastructure specification of a serverless Pinecone Index.

SparseValues is a sparse vector objects, most commonly used for [hybrid search].

UpdateVectorRequest holds the parameters for the UpdateVectorRequest object, which is passed into the UpdateVector method.

Usage is the usage stats ([Read Units]) for a Pinecone Index.

Vector is a [dense or sparse vector object] with optional metadata.

Cloud is the [cloud provider] to be used for a Pinecone serverless Index.

CollectionStatus is the status of a Pinecone Collection.

DeletionProtection determines whether [deletion protection] is "enabled" or "disabled" for the index.

IndexMetric is the [distance metric] to be used by similarity search against a Pinecone Index.

IndexStatusState is the state of a Pinecone Index.

Metadata represents optional, additional information that can be [attached to, or updated for, a vector] in a Pinecone Index.

MetadataFilter represents the [metadata filters] attached to a Pinecone request.