Share via


PineconeMemoryStore.GetWithDocumentIdAsync Method

Definition

Get a MemoryRecord from the Pinecone Vector database by pointId.

public System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.Memory.MemoryRecord?> GetWithDocumentIdAsync (string indexName, string documentId, int limit = 3, string indexNamespace = "", bool withEmbedding = false, System.Threading.CancellationToken cancellationToken = default);
abstract member GetWithDocumentIdAsync : string * string * int * string * bool * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.Memory.MemoryRecord>
override this.GetWithDocumentIdAsync : string * string * int * string * bool * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.SemanticKernel.Memory.MemoryRecord>
Public Function GetWithDocumentIdAsync (indexName As String, documentId As String, Optional limit As Integer = 3, Optional indexNamespace As String = "", Optional withEmbedding 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 record from.

documentId
String

The unique indexed ID associated with the Pinecone vector record to get.

limit
Int32
indexNamespace
String

The namespace associated with the Pinecone vector record to get.

withEmbedding
Boolean

If true, the embedding will be returned in the memory record.

cancellationToken
CancellationToken

Cancellation token.

Returns

Implements

Exceptions

Applies to