Share via


IPineconeMemoryStore.GetFromNamespaceAsync Method

Definition

Gets a memory record from the data store in the given namespace.

public System.Threading.Tasks.Task<Microsoft.SemanticKernel.Memory.MemoryRecord?> GetFromNamespaceAsync (string indexName, string indexNamespace, string key, bool withEmbedding = false, System.Threading.CancellationToken cancellationToken = default);
abstract member GetFromNamespaceAsync : string * string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.SemanticKernel.Memory.MemoryRecord>
Public Function GetFromNamespaceAsync (indexName As String, indexNamespace As String, key As String, Optional withEmbedding As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of MemoryRecord)

Parameters

indexName
String

The name associated with a collection of embeddings.

indexNamespace
String

The namespace associated with a collection of embeddings.

key
String

The unique id associated with the memory record to get.

withEmbedding
Boolean

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

cancellationToken
CancellationToken

Cancellation token.

Returns

The memory record if found, otherwise null.

Applies to