A B C D E F G H I K M N O P R S T U V W
All Classes All Packages

A

ACCESS_DENIED - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Access denied.

addAll(ChatHistory) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Add all messages from the given chat history to this chat history

addAssistantMessage(String) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Add an assistant message to the chat history

addFunction(KernelFunction<?>) - Method in class com.microsoft.semantickernel.plugin.KernelPlugin

Adds a function to the plugin.

addFunctionInvokedHook(Function<FunctionInvokedEvent<?>, FunctionInvokedEvent<?>>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Add a KernelHook.FunctionInvokedHook to the collection of hooks.

addFunctionInvokedHook(Function<FunctionInvokedEvent<?>, FunctionInvokedEvent<?>>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks.UnmodifiableKernelHooks

addFunctionInvokingHook(Function<FunctionInvokingEvent<?>, FunctionInvokingEvent<?>>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Add a KernelHook.FunctionInvokingHook to the collection of hooks.

addFunctionInvokingHook(Function<FunctionInvokingEvent<?>, FunctionInvokingEvent<?>>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks.UnmodifiableKernelHooks

addGlobalConverter(ContextVariableTypeConverter<?>) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypes

Add a converter to the global collection of context variable type converters.

addHook(KernelHook<?>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Add a KernelHook to the collection of hooks.

addHook(KernelHook<?>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks.UnmodifiableKernelHooks

addHook(String, KernelHook<?>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Add a KernelHook to the collection of hooks.

addHook(String, KernelHook<?>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks.UnmodifiableKernelHooks

addHooks(KernelHooks) - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Appends the given hooks to this collection.

addHooks(KernelHooks) - Method in class com.microsoft.semantickernel.hooks.KernelHooks.UnmodifiableKernelHooks

addInputVariable(InputVariable) - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig.Builder

Add an input variable to the prompt template config.

addKernelHook(KernelHook<?>) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation

Add a kernel hook to the function invocation.

addKernelHooks(KernelHooks) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation

Add kernel hooks to the function invocation.

addMessage(AuthorRole, String) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Add a message to the chat history

addMessage(AuthorRole, String, Charset, FunctionResultMetadata) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Add a message to the chat history

addMessage(ChatMessageContent<?>) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Add a message to the chat history

addPreChatCompletionHook(Function<PreChatCompletionEvent, PreChatCompletionEvent>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Add a KernelHook.PreChatCompletionHook to the collection of hooks.

addPreChatCompletionHook(Function<PreChatCompletionEvent, PreChatCompletionEvent>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks.UnmodifiableKernelHooks

addPromptRenderedHook(Function<PromptRenderedEvent, PromptRenderedEvent>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Add a KernelHook.PromptRenderedHook to the collection of hooks.

addPromptRenderedHook(Function<PromptRenderedEvent, PromptRenderedEvent>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks.UnmodifiableKernelHooks

addPromptRenderingHook(Function<PromptRenderingEvent, PromptRenderingEvent>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Add a KernelHook.PromptRenderingHook to the collection of hooks.

addPromptRenderingHook(Function<PromptRenderingEvent, PromptRenderingEvent>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks.UnmodifiableKernelHooks

addSystemMessage(String) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Add an system message to the chat history

addUserMessage(String) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Add a user message to the chat history

AggregatorPromptTemplateFactory - Class in com.microsoft.semantickernel.semanticfunctions

An collection of PromptTemplateFactory instances.

AggregatorPromptTemplateFactory(List<PromptTemplateFactory>) - Constructor for class com.microsoft.semantickernel.semanticfunctions.AggregatorPromptTemplateFactory

Creates a new instance of AggregatorPromptTemplateFactory.

AIException - Exception in com.microsoft.semantickernel.exceptions

AI logic exception

AIException(AIException.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.exceptions.AIException

Initializes a new instance of the AIException class.

AIException(AIException.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.exceptions.AIException

Initializes a new instance of the AIException class.

AIException(AIException.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.exceptions.AIException

Initializes a new instance of the AIException class.

AIException.ErrorCodes - Enum in com.microsoft.semantickernel.exceptions

Error codes

AIService - Interface in com.microsoft.semantickernel.services

Marker interface for AI services.

AIServiceCollection - Class in com.microsoft.semantickernel.services

A collection of AI services.

AIServiceCollection() - Constructor for class com.microsoft.semantickernel.services.AIServiceCollection

AIServiceSelection<T extends AIService> - Class in com.microsoft.semantickernel.services

The result of an AI service selection.

AIServiceSelection(T, PromptExecutionSettings) - Constructor for class com.microsoft.semantickernel.services.AIServiceSelection

Creates a new AI service selection.

AIServiceSelector - Interface in com.microsoft.semantickernel.services

Represents a selector which will return an AIServiceSelection containing instances of AIService and PromptExecutionSettings from the specified provider based on the model settings.

allowAllKernelFunctions(boolean) - Static method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior

Allow all kernel functions.

AllowedKernelFunctions(boolean, boolean, List<KernelFunction<?>>) - Constructor for class com.microsoft.semantickernel.orchestration.ToolCallBehavior.AllowedKernelFunctions

Create a new instance of AllowedKernelFunctions.

allowOnlyKernelFunctions(boolean, KernelFunction<?>...) - Static method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior

Allow a set of kernel functions.

allowOnlyKernelFunctions(boolean, List<KernelFunction<?>>) - Static method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior

Allow a set of kernel functions.

ASSISTANT - com.microsoft.semantickernel.services.chatcompletion.AuthorRole

An assistant message is a message generated by the assistant.

AuthorRole - Enum in com.microsoft.semantickernel.services.chatcompletion

Role of the author of a chat message

B

BaseAIServiceSelector - Class in com.microsoft.semantickernel.services

Base class for AIServiceSelector implementations which provides a Map based collection from which an AIService can be selected.

BooleanVariableContextVariableTypeConverter - Class in com.microsoft.semantickernel.contextvariables.converters

A ContextVariableTypeConverter for Boolean variables.

BooleanVariableContextVariableTypeConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.BooleanVariableContextVariableTypeConverter

Initializes a new instance of the BooleanVariableContextVariableTypeConverter class.

build() - Method in interface com.microsoft.semantickernel.builders.SemanticKernelBuilder

Build the object.

build() - Method in class com.microsoft.semantickernel.Kernel.Builder

Builds a new instance of Kernel with the services and plugins provided.

build() - Method in class com.microsoft.semantickernel.orchestration.InvocationContext.Builder

build() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Build the PromptExecutionSettings.

build() - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Create a new KernelFunction instance from the builder.

build() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments.Builder

build() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.Builder

Builds a new instance of KernelFunction.

build() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

build() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig.Builder

Build the prompt template config.

build() - Method in class com.microsoft.semantickernel.services.textcompletion.TextGenerationService.Builder

build(PromptTemplateConfig) - Static method in interface com.microsoft.semantickernel.semanticfunctions.PromptTemplateFactory

Create a prompt template, if possible, from the given configuration.

build(String, CompletionsUsage, OffsetDateTime) - Static method in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata

Create a new instance of FunctionResultMetadata.

Buildable - Interface in com.microsoft.semantickernel.builders

A marker interface for all classes that are buildable.

builder() - Static method in class com.microsoft.semantickernel.Kernel

Get the fluent builder for creating a new instance of Kernel.

builder() - Static method in class com.microsoft.semantickernel.orchestration.InvocationContext

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

builder() - Static method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

Create a new builder for PromptExecutionSettings.

builder() - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

Create a new instance of Builder.

builder() - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod

A builder for KernelFunction.

builder() - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt

Creates a new instance of KernelFunctionFromPrompt.Builder.

builder() - Static method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Create a builder for a prompt template config.

builder() - Static method in interface com.microsoft.semantickernel.services.chatcompletion.ChatCompletionService

Get a builder for creating a ChatCompletionService.

builder() - Static method in interface com.microsoft.semantickernel.services.textcompletion.TextGenerationService

Get the builder for the TextGenerationService

Builder() - Constructor for class com.microsoft.semantickernel.Kernel.Builder

Builder() - Constructor for class com.microsoft.semantickernel.orchestration.InvocationContext.Builder

Builder() - Constructor for class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Builder() - Constructor for class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments.Builder

Create a new instance of Builder.

Builder() - Constructor for class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.Builder

Builder() - Constructor for class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

Builder() - Constructor for class com.microsoft.semantickernel.services.chatcompletion.ChatCompletionService.Builder

Builder() - Constructor for class com.microsoft.semantickernel.services.textcompletion.TextGenerationService.Builder

C

CaseInsensitiveMap<T> - Class in com.microsoft.semantickernel.contextvariables

A java.util.HashMap in which the keys are case-insensitive.

CaseInsensitiveMap() - Constructor for class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

Creates a new instance of the CaseInsensitiveMap class.

CaseInsensitiveMap(Map<String, T>) - Constructor for class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

Creates a new instance of the CaseInsensitiveMap class.

CharacterVariableContextVariableTypeConverter - Class in com.microsoft.semantickernel.contextvariables.converters

A ContextVariableTypeConverter for java.lang.Character variables.

CharacterVariableContextVariableTypeConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.CharacterVariableContextVariableTypeConverter

Initializes a new instance of the CharacterVariableContextVariableTypeConverter class.

ChatCompletionService - Interface in com.microsoft.semantickernel.services.chatcompletion

Chat completion service interface.

ChatCompletionService.Builder - Class in com.microsoft.semantickernel.services.chatcompletion

Builder API for creating a ChatCompletionService.

ChatHistory - Class in com.microsoft.semantickernel.services.chatcompletion

Provides a history of messages between the User, Assistant and System

ChatHistory() - Constructor for class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

The default constructor adds an "Assistant is a large language model." system message to the chat history

ChatHistory(String) - Constructor for class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Constructor that adds the given system instructions to the chat history.

ChatHistory(List<ChatMessageContent<?>>) - Constructor for class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Constructor that adds the given chat message contents to the chat history.

ChatHistoryVariableContextVariableTypeConverter - Class in com.microsoft.semantickernel.contextvariables.converters

A ContextVariableTypeConverter for com.microsoft.semantickernel.chathistory.ChatHistory variables.

ChatHistoryVariableContextVariableTypeConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.ChatHistoryVariableContextVariableTypeConverter

Initializes a new instance of the ChatHistoryVariableContextVariableTypeConverter class.

ChatMessageContent<T> - Class in com.microsoft.semantickernel.services.chatcompletion

Represents the content of a chat message

ChatMessageContent(AuthorRole, String) - Constructor for class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent

Creates a new instance of the ChatMessageContent class.

ChatMessageContent(AuthorRole, String, String, T, Charset, FunctionResultMetadata) - Constructor for class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent

Creates a new instance of the ChatMessageContent class.

ChatMessageContent(AuthorRole, List<KernelContent<T>>, String, T, Charset, FunctionResultMetadata) - Constructor for class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent

Creates a new instance of the ChatMessageContent class.

clear() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

cloneOptionsWithMessages(ChatCompletionsOptions, List<ChatRequestMessage>) - Static method in interface com.microsoft.semantickernel.hooks.KernelHook.PreChatCompletionHook

A convenience method to clone the options with the messages from the event.

CollectionVariableContextVariableTypeConverter - Class in com.microsoft.semantickernel.contextvariables.converters

A ContextVariableTypeConverter for java.util.Collection variables.

CollectionVariableContextVariableTypeConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.CollectionVariableContextVariableTypeConverter

Creates a new instance of the CollectionVariableContextVariableTypeConverter class.

com.microsoft.semantickernel - package com.microsoft.semantickernel

com.microsoft.semantickernel.builders - package com.microsoft.semantickernel.builders

com.microsoft.semantickernel.connectors - package com.microsoft.semantickernel.connectors

com.microsoft.semantickernel.contextvariables - package com.microsoft.semantickernel.contextvariables

com.microsoft.semantickernel.contextvariables.converters - package com.microsoft.semantickernel.contextvariables.converters

com.microsoft.semantickernel.exceptions - package com.microsoft.semantickernel.exceptions

com.microsoft.semantickernel.hooks - package com.microsoft.semantickernel.hooks

com.microsoft.semantickernel.orchestration - package com.microsoft.semantickernel.orchestration

com.microsoft.semantickernel.plugin - package com.microsoft.semantickernel.plugin

com.microsoft.semantickernel.semanticfunctions - package com.microsoft.semantickernel.semanticfunctions

com.microsoft.semantickernel.semanticfunctions.annotations - package com.microsoft.semantickernel.semanticfunctions.annotations

com.microsoft.semantickernel.services - package com.microsoft.semantickernel.services

com.microsoft.semantickernel.services.chatcompletion - package com.microsoft.semantickernel.services.chatcompletion

com.microsoft.semantickernel.services.textcompletion - package com.microsoft.semantickernel.services.textcompletion

com.microsoft.semantickernel.templateengine.handlebars - package com.microsoft.semantickernel.templateengine.handlebars

com.microsoft.semantickernel.templateengine.semantickernel - package com.microsoft.semantickernel.templateengine.semantickernel

com.microsoft.semantickernel.text - package com.microsoft.semantickernel.text

CompletionUsageContextVariableTypeConverter - Class in com.microsoft.semantickernel.contextvariables.converters

A ContextVariableTypeConverter for com.azure.ai.openai.models.CompletionsUsage variables.

CompletionUsageContextVariableTypeConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.CompletionUsageContextVariableTypeConverter

Creates a new instance of the CompletionUsageContextVariableTypeConverter class.

compute(String, BiFunction<? super String, ? super T, ? extends T>) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

computeIfAbsent(String, Function<? super String, ? extends T>) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

computeIfPresent(String, BiFunction<? super String, ? super T, ? extends T>) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

CONFIGURATION_NOT_FOUND - com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes

Could not find configuration file

ConfigurationException - Exception in com.microsoft.semantickernel.exceptions

An exception that is thrown when there is an error with the Semantic Kernel configuration.

ConfigurationException(ConfigurationException.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.exceptions.ConfigurationException

Creates a new instance of the ConfigurationException class.

ConfigurationException(ConfigurationException.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.exceptions.ConfigurationException

Creates a new instance of the ConfigurationException class.

ConfigurationException(ConfigurationException.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.exceptions.ConfigurationException

Creates a new instance of the ConfigurationException class.

ConfigurationException.ErrorCodes - Enum in com.microsoft.semantickernel.exceptions

ErrorCodes for this exception.

containsKey(Object) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

containsKey(Object) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

containsValue(Object) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

ContextVariable<T> - Class in com.microsoft.semantickernel.contextvariables

A context variable wraps an arbitrary value and a ContextVariableType.

ContextVariable(ContextVariableType<T>, T) - Constructor for class com.microsoft.semantickernel.contextvariables.ContextVariable

Creates a new instance of the ContextVariable class.

ContextVariableType<T> - Class in com.microsoft.semantickernel.contextvariables

A type of context variable, with a converter to convert objects to the type.

ContextVariableType(ContextVariableTypeConverter<T>, Class<T>) - Constructor for class com.microsoft.semantickernel.contextvariables.ContextVariableType

Create a new context variable type.

ContextVariableTypeConverter<T> - Class in com.microsoft.semantickernel.contextvariables

A converter for a context variable type.

ContextVariableTypeConverter(Class<T>, Function<Object, T>, Function<T, String>, Function<String, T>) - Constructor for class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter

Create a new context variable type converter.

ContextVariableTypeConverter(Class<T>, Function<Object, T>, Function<T, String>, Function<String, T>, List<ContextVariableTypeConverter.Converter<T, ?>>) - Constructor for class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter

Create a new context variable type converter.

ContextVariableTypeConverter.Converter<T,U> - Interface in com.microsoft.semantickernel.contextvariables

A converter from one type to another.

ContextVariableTypeConverter.DefaultConverter<T,U> - Class in com.microsoft.semantickernel.contextvariables

A base class for concrete implementations of ContextVariableTypeConverter.Converter.

ContextVariableTypeConverter.NoopConverter<T> - Class in com.microsoft.semantickernel.contextvariables

A converter that does no conversion.

ContextVariableTypes - Class in com.microsoft.semantickernel.contextvariables

A collection of context variable types, with converters to convert objects to the types.

ContextVariableTypes() - Constructor for class com.microsoft.semantickernel.contextvariables.ContextVariableTypes

Create a new collection of context variable types.

ContextVariableTypes(ContextVariableTypes) - Constructor for class com.microsoft.semantickernel.contextvariables.ContextVariableTypes

Create a new collection of context variable types.

ContextVariableTypes(List<ContextVariableTypeConverter<?>>) - Constructor for class com.microsoft.semantickernel.contextvariables.ContextVariableTypes

Create a new collection of context variable types.

convert(Object, Class<T>) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypes

Convert the given object to the given class, if possible.

convert(U, ContextVariableType<T>) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Converts the given value to the requested result type.

convert(U, Class<T>, ContextVariableTypes) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Converts the given value to the requested result type.

copy() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Create a builder for a prompt template config which is a clone of the current object.

COULD_NOT_READ_CONFIGURATION - com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes

Could not parse or load configuration file

create(Method, Object, String, String, String, List<KernelParameterMetadata<?>>, KernelReturnParameterMetadata<?>) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod

Creates a new instance of KernelFunctionFromMethod from a method.

CREATED_AT - Static variable in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata

The key for createdAt metadata.

createFromFunctions(String, String, List<KernelFunction<?>>) - Static method in class com.microsoft.semantickernel.plugin.KernelPluginFactory

Initializes the new plugin from the provided name, description, and function collection.

createFromFunctions(String, List<KernelFunction<?>>) - Static method in class com.microsoft.semantickernel.plugin.KernelPluginFactory

Creates a plugin from the provided name and function collection.

createFromMethod(Method, Object) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

Creates a KernelFunction instance for a method, specified via a Method instance

createFromObject(Object, String) - Static method in class com.microsoft.semantickernel.plugin.KernelPluginFactory

Creates a plugin that wraps the specified target object.

createFromPrompt(PromptTemplateConfig) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

Builder for creating a KernelFunction instance for a given PromptTemplateConfig.

createFromPrompt(String) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

Creates a KernelFunction instance based on a given prompt

CURRENT_SCHEMA - Static variable in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

The current prompt template config schema version.

D

DateTimeContextVariableTypeConverter - Class in com.microsoft.semantickernel.contextvariables.converters

A ContextVariableTypeConverter for java.time.OffsetDateTime variables.

DateTimeContextVariableTypeConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.DateTimeContextVariableTypeConverter

Creates a new instance of the DateTimeContextVariableTypeConverter class.

DEFAULT_BEST_OF - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

DEFAULT_CONFIG_NAME - Static variable in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

The default name for a prompt template config.

DEFAULT_FREQUENCY_PENALTY - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

DEFAULT_MAX_TOKENS - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

DEFAULT_PRESENCE_PENALTY - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

DEFAULT_RESULTS_PER_PROMPT - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

DEFAULT_SERVICE_ID - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

DEFAULT_TEMPERATURE - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

DEFAULT_TOP_P - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

defaultTemplateBuilder() - Static method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Create a builder for a prompt template config, where the constructed template will be considered the default to be used if no other config is selected.

defaultValue() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.KernelFunctionParameter

The default value of the parameter.

DefineKernelFunction - Annotation Type in com.microsoft.semantickernel.semanticfunctions.annotations

Annotation that defines a method that can be invoked as a native function

description() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.DefineKernelFunction

The description of what the function does.

description() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.KernelFunctionParameter

The description of the parameter.

E

empty() - Static method in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata

Create a new instance of FunctionResultMetadata with no metadata.

entrySet() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

executeHooks(T) - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Executes the hooks in this collection that accept the event.

F

forEach(Consumer<? super ChatMessageContent<?>>) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Perform the given action for each message in the chat history

formFullFunctionName(String, String) - Static method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior

Form the full function name.

from(Kernel) - Static method in class com.microsoft.semantickernel.Kernel

Creates a Builder that can create a copy of the Kernel.

fromObject(Object) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter

Convert the object to the type of the context variable using the fromObject function provided to the constructor.

fromObject(Object) - Method in class com.microsoft.semantickernel.contextvariables.converters.NumberVariableContextVariableTypeConverter

fromPromptString(String) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter

Convert the prompt string to the type using the fromPromptString function provided to the constructor.

fromPromptString(String) - Method in class com.microsoft.semantickernel.contextvariables.converters.NumberVariableContextVariableTypeConverter

fromPromptYaml(String) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionYaml

Create a KernelFunction instance for a prompt function using the specified markdown text.

fromPromptYaml(String, PromptTemplateFactory) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionYaml

Create a KernelFunction instance for a prompt function using the specified markdown text.

fromYaml(Path) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionYaml

Create a KernelFunction instance for a prompt function using the specified markdown text.

FUNCTION_NOT_FOUND - com.microsoft.semantickernel.templateengine.semantickernel.TemplateException.ErrorCodes

The template requires an unknown function.

FUNCTION_TYPE_NOT_SUPPORTED - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Function type not supported.

FunctionInvocation<T> - Class in com.microsoft.semantickernel.orchestration

FunctionInvocation supports fluent invocation of a function in the kernel.

FunctionInvocation(Kernel, KernelFunction<?>, ContextVariableType<T>) - Constructor for class com.microsoft.semantickernel.orchestration.FunctionInvocation

Create a new function invocation.

FunctionInvocation(Kernel, KernelFunction<T>) - Constructor for class com.microsoft.semantickernel.orchestration.FunctionInvocation

Create a new function invocation.

FunctionInvokedEvent<T> - Class in com.microsoft.semantickernel.hooks

Represents a KernelHookEvent that is raised after a function is invoked.

FunctionInvokedEvent(KernelFunction<T>, KernelFunctionArguments, FunctionResult<T>) - Constructor for class com.microsoft.semantickernel.hooks.FunctionInvokedEvent

Creates a new instance of the FunctionInvokedEvent class.

FunctionInvokingEvent<T> - Class in com.microsoft.semantickernel.hooks

Represents a KernelHookEvent that is raised before a function is invoked.

FunctionInvokingEvent(KernelFunction<T>, KernelFunctionArguments) - Constructor for class com.microsoft.semantickernel.hooks.FunctionInvokingEvent

Creates a new instance of the FunctionInvokingEvent class.

FunctionResult<T> - Class in com.microsoft.semantickernel.orchestration

The result of a function invocation.

FunctionResult(ContextVariable<T>) - Constructor for class com.microsoft.semantickernel.orchestration.FunctionResult

Create a new instance of FunctionResult with no metadata.

FunctionResult(ContextVariable<T>, FunctionResultMetadata) - Constructor for class com.microsoft.semantickernel.orchestration.FunctionResult

Create a new instance of FunctionResult.

FunctionResultMetadata - Class in com.microsoft.semantickernel.orchestration

Metadata about the result of a function invocation.

FunctionResultMetadata() - Constructor for class com.microsoft.semantickernel.orchestration.FunctionResultMetadata

Create a new instance of FunctionResultMetadata.

FunctionResultMetadata(CaseInsensitiveMap<ContextVariable<?>>) - Constructor for class com.microsoft.semantickernel.orchestration.FunctionResultMetadata

Create a new instance of FunctionResultMetadata.

G

get(Object) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

get(Object) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

get(String) - Method in class com.microsoft.semantickernel.plugin.KernelPlugin

Gets a function by name.

get(String) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

Return the variable with the given name

getArguments() - Method in class com.microsoft.semantickernel.hooks.FunctionInvokedEvent

Gets the arguments that were passed to the function.

getArguments() - Method in class com.microsoft.semantickernel.hooks.FunctionInvokingEvent

Gets the arguments that are being passed to the function.

getArguments() - Method in class com.microsoft.semantickernel.hooks.PromptRenderedEvent

Gets the arguments that were passed to the function.

getArguments() - Method in class com.microsoft.semantickernel.hooks.PromptRenderingEvent

Gets the arguments that were passed to the function.

getAuthorRole() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent

Gets the author role that generated the content

getBestOf() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

The log probability threshold for a result to be considered.

getChatMessageContentsAsync(ChatHistory, Kernel, InvocationContext) - Method in interface com.microsoft.semantickernel.services.chatcompletion.ChatCompletionService

Gets the chat message contents asynchronously using ChatHistory to support a turn-based conversation.

getChatMessageContentsAsync(String, Kernel, InvocationContext) - Method in interface com.microsoft.semantickernel.services.chatcompletion.ChatCompletionService

Gets the chat message contents asynchronously using a prompt.

getChoiceIndex() - Method in class com.microsoft.semantickernel.services.StreamingKernelContent

Gets the zero-based index of the choice in the streaming sequence.

getClazz() - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableType

Get the class of the type.

getContent() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent

Gets the content

getContent() - Method in class com.microsoft.semantickernel.services.KernelContent

Gets the content returned by the AI service.

getContent() - Method in class com.microsoft.semantickernel.services.textcompletion.StreamingTextContent

getContent() - Method in class com.microsoft.semantickernel.services.textcompletion.TextContent

getContextVariableTypes() - Method in class com.microsoft.semantickernel.orchestration.InvocationContext

Get the types of context variables.

getConverter() - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableType

Get the converter for this type.

getCreatedAt() - Method in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata

Get the time the result was created.

getDefaultValue() - Method in class com.microsoft.semantickernel.semanticfunctions.InputParameter

Default value when nothing is provided

getDefaultValue() - Method in class com.microsoft.semantickernel.semanticfunctions.InputVariable

Gets the default value of the input variable.

getDefaultValue() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelParameterMetadata

Gets the default value of the parameter.

getDescription() - Method in class com.microsoft.semantickernel.plugin.KernelPlugin

Gets the description of the plugin.

getDescription() - Method in class com.microsoft.semantickernel.plugin.KernelReturnParameterMetadata

Gets the description of the return parameter.

getDescription() - Method in class com.microsoft.semantickernel.semanticfunctions.InputParameter

Parameter description for UI apps and planner.

getDescription() - Method in class com.microsoft.semantickernel.semanticfunctions.InputVariable

Gets the description of the input variable.

getDescription() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

getDescription() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata

Get the description of the function.

getDescription() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelParameterMetadata

Gets the description of the parameter.

getDescription() - Method in class com.microsoft.semantickernel.semanticfunctions.MethodDetails

Get the description of the method.

getDescription() - Method in class com.microsoft.semantickernel.semanticfunctions.OutputVariable

Get the description of the output variable.

getDescription() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Get the description of the prompt template config.

getEncoding() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent

Gets the encoding of the content

getErrorCode() - Method in exception com.microsoft.semantickernel.exceptions.AIException

Gets the error code.

getErrorCode() - Method in exception com.microsoft.semantickernel.exceptions.ConfigurationException

Gets the error code.

getErrorCode() - Method in exception com.microsoft.semantickernel.templateengine.semantickernel.TemplateException

Gets the error code for this exception.

getExecutionSettings() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

Get an unmodifiable map of the execution settings for the function.

getExecutionSettings() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Get the prompt execution settings of the prompt template config.

getFrequencyPenalty() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

Frequency penalty encourages the model to avoid repeating the same token in the output.

getFunction() - Method in class com.microsoft.semantickernel.hooks.FunctionInvokedEvent

Gets the function that was invoked.

getFunction() - Method in class com.microsoft.semantickernel.hooks.FunctionInvokingEvent

Gets the function that is being invoked.

getFunction() - Method in class com.microsoft.semantickernel.hooks.PromptRenderedEvent

Gets the function that was invoked.

getFunction() - Method in class com.microsoft.semantickernel.hooks.PromptRenderingEvent

Gets the function that was invoked.

getFunction() - Method in class com.microsoft.semantickernel.semanticfunctions.MethodDetails

Get the function that implements the method.

getFunction(String, String) - Method in class com.microsoft.semantickernel.Kernel

Gets the function with the specified name from the plugin with the specified name.

getFunctions() - Method in class com.microsoft.semantickernel.Kernel

Gets the functions available through the kernel.

getFunctions() - Method in class com.microsoft.semantickernel.plugin.KernelPlugin

Gets the functions in the plugin.

getGlobalKernelHooks() - Method in class com.microsoft.semantickernel.Kernel

Get the KernelHooks used throughout the kernel.

getGlobalVariableTypeForClass(Class<T>) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypes

Get the global context variable type for the given class.

getId() - Method in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata

Get the id of the result of the function invocation.

getInnerContent() - Method in class com.microsoft.semantickernel.services.KernelContent

Gets the inner content representation.

getInput() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

Get the input (entry in the MAIN_KEY slot)

getInputVariables() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Get the inputVariables of the prompt template config.

getItems() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent

Gets the KernelContent items that comprise the content.

getKernelHooks() - Method in class com.microsoft.semantickernel.orchestration.InvocationContext

Get the hooks to use for the invocation.

getKernelParametersMetadata() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Get the parameters metadata.

getKernelReturnParameterMetadata() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Get the return parameter metadata.

getLastMessage() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Get last message

getMaximumAutoInvokeAttempts() - Method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior

Get the maximum number of times that auto-invocation will be attempted.

getMaxTokens() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

The maximum number of tokens to generate in the output.

getMessage() - Method in enum com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Gets the error message.

getMessage() - Method in enum com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes

Gets the message for the error code.

getMessage() - Method in enum com.microsoft.semantickernel.templateengine.semantickernel.TemplateException.ErrorCodes

Gets the message for the error code.

getMessage(String) - Method in enum com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes

Format the message with the given parameter.

getMessages() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Get the chat history

getMetadata() - Method in class com.microsoft.semantickernel.orchestration.FunctionResult

Get the metadata about the result of the function invocation.

getMetadata() - Method in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata

Get the metadata about the result of the function invocation.

getMetadata() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

Get the metadata for the function.

getMetadata() - Method in class com.microsoft.semantickernel.services.KernelContent

Gets the metadata associated with the content.

getModelId() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

Get the id of the model to use for prompt execution.

getModelId() - Method in interface com.microsoft.semantickernel.services.AIService

Gets the model identifier.

getModelId() - Method in class com.microsoft.semantickernel.services.KernelContent

Gets the model identifier used to generate the content.

getName() - Method in interface com.microsoft.semantickernel.connectors.WebSearchEngineConnector.WebPage

Gets the name of the web page.

getName() - Method in class com.microsoft.semantickernel.plugin.KernelPlugin

Gets the name of the plugin.

getName() - Method in class com.microsoft.semantickernel.semanticfunctions.InputParameter

Name of the parameter to pass to the function.

getName() - Method in class com.microsoft.semantickernel.semanticfunctions.InputVariable

Gets the name of the input variable.

getName() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

getName() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata

Get the name of the function.

getName() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelParameterMetadata

Gets the name of the parameter.

getName() - Method in class com.microsoft.semantickernel.semanticfunctions.MethodDetails

Get the name of the method.

getName() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Get the name of the prompt template config.

getOptions() - Method in class com.microsoft.semantickernel.hooks.PreChatCompletionEvent

Gets the chat completion options.

getOrDefault(Object, T) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

getOutputVariable() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Get the output variable of the prompt template config.

getParameters() - Method in class com.microsoft.semantickernel.semanticfunctions.InputConfig

Gets the list of input parameters.

getParameters() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata

Get the parameters of the function.

getParameters() - Method in class com.microsoft.semantickernel.semanticfunctions.MethodDetails

Get the parameters of the method.

getParameterType() - Method in class com.microsoft.semantickernel.plugin.KernelReturnParameterMetadata

Gets the type of the return parameter.

getPlugin(String) - Method in class com.microsoft.semantickernel.Kernel

Gets the plugin with the specified name.

getPluginName() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

getPluginName() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata

Get the name of the plugin to which the function belongs

getPlugins() - Method in class com.microsoft.semantickernel.Kernel

Gets the plugins that were added to the kernel.

getPresencePenalty() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

Presence penalty encourages the model to use a more or less diverse range of tokens in the output.

getPriority() - Method in interface com.microsoft.semantickernel.hooks.KernelHook

The priority of the hook.

getPrompt() - Method in class com.microsoft.semantickernel.hooks.PromptRenderedEvent

Gets the prompt that was rendered.

getPromptExecutionSettings() - Method in class com.microsoft.semantickernel.orchestration.InvocationContext

Get the settings for prompt execution.

getRequiredFunction() - Method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior.RequiredKernelFunction

getResult() - Method in class com.microsoft.semantickernel.hooks.FunctionInvokedEvent

Gets the result of the function invocation.

getResult() - Method in class com.microsoft.semantickernel.orchestration.FunctionResult

Get the result of the function invocation.

getResultsPerPrompt() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

The number of results to generate for each prompt.

getResultVariable() - Method in class com.microsoft.semantickernel.orchestration.FunctionResult

Get the result of the function invocation.

getReturnParameter() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata

Get the return parameter of the function.

getReturnParameter() - Method in class com.microsoft.semantickernel.semanticfunctions.MethodDetails

Get the return parameter of the method.

getService() - Method in class com.microsoft.semantickernel.services.AIServiceSelection

Gets the selected AI service.

getService(Class<T>) - Method in class com.microsoft.semantickernel.Kernel

Get the service of the specified type from the kernel.

getService(Class<T>) - Method in class com.microsoft.semantickernel.services.OrderedAIServiceSelector

Gets the service of the specified type.

getService(String) - Method in class com.microsoft.semantickernel.services.OrderedAIServiceSelector

Gets the service with the specified service id.

getService(String, Class<U>) - Method in interface com.microsoft.semantickernel.services.NamedServiceProvider

Gets the service of the specified type and name, or null if not found.

getServiceId() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

Get the id of the AI service to use for prompt execution.

getServiceId() - Method in interface com.microsoft.semantickernel.services.AIService

Gets the service identifier.

getServiceSelector() - Method in class com.microsoft.semantickernel.Kernel

Get the AIServiceSelector used to query for services available through the kernel.

getSettings() - Method in class com.microsoft.semantickernel.services.AIServiceSelection

Gets the settings associated with the selected service.

getSnippet() - Method in interface com.microsoft.semantickernel.connectors.WebSearchEngineConnector.WebPage

Gets the snippet of the web page.

getStopSequences() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

The stop sequences to use for prompt execution.

getStreamingTextContentsAsync(String, PromptExecutionSettings, Kernel) - Method in interface com.microsoft.semantickernel.services.textcompletion.TextGenerationService

Get streaming results for the prompt using the specified execution settings.

getTargetType() - Method in interface com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.Converter

Get the class of the target type.

getTargetType() - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.DefaultConverter

getTemperature() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

The temperature setting controls the randomness of the output.

getTemplate() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Get the template of the prompt template config.

getTemplateFormat() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Get the template format of the prompt template config.

getTextContentsAsync(String, PromptExecutionSettings, Kernel) - Method in interface com.microsoft.semantickernel.services.textcompletion.TextGenerationService

Creates a completion for the prompt and settings.

getTokenSelectionBiases() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

The token selection biases to use for prompt execution.

getToolCallBehavior() - Method in class com.microsoft.semantickernel.orchestration.InvocationContext

Get the behavior for tool calls.

getTopP() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

The topP setting controls how many different words or phrases are considered to predict the next token.

getType() - Method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Get the type of the context variable.

getType() - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter

Get the class of the type.

getType() - Method in class com.microsoft.semantickernel.semanticfunctions.InputVariable

Gets the type of the input variable.

getType() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelParameterMetadata

Gets the type of the parameter.

getType() - Method in class com.microsoft.semantickernel.semanticfunctions.OutputVariable

Get the type of the output variable.

getTypeClass() - Method in class com.microsoft.semantickernel.semanticfunctions.InputVariable

Gets the class of the type of the input variable.

getUrl() - Method in interface com.microsoft.semantickernel.connectors.WebSearchEngineConnector.WebPage

Gets the URL of the web page.

getUsage() - Method in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata

Get the usage of the result of the function invocation.

getUser() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

The user to associate with the prompt execution.

getValue() - Method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Get the value of the context variable.

getValue() - Method in class com.microsoft.semantickernel.services.textcompletion.TextContent

Gets the content.

getValue(Class<U>) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Get the value of the context variable.

getVariableTypeForClass(Class<T>) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypes

Get the context variable type for the given class.

getVariableTypeForSuperClass(Class<T>) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypes

Get the context variable type for the given class or for a type that is assignable from the given class.

H

HANDLEBARS_TEMPLATE_FORMAT - Static variable in class com.microsoft.semantickernel.semanticfunctions.HandlebarsPromptTemplateFactory

The handlebars template format.

HandlebarsPromptTemplate - Class in com.microsoft.semantickernel.templateengine.handlebars

A prompt template that uses the Handlebars template engine to render prompts.

HandlebarsPromptTemplate(PromptTemplateConfig) - Constructor for class com.microsoft.semantickernel.templateengine.handlebars.HandlebarsPromptTemplate

Initializes a new instance of the HandlebarsPromptTemplate class.

HandlebarsPromptTemplateFactory - Class in com.microsoft.semantickernel.semanticfunctions

A factory for creating a HandlebarsPromptTemplate instance for a PromptTemplateConfig that uses the handlebars template format.

HandlebarsPromptTemplateFactory() - Constructor for class com.microsoft.semantickernel.semanticfunctions.HandlebarsPromptTemplateFactory

I

ID - Static variable in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata

The key for id metadata.

importPluginFromDirectory(Path, String, PromptTemplateFactory) - Static method in class com.microsoft.semantickernel.plugin.KernelPluginFactory

Imports a plugin from a directory.

importPluginFromResourcesDirectory(String, String, String, PromptTemplateFactory, Class<?>) - Static method in class com.microsoft.semantickernel.plugin.KernelPluginFactory

Imports a plugin from a resource directory, which may be on the classpath or filesystem.

InputConfig - Class in com.microsoft.semantickernel.semanticfunctions

Input configuration (list of all input parameters for a semantic function).

InputConfig(List<InputParameter>) - Constructor for class com.microsoft.semantickernel.semanticfunctions.InputConfig

Creates a new instance of the InputConfig class.

InputParameter - Class in com.microsoft.semantickernel.semanticfunctions

Input parameter for semantic functions

InputParameter(String, String, String) - Constructor for class com.microsoft.semantickernel.semanticfunctions.InputParameter

Creates a new instance of the InputParameter class.

inputs() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.SKSample

An example of inputs to the function.

InputVariable - Class in com.microsoft.semantickernel.semanticfunctions

Metadata for an input variable of a KernelFunction.

InputVariable(String) - Constructor for class com.microsoft.semantickernel.semanticfunctions.InputVariable

Creates a new instance of InputVariable.

InputVariable(String, String, String, String, boolean) - Constructor for class com.microsoft.semantickernel.semanticfunctions.InputVariable

Creates a new instance of InputVariable.

InstantContextVariableTypeConverter - Class in com.microsoft.semantickernel.contextvariables.converters

A ContextVariableTypeConverter for java.time.Instant variables.

InstantContextVariableTypeConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.InstantContextVariableTypeConverter

Creates a new instance of the InstantContextVariableTypeConverter class.

INVALID_CONFIGURATION - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Invalid configuration.

INVALID_REQUEST - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Invalid request.

INVALID_RESPONSE_CONTENT - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Invalid response.

InvocationContext - Class in com.microsoft.semantickernel.orchestration

Context passed to a Kernel or KernelFunction invoke.

InvocationContext.Builder - Class in com.microsoft.semantickernel.orchestration

Builder for InvocationContext.

invoke(Kernel) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

Invokes this KernelFunction.

invoke(Kernel, KernelFunction<T>, KernelFunctionArguments, ContextVariableType<T>, InvocationContext) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.ImplementationFunc

Invokes the function.

invoke(Kernel, KernelFunctionArguments, ContextVariableType<T>, InvocationContext) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

Invokes this KernelFunction.

invoke(KernelFunction<T>) - Method in class com.microsoft.semantickernel.Kernel

Invokes a KernelFunction.

invoke(String, String) - Method in class com.microsoft.semantickernel.Kernel

Invokes a KernelFunction function by name.

invokeAsync(Kernel) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

Invokes this KernelFunction.

invokeAsync(Kernel, KernelFunction<T>, KernelFunctionArguments, ContextVariableType<T>, InvocationContext) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.ImplementationFunc

Invokes the function.

invokeAsync(Kernel, KernelFunctionArguments, ContextVariableType<T>, InvocationContext) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

Invokes this KernelFunction.

invokeAsync(Kernel, KernelFunctionArguments, ContextVariableType<T>, InvocationContext) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod

Concrete implementation of the abstract method in KernelFunction.

invokeAsync(Kernel, KernelFunctionArguments, ContextVariableType<T>, InvocationContext) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt

invokeAsync(KernelFunction<T>) - Method in class com.microsoft.semantickernel.Kernel

Invokes a KernelFunction.

invokeAsync(String, String) - Method in class com.microsoft.semantickernel.Kernel

Invokes a KernelFunction function by name.

isAllKernelFunctionsAllowed() - Method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior.AllowedKernelFunctions

Check whether all kernel functions are allowed.

isAutoInvokeAllowed() - Method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior

Check whether auto-invocation is enabled.

isEmpty() - Method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Returns true if the value of this ContextVariable is null or empty.

isEmpty() - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Determines if this collection of hooks is empty.

isEmpty() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

isFunctionAllowed(KernelFunction<?>) - Method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior.AllowedKernelFunctions

Check whether the given function is allowed.

isFunctionAllowed(String, String) - Method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior.AllowedKernelFunctions

Check whether the given function is allowed.

isNullOrEmpty(String) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

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

isRequired() - Method in class com.microsoft.semantickernel.semanticfunctions.InputVariable

Gets whether the input variable is required.

isRequired() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelParameterMetadata

Gets whether the parameter is required.

iterator() - Method in class com.microsoft.semantickernel.plugin.KernelPlugin

Get an Iterator that iterates over the functions of this plugin.

iterator() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Create an Iterator from the chat history.

K

Kernel - Class in com.microsoft.semantickernel

Provides state for use throughout a Semantic Kernel workload.

Kernel(AIServiceCollection, Function<AIServiceCollection, AIServiceSelector>, List<KernelPlugin>, KernelHooks) - Constructor for class com.microsoft.semantickernel.Kernel

Initializes a new instance of Kernel.

Kernel.Builder - Class in com.microsoft.semantickernel

A fluent builder for creating a new instance of Kernel.

KernelContent<T> - Class in com.microsoft.semantickernel.services

Base class which represents the content returned by an AI service.

KernelContent(T, String, FunctionResultMetadata) - Constructor for class com.microsoft.semantickernel.services.KernelContent

Initializes a new instance of the KernelContent class.

KernelFunction<T> - Class in com.microsoft.semantickernel.semanticfunctions

Semantic Kernel callable function interface.

KernelFunction.FromPromptBuilder<T> - Interface in com.microsoft.semantickernel.semanticfunctions

Builder for creating a KernelFunction from a prompt.

KernelFunctionArguments - Class in com.microsoft.semantickernel.semanticfunctions

Arguments to a kernel function.

KernelFunctionArguments.Builder - Class in com.microsoft.semantickernel.semanticfunctions

Builder for ContextVariables

KernelFunctionFromMethod<T> - Class in com.microsoft.semantickernel.semanticfunctions

A KernelFunction that is created from a method.

KernelFunctionFromMethod.Builder<T> - Class in com.microsoft.semantickernel.semanticfunctions

A builder for KernelFunction.

KernelFunctionFromMethod.ImplementationFunc<T> - Interface in com.microsoft.semantickernel.semanticfunctions

Concrete implementation of the abstract method in KernelFunction.

KernelFunctionFromPrompt<T> - Class in com.microsoft.semantickernel.semanticfunctions

A KernelFunction implementation that is created from a prompt template.

KernelFunctionFromPrompt.Builder<T> - Class in com.microsoft.semantickernel.semanticfunctions

A builder for creating a KernelFunction from a prompt template.

KernelFunctionMetadata<T> - Class in com.microsoft.semantickernel.semanticfunctions

Metadata about a kernel function.

KernelFunctionMetadata(String, String, String, List<KernelParameterMetadata<?>>, KernelReturnParameterMetadata<T>) - Constructor for class com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata

Create a new instance of KernelFunctionMetadata.

KernelFunctionParameter - Annotation Type in com.microsoft.semantickernel.semanticfunctions.annotations

Annotates a parameter to a native function

KernelFunctionYaml - Class in com.microsoft.semantickernel.semanticfunctions

A class for creating a KernelFunction instance from a YAML representation of a prompt function.

KernelFunctionYaml() - Constructor for class com.microsoft.semantickernel.semanticfunctions.KernelFunctionYaml

KernelHook<T extends KernelHookEvent> - Interface in com.microsoft.semantickernel.hooks

Represents a hook that can be used to intercept and modify arguments to KernelFunctions.

KernelHook.FunctionInvokedHook - Interface in com.microsoft.semantickernel.hooks

A hook that accepts FunctionInvokedEvent

KernelHook.FunctionInvokingHook - Interface in com.microsoft.semantickernel.hooks

A hook that accepts FunctionInvokingEvent

KernelHook.PreChatCompletionHook - Interface in com.microsoft.semantickernel.hooks

A hook that accepts PreChatCompletionEvent

KernelHook.PromptRenderedHook - Interface in com.microsoft.semantickernel.hooks

A hook that accepts PromptRenderedEvent

KernelHook.PromptRenderingHook - Interface in com.microsoft.semantickernel.hooks

A hook that accepts PromptRenderingEvent

KernelHookEvent - Interface in com.microsoft.semantickernel.hooks

A marker interface for events that can be intercepted by a KernelHook.

KernelHooks - Class in com.microsoft.semantickernel.hooks

Represents a collection of hooks that can be used to intercept and modify events in the kernel.

KernelHooks() - Constructor for class com.microsoft.semantickernel.hooks.KernelHooks

Creates a new instance of the KernelHooks class.

KernelHooks(KernelHooks) - Constructor for class com.microsoft.semantickernel.hooks.KernelHooks

Creates a copy of the KernelHooks.

KernelHooks(Map<String, KernelHook<?>>) - Constructor for class com.microsoft.semantickernel.hooks.KernelHooks

Creates a new instance of the KernelHooks class from the given hooks.

KernelHooks.UnmodifiableKernelHooks - Class in com.microsoft.semantickernel.hooks

A wrapper for KernelHooks that disables mutating methods.

KernelParameterMetadata<T> - Class in com.microsoft.semantickernel.semanticfunctions

Metadata for a parameter to a kernel function.

KernelParameterMetadata(String, String, Class<T>, String, boolean) - Constructor for class com.microsoft.semantickernel.semanticfunctions.KernelParameterMetadata

Creates a new instance of the KernelParameterMetadata class.

KernelPlugin - Class in com.microsoft.semantickernel.plugin

A plugin contains a collection of functions that can be invoked by the Semantic Kernel.

KernelPlugin(String, String, Map<String, KernelFunction<?>>) - Constructor for class com.microsoft.semantickernel.plugin.KernelPlugin

Creates a new instance of the KernelPlugin class.

KernelPluginFactory - Class in com.microsoft.semantickernel.plugin

Factory for creating KernelPlugin instances.

KernelPluginFactory() - Constructor for class com.microsoft.semantickernel.plugin.KernelPluginFactory

KernelPromptTemplateFactory - Class in com.microsoft.semantickernel.semanticfunctions

Factory for creating prompt templates.

KernelPromptTemplateFactory() - Constructor for class com.microsoft.semantickernel.semanticfunctions.KernelPromptTemplateFactory

KernelReturnParameterMetadata<T> - Class in com.microsoft.semantickernel.plugin

Metadata for a return parameter of a KernelFunction.

KernelReturnParameterMetadata(String, Class<T>) - Constructor for class com.microsoft.semantickernel.plugin.KernelReturnParameterMetadata

Creates a new instance of KernelReturnParameterMetadata.

keySet() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

M

MAIN_KEY - Static variable in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

Default key for the main input.

MAX_RESULTS_PER_PROMPT - Static variable in interface com.microsoft.semantickernel.services.TextAIService

The maximum number of results per prompt

MAXIMUM_INFLIGHT_AUTO_INVOKES - Static variable in interface com.microsoft.semantickernel.services.TextAIService

The maximum number of auto-invokes that can be in-flight at any given time as part of the current asynchronous chain of execution.

merge(String, T, BiFunction<? super T, ? super T, ? extends T>) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

MethodDetails - Class in com.microsoft.semantickernel.semanticfunctions

Metadata for a method that can be used as a kernel function.

MethodDetails(String, String, KernelFunctionFromMethod.ImplementationFunc<?>, List<KernelParameterMetadata<?>>, KernelReturnParameterMetadata<?>) - Constructor for class com.microsoft.semantickernel.semanticfunctions.MethodDetails

Constructor.

MODEL_NOT_AVAILABLE - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Model not available.

N

name() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.DefineKernelFunction

The name of the function.

name() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.KernelFunctionParameter

The name of the parameter.

NamedServiceProvider<T> - Interface in com.microsoft.semantickernel.services

A service provider for named services.

NO_DEFAULT_VALUE - Static variable in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.KernelFunctionParameter

A special value that is used to indicate that no default value is provided.

NO_RESPONSE - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

No response.

NO_VALID_CONFIGURATIONS_FOUND - com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes

Could not find any valid configuration settings

NoopConverter(Class<T>) - Constructor for class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.NoopConverter

Create a new noop converter.

NumberVariableContextVariableTypeConverter<T extends Number> - Class in com.microsoft.semantickernel.contextvariables.converters

A ContextVariableTypeConverter for java.lang.Number type variables.

NumberVariableContextVariableTypeConverter(Class<T>, Function<String, T>, Function<Number, T>) - Constructor for class com.microsoft.semantickernel.contextvariables.converters.NumberVariableContextVariableTypeConverter

Creates a new instance of the NumberVariableContextVariableTypeConverter class.

O

of(CompletionsUsage) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Convenience method for creating a ContextVariable from the given CompletionsUsage instance.

of(Object) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableType

Create a context variable of this type from the given object, converting it to type T if necessary.

of(String) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Convenience method for creating a ContextVariable from the given String instance.

of(OffsetDateTime) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Convenience method for creating a ContextVariable from the given OffsetDateTime instance.

of(T, ContextVariableTypeConverter<T>) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Creates a new instance of the ContextVariable class.

ofGlobalType(Object) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Convenience method for creating a ContextVariable from the given object.

OrderedAIServiceSelector - Class in com.microsoft.semantickernel.services

Implementation of AIServiceSelector that selects the AI service based on the order of the execution settings.

OrderedAIServiceSelector() - Constructor for class com.microsoft.semantickernel.services.OrderedAIServiceSelector

Initializes a new instance of the OrderedAIServiceSelector class with an empty collection of services.

OrderedAIServiceSelector(AIServiceCollection) - Constructor for class com.microsoft.semantickernel.services.OrderedAIServiceSelector

Initializes a new instance of the OrderedAIServiceSelector class with the specified services.

output() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.SKSample

An example output of the function given the inputs.

OutputVariable - Class in com.microsoft.semantickernel.semanticfunctions

Metadata for an output variable of a kernel function.

OutputVariable(String, String) - Constructor for class com.microsoft.semantickernel.semanticfunctions.OutputVariable

Constructor.

P

parseFromJson(String) - Static method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Deserialize the JSON string to a PromptTemplateConfig.

PreChatCompletionEvent - Class in com.microsoft.semantickernel.hooks

Represents a KernelHookEvent that is raised before a chat completion is invoked.

PreChatCompletionEvent(ChatCompletionsOptions) - Constructor for class com.microsoft.semantickernel.hooks.PreChatCompletionEvent

Creates a new instance of the PreChatCompletionEvent class.

prettyPrint() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

Create formatted string of the variables

PromptExecutionSettings - Class in com.microsoft.semantickernel.orchestration

Configuration settings for prompt execution.

PromptExecutionSettings(String, String, Double, Double, Double, Double, Integer, Integer, Integer, String, List<String>, Map<Integer, Integer>) - Constructor for class com.microsoft.semantickernel.orchestration.PromptExecutionSettings

Create a new instance of PromptExecutionSettings.

PromptExecutionSettings.Builder - Class in com.microsoft.semantickernel.orchestration

Builder for PromptExecutionSettings.

PromptRenderedEvent - Class in com.microsoft.semantickernel.hooks

Represents a KernelHookEvent that is raised after a prompt is rendered.

PromptRenderedEvent(KernelFunction, KernelFunctionArguments, String) - Constructor for class com.microsoft.semantickernel.hooks.PromptRenderedEvent

Creates a new instance of the PromptRenderedEvent class.

PromptRenderingEvent - Class in com.microsoft.semantickernel.hooks

Represents a KernelHookEvent that is raised after a prompt is rendered.

PromptRenderingEvent(KernelFunction<?>, KernelFunctionArguments) - Constructor for class com.microsoft.semantickernel.hooks.PromptRenderingEvent

Creates a new instance of the PromptRenderingEvent class.

PromptTemplate - Interface in com.microsoft.semantickernel.semanticfunctions

Represents a prompt template that can be rendered to a string.

PromptTemplateConfig - Class in com.microsoft.semantickernel.semanticfunctions

Metadata for a prompt template.

PromptTemplateConfig(int, String, String, String, String, List<InputVariable>, OutputVariable, Map<String, PromptExecutionSettings>) - Constructor for class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Constructor for a prompt template config

PromptTemplateConfig(PromptTemplateConfig) - Constructor for class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

Copy constructor.

PromptTemplateConfig.Builder - Class in com.microsoft.semantickernel.semanticfunctions

Builder for a prompt template config.

PromptTemplateFactory - Interface in com.microsoft.semantickernel.semanticfunctions

The interface that a PromptTemplateFactory implementation must provide.

PromptTemplateFactory.UnknownTemplateFormatException - Exception in com.microsoft.semantickernel.semanticfunctions

Exception thrown when the template format is not supported.

put(String, ContextVariable<?>) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

put(String, T) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

putAll(Map<? extends String, ? extends ContextVariable<?>>) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

putAll(Map<? extends String, ? extends T>) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

putConverter(ContextVariableTypeConverter<T>) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypes

Add a converter to this ContextVariableTypes instance.

putConverters(ContextVariableTypes) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypes

Add all the converters from the given collection to this collection.

putIfAbsent(String, T) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

R

remove(Object) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

remove(Object) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

remove(Object, Object) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

removeHook(String) - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Remove a hook from the collection of hooks.

removeHook(String) - Method in class com.microsoft.semantickernel.hooks.KernelHooks.UnmodifiableKernelHooks

renderAsync(Kernel, KernelFunctionArguments, InvocationContext) - Method in interface com.microsoft.semantickernel.semanticfunctions.PromptTemplate

Renders the template using the supplied Kernel, KernelFunctionArguments, and InvocationContext.

renderAsync(Kernel, KernelFunctionArguments, InvocationContext) - Method in class com.microsoft.semantickernel.templateengine.handlebars.HandlebarsPromptTemplate

replace(String, T) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

replace(String, T, T) - Method in class com.microsoft.semantickernel.contextvariables.CaseInsensitiveMap

REQUEST_TIMEOUT - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Request timeout.

required() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.KernelFunctionParameter

Whether a value is required for this argument.

RequiredKernelFunction(KernelFunction<?>) - Constructor for class com.microsoft.semantickernel.orchestration.ToolCallBehavior.RequiredKernelFunction

Create a new instance of RequiredKernelFunction.

requireKernelFunction(KernelFunction<?>) - Static method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior

Require a function.

returnDescription() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.DefineKernelFunction

The description of the return value of the function.

returnType() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.DefineKernelFunction

The fully qualified class name of the return value of the function, for example, "java.lang.String".

RUNTIME_ERROR - com.microsoft.semantickernel.templateengine.semantickernel.TemplateException.ErrorCodes

The template execution failed, e.g.

S

samples() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.DefineKernelFunction

Examples of how to use the function.

searchAsync(String, int, int) - Method in interface com.microsoft.semantickernel.connectors.WebSearchEngineConnector

Execute a web search engine search.

SEMANTIC_KERNEL_TEMPLATE_FORMAT - Static variable in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig

The default template format for a prompt template config.

SemanticKernelBuilder<T extends Buildable> - Interface in com.microsoft.semantickernel.builders

Interface for all builders that create Buildable objects.

SERVICE_ERROR - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Service error.

ServiceNotFoundException - Exception in com.microsoft.semantickernel.services

Exception thrown when a service is not found.

ServiceNotFoundException(String) - Constructor for exception com.microsoft.semantickernel.services.ServiceNotFoundException

Initializes a new instance of the ServiceNotFoundException class.

size() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

SKCheckedException - Exception in com.microsoft.semantickernel.exceptions

Provides the base exception from which all CHECKED Semantic Kernel exceptions derive.

SKException - Exception in com.microsoft.semantickernel.exceptions

Provides the base exception from which all Semantic Kernel exceptions derive.

SKException(String) - Constructor for exception com.microsoft.semantickernel.exceptions.SKException

Initializes a new instance of the SKException class with its message set to message.

SKException(String, Throwable) - Constructor for exception com.microsoft.semantickernel.exceptions.SKException

Initializes a new instance of the SKException class with its message set to message.

SKSample - Annotation Type in com.microsoft.semantickernel.semanticfunctions.annotations

Annotation that decorates an DefineKernelFunction annotation to provide examples of how to use the function.

spliterator() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory

Create a Spliterator from the chat history

splitMarkDownLines(String, int) - Static method in class com.microsoft.semantickernel.text.TextChunker

Split markdown text into lines

splitMarkdownParagraphs(List<String>, int) - Static method in class com.microsoft.semantickernel.text.TextChunker

Split markdown text into paragraphs

splitPlainTextLines(String, int) - Static method in class com.microsoft.semantickernel.text.TextChunker

Split plain text into lines

splitPlainTextParagraphs(List<String>, int) - Static method in class com.microsoft.semantickernel.text.TextChunker

Split plain text into paragraphs

StreamingKernelContent<T> - Class in com.microsoft.semantickernel.services

Base class which represents the content returned by a streaming AI service.

StreamingTextContent - Class in com.microsoft.semantickernel.services.textcompletion

StreamingTextContent is a wrapper for TextContent that allows for streaming.

StreamingTextContent(TextContent) - Constructor for class com.microsoft.semantickernel.services.textcompletion.StreamingTextContent

Initializes a new instance of the StreamingTextContent class with a provided text content.

StringVariableContextVariableTypeConverter - Class in com.microsoft.semantickernel.contextvariables.converters

A ContextVariableTypeConverter for java.lang.String variables.

StringVariableContextVariableTypeConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.StringVariableContextVariableTypeConverter

Creates a new instance of the StringVariableContextVariableTypeConverter class.

subscribe(CoreSubscriber<? super FunctionResult<T>>) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation

This method hanldes the reactive stream when the KernelFunciton is invoked.

SYNTAX_ERROR - com.microsoft.semantickernel.templateengine.semantickernel.TemplateException.ErrorCodes

Syntax error, the template syntax used is not valid.

SYSTEM - com.microsoft.semantickernel.services.chatcompletion.AuthorRole

A system message helps set the behavior of the assistant.

T

TemplateException - Exception in com.microsoft.semantickernel.templateengine.semantickernel

Exception thrown when a template error occurs.

TemplateException(TemplateException.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.templateengine.semantickernel.TemplateException

Initializes a new instance of the TemplateException class with a provided error code.

TemplateException(TemplateException.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.templateengine.semantickernel.TemplateException

Initializes a new instance of the TemplateException class with a provided error code.

TemplateException(TemplateException.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.templateengine.semantickernel.TemplateException

Initializes a new instance of the TemplateException class with a provided error code.

TemplateException.ErrorCodes - Enum in com.microsoft.semantickernel.templateengine.semantickernel

Error codes for TemplateException.

test(KernelHookEvent) - Method in interface com.microsoft.semantickernel.hooks.KernelHook.FunctionInvokedHook

test(KernelHookEvent) - Method in interface com.microsoft.semantickernel.hooks.KernelHook.FunctionInvokingHook

test(KernelHookEvent) - Method in interface com.microsoft.semantickernel.hooks.KernelHook.PreChatCompletionHook

test(KernelHookEvent) - Method in interface com.microsoft.semantickernel.hooks.KernelHook.PromptRenderedHook

test(KernelHookEvent) - Method in interface com.microsoft.semantickernel.hooks.KernelHook.PromptRenderingHook

TextAIService - Interface in com.microsoft.semantickernel.services

Marker interface for Text AI services, typically Chat or Text generation for OpenAI

TextChunker - Class in com.microsoft.semantickernel.text

Split text in chunks, attempting to leave meaning intact.

TextChunker() - Constructor for class com.microsoft.semantickernel.text.TextChunker

TextContent - Class in com.microsoft.semantickernel.services.textcompletion

Content from a text completion service.

TextContent(String, String, FunctionResultMetadata) - Constructor for class com.microsoft.semantickernel.services.textcompletion.TextContent

Initializes a new instance of the TextContent class with a provided content, model ID, and metadata.

TextContentVariableContextVariableTypeConverter - Class in com.microsoft.semantickernel.contextvariables.converters

A converter for a context variable type.

TextContentVariableContextVariableTypeConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.TextContentVariableContextVariableTypeConverter

Initializes a new instance of the TextContentVariableContextVariableTypeConverter class.

TextGenerationService - Interface in com.microsoft.semantickernel.services.textcompletion

Interface for text completion services

TextGenerationService.Builder - Class in com.microsoft.semantickernel.services.textcompletion

Builder for a TextGenerationService

THROTTLING - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Throttling.

toBuilder() - Method in class com.microsoft.semantickernel.Kernel

Creates a Builder that can create a copy of the current instance of Kernel.

toEmbeddingString() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

Create a string for generating an embedding for a function.

toManualString(boolean) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunction

Create a manual-friendly string for a function.

toObject(Object, Class<U>) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter

Use this converter to convert the object to the type of the context variable.

toObject(Object, Class<U>) - Method in class com.microsoft.semantickernel.contextvariables.converters.NumberVariableContextVariableTypeConverter

toObject(T) - Method in interface com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.Converter

Convert the object to the target type.

TOOL - com.microsoft.semantickernel.services.chatcompletion.AuthorRole

A tool message is a message generated by a tool.

ToolCallBehavior - Class in com.microsoft.semantickernel.orchestration

Defines the behavior of a tool call.

ToolCallBehavior.AllowedKernelFunctions - Class in com.microsoft.semantickernel.orchestration

A set of allowed kernel functions.

ToolCallBehavior.RequiredKernelFunction - Class in com.microsoft.semantickernel.orchestration

A required kernel function.

toPromptString() - Method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Use the convert of the type of this ContextVariable to convert the value of this ContextVariable to a prompt string.

toPromptString(ContextVariableTypeConverter<T>) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Use the given ContextVariableTypeConverter to convert the value of this ContextVariable to a prompt string.

toPromptString(T) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter

Convert the type to a prompt string using the toPromptString function provided to the constructor.

toString() - Method in enum com.microsoft.semantickernel.services.chatcompletion.AuthorRole

toString() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent

tryCreate(PromptTemplateConfig) - Method in class com.microsoft.semantickernel.semanticfunctions.AggregatorPromptTemplateFactory

tryCreate(PromptTemplateConfig) - Method in class com.microsoft.semantickernel.semanticfunctions.HandlebarsPromptTemplateFactory

tryCreate(PromptTemplateConfig) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelPromptTemplateFactory

tryCreate(PromptTemplateConfig) - Method in interface com.microsoft.semantickernel.semanticfunctions.PromptTemplateFactory

Create a prompt template, if possible, from the given configuration.

trySelectAIService(Class<T>, KernelFunction<?>, KernelFunctionArguments) - Method in interface com.microsoft.semantickernel.services.AIServiceSelector

Resolves an AIService and associated and PromptExecutionSettings based on the associated KernelFunction and KernelFunctionArguments.

trySelectAIService(Class<T>, KernelFunction<?>, KernelFunctionArguments) - Method in class com.microsoft.semantickernel.services.BaseAIServiceSelector

trySelectAIService(Class<T>, KernelFunction<?>, KernelFunctionArguments, Map<Class<? extends AIService>, AIService>) - Method in class com.microsoft.semantickernel.services.OrderedAIServiceSelector

type() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.KernelFunctionParameter

The type of the parameter.

U

UNEXPECTED_BLOCK_TYPE - com.microsoft.semantickernel.templateengine.semantickernel.TemplateException.ErrorCodes

The block type produced be the tokenizer was not expected.

UNKNOWN_ERROR - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Unknown error.

UNKNOWN_ERROR - com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes

Unknown error

UNKNOWN_ERROR - com.microsoft.semantickernel.templateengine.semantickernel.TemplateException.ErrorCodes

Unknown error.

UnknownTemplateFormatException(String) - Constructor for exception com.microsoft.semantickernel.semanticfunctions.PromptTemplateFactory.UnknownTemplateFormatException

Constructor.

unmodifiableClone() - Method in class com.microsoft.semantickernel.hooks.KernelHooks

Creates an unmodifiable copy of this KernelHooks.

untypedOf(Object, Class<?>, ContextVariableTypes) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariable

Creates a new instance of the ContextVariable class without using strong typing.

USAGE - Static variable in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata

The key for usage metadata.

USER - com.microsoft.semantickernel.services.chatcompletion.AuthorRole

A user message is a message generated by the user.

V

VALUE_NOT_FOUND - com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes

Could not find value for configuration key

valueOf(String) - Static method in enum com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.microsoft.semantickernel.services.chatcompletion.AuthorRole

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.microsoft.semantickernel.templateengine.semantickernel.TemplateException.ErrorCodes

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.microsoft.semantickernel.exceptions.AIException.ErrorCodes

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

values() - Static method in enum com.microsoft.semantickernel.services.chatcompletion.AuthorRole

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.microsoft.semantickernel.templateengine.semantickernel.TemplateException.ErrorCodes

Returns an array containing the constants of this enum type, in the order they are declared.

VoidVariableContextVariableTypeConverter - Class in com.microsoft.semantickernel.contextvariables.converters

A ContextVariableTypeConverter for java.lang.Void types.

VoidVariableContextVariableTypeConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.VoidVariableContextVariableTypeConverter

Creates a new instance of the VoidVariableContextVariableTypeConverter class.

W

WebSearchEngineConnector - Interface in com.microsoft.semantickernel.connectors

Web search engine connector interface.

WebSearchEngineConnector.WebPage - Interface in com.microsoft.semantickernel.connectors

Represents a web page.

withAIService(Class<T>, T) - Method in class com.microsoft.semantickernel.Kernel.Builder

Adds a service to the kernel.

withArguments(KernelFunctionArguments) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation

Supply arguments to the function invocation.

withBestOf(int) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the best of setting for prompt execution.

withContextVariableConverter(ContextVariableTypeConverter<?>) - Method in class com.microsoft.semantickernel.orchestration.InvocationContext.Builder

Add a context variable type converter to the builder.

withDefaultExecutionSettings(PromptExecutionSettings) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the default execution settings for the function.

withDefaultExecutionSettings(PromptExecutionSettings) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withDescription(String) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the description of the function.

withDescription(String) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.Builder

Sets the description to use to build the function.

withDescription(String) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withDescription(String) - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig.Builder

Set the description of the prompt template config.

withExecutionSettings(Map<String, PromptExecutionSettings>) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the execution settings for the function.

withExecutionSettings(Map<String, PromptExecutionSettings>) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withExecutionSettings(Map<String, PromptExecutionSettings>) - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig.Builder

Set the prompt execution settings of the prompt template config.

withFrequencyPenalty(double) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the frequency penalty setting for prompt execution.

withFunctionName(String) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.Builder

Sets the function name to use to build the function.

withInput(ContextVariable<T>) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments.Builder

Builds an instance with the given content in the default main key

withInput(Object) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments.Builder

Builds an instance with the given content in the default main key

withInput(T, ContextVariableTypeConverter<T>) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments.Builder

Builds an instance with the given content in the default main key

withInputParameters(List<InputVariable>) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the input parameters for the function.

withInputParameters(List<InputVariable>) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withInputVariables(List<InputVariable>) - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig.Builder

Set the inputVariables of the prompt template config.

withInvocationContext(InvocationContext) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation

Use an invocation context variable to supply the types, tool call behavior, prompt execution settings, and kernel hooks to the function invocation.

withKernelHooks(KernelHooks) - Method in class com.microsoft.semantickernel.orchestration.InvocationContext.Builder

Add kernel hooks to the builder.

withMaxTokens(int) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the maximum number of tokens to generate in the output.

withMethod(Method) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.Builder

Sets the method to use to build the function.

withModelId(String) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the id of the model to use for prompt execution.

withModelId(String) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatCompletionService.Builder

Sets the model ID to use with the ChatCompletion service.

withModelId(String) - Method in class com.microsoft.semantickernel.services.textcompletion.TextGenerationService.Builder

Sets the model ID for the service

withName(String) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the name of the function.

withName(String) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withName(String) - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig.Builder

Set the name of the prompt template config.

withOpenAIAsyncClient(OpenAIAsyncClient) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatCompletionService.Builder

Sets the OpenAIClient to use for communication with the ChatCompletion service.

withOpenAIAsyncClient(OpenAIAsyncClient) - Method in class com.microsoft.semantickernel.services.textcompletion.TextGenerationService.Builder

Sets the OpenAI client for the service

withOutputVariable(OutputVariable) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the output variable for the function.

withOutputVariable(OutputVariable) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withOutputVariable(OutputVariable) - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig.Builder

Set the output variable of the prompt template config.

withOutputVariable(String, String) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the output variable for the function.

withOutputVariable(String, String) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withParameters(List<KernelParameterMetadata<?>>) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.Builder

Sets the parameters to use to build the function.

withPlugin(KernelPlugin) - Method in class com.microsoft.semantickernel.Kernel.Builder

Adds a plugin to the kernel.

withPluginName(String) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.Builder

Sets the plugin name to use to build the function.

withPresencePenalty(double) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the presence penalty setting for prompt execution.

withPromptExecutionSettings(PromptExecutionSettings) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation

Supply prompt execution settings to the function invocation.

withPromptExecutionSettings(PromptExecutionSettings) - Method in class com.microsoft.semantickernel.orchestration.InvocationContext.Builder

Add prompt execution settings to the builder.

withPromptTemplate(PromptTemplate) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the prompt template for the function.

withPromptTemplate(PromptTemplate) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withPromptTemplateConfig(PromptTemplateConfig) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the prompt template config used to build the function.

withPromptTemplateConfig(PromptTemplateConfig) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withPromptTemplateFactory(PromptTemplateFactory) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the prompt template factory used to build the function.

withPromptTemplateFactory(PromptTemplateFactory) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withResultsPerPrompt(int) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the number of results to generate for each prompt.

withResultType(ContextVariableType<U>) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation

Supply the result type of function invocation.

withReturnParameter(KernelReturnParameterMetadata<?>) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.Builder

Sets the return parameter to use to build the function.

withServiceId(String) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the id of the AI service to use for prompt execution.

withServiceId(String) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatCompletionService.Builder

Sets the service ID to use with the ChatCompletion service.

withServiceId(String) - Method in class com.microsoft.semantickernel.services.textcompletion.TextGenerationService.Builder

Sets the service ID for the service

withServiceSelector(Function<AIServiceCollection, AIServiceSelector>) - Method in class com.microsoft.semantickernel.Kernel.Builder

Sets the service selector provider for the kernel.

withStopSequences(List<String>) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the stop sequences to use for prompt execution.

withTarget(Object) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.Builder

Sets the target to use to build the function.

withTemperature(double) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the temperature setting for prompt execution.

withTemplate(String) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the template for the function.

withTemplate(String) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withTemplate(String) - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig.Builder

Set the template of the prompt template config.

withTemplateFormat(String) - Method in interface com.microsoft.semantickernel.semanticfunctions.KernelFunction.FromPromptBuilder

Set the template format for the function.

withTemplateFormat(String) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt.Builder

withTemplateFormat(String) - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig.Builder

Set the template format of the prompt template config.

withTokenSelectionBiases(Map<Integer, Integer>) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the token selection biases to use for prompt execution.

withToolCallBehavior(ToolCallBehavior) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation

Supply tool call behavior to the function invocation.

withToolCallBehavior(ToolCallBehavior) - Method in class com.microsoft.semantickernel.orchestration.InvocationContext.Builder

Add tool call behavior to the builder.

withTopP(double) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the topP setting for prompt execution.

withTypeConverter(ContextVariableTypeConverter<?>) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation

Supply a type converter to the function invocation.

withTypes(ContextVariableTypes) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation

Supply a context variable type to the function invocation.

withUser(String) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder

Set the user to associate with the prompt execution.

withVariable(String, ContextVariable<T>) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments.Builder

Set variable

withVariable(String, Object) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments.Builder

Set variable, uses the default type converters

withVariable(String, T, ContextVariableTypeConverter<T>) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments.Builder

Set variable

withVariables(Map<String, ContextVariable<?>>) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments.Builder

Builds an instance with the given variables

A B C D E F G H I K M N O P R S T U V W
All Classes All Packages