Package com.microsoft.semantickernel.orchestration

Class AbstractSKContext

java.lang.Object

com.microsoft.semantickernel.orchestration.AbstractSKContext

All Implemented Interfaces:

Buildable, SKContext

public abstract class AbstractSKContext
extends Object
implements SKContext

Semantic Kernel context

Nested Class Summary

Nested classes/interfaces inherited from interface com.microsoft.semantickernel.orchestration.SKContext

SKContext.Builder

Method Summary

Modifier and Type	Method	Description
SKContext	appendToVariable(String key, String content)	Appends data to the given key
SKContext	copy()	Clones the context
String	getLastErrorDescription()
Exception	getLastException()
String	getResult()	Obtain the result of the execution that produced this context.
SemanticTextMemory	getSemanticMemory()	Provides access to the context's semantic memory
ReadOnlySkillCollection	getSkills()	Provides access to the skills within this context
ContextVariables	getVariables()	Return a copy of all variables within the context
boolean	isErrorOccurred()
SKContext	setVariable(String key, String content)	Sets the given variable
SKContext	update(ContextVariables newData)	Merges in the given variables.
SKContext	update(String content)	Updates the input entry with the given data

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.semantickernel.orchestration.SKContext

build

Method Detail

getResult

@Nullable
public String getResult()

Description copied from interface: SKContext

Obtain the result of the execution that produced this context. This will be the "input" entry in the variables.

Specified by:

getResult in interface SKContext

Returns:

the "input" entry in the variables

getVariables

public ContextVariables getVariables()

Description copied from interface: SKContext

Return a copy of all variables within the context

Specified by:

getVariables in interface SKContext

Returns:

a clone of the variables

copy

@CheckReturnValue
public SKContext copy()

Description copied from interface: SKContext

Clones the context

Specified by:

copy in interface SKContext

Returns:

a copy of this context

getSemanticMemory

@Nullable
public SemanticTextMemory getSemanticMemory()

Description copied from interface: SKContext

Provides access to the context's semantic memory

Specified by:

getSemanticMemory in interface SKContext

Returns:

the semantic memory

getSkills

public ReadOnlySkillCollection getSkills()

Description copied from interface: SKContext

Provides access to the skills within this context

Specified by:

getSkills in interface SKContext

Returns:

the skills

setVariable

public SKContext setVariable(@Nonnull
                             String key,
                             @Nonnull
                             String content)

Description copied from interface: SKContext

Sets the given variable

Specified by:

setVariable in interface SKContext

Parameters:

key - if null defaults to the "input" key

content - value to set

Returns:

Context for fluent calls

appendToVariable

public SKContext appendToVariable(@Nonnull
                                  String key,
                                  @Nonnull
                                  String content)

Description copied from interface: SKContext

Appends data to the given key

Specified by:

appendToVariable in interface SKContext

Parameters:

key - key to set

content - value to set

Returns:

Context for fluent calls

update

public SKContext update(@Nonnull
                        String content)

Description copied from interface: SKContext

Updates the input entry with the given data

Specified by:

update in interface SKContext

Parameters:

content - value to set

Returns:

Context for fluent calls

update

public SKContext update(@Nonnull
                        ContextVariables newData)

Description copied from interface: SKContext

Merges in the given variables. Duplicate keys provided by newData will overwrite existing entries.

Specified by:

update in interface SKContext

Parameters:

newData - variables to merge in

Returns:

Context for fluent calls

isErrorOccurred

public boolean isErrorOccurred()

getLastErrorDescription

public String getLastErrorDescription()

getLastException

@Nullable
public Exception getLastException()