Class PineconeStore
Pinecone implementation of IVectorStore.
Mapping model:
- Collection (physical) โ Pinecone index (via IndexHost)
- All metadata stored as Pinecone metadata fields.
public class PineconeStore : IVectorStore, IDisposable
- Inheritance
-
PineconeStore
- Implements
- Inherited Members
Constructors
PineconeStore(PineconeOptions)
Creates a new PineconeStore that owns its HttpClient.
public PineconeStore(PineconeOptions options)
Parameters
optionsPineconeOptions
PineconeStore(PineconeOptions, HttpClient)
Creates a new PineconeStore using an externally managed HttpClient.
public PineconeStore(PineconeOptions options, HttpClient httpClient)
Parameters
optionsPineconeOptionshttpClientHttpClient
Methods
CountAsync(VectorFilter?, CancellationToken)
Returns the number of records matching the optional filter.
When filter is null, returns the total record count.
Implementations may ignore MinScore as it is not meaningful for counting.
public Task<long> CountAsync(VectorFilter? filter = null, CancellationToken cancellationToken = default)
Parameters
filterVectorFiltercancellationTokenCancellationToken
Returns
DeleteAsync(string, VectorFilter?, CancellationToken)
Deletes a single record by its Id.
Implementations may use filter to narrow by metadata conditions.
public Task DeleteAsync(string id, VectorFilter? filter = null, CancellationToken cancellationToken = default)
Parameters
idstringfilterVectorFiltercancellationTokenCancellationToken
Returns
DeleteByFilterAsync(VectorFilter, CancellationToken)
Deletes all records matching the specified filter.
public Task DeleteByFilterAsync(VectorFilter filter, CancellationToken cancellationToken = default)
Parameters
filterVectorFiltercancellationTokenCancellationToken
Returns
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public void Dispose()
GetAsync(string, VectorFilter?, CancellationToken)
Retrieves a single record by its Id.
Implementations may use filter to narrow results by metadata conditions.
public Task<VectorRecord?> GetAsync(string id, VectorFilter? filter = null, CancellationToken cancellationToken = default)
Parameters
idstringfilterVectorFiltercancellationTokenCancellationToken
Returns
GetBatchAsync(IEnumerable<string>, VectorFilter?, CancellationToken)
Retrieves multiple records by their Ids in a single batch operation.
Records that do not exist or do not match filter are omitted from the result.
The order of results is not guaranteed to match the order of ids.
public Task<IReadOnlyList<VectorRecord>> GetBatchAsync(IEnumerable<string> ids, VectorFilter? filter = null, CancellationToken cancellationToken = default)
Parameters
idsIEnumerable<string>filterVectorFiltercancellationTokenCancellationToken
Returns
HybridSearchAsync(float[], string, int, VectorFilter?, CancellationToken)
Performs a native hybrid search using Pinecone's server-side dense + sparse fusion.
Dense vector search and sparse (BM25-based) vector search are combined by Pinecone internally.
Requires the index to use dotproduct metric.
public Task<IReadOnlyList<VectorSearchResult>> HybridSearchAsync(float[] denseVector, string query, int topK, VectorFilter? filter = null, CancellationToken cancellationToken = default)
Parameters
denseVectorfloat[]querystringtopKintfilterVectorFiltercancellationTokenCancellationToken
Returns
SearchAsync(float[], int, VectorFilter?, CancellationToken)
Performs a similarity search. Implementations should respect Conditions and MinScore when present.
public Task<IReadOnlyList<VectorSearchResult>> SearchAsync(float[] queryVector, int topK = 5, VectorFilter? filter = null, CancellationToken cancellationToken = default)
Parameters
queryVectorfloat[]The query embedding vector.
topKintMaximum number of results to return.
filterVectorFilterOptional filter criteria (metadata conditions, min score).
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<IReadOnlyList<VectorSearchResult>>
Results ordered by descending similarity score.
UpsertAsync(VectorRecord, CancellationToken)
Inserts or updates a single vector record. If a record with the same Id already exists, it is overwritten.
public Task UpsertAsync(VectorRecord record, CancellationToken cancellationToken = default)
Parameters
recordVectorRecordcancellationTokenCancellationToken
Returns
UpsertBatchAsync(IEnumerable<VectorRecord>, CancellationToken)
Inserts or updates multiple vector records in a batch.
public Task UpsertBatchAsync(IEnumerable<VectorRecord> records, CancellationToken cancellationToken = default)
Parameters
recordsIEnumerable<VectorRecord>cancellationTokenCancellationToken
Returns
VerifyConnectionAsync(CancellationToken)
Verifies that the store can reach its backend (e.g. database, API). Throws on failure. In-memory stores succeed immediately.
public Task VerifyConnectionAsync(CancellationToken cancellationToken = default)
Parameters
cancellationTokenCancellationToken