Class PineconeOptions

Namespace

Mythosia.VectorDb.Pinecone

Assembly

Mythosia.VectorDb.Pinecone.dll

Configuration options for PineconeStore.

public class PineconeOptions

Inheritance

object

PineconeOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ApiKey

Pinecone API key. Required.

public string ApiKey { get; set; }

Property Value

string

AutoCreateIndex

When true, the store will automatically create the Pinecone index via the Control Plane API if it does not already exist. The index is created with dotproduct metric (required for hybrid search). Requires IndexName, Dimension, Cloud, and Region to be set. Default: false.

public bool AutoCreateIndex { get; set; }

Property Value

bool

Cloud

Cloud provider for serverless index (e.g. "aws", "gcp", "azure"). Required when AutoCreateIndex is true.

public string? Cloud { get; set; }

Property Value

string

ControlPlaneHost

Pinecone Control Plane API host. Default: https://api.pinecone.io.

public string ControlPlaneHost { get; set; }

Property Value

string

Dimension

Vector dimension. Required when AutoCreateIndex is true.

public int Dimension { get; set; }

Property Value

int

IndexHost

Pinecone data plane host for a specific index. Examples:

• https://my-index-xxxx.svc.us-east1-gcp.pinecone.io
• my-index-xxxx.svc.us-east1-gcp.pinecone.io Required.

public string IndexHost { get; set; }

Property Value

string

IndexName

Name of the Pinecone index. Required when AutoCreateIndex is true. Used to create or discover the index via the Control Plane API.

public string? IndexName { get; set; }

Property Value

string

Namespace

Optional Pinecone namespace for data isolation within a single index. When set, all operations (upsert, query, fetch, delete) are scoped to this namespace. When null (default), the Pinecone default namespace ("") is used.

public string? Namespace { get; set; }

Property Value

string

Region

Cloud region for serverless index (e.g. "us-east-1"). Required when AutoCreateIndex is true.

public string? Region { get; set; }

Property Value

string

RequestTimeoutSeconds

Timeout for requests when the store creates its own HttpClient. Default: 100 seconds.

public int RequestTimeoutSeconds { get; set; }

Property Value

int

UpsertBatchSize

Max vectors per upsert request. Default: 100.

public int UpsertBatchSize { get; set; }

Property Value

int

Methods

Validate()

Validates the options and throws ArgumentException if invalid.

public void Validate()