PineconeClient Class

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.Pinecone

Assembly:: Microsoft.SemanticKernel.Connectors.Pinecone.dll

Package:: Microsoft.SemanticKernel.Connectors.Pinecone v1.45.0-preview

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A client for the Pinecone API

public sealed class PineconeClient : Microsoft.SemanticKernel.Connectors.Pinecone.IPineconeClient

type PineconeClient = class
    interface IPineconeClient

Public NotInheritable Class PineconeClient
Implements IPineconeClient

Inheritance: Object
PineconeClient

Implements: IPineconeClient

Constructors

Name	Description
PineconeClient(String, String, ILoggerFactory, HttpClient)	Initializes a new instance of the PineconeClient class.

Methods

Name	Description
ConfigureIndexAsync(String, Int32, PodType, CancellationToken)	Configure index
CreateIndexAsync(IndexDefinition, CancellationToken)	Create index
DeleteAsync(String, IEnumerable<String>, String, Dictionary<String,Object>, Boolean, CancellationToken)	Delete
DeleteIndexAsync(String, CancellationToken)	Delete Index
DescribeIndexAsync(String, CancellationToken)	Describe index
DescribeIndexStatsAsync(String, Dictionary<String,Object>, CancellationToken)	Describe Index Stats
DoesIndexExistAsync(String, CancellationToken)	Check if a vector collection exists.
FetchVectorsAsync(String, IEnumerable<String>, String, Boolean, CancellationToken)	Get vectors by id
GetMostRelevantAsync(String, ReadOnlyMemory<Single>, Double, Int32, Boolean, Boolean, String, Dictionary<String,Object>, CancellationToken)	Find the nearest vectors in a collection using vector similarity search.
ListIndexesAsync(CancellationToken)	List indexes
QueryAsync(String, Query, Boolean, Boolean, CancellationToken)	Gets the most relevant vectors to a list of queries
UpdateAsync(String, PineconeDocument, String, CancellationToken)	Updates a vector
UpsertAsync(String, IEnumerable<PineconeDocument>, String, CancellationToken)	Upserts a list of documents

Applies to