All Classes

Class	Description
AggregatorPromptTemplateFactory	An collection of PromptTemplateFactory instances.
AIException	AI logic exception
AIException.ErrorCodes	Error codes
AIService	Marker interface for AI services.
AIServiceCollection	A collection of AI services.
AIServiceSelection<T extends AIService>	The result of an AI service selection.
AIServiceSelector	Represents a selector which will return an AIServiceSelection containing instances of AIService and PromptExecutionSettings from the specified provider based on the model settings.
AudioContent	Represents audio content.
AudioContent.Builder	Represents a builder for audio content.
AudioToTextExecutionSettings	Represents audio content.
AudioToTextExecutionSettings.Builder	Represents a builder for audio to text execution settings.
AudioToTextService	Provides audio to text service.
AudioToTextService.Builder	Builder for the AudioToTextService.
AuthorRole	Role of the author of a chat message
BaseAIServiceSelector	Base class for AIServiceSelector implementations which provides a Map based collection from which an AIService can be selected.
BooleanVariableContextVariableTypeConverter	A ContextVariableTypeConverter for Boolean variables.
CaseInsensitiveMap<T>	A java.util.HashMap in which the keys are case-insensitive.
CharacterVariableContextVariableTypeConverter	A ContextVariableTypeConverter for java.lang.Character variables.
ChatCompletionService	Chat completion service interface.
ChatHistory	Provides a history of messages between the User, Assistant and System
ChatHistoryVariableContextVariableTypeConverter	A ContextVariableTypeConverter for com.microsoft.semantickernel.chathistory.ChatHistory variables.
ChatMessageContent<T>	Represents the content of a chat message
ChatMessageContentType	Represents the content of a chat message
ChatMessageImageContent<T>
ChatMessageImageContent.Builder<T>
ChatMessageImageContent.ImageDetail	The detail level of the image to include in the chat message.
ChatMessageTextContent	Represents the content of a chat message which contains text
ChatMessageTextContent.Builder
CollectionVariableContextVariableTypeConverter	A ContextVariableTypeConverter for java.util.Collection variables.
CompletionUsageContextVariableTypeConverter	A ContextVariableTypeConverter for com.azure.ai.openai.models.CompletionsUsage variables.
ConfigurationException	An exception that is thrown when there is an error with the Semantic Kernel configuration.
ConfigurationException.ErrorCodes	ErrorCodes for this exception.
ContextVariable<T>	A context variable wraps an arbitrary value and a ContextVariableType.
ContextVariableJacksonConverter	A utility class for creating ContextVariableTypeConverter instances that use Jackson for serialization and deserialization.
ContextVariableType<T>	A type of context variable, with a converter to convert objects to the type.
ContextVariableTypeConverter<T>	A converter for a context variable type.
ContextVariableTypeConverter.Builder<T>	A builder for a context variable type converter.
ContextVariableTypeConverter.Converter<T,U>	A converter from one type to another.
ContextVariableTypeConverter.DefaultConverter<T,U>	A base class for concrete implementations of ContextVariableTypeConverter.Converter.
ContextVariableTypeConverter.NoopConverter<T>	A converter that does no conversion.
ContextVariableTypeConverter.ToPromptStringFunction<T>
ContextVariableTypes	A collection of context variable types, with converters to convert objects to the types.
DateTimeContextVariableTypeConverter	A ContextVariableTypeConverter for java.time.OffsetDateTime variables.
DefineKernelFunction	Annotation that defines a method that can be invoked as a native function
Embedding	Represents a strongly typed vector of numeric data.
EmbeddingGenerationService<TValue>	Interface for text embedding generation services
FunctionInvocation<T>	FunctionInvocation supports fluent invocation of a function in the kernel.
FunctionInvokedEvent<T>	Represents a KernelHookEvent that is raised after a function is invoked.
FunctionInvokingEvent<T>	Represents a KernelHookEvent that is raised before a function is invoked.
FunctionResult<T>	The result of a function invocation.
FunctionResultMetadata<UsageType>	Metadata about the result of a function invocation.
HandlebarsPromptTemplate	A prompt template that uses the Handlebars template engine to render prompts.
HandlebarsPromptTemplateFactory	A factory for creating a HandlebarsPromptTemplate instance for a PromptTemplateConfig that uses the handlebars template format.
InputConfig	Input configuration (list of all input parameters for a semantic function).
InputParameter	Input parameter for semantic functions
InputVariable	Metadata for an input variable of a KernelFunction.
InstantContextVariableTypeConverter	A ContextVariableTypeConverter for java.time.Instant variables.
InvocationContext	Context passed to a Kernel or KernelFunction invoke.
InvocationContext.Builder	Builder for InvocationContext.
InvocationReturnMode
Kernel	Provides state for use throughout a Semantic Kernel workload.
Kernel.Builder	A fluent builder for creating a new instance of Kernel.
KernelContent<T>	Base class which represents the content returned by an AI service.
KernelFunction<T>	Semantic Kernel callable function interface.
KernelFunction.FromPromptBuilder<T>	Builder for creating a KernelFunction from a prompt.
KernelFunctionArguments	Arguments to a kernel function.
KernelFunctionArguments.Builder	Builder for ContextVariables
KernelFunctionFromMethod<T>	A KernelFunction that is created from a method.
KernelFunctionFromMethod.Builder<T>	A builder for KernelFunction.
KernelFunctionFromMethod.ImplementationFunc<T>	Concrete implementation of the abstract method in KernelFunction.
KernelFunctionFromPrompt<T>	A KernelFunction implementation that is created from a prompt template.
KernelFunctionFromPrompt.Builder<T>	A builder for creating a KernelFunction from a prompt template.
KernelFunctionMetadata<T>	Metadata about a kernel function.
KernelFunctionParameter	Annotates a parameter to a native function
KernelFunctionYaml	A class for creating a KernelFunction instance from a YAML representation of a prompt function.
KernelHook<T extends KernelHookEvent>	Represents a hook that can be used to intercept and modify arguments to KernelFunctions.
KernelHook.FunctionInvokedHook	A hook that accepts FunctionInvokedEvent
KernelHook.FunctionInvokingHook	A hook that accepts FunctionInvokingEvent
KernelHook.PostChatCompletionHook	A hook that accepts PostChatCompletionEvent
KernelHook.PreChatCompletionHook	A hook that accepts PreChatCompletionEvent
KernelHook.PreToolCallHook	A hook that accepts PreToolCallEvent
KernelHook.PromptRenderedHook	A hook that accepts PromptRenderedEvent
KernelHook.PromptRenderingHook	A hook that accepts PromptRenderingEvent
KernelHookEvent	A marker interface for events that can be intercepted by a KernelHook.
KernelHooks	Represents a collection of hooks that can be used to intercept and modify events in the kernel.
KernelHooks.UnmodifiableKernelHooks	A wrapper for KernelHooks that disables mutating methods.
KernelPlugin	A plugin contains a collection of functions that can be invoked by the Semantic Kernel.
KernelPluginFactory	Factory for creating KernelPlugin instances.
KernelPromptTemplateFactory	Factory for creating prompt templates.
MethodDetails	Metadata for a method that can be used as a kernel function.
NamedServiceProvider<T>	A service provider for named services.
NumberVariableContextVariableTypeConverter<T extends Number>	A ContextVariableTypeConverter for java.lang.Number type variables.
OpenAiServiceBuilder<C,T extends AIService,U extends OpenAiServiceBuilder<C,T,U>>	Builder for an OpenAI service.
OrderedAIServiceSelector	Implementation of AIServiceSelector that selects the AI service based on the order of the execution settings.
OutputVariable<T>	Metadata for an output variable of a kernel function.
PostChatCompletionEvent	Represents a KernelHookEvent that is raised after a chat completion is invoked.
PreChatCompletionEvent	Represents a KernelHookEvent that is raised before a chat completion is invoked.
PreToolCallEvent	Represents a KernelHookEvent that is raised before a tool call is invoked.
PrimitiveBooleanVariableContextVariableTypeConverter	A ContextVariableTypeConverter for Boolean variables.
PrimitiveVariableContextVariableTypeConverter<T>	A ContextVariableTypeConverter for primitive variables.
PromptExecutionSettings	Configuration settings for prompt execution.
PromptExecutionSettings.Builder	Builder for PromptExecutionSettings.
PromptRenderedEvent	Represents a KernelHookEvent that is raised after a prompt is rendered.
PromptRenderingEvent	Represents a KernelHookEvent that is raised after a prompt is rendered.
PromptTemplate	Represents a prompt template that can be rendered to a string.
PromptTemplateConfig	Metadata for a prompt template.
PromptTemplateConfig.Builder	Builder for a prompt template config.
PromptTemplateFactory	The interface that a PromptTemplateFactory implementation must provide.
PromptTemplateFactory.UnknownTemplateFormatException	Exception thrown when the template format is not supported.
PromptTemplateOption
ResponseFormat
SemanticKernelBuilder<T>	Interface for all builders.
ServiceNotFoundException	Exception thrown when a service is not found.
SKCheckedException	Provides the base exception from which all CHECKED Semantic Kernel exceptions derive.
SKException	Provides the base exception from which all Semantic Kernel exceptions derive.
SKSample	Annotation that decorates an DefineKernelFunction annotation to provide examples of how to use the function.
StreamingKernelContent<T>	Base class which represents the content returned by a streaming AI service.
StreamingTextContent	StreamingTextContent is a wrapper for TextContent that allows for streaming.
StringVariableContextVariableTypeConverter	A ContextVariableTypeConverter for java.lang.String variables.
TemplateException	Exception thrown when a template error occurs.
TemplateException.ErrorCodes	Error codes for TemplateException.
TextAIService	Marker interface for Text AI services, typically Chat or Text generation for OpenAI
TextChunker	Split text in chunks, attempting to leave meaning intact.
TextContent	Content from a text completion service.
TextContentVariableContextVariableTypeConverter	A converter for a context variable type.
TextEmbeddingGenerationService	Interface for text embedding generation services
TextGenerationService	Interface for text completion services
TextGenerationService.Builder	Builder for a TextGenerationService
TextToAudioExecutionSettings	Represents the settings for text to audio execution.
TextToAudioExecutionSettings.Builder	Represents a builder for text to audio execution settings.
TextToAudioService	Provides audio to text service.
TextToAudioService.Builder	Builder for the TextToAudioService.
ToolCallBehavior	Defines the behavior of a tool call.
ToolCallBehavior.AllowedKernelFunctions	A set of allowed kernel functions.
ToolCallBehavior.RequiredKernelFunction	A required kernel function.
VoidVariableContextVariableTypeConverter	A ContextVariableTypeConverter for java.lang.Void types.
WebSearchEngineConnector	Web search engine connector interface.
WebSearchEngineConnector.WebPage	Represents a web page.