Package com.microsoft.semantickernel.semanticfunctions

Class KernelFunctionArguments

java.lang.Object

com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

All Implemented Interfaces:

Map<String,ContextVariable<?>>

public class KernelFunctionArguments
extends Object
implements Map<String,ContextVariable<?>>

Arguments to a kernel function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KernelFunctionArguments.Builder	Builder for ContextVariables

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static String	MAIN_KEY	Default key for the main input.

Method Summary

Modifier and Type	Method	Description
static KernelFunctionArguments.Builder	builder()	Create a new instance of Builder.
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
KernelFunctionArguments	copy()	Create a copy of the current instance
Set<Map.Entry<String,ContextVariable<?>>>	entrySet()
ContextVariable<?>	get(Object key)
ContextVariable<?>	get(String key)	Return the variable with the given name
ContextVariable<?>	getInput()	Get the input (entry in the MAIN_KEY slot)
boolean	isEmpty()
boolean	isNullOrEmpty(String key)	Return whether the variable with the given name is null or empty.
Set<String>	keySet()
String	prettyPrint()	Create formatted string of the variables
ContextVariable<?>	put(String key, ContextVariable<?> value)
void	putAll(Map<? extends String,? extends ContextVariable<?>> m)
ContextVariable<?>	remove(Object key)
int	size()
Collection<ContextVariable<?>>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

MAIN_KEY

public static final String MAIN_KEY

Default key for the main input.

See Also:

Constant Field Values

Method Detail

builder

public static KernelFunctionArguments.Builder builder()

Create a new instance of Builder.

Returns:

Builder

getInput

@Nullable
public ContextVariable<?> getInput()

Get the input (entry in the MAIN_KEY slot)

Returns:

input

prettyPrint

public String prettyPrint()

Create formatted string of the variables

Returns:

formatted string

get

@Nullable
public ContextVariable<?> get(String key)

Return the variable with the given name

Parameters:

key - variable name

Returns:

content of the variable

isNullOrEmpty

public boolean isNullOrEmpty(String key)

Return whether the variable with the given name is null or empty.

Parameters:

key - the key for the variable

Returns:

true if the variable is null or empty, false otherwise

size

public int size()

Specified by:

size in interface Map<String,ContextVariable<?>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,ContextVariable<?>>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,ContextVariable<?>>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,ContextVariable<?>>

get

@Nullable
public ContextVariable<?> get(Object key)

Specified by:

get in interface Map<String,ContextVariable<?>>

put

public ContextVariable<?> put(String key,
                              ContextVariable<?> value)

Specified by:

put in interface Map<String,ContextVariable<?>>

remove

public ContextVariable<?> remove(Object key)

Specified by:

remove in interface Map<String,ContextVariable<?>>

putAll

public void putAll(Map<? extends String,? extends ContextVariable<?>> m)

Specified by:

putAll in interface Map<String,ContextVariable<?>>

clear

public void clear()

Specified by:

clear in interface Map<String,ContextVariable<?>>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,ContextVariable<?>>

values

public Collection<ContextVariable<?>> values()

Specified by:

values in interface Map<String,ContextVariable<?>>

entrySet

public Set<Map.Entry<String,ContextVariable<?>>> entrySet()

Specified by:

entrySet in interface Map<String,ContextVariable<?>>

copy

public KernelFunctionArguments copy()

Create a copy of the current instance

Returns:

copy of the current instance