Package com.microsoft.semantickernel.orchestration

Class InvocationContext

java.lang.Object

com.microsoft.semantickernel.orchestration.InvocationContext

public class InvocationContext
extends Object

Context passed to a Kernel or KernelFunction invoke. This class is primarily for internal use. The preferred way to supply a context is to use the discrete "with" methods in FunctionInvocation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InvocationContext.Builder	Builder for InvocationContext.

Method Summary

Modifier and Type	Method	Description
static InvocationContext.Builder	builder()	Create a new InvocationContext.Builder for building an instance of InvocationContext.
static InvocationContext.Builder	copy(InvocationContext context)	Create a new instance of InvocationContext by copying the values from another instance.
ContextVariableTypes	getContextVariableTypes()	Get the types of context variables.
KernelHooks.UnmodifiableKernelHooks	getKernelHooks()	Get the hooks to use for the invocation.
PromptExecutionSettings	getPromptExecutionSettings()	Get the settings for prompt execution.
ToolCallBehavior	getToolCallBehavior()	Get the behavior for tool calls.
InvocationReturnMode	returnMode()	Get the return mode for the invocation.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static InvocationContext.Builder builder()

Create a new InvocationContext.Builder for building an instance of InvocationContext.

Returns:

the new Builder.

copy

public static InvocationContext.Builder copy(InvocationContext context)

Create a new instance of InvocationContext by copying the values from another instance.

Parameters:

context - The context to copy.

Returns:

The new instance of InvocationContext.

getKernelHooks

@Nullable
public KernelHooks.UnmodifiableKernelHooks getKernelHooks()

Get the hooks to use for the invocation.

Returns:

The hooks to use for the invocation.

getPromptExecutionSettings

@Nullable
public PromptExecutionSettings getPromptExecutionSettings()

Get the settings for prompt execution.

Returns:

The settings for prompt execution.

getToolCallBehavior

@Nullable
public ToolCallBehavior getToolCallBehavior()

Get the behavior for tool calls.

Returns:

The behavior for tool calls.

getContextVariableTypes

public ContextVariableTypes getContextVariableTypes()

Get the types of context variables.

Returns:

The types of context variables.

returnMode

public InvocationReturnMode returnMode()

Get the return mode for the invocation.

Returns:

this InvocationContext.Builder