IPineconeMemoryStore.GetWithDocumentIdAsync 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.
Gets the memory records associated with the given document id.
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>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 of the index to search.
- documentId
- String
the document id to search for.
- limit
- Int32
the number of results to return.
- indexNamespace
- String
the namespace to search.
- withEmbedding
- Boolean
if true, the embedding will be returned in the memory record.
- cancellationToken
- CancellationToken
Returns
the memory records associated with the document id provided.