PineconeClient.QueryAsync Method

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.Pinecone

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

Package:: Microsoft.SemanticKernel.Connectors.Pinecone v1.20.0-alpha

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.

Gets the most relevant vectors to a list of queries

public System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.Connectors.Pinecone.PineconeDocument?> QueryAsync (string indexName, Microsoft.SemanticKernel.Connectors.Pinecone.Query query, bool includeValues = false, bool includeMetadata = true, System.Threading.CancellationToken cancellationToken = default);

abstract member QueryAsync : string * Microsoft.SemanticKernel.Connectors.Pinecone.Query * bool * bool * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.Connectors.Pinecone.PineconeDocument>
override this.QueryAsync : string * Microsoft.SemanticKernel.Connectors.Pinecone.Query * bool * bool * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.Connectors.Pinecone.PineconeDocument>

Public Function QueryAsync (indexName As String, query As Query, Optional includeValues As Boolean = false, Optional includeMetadata As Boolean = true, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PineconeDocument)

Parameters

indexName: String

the name of the index

query: Query

the query parameters

includeValues: Boolean

whether to include the vector values

includeMetadata: Boolean

whether to include the metadata

cancellationToken: CancellationToken

Returns

IAsyncEnumerable<PineconeDocument>

a list of query matches

Implements

QueryAsync(String, Query, Boolean, Boolean, CancellationToken)

Applies to

Partager via