Package com.microsoft.semantickernel.connectors.memory.azurecognitivesearch

Class AzureCognitiveSearchMemoryRecord

java.lang.Object

com.microsoft.semantickernel.connectors.memory.azurecognitivesearch.AzureCognitiveSearchMemoryRecord

public final class AzureCognitiveSearchMemoryRecord
extends Object

Azure Cognitive Search record and index definition. Note: once defined, index cannot be modified.

Constructor Summary

Constructors

Constructor	Description
AzureCognitiveSearchMemoryRecord(String id, String text, String description, String additionalMetadata, List<Float> embedding, String externalSourceName, boolean isReference)

Method Summary

Modifier and Type	Method	Description
static AzureCognitiveSearchMemoryRecord	fromMemoryRecord(MemoryRecord record)
String	getAdditionalMetadata()	Additional metadata.
String	getDescription()	Optional description of the content, e.g.
List<Float>	getEmbedding()	Embedding vector.
String	getExternalSourceName()	Name of the external source, in cases where the content and the Id are referenced to external information.
String	getId()	Record ID.
String	getText()	Content is stored here.
boolean	isReference()	Whether the record references external information.
MemoryRecord	toMemoryRecord()
MemoryRecord	toMemoryRecord(boolean withEmbeddings)
MemoryRecordMetadata	toMemoryRecordMetadata()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AzureCognitiveSearchMemoryRecord

public AzureCognitiveSearchMemoryRecord(String id,
                                        String text,
                                        String description,
                                        String additionalMetadata,
                                        List<Float> embedding,
                                        String externalSourceName,
                                        boolean isReference)

Method Detail

getId

public String getId()

Record ID. The record is not filterable to save quota, also SK uses only semantic search.

Returns:

Record ID.

getText

public String getText()

Content is stored here.

Returns:

Content is stored here, null if not set.

getDescription

public String getDescription()

Optional description of the content, e.g. a title. This can be useful when indexing external data without pulling in the entire content.

Returns:

Optional description of the content, null if not set.

getAdditionalMetadata

public String getAdditionalMetadata()

Additional metadata. Currently, this is a String where you could store serialized data as JSON. In future the design might change to allow storing named values and leverage filters.

Returns:

Additional metadata, null if not set.

getEmbedding

public List<Float> getEmbedding()

Embedding vector.

Returns:

Embedding vector.

getExternalSourceName

public String getExternalSourceName()

Name of the external source, in cases where the content and the Id are referenced to external information.

Returns:

Name of the external source, in cases where the content and the Id are referenced to external information, null if not set.

isReference

public boolean isReference()

Whether the record references external information.

Returns:

true if the record references external information, false otherwise.

toMemoryRecordMetadata

public MemoryRecordMetadata toMemoryRecordMetadata()

fromMemoryRecord

public static AzureCognitiveSearchMemoryRecord fromMemoryRecord(MemoryRecord record)

toMemoryRecord

public MemoryRecord toMemoryRecord()

toMemoryRecord

public MemoryRecord toMemoryRecord(boolean withEmbeddings)