PineconeMemoryStore.GetWithDocumentIdBatchAsync Method
Definition
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.
Get a MemoryRecord from the Pinecone Vector database by a group of documentIds.
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>
override this.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 associated with the index to get the Pinecone vector records from.
- documentIds
- IEnumerable<String>
The unique indexed IDs associated with Pinecone vector records to get.
- limit
- Int32
- indexNamespace
- String
The namespace associated with the Pinecone vector records to get.
- withEmbeddings
- Boolean
If true, the embeddings will be returned in the memory records.
- cancellationToken
- CancellationToken
Cancellation token.