Share via


IPineconeMemoryStore.GetWithDocumentIdBatchAsync Method

Definition

Gets the memory records associated with the given document ids.

public System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.Memory.MemoryRecord?> GetWithDocumentIdBatchAsync (string indexName, System.Collections.Generic.IEnumerable<string> documentIds, int limit = 3, string indexNamespace = "", bool withEmbeddings = false, System.Threading.CancellationToken cancellationToken = default);
abstract member GetWithDocumentIdBatchAsync : string * seq<string> * int * string * bool * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.Memory.MemoryRecord>
Public Function GetWithDocumentIdBatchAsync (indexName As String, documentIds As IEnumerable(Of String), Optional limit As Integer = 3, Optional indexNamespace As String = "", Optional withEmbeddings As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of MemoryRecord)

Parameters

indexName
String

the name of the index to search.

documentIds
IEnumerable<String>

the document ids to search for.

limit
Int32

the number of results to return.

indexNamespace
String

the namespace to search.

withEmbeddings
Boolean

if true, the embeddings will be returned in the memory records.

cancellationToken
CancellationToken

Returns

the memory records associated with the document ids provided.

Applies to