MemoryRecord.ReferenceRecord 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.
Prepare an instance about a memory which source is stored externally. The universal resource identifies points to the URL (or equivalent) to find the original source.
public static Microsoft.SemanticKernel.Memory.MemoryRecord ReferenceRecord (string externalId, string sourceName, string? description, ReadOnlyMemory<float> embedding, string? additionalMetadata = default, string? key = default, DateTimeOffset? timestamp = default);static member ReferenceRecord : string * string * string * ReadOnlyMemory<single> * string * string * Nullable<DateTimeOffset> -> Microsoft.SemanticKernel.Memory.MemoryRecordPublic Shared Function ReferenceRecord (externalId As String, sourceName As String, description As String, embedding As ReadOnlyMemory(Of Single), Optional additionalMetadata As String = Nothing, Optional key As String = Nothing, Optional timestamp As Nullable(Of DateTimeOffset) = Nothing) As MemoryRecordParameters
- externalId
- String
URL (or equivalent) to find the original source.
- sourceName
- String
Name of the external service, e.g. "MSTeams", "GitHub", "WebSite", "Outlook IMAP", etc.
- description
- String
Optional description of the record. Note: the description is not indexed.
- embedding
- ReadOnlyMemory<Single>
Source content embedding.
- additionalMetadata
- String
Optional string for saving custom metadata.
- key
- String
Optional existing database key.
- timestamp
- Nullable<DateTimeOffset>
optional timestamp.
Returns
Memory record