Uses of Class
com.microsoft.semantickernel.contextvariables.ContextVariable

Packages that use ContextVariable

Package	Description
com.microsoft.semantickernel.contextvariables
com.microsoft.semantickernel.orchestration
com.microsoft.semantickernel.semanticfunctions

Uses of ContextVariable in com.microsoft.semantickernel.contextvariables

Methods in com.microsoft.semantickernel.contextvariables that return ContextVariable

Modifier and Type	Method	Description
<T> ContextVariable<T>	ContextVariableTypes.contextVariableOf(T value)	Create a context variable of the given value.
static <T,U> ContextVariable<T>	ContextVariable.convert(U it, ContextVariableType<T> requestedResultType)	Converts the given value to the requested result type.
static <T,U> ContextVariable<T>	ContextVariable.convert(U it, Class<T> requestedResultType, ContextVariableTypes contextVariableTypes)	Converts the given value to the requested result type.
static ContextVariable<com.azure.ai.openai.models.CompletionsUsage>	ContextVariable.of(com.azure.ai.openai.models.CompletionsUsage x)	Convenience method for creating a ContextVariable from the given CompletionsUsage instance.
static ContextVariable<String>	ContextVariable.of(String value)	Convenience method for creating a ContextVariable from the given String instance.
static ContextVariable<OffsetDateTime>	ContextVariable.of(OffsetDateTime x)	Convenience method for creating a ContextVariable from the given OffsetDateTime instance.
static <T> ContextVariable<T>	ContextVariable.of(T value, ContextVariableTypeConverter<T> converter)	Creates a new instance of the ContextVariable class.
ContextVariable<T>	ContextVariableType.of(Object it)	Create a context variable of this type from the given object, converting it to type T if necessary.
static ContextVariable<Object>	ContextVariable.ofGlobalType(Object x)	Convenience method for creating a ContextVariable from the given object.
static ContextVariable<?>	ContextVariable.untypedOf(Object value, Class<?> clazz, ContextVariableTypes types)	Creates a new instance of the ContextVariable class without using strong typing.

Uses of ContextVariable in com.microsoft.semantickernel.orchestration

Methods in com.microsoft.semantickernel.orchestration that return ContextVariable

Modifier and Type	Method	Description
ContextVariable<T>	FunctionResult.getResultVariable()	Get the result of the function invocation.

Methods in com.microsoft.semantickernel.orchestration that return types with arguments of type ContextVariable

Modifier and Type	Method	Description
CaseInsensitiveMap<ContextVariable<?>>	FunctionResultMetadata.getMetadata()	Get the metadata about the result of the function invocation.

Constructors in com.microsoft.semantickernel.orchestration with parameters of type ContextVariable

Constructor	Description
FunctionResult(ContextVariable<T> result, FunctionResultMetadata metadata, Object unconvertedResult)	Create a new instance of FunctionResult.
FunctionResult(ContextVariable<T> of, Object unconvertedResult)	Create a new instance of FunctionResult with no metadata.

Constructor parameters in com.microsoft.semantickernel.orchestration with type arguments of type ContextVariable

Constructor	Description
FunctionResultMetadata(CaseInsensitiveMap<ContextVariable<?>> metadata)	Create a new instance of FunctionResultMetadata.

Uses of ContextVariable in com.microsoft.semantickernel.semanticfunctions

Methods in com.microsoft.semantickernel.semanticfunctions that return ContextVariable

Modifier and Type	Method	Description
ContextVariable<?>	KernelFunctionArguments.get(Object key)
ContextVariable<?>	KernelFunctionArguments.get(String key)	Return the variable with the given name
ContextVariable<?>	KernelFunctionArguments.getInput()	Get the input (entry in the MAIN_KEY slot)
ContextVariable<?>	KernelFunctionArguments.put(String key, ContextVariable<?> value)
ContextVariable<?>	KernelFunctionArguments.remove(Object key)

Methods in com.microsoft.semantickernel.semanticfunctions that return types with arguments of type ContextVariable

Modifier and Type	Method	Description
Set<Map.Entry<String,ContextVariable<?>>>	KernelFunctionArguments.entrySet()
Collection<ContextVariable<?>>	KernelFunctionArguments.values()

Methods in com.microsoft.semantickernel.semanticfunctions with parameters of type ContextVariable

Modifier and Type	Method	Description
ContextVariable<?>	KernelFunctionArguments.put(String key, ContextVariable<?> value)
<T> KernelFunctionArguments.Builder	KernelFunctionArguments.Builder.withInput(ContextVariable<T> content)	Builds an instance with the given content in the default main key
<T> KernelFunctionArguments.Builder	KernelFunctionArguments.Builder.withVariable(String key, ContextVariable<T> value)	Set variable

Method parameters in com.microsoft.semantickernel.semanticfunctions with type arguments of type ContextVariable

Modifier and Type	Method	Description
void	KernelFunctionArguments.putAll(Map<? extends String,? extends ContextVariable<?>> m)
KernelFunctionArguments.Builder	KernelFunctionArguments.Builder.withVariables(Map<String,ContextVariable<?>> map)	Builds an instance with the given variables