Index (Semantic Kernel API 1.4.2 API)

A B C D E F G H I J K L 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
addAll(List<ChatMessageContent<?>>) - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory: Add all messages to the 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
addPostChatCompletionHook(Function<PostChatCompletionEvent, PostChatCompletionEvent>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks: Add a PostChatCompletionEvent to the collection of hooks.
addPostChatCompletionHook(Function<PostChatCompletionEvent, PostChatCompletionEvent>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks.UnmodifiableKernelHooks
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
addPreToolCallHook(Function<PreToolCallEvent, PreToolCallEvent>) - Method in class com.microsoft.semantickernel.hooks.KernelHooks: Add a KernelHook.PreToolCallHook to the collection of hooks.
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
addPromptTemplateOption(PromptTemplateOption) - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig.Builder: Set the prompt template options.
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.
ALLOW_CONTEXT_VARIABLE_METHOD_CALLS_UNSAFE - com.microsoft.semantickernel.semanticfunctions.PromptTemplateOption: Allow methods on objects provided as arguments to an invocation, to be invoked when rendering a template and its return value used.
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.
anyTagEqualTo(String, Object) - Method in class com.microsoft.semantickernel.data.vectorsearch.VectorSearchFilter.Builder: Adds an AnyTagEqualToFilterClause to the filter.
AnyTagEqualToFilterClause - Class in com.microsoft.semantickernel.data.filter: A filter clause that filters on any tag equal to a value.
AnyTagEqualToFilterClause(String, Object) - Constructor for class com.microsoft.semantickernel.data.filter.AnyTagEqualToFilterClause: Creates a new instance of the AnyTagEqualToFilterClause class.
ASSISTANT - com.microsoft.semantickernel.services.chatcompletion.AuthorRole: An assistant message is a message generated by the assistant.
assistantMessage(String) - Static method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent: Create a message with the author role set to AuthorRole.ASSISTANT
AudioContent - Class in com.microsoft.semantickernel.services.audio: Represents audio content.
AudioContent(byte[], String) - Constructor for class com.microsoft.semantickernel.services.audio.AudioContent: Creates an instance of audio content.
AudioContent.Builder - Class in com.microsoft.semantickernel.services.audio: Represents a builder for audio content.
AudioToTextExecutionSettings - Class in com.microsoft.semantickernel.services.audio: Represents audio content.
AudioToTextExecutionSettings(String, String, String, String, String, Double) - Constructor for class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings: Creates an instance of audio to text execution settings.
AudioToTextExecutionSettings.Builder - Class in com.microsoft.semantickernel.services.audio: Represents a builder for audio to text execution settings.
AudioToTextService - Interface in com.microsoft.semantickernel.services.audio: Provides audio to text service.
AudioToTextService.Builder - Class in com.microsoft.semantickernel.services.audio: Builder for the AudioToTextService.
AuthorRole - Enum in com.microsoft.semantickernel.services.chatcompletion: Role of the author of a chat message
AUTO - com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.ImageDetail: Automatically determine the detail level

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.contextvariables.ContextVariableTypeConverter.Builder: Build the context variable type converter.
build() - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchFilter.Builder: Builds the filter.
build() - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions.Builder: Builds a new instance of the TextSearchOptions class.
build() - Method in class com.microsoft.semantickernel.data.vectorsearch.VectorSearchFilter.Builder: Builds the VectorSearchFilter.
build() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDataField.Builder: Builds a new instance of the VectorStoreRecordDataField class.
build() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField.Builder: Builds the field.
build() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordKeyField.Builder
build() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordVectorField.Builder: Builds a new instance of the VectorStoreRecordVectorField class.
build() - Method in class com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions.Builder: Builds the options.
build() - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions.Builder: Builds a new instance of the VectorSearchOptions class.
build() - Method in class com.microsoft.semantickernel.data.VectorStoreTextSearch.Builder: Builds the VectorStoreTextSearch instance.
build() - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollectionOptions.Builder: Builds the options.
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 class com.microsoft.semantickernel.orchestration.responseformat.JsonSchemaResponseFormat.Builder: Builds the JsonSchemaResponseFormat instance.
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.audio.AudioContent.Builder: Builds the audio content.
build() - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings.Builder: Builds the audio to text execution settings.
build() - Method in class com.microsoft.semantickernel.services.audio.TextToAudioExecutionSettings.Builder: Builds the settings.
build() - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.Builder
build() - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent.Builder
build() - Method in class com.microsoft.semantickernel.services.openai.OpenAiServiceBuilder: Builds the service.
build(PromptTemplateConfig) - Static method in interface com.microsoft.semantickernel.semanticfunctions.PromptTemplateFactory: Create a prompt template, if possible, from the given configuration.
build(String) - Static method in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata: Create a new instance of FunctionResultMetadata.
build(String, Class<?>, String, String, List<?>, boolean) - Static method in class com.microsoft.semantickernel.semanticfunctions.InputVariable: Creates a new instance of InputVariable.
build(String, Exception) - Static method in exception com.microsoft.semantickernel.exceptions.SKCheckedException: Forms a checked exception, if the exception is already an SK exception, it will be unwrapped and the cause extracted.
build(String, Exception) - Static method in exception com.microsoft.semantickernel.exceptions.SKException: Forms an unchecked exception, if the exception is already an SK exception, it will be unwrapped and the cause extracted.
build(String, UsageType, OffsetDateTime) - Static method in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata: Create a new instance of FunctionResultMetadata.
builder() - Static method in class com.microsoft.semantickernel.data.textsearch.TextSearchFilter: Creates a new instance of the TextSearchFilter.Builder class.
builder() - Static method in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions: Creates a new instance of the TextSearchOptions.Builder class.
builder() - Static method in class com.microsoft.semantickernel.data.vectorsearch.VectorSearchFilter: Creates a VectorSearchFilter.Builder for the VectorSearchFilter class.
builder() - Static method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDataField: Create a builder for the VectorStoreRecordDataField class.
builder() - Static method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordKeyField: Create a builder for the VectorStoreRecordKeyField class.
builder() - Static method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordVectorField: Create a builder for the VectorStoreRecordVectorField class.
builder() - Static method in class com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions: Creates a new builder.
builder() - Static method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions: Creates a new instance of the Builder class.
builder() - Static method in class com.microsoft.semantickernel.data.VectorStoreTextSearch: Create a new instance of VectorStoreTextSearch.Builder.
builder() - Static method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollectionOptions: Creates a new builder.
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.orchestration.responseformat.JsonSchemaResponseFormat: Creates a new instance of the JsonSchemaResponseFormat class.
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 class com.microsoft.semantickernel.services.audio.AudioContent: Creates a new builder.
builder() - Static method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings: Creates a new builder.
builder() - Static method in interface com.microsoft.semantickernel.services.audio.AudioToTextService: Builder for the AudioToTextService.
builder() - Static method in class com.microsoft.semantickernel.services.audio.TextToAudioExecutionSettings: Creates a new builder.
builder() - Static method in interface com.microsoft.semantickernel.services.audio.TextToAudioService: Gets the builder for the TextToAudioService.
builder() - Static method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent: Create a new builder for the ChatMessageImageContent class.
builder() - Static method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent: Create a new builder for the ChatMessageTextContent class.
builder() - Static method in interface com.microsoft.semantickernel.services.textcompletion.TextGenerationService: Get the builder for the TextGenerationService
builder(Class<T>) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter: Create a new builder for a context variable type converter.
builder(Class<T>) - Static method in class com.microsoft.semantickernel.contextvariables.converters.ContextVariableJacksonConverter: Creates a new ContextVariableTypeConverter.Builder for a ContextVariableTypeConverter that uses Jackson for serialization and deserialization.
builder(Class<T>) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromPrompt: Creates a new instance of KernelFunctionFromPrompt.Builder.
builder(Class<T>, ObjectMapper) - Static method in class com.microsoft.semantickernel.contextvariables.converters.ContextVariableJacksonConverter: Creates a new ContextVariableTypeConverter.Builder for a ContextVariableTypeConverter that uses Jackson for serialization and deserialization.
Builder() - Constructor for class com.microsoft.semantickernel.data.textsearch.TextSearchFilter.Builder
Builder() - Constructor for class com.microsoft.semantickernel.data.textsearch.TextSearchOptions.Builder
Builder() - Constructor for class com.microsoft.semantickernel.data.vectorsearch.VectorSearchFilter.Builder
Builder() - Constructor for class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDataField.Builder
Builder() - Constructor for class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField.Builder
Builder() - Constructor for class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordKeyField.Builder
Builder() - Constructor for class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordVectorField.Builder
Builder() - Constructor for class com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions.Builder
Builder() - Constructor for class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions.Builder
Builder() - Constructor for class com.microsoft.semantickernel.data.VectorStoreTextSearch.Builder
Builder() - Constructor for class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollectionOptions.Builder
Builder() - Constructor for class com.microsoft.semantickernel.Kernel.Builder: Construct a Builder for creating a new instance of Kernel.
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.orchestration.responseformat.JsonSchemaResponseFormat.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.audio.AudioContent.Builder
Builder() - Constructor for class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings.Builder
Builder() - Constructor for class com.microsoft.semantickernel.services.audio.AudioToTextService.Builder
Builder() - Constructor for class com.microsoft.semantickernel.services.audio.TextToAudioService.Builder
Builder() - Constructor for class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.Builder
Builder() - Constructor for class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent.Builder
Builder() - Constructor for class com.microsoft.semantickernel.services.textcompletion.TextGenerationService.Builder
Builder(Class<T>) - Constructor for class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.Builder: Create a new builder for a context variable type converter.

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.
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
ChatHistory(String) - Constructor for class com.microsoft.semantickernel.services.chatcompletion.ChatHistory: Constructor that adds the given system instructions to the chat history.
ChatHistory(List<? extends 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, String, String, T, Charset, FunctionResultMetadata, ChatMessageContentType) - 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, ChatMessageContentType) - Constructor for class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent: Creates a new instance of the ChatMessageContent class.
ChatMessageContentType - Enum in com.microsoft.semantickernel.services.chatcompletion.message: Represents the content of a chat message
ChatMessageImageContent<T> - Class in com.microsoft.semantickernel.services.chatcompletion.message: Represents an image content in a chat message.
ChatMessageImageContent(String, String, ChatMessageImageContent.ImageDetail) - Constructor for class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent: Create a new instance of the ChatMessageImageContent class.
ChatMessageImageContent.Builder<T> - Class in com.microsoft.semantickernel.services.chatcompletion.message: Builder for the ChatMessageImageContent class.
ChatMessageImageContent.ImageDetail - Enum in com.microsoft.semantickernel.services.chatcompletion.message: The detail level of the image to include in the chat message.
ChatMessageTextContent - Class in com.microsoft.semantickernel.services.chatcompletion.message: Represents the content of a chat message which contains text
ChatMessageTextContent(AuthorRole, String, String, Charset, FunctionResultMetadata) - Constructor for class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent: Creates a new instance of the ChatMessageTextContent class.
ChatMessageTextContent.Builder - Class in com.microsoft.semantickernel.services.chatcompletion.message: Builder for the ChatMessageTextContent 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.
collectionExistsAsync() - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollection: Checks if the collection exists in the store.
collectionExistsAsync() - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Checks if the collection exists in the store.
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.
CollectionVariableContextVariableTypeConverter(String) - 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.data - package com.microsoft.semantickernel.data
com.microsoft.semantickernel.data.filter - package com.microsoft.semantickernel.data.filter
com.microsoft.semantickernel.data.textsearch - package com.microsoft.semantickernel.data.textsearch
com.microsoft.semantickernel.data.vectorsearch - package com.microsoft.semantickernel.data.vectorsearch
com.microsoft.semantickernel.data.vectorstorage - package com.microsoft.semantickernel.data.vectorstorage
com.microsoft.semantickernel.data.vectorstorage.annotations - package com.microsoft.semantickernel.data.vectorstorage.annotations
com.microsoft.semantickernel.data.vectorstorage.definition - package com.microsoft.semantickernel.data.vectorstorage.definition
com.microsoft.semantickernel.data.vectorstorage.options - package com.microsoft.semantickernel.data.vectorstorage.options
com.microsoft.semantickernel.exceptions - package com.microsoft.semantickernel.exceptions
com.microsoft.semantickernel.hooks - package com.microsoft.semantickernel.hooks
com.microsoft.semantickernel.localization - package com.microsoft.semantickernel.localization
com.microsoft.semantickernel.orchestration - package com.microsoft.semantickernel.orchestration
com.microsoft.semantickernel.orchestration.responseformat - package com.microsoft.semantickernel.orchestration.responseformat
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.audio - package com.microsoft.semantickernel.services.audio
com.microsoft.semantickernel.services.chatcompletion - package com.microsoft.semantickernel.services.chatcompletion
com.microsoft.semantickernel.services.chatcompletion.message - package com.microsoft.semantickernel.services.chatcompletion.message
com.microsoft.semantickernel.services.openai - package com.microsoft.semantickernel.services.openai
com.microsoft.semantickernel.services.textcompletion - package com.microsoft.semantickernel.services.textcompletion
com.microsoft.semantickernel.services.textembedding - package com.microsoft.semantickernel.services.textembedding
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.
containsField(String) - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDefinition: Checks if the record definition contains a field with the specified name.
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.
ContextVariableJacksonConverter - Class in com.microsoft.semantickernel.contextvariables.converters: A utility class for creating ContextVariableTypeConverter instances that use Jackson for serialization and deserialization.
ContextVariableJacksonConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.ContextVariableJacksonConverter
contextVariableOf(T) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypes: Create a context variable of the given value.
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>, ContextVariableTypeConverter.ToPromptStringFunction<T>, Function<String, T>) - Constructor for class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter: Create a new context variable type converter.
ContextVariableTypeConverter(Class<T>, Function<Object, T>, ContextVariableTypeConverter.ToPromptStringFunction<T>, Function<String, T>, List<ContextVariableTypeConverter.Converter<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>) - 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.Builder<T> - Class in com.microsoft.semantickernel.contextvariables: A builder for a 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.
ContextVariableTypeConverter.ToPromptStringFunction<T> - Interface in com.microsoft.semantickernel.contextvariables: A function to convert ContextVariable to a prompt string.
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.
convertToString(Object) - Static method in class com.microsoft.semantickernel.contextvariables.converters.StringVariableContextVariableTypeConverter: Converts the specified object to a string.
copy() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments: Create a copy of the current instance
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.
copy(InvocationContext) - Static method in class com.microsoft.semantickernel.orchestration.InvocationContext: Create a new instance of InvocationContext by copying the values from another instance.
COSINE_DISTANCE - com.microsoft.semantickernel.data.vectorstorage.definition.DistanceFunction: Cosine distance function. 1 - cosine similarity.
COSINE_SIMILARITY - com.microsoft.semantickernel.data.vectorstorage.definition.DistanceFunction: Cosine (angular) similarity function.
cosineDistance(List<Float>, List<Float>) - Static method in class com.microsoft.semantickernel.data.vectorsearch.VectorOperations: Calculates the cosine distance of two vectors.
cosineSimilarity(List<Float>, List<Float>) - Static method in class com.microsoft.semantickernel.data.vectorsearch.VectorOperations: Calculates the cosine similarity of two vectors.
COULD_NOT_READ_CONFIGURATION - com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes: Could not parse or load configuration file
create(Class<T>) - Static method in class com.microsoft.semantickernel.contextvariables.converters.ContextVariableJacksonConverter: Creates a new ContextVariableTypeConverter that uses Jackson for serialization and deserialization.
create(Class<T>, ObjectMapper) - Static method in class com.microsoft.semantickernel.contextvariables.converters.ContextVariableJacksonConverter: Creates a new ContextVariableTypeConverter that uses Jackson for serialization and deserialization.
create(Method, Object, String, String, String, List<InputVariable>, OutputVariable<?>) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod: Creates a new instance of KernelFunctionFromMethod from a method.
createCollectionAsync() - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollection: Creates the collection in the store.
createCollectionAsync() - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Creates the collection in the store.
createCollectionIfNotExistsAsync() - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollection: Creates the collection in the store if it does not exist.
createCollectionIfNotExistsAsync() - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Creates the collection in the store if it does not exist.
CREATED_AT - Static variable in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata: The key for createdAt metadata.
createDefault() - Static method in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions: Creates a new instance of the TextSearchOptions class with default values.
createDefault() - Static method in class com.microsoft.semantickernel.data.vectorsearch.VectorSearchFilter: Creates a new instance of the VectorSearchFilter class.
createDefault(String) - Static method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions: Creates a new instance of the VectorSearchOptions class with default values.
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(Class<?>, Object, String) - Static method in class com.microsoft.semantickernel.plugin.KernelPluginFactory: Creates a plugin that wraps the specified target object.
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: The default for PromptExecutionSettings.getBestOf() if best_of is not provided.
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: The default for PromptExecutionSettings.getFrequencyPenalty() if PromptExecutionSettings.Builder.withFrequencyPenalty(double) frequency_penalty} is not provided.
DEFAULT_MAX_TOKENS - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings: The default for PromptExecutionSettings.getMaxTokens() if max_tokens is not provided.
DEFAULT_PRESENCE_PENALTY - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings: The default for PromptExecutionSettings.getPresencePenalty() if presence_penalty is not provided.
DEFAULT_RESULTS_PER_PROMPT - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings: The default for PromptExecutionSettings.getResultsPerPrompt() if results per prompt (n) is not provided.
DEFAULT_SERVICE_ID - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings: The default for PromptExecutionSettings.getServiceId() if a service id is not provided.
DEFAULT_TEMPERATURE - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings: The default for PromptExecutionSettings.getTemperature() if temperature is not provided.
DEFAULT_TOP - Static variable in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions: The default number of search results to return.
DEFAULT_TOP - Static variable in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions: The default limit of the number of results to return.
DEFAULT_TOP_P - Static variable in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings: The default for PromptExecutionSettings.getTopP() if top_p is not provided.
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.
DefaultTextSearchResultMapper - Class in com.microsoft.semantickernel.data.textsearch: Default implementation of TextSearchResultMapper.
DefaultTextSearchResultMapper() - Constructor for class com.microsoft.semantickernel.data.textsearch.DefaultTextSearchResultMapper
DefaultTextSearchStringMapper - Class in com.microsoft.semantickernel.data.textsearch: Default implementation of TextSearchStringMapper.
DefaultTextSearchStringMapper() - Constructor for class com.microsoft.semantickernel.data.textsearch.DefaultTextSearchStringMapper
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
deleteAsync(String, DeleteRecordOptions) - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Deletes a record from the store.
deleteAsync(Key, DeleteRecordOptions) - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollection: Deletes a record from the store.
deleteBatchAsync(List<String>, DeleteRecordOptions) - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Deletes a batch of records from the store.
deleteBatchAsync(List<Key>, DeleteRecordOptions) - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollection: Deletes a batch of records from the store.
deleteCollectionAsync() - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollection: Deletes the collection from the store.
deleteCollectionAsync() - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Deletes the collection from the store.
DeleteRecordOptions - Class in com.microsoft.semantickernel.data.vectorstorage.options: Options for deleting a record.
DeleteRecordOptions() - Constructor for class com.microsoft.semantickernel.data.vectorstorage.options.DeleteRecordOptions
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.
dimensions() - Method in annotation type com.microsoft.semantickernel.data.vectorstorage.annotations.VectorStoreRecordVector: Number of dimensions in the vector.
distanceFunction() - Method in annotation type com.microsoft.semantickernel.data.vectorstorage.annotations.VectorStoreRecordVector: Distance function to be used for to compute the distance between vectors.
DistanceFunction - Enum in com.microsoft.semantickernel.data.vectorstorage.definition: Distance functions for vector storage.
divide(List<Float>, float) - Static method in class com.microsoft.semantickernel.data.vectorsearch.VectorOperations: Divides the elements of the vector by the divisor.
dot(List<Float>, List<Float>) - Static method in class com.microsoft.semantickernel.data.vectorsearch.VectorOperations: Calculates the dot product of two vectors.
DOT_PRODUCT - com.microsoft.semantickernel.data.vectorstorage.definition.DistanceFunction: Dot product between two vectors.

E

Embedding - Class in com.microsoft.semantickernel.services.textembedding: Represents a strongly typed vector of numeric data.
Embedding() - Constructor for class com.microsoft.semantickernel.services.textembedding.Embedding: Initializes a new instance of the Embedding class.
Embedding(float[]) - Constructor for class com.microsoft.semantickernel.services.textembedding.Embedding: Initializes a new instance of the Embedding class that contains numeric elements copied from the specified array
Embedding(List<Float>) - Constructor for class com.microsoft.semantickernel.services.textembedding.Embedding: Initializes a new instance of the Embedding class that contains numeric elements copied from the specified collection
EmbeddingGenerationService<TValue> - Interface in com.microsoft.semantickernel.services.textembedding: Interface for text embedding generation services
empty() - Static method in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata: Create a new instance of FunctionResultMetadata with no metadata.
empty() - Static method in class com.microsoft.semantickernel.services.textembedding.Embedding: Returns an empty Embedding instance.
entrySet() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments
equals(Object) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings
equals(Object) - Method in class com.microsoft.semantickernel.semanticfunctions.InputVariable
equals(Object) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata
equals(Object) - Method in class com.microsoft.semantickernel.semanticfunctions.OutputVariable
equals(Object) - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig
equalTo(String, Object) - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchFilter.Builder: Adds an EqualToFilterClause to the filter.
equalTo(String, Object) - Method in class com.microsoft.semantickernel.data.vectorsearch.VectorSearchFilter.Builder: Adds an EqualToFilterClause to the filter.
EqualToFilterClause - Class in com.microsoft.semantickernel.data.filter: A filter clause that filters on a field equal to a value.
EqualToFilterClause(String, Object) - Constructor for class com.microsoft.semantickernel.data.filter.EqualToFilterClause: Initializes a new instance of the EqualToFilterClause class.
escapeXmlString(String) - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter: To be used when toPromptString is called
escapeXmlStringValue(TextContent) - Static method in class com.microsoft.semantickernel.contextvariables.converters.TextContentVariableContextVariableTypeConverter: Escapes the XML string value.
EUCLIDEAN_DISTANCE - com.microsoft.semantickernel.data.vectorstorage.definition.DistanceFunction: Euclidean distance function.
euclideanDistance(List<Float>, List<Float>) - Static method in class com.microsoft.semantickernel.data.vectorsearch.VectorOperations: Calculates the Euclidean distance between two vectors.
euclideanLength(List<Float>) - Static method in class com.microsoft.semantickernel.data.vectorsearch.VectorOperations: Calculates the Euclidean length of a vector.
exactSimilaritySearch(List<Record>, List<Float>, VectorStoreRecordVectorField, DistanceFunction, VectorSearchOptions) - Static method in class com.microsoft.semantickernel.data.vectorsearch.VectorOperations: Performs an exact similarity search on a list of records using a vector field.
executeHooks(T) - Method in class com.microsoft.semantickernel.hooks.KernelHooks: Executes the hooks in this collection that accept the event.

F

FilterClause - Interface in com.microsoft.semantickernel.data.filter: A filter clause for a query.
FilterMapping - Interface in com.microsoft.semantickernel.data.filter
filterRecords(List<Record>, VectorSearchFilter, VectorStoreRecordDefinition, ObjectMapper) - Static method in class com.microsoft.semantickernel.data.VolatileVectorStoreCollectionSearchMapping: Filters the records based on the given VectorSearchFilter.
FLAT - com.microsoft.semantickernel.data.vectorstorage.definition.IndexKind: Flat index, which performs an exact nearest neighbour search.
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.
fromFields(List<VectorStoreRecordField>) - Static method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDefinition: Create a VectorStoreRecordDefinition from a collection of fields.
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.PrimitiveVariableContextVariableTypeConverter
fromObject(Function<Object, T>) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.Builder: Set the function to convert an object to the type.
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.PrimitiveVariableContextVariableTypeConverter
fromPromptString(Function<String, T>) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.Builder: Set the function to convert a prompt string to the type.
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.
fromRecord(Object) - Static method in class com.microsoft.semantickernel.data.textsearch.TextSearchResult: Creates a new instance of the TextSearchResult class from a record.
fromRecordClass(Class<?>) - Static method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDefinition: Create a VectorStoreRecordDefinition from a model.
fromResultToString(Object) - Method in class com.microsoft.semantickernel.data.textsearch.DefaultTextSearchStringMapper: Maps a search result to a string.
fromResultToString(Object) - Method in interface com.microsoft.semantickernel.data.textsearch.TextSearchStringMapper: Maps a search result to a string.
fromResultToTextSearchResult(Object) - Method in class com.microsoft.semantickernel.data.textsearch.DefaultTextSearchResultMapper: Maps a search result to a TextSearchResult.
fromResultToTextSearchResult(Object) - Method in interface com.microsoft.semantickernel.data.textsearch.TextSearchResultMapper: Maps a search result to a TextSearchResult.
fromYaml(Path) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionYaml: Create a KernelFunction instance for a prompt function using the specified markdown text.
FULL_HISTORY - com.microsoft.semantickernel.orchestration.InvocationReturnMode: Function invocations that build upon a history of previous invocations, such as Chat Completions, will return the full history of messages.
FUNCTION_NAME_SEPARATOR - Static variable in class com.microsoft.semantickernel.orchestration.ToolCallBehavior: The separator between the plugin name and the function name.
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>, FunctionResultMetadata<?>, Object) - Constructor for class com.microsoft.semantickernel.orchestration.FunctionResult: Create a new instance of FunctionResult.
FunctionResult(ContextVariable<T>, Object) - Constructor for class com.microsoft.semantickernel.orchestration.FunctionResult: Create a new instance of FunctionResult with no metadata.
FunctionResultMetadata<UsageType> - 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

generateEmbeddingAsync(TValue) - Method in interface com.microsoft.semantickernel.services.textembedding.EmbeddingGenerationService: Generates an embedding associated to the data
generateEmbeddingsAsync(List<TValue>) - Method in interface com.microsoft.semantickernel.services.textembedding.EmbeddingGenerationService: Generates a list of embeddings associated to the data
generateSchema(Class<?>) - Method in interface com.microsoft.semantickernel.orchestration.responseformat.ResponseSchemaGenerator: Generate a json schema for the given class.
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
getAllFields() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDefinition: Gets all fields in the record definition.
getAnyTagEqualToFilter(AnyTagEqualToFilterClause) - Method in interface com.microsoft.semantickernel.data.filter.FilterMapping: Gets the filter string for the given any tag equal to filter clause.
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.PreToolCallEvent: Gets the tool call arguments.
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.
getAsync(String, GetRecordOptions) - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Gets a record from the store.
getAsync(Key, GetRecordOptions) - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollection: Gets a record from the store.
getAudioContentAsync(String, TextToAudioExecutionSettings) - Method in interface com.microsoft.semantickernel.services.audio.TextToAudioService: Get audio content from text.
getAuthorRole() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent: Gets the author role that generated the content
getBatchAsync(List<String>, GetRecordOptions) - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Gets a batch of records from the store.
getBatchAsync(List<Key>, GetRecordOptions) - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollection: Gets a batch of records from the store.
getBestOf() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings: The log probability threshold for a result to be considered.
getChatCompletions() - Method in class com.microsoft.semantickernel.hooks.PostChatCompletionEvent: Gets the chat completions.
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.StreamingTextContent: 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.
getCollection(String, VectorStoreRecordCollectionOptions<Key, Record>) - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStore: Gets a collection from the vector store.
getCollection(String, VectorStoreRecordCollectionOptions<Key, Record>) - Method in class com.microsoft.semantickernel.data.VolatileVectorStore: Gets a collection from the vector store.
getCollectionName() - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollection: Gets the name of the collection.
getCollectionName() - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Gets the name of the collection.
getCollectionNamesAsync() - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStore: Gets the names of all collections in the vector store.
getCollectionNamesAsync() - Method in class com.microsoft.semantickernel.data.VolatileVectorStore: Gets the names of all collections in the vector store.
getContent() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent: Gets the content
getContent() - Method in interface com.microsoft.semantickernel.services.KernelContent: Gets the content returned by the AI service.
getContent() - Method in class com.microsoft.semantickernel.services.textcompletion.TextContent
getContentType() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent: Gets the content type
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.
getData() - Method in class com.microsoft.semantickernel.services.audio.AudioContent: Gets the audio data.
getDataFields() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDefinition: Gets the data fields in the record definition.
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.
getDeploymentName() - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings: The deployment name to use for audio transcription.
getDescription() - Method in class com.microsoft.semantickernel.plugin.KernelPlugin: Gets the description of the plugin.
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: Get the description of the function.
getDescription() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata: Get the description of the function.
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.
getDetail() - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent: Get the detail level of the image to include in the chat message.
getDimensions() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordVectorField: Gets the number of dimensions in the vector.
getDistanceFunction() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordVectorField: Gets the distance function.
getEffectiveStorageName() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField: Gets the effective storage name of the field.
getEncoding() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatMessageContent: Gets the encoding of the content
getEnumOptions(Class<?>) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod: Gets the constants from an enum type.
getEnumValues() - Method in class com.microsoft.semantickernel.semanticfunctions.InputVariable: Gets the possible enum values of the input variable.
getEqualToFilter(EqualToFilterClause) - Method in interface com.microsoft.semantickernel.data.filter.FilterMapping: Gets the filter string for the given equal to filter clause.
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.
getField(String) - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDefinition: Gets the field with the specified name.
getFieldName() - Method in class com.microsoft.semantickernel.data.filter.AnyTagEqualToFilterClause: Gets the field name to filter on.
getFieldName() - Method in class com.microsoft.semantickernel.data.filter.EqualToFilterClause: Gets the field name to filter on.
getFieldType() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField: Gets the field type.
getFilename() - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings: The optional filename or descriptive identifier to associate with the audio data.
getFilter() - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions: Gets the search filter.
getFilter(VectorSearchFilter, VectorStoreRecordDefinition) - Method in interface com.microsoft.semantickernel.data.filter.FilterMapping: Gets the filter string for the given vector search filter and record definition.
getFilterClauses() - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchFilter: Gets the filter clauses.
getFilterClauses() - Method in class com.microsoft.semantickernel.data.vectorsearch.VectorSearchFilter: Gets the filter clauses.
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.PreToolCallEvent: Get the tool call function.
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(Method, Object) - Static method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod: Gets the function from 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.
getGlobalTypes() - Static method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypes: Get the globally available collectors, which is the default collection of context variable types and those that have been added with ContextVariableTypes.addGlobalConverter(ContextVariableTypeConverter).
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.
getId() - Method in interface com.microsoft.semantickernel.services.chatcompletion.StreamingChatContent: Gets the ID of the content.
getIndexKind() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordVectorField: Gets the index kind.
getInnerContent() - Method in class com.microsoft.semantickernel.services.audio.AudioContent: Gets the inner content.
getInnerContent() - Method in interface com.microsoft.semantickernel.services.KernelContent: The inner content representation.
getInnerContent() - Method in class com.microsoft.semantickernel.services.KernelContentImpl: 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.
getJsonSchema() - Method in class com.microsoft.semantickernel.orchestration.responseformat.JsonSchemaResponseFormat: Gets the JSON schema.
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.
getKeyClass() - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollectionOptions: Gets the key class.
getKeyClass() - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollectionOptions: Gets the key class.
getKeyField() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDefinition: Gets the key field in the record definition.
getLanguage() - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings: The language of the audio data as two-letter ISO-639-1 language code (e.g.
getLastMessage() - Method in class com.microsoft.semantickernel.services.chatcompletion.ChatHistory: Get last message
getLink() - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchResult: Gets the link of the search result.
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.data.textsearch.KernelSearchResults: Gets the metadata associated with the search results.
getMetadata() - Method in class com.microsoft.semantickernel.data.vectorsearch.VectorSearchResults: Gets the metadata associated with the search results.
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.audio.AudioContent: Gets the metadata.
getMetadata() - Method in interface com.microsoft.semantickernel.services.KernelContent: The metadata associated with the content.
getMetadata() - Method in class com.microsoft.semantickernel.services.KernelContentImpl: 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.audio.AudioContent: Gets the model ID.
getName() - Method in interface com.microsoft.semantickernel.connectors.WebSearchEngineConnector.WebPage: Gets the name of the web page.
getName() - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchResult: Gets the name of the search result.
getName() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField: Gets the name of the field.
getName() - Method in class com.microsoft.semantickernel.orchestration.responseformat.JsonResponseSchema: Gets the name of the schema.
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. e.g. when using "{{$input}}" the name is "input", when using "{{$style}}" the name is "style", etc.
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: Get the name of the function.
getName() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata: Get the name of the function.
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.
getNonVectorFields() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDefinition: Gets the non-vector fields in the record definition.
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.
getOutputVariableType() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata: Get the return parameter of the function.
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.
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: Get the plugin name of the function.
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.
getPrompt() - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings: An optional hint to guide the model's style or continue from a prior audio segment.
getPromptExecutionSettings() - Method in class com.microsoft.semantickernel.orchestration.InvocationContext: Get the settings for prompt execution.
getPromptTemplateOptions() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig: Get the prompt template options of the prompt template config.
getRecord() - Method in class com.microsoft.semantickernel.data.vectorsearch.VectorSearchResult: Gets the record.
getRecordClass() - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollectionOptions: Gets the record class.
getRecordClass() - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollectionOptions: Gets the record class.
getRecordDefinition() - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollectionOptions: Gets the record definition.
getRecordDefinition() - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollectionOptions: Gets the record definition.
GetRecordOptions - Class in com.microsoft.semantickernel.data.vectorstorage.options: Options for getting a record.
GetRecordOptions(boolean) - Constructor for class com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions: Creates a new instance of the GetRecordOptions class.
GetRecordOptions(boolean, boolean) - Constructor for class com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions: Creates a new instance of the GetRecordOptions class.
GetRecordOptions.Builder - Class in com.microsoft.semantickernel.data.vectorstorage.options: A builder for GetRecordOptions.
getRecordToStorageModelMapper() - Method in class com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordMapper: Gets the function to convert a record to a storage model.
getRequiredFunction() - Method in class com.microsoft.semantickernel.orchestration.ToolCallBehavior.RequiredKernelFunction: Get the required function.
getResponseFormat() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings: The response format to use for prompt execution.
getResponseFormat() - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings: The requested format of the transcription response data, which will influence the content and detail of the result.
getResponseFormat() - Method in class com.microsoft.semantickernel.services.audio.TextToAudioExecutionSettings: Gets the response format.
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.
getResults() - Method in class com.microsoft.semantickernel.data.textsearch.KernelSearchResults: Gets the search results.
getResults() - Method in class com.microsoft.semantickernel.data.vectorsearch.VectorSearchResults: Gets the search results.
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.MethodDetails: Get the return parameter of the method.
getSchema() - Method in class com.microsoft.semantickernel.orchestration.responseformat.JsonResponseSchema: Gets the schema.
getSchema() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig: Get the schema version of the prompt template config.
getScore() - Method in class com.microsoft.semantickernel.data.vectorsearch.VectorSearchResult: Gets the score.
getSearchResultsAsync(String, TextSearchOptions) - Method in interface com.microsoft.semantickernel.data.textsearch.TextSearch: Perform a search for content related to the specified query and return Object values representing the search results.
getSearchResultsAsync(String, TextSearchOptions) - Method in class com.microsoft.semantickernel.data.VectorStoreTextSearch: Perform a search for content related to the specified query and return Object values representing the search results.
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) - 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.
getSkip() - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions: Gets the offset of the results to return.
getSkip() - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions: Gets the offset of the results to return.
getSnippet() - Method in interface com.microsoft.semantickernel.connectors.WebSearchEngineConnector.WebPage: Gets the snippet of the web page.
getSpeed() - Method in class com.microsoft.semantickernel.services.audio.TextToAudioExecutionSettings: Gets the speed.
getStopSequences() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings: The stop sequences to use for prompt execution.
getStorageModelToRecordMapper() - Method in class com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordMapper: Gets the function to convert a storage model to a record.
getStorageName() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField: Gets the storage name of the field.
getStreamingChatMessageContentsAsync(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.
getStreamingChatMessageContentsAsync(String, Kernel, InvocationContext) - Method in interface com.microsoft.semantickernel.services.chatcompletion.ChatCompletionService: Gets the chat message contents asynchronously using a prompt.
getStreamingTextContentsAsync(String, PromptExecutionSettings, Kernel) - Method in interface com.microsoft.semantickernel.services.textcompletion.TextGenerationService: Get streaming results for the prompt using the specified execution settings.
getString(String) - Static method in class com.microsoft.semantickernel.contextvariables.converters.CollectionVariableContextVariableTypeConverter: Gets a function that converts a collection to a string.
getString(String) - Static method in class com.microsoft.semantickernel.localization.SemanticKernelResources: Get the string for the specified id from the resource bundle.
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
getTelemetry() - Method in class com.microsoft.semantickernel.orchestration.InvocationContext
getTemperature() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings: The temperature setting controls the randomness of the output.
getTemperature() - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings: The randomness of the generated text.
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(AudioContent, AudioToTextExecutionSettings) - Method in interface com.microsoft.semantickernel.services.audio.AudioToTextService: Get text contents from audio content.
getTextContentsAsync(String, PromptExecutionSettings, Kernel) - Method in interface com.microsoft.semantickernel.services.textcompletion.TextGenerationService: Creates a completion for the prompt and settings.
getTextSearchResultsAsync(String, TextSearchOptions) - Method in interface com.microsoft.semantickernel.data.textsearch.TextSearch: Perform a search for content related to the specified query and return TextSearchResult values representing the search results.
getTextSearchResultsAsync(String, TextSearchOptions) - Method in class com.microsoft.semantickernel.data.VectorStoreTextSearch: Perform a search for content related to the specified query and return TextSearchResult values representing the search results.
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.
getTop() - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions: Gets the limit of the number of results to return.
getTop() - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions: Gets the limit of the number of results to return.
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.
getTotalCount() - Method in class com.microsoft.semantickernel.data.textsearch.KernelSearchResults: Gets the total count of search results.
getTotalCount() - Method in class com.microsoft.semantickernel.data.vectorsearch.VectorSearchResults: Gets the total count of search results.
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.orchestration.responseformat.ResponseFormat: Gets the type of the response format.
getType() - Method in class com.microsoft.semantickernel.semanticfunctions.InputVariable: Gets the type of the input variable.
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.
getTypeForName(String) - Static method in class com.microsoft.semantickernel.plugin.KernelPluginFactory: Returns the class for the provided type name.
getUnconvertedResult() - Method in class com.microsoft.semantickernel.orchestration.FunctionResult: Get the result of the function invocation before it was converted to the expected type.
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.data.filter.AnyTagEqualToFilterClause: Gets the value.
getValue() - Method in class com.microsoft.semantickernel.data.filter.EqualToFilterClause: Gets the value.
getValue() - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchResult: Gets the value of the search result.
getValue() - Method in enum com.microsoft.semantickernel.data.vectorstorage.definition.DistanceFunction: Gets the function name.
getValue() - Method in enum com.microsoft.semantickernel.data.vectorstorage.definition.IndexKind: Gets the string value of the index kind.
getValue() - Method in class com.microsoft.semantickernel.services.textcompletion.TextContent: Gets the content.
getValue(Class) - 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. its super class.
getVector() - Method in class com.microsoft.semantickernel.services.textembedding.Embedding: Return the embedding vector as a read-only list.
getVectorFieldName() - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions: Gets the name of the vector field.
getVectorFields() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDefinition: Gets the vector fields in the record definition.
getVectorSearchFilter() - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions: Gets the vector search filter.
getVoice() - Method in class com.microsoft.semantickernel.services.audio.TextToAudioExecutionSettings: Gets the voice.

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: Initializes a new instance of the HandlebarsPromptTemplateFactory class.
hashCode() - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings
hashCode() - Method in class com.microsoft.semantickernel.semanticfunctions.InputVariable
hashCode() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata
hashCode() - Method in class com.microsoft.semantickernel.semanticfunctions.OutputVariable
hashCode() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig
HIGH - com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.ImageDetail: High detail
HNSW - com.microsoft.semantickernel.data.vectorstorage.definition.IndexKind: Hierarchical Navigable Small World, which performs an approximate nearest neighbour (ANN) search.

I

ID - Static variable in class com.microsoft.semantickernel.orchestration.FunctionResultMetadata: The key for id metadata.
IMAGE_URL - com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageContentType: The content is an image
importPluginFromDirectory(Path, String, PromptTemplateFactory) - Static method in class com.microsoft.semantickernel.plugin.KernelPluginFactory: Imports a plugin from a directory.
importPluginFromResourcesDirectory(String, String, String, PromptTemplateFactory) - Static method in class com.microsoft.semantickernel.plugin.KernelPluginFactory: Imports a plugin from a resource directory on the filesystem.
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.
includeVectors(boolean) - Method in class com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions.Builder: Sets whether to include vectors.
indexKind() - Method in annotation type com.microsoft.semantickernel.data.vectorstorage.annotations.VectorStoreRecordVector: Type of index to be used for the vector.
IndexKind - Enum in com.microsoft.semantickernel.data.vectorstorage.definition: Represents the kind of index to use for a vector store.
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, List<?>) - 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.
InvocationReturnMode - Enum in com.microsoft.semantickernel.orchestration: Represents the mode in which a function invocation should return its results.
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.
invokePromptAsync(String) - Method in class com.microsoft.semantickernel.Kernel: Invokes a Prompt.
invokePromptAsync(String, KernelFunctionArguments) - Method in class com.microsoft.semantickernel.Kernel: Invokes a Prompt.
invokePromptAsync(String, KernelFunctionArguments, InvocationContext) - Method in class com.microsoft.semantickernel.Kernel: Invokes a Prompt.
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
isFilterable() - Method in annotation type com.microsoft.semantickernel.data.vectorstorage.annotations.VectorStoreRecordData: Whether the field is filterable.
isFilterable() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDataField: Gets a value indicating whether the field is filterable.
isFilterable(boolean) - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDataField.Builder: Sets a value indicating whether the field is filterable.
isFullTextSearchable() - Method in annotation type com.microsoft.semantickernel.data.vectorstorage.annotations.VectorStoreRecordData: Whether the field is full text searchable.
isFullTextSearchable() - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDataField: Gets a value indicating whether the field is full text searchable.
isFullTextSearchable(boolean) - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDataField.Builder: Sets a value indicating whether the field is full text searchable.
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.
isIncludeTotalCount() - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions: Gets a value indicating whether to include the total count of search results.
isIncludeTotalCount() - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions: Gets a value indicating whether to include the total count of the results.
isIncludeVectors() - Method in class com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions: Gets whether to include vectors.
isIncludeVectors() - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions: Gets a value indicating whether to include vectors in the results.
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.
isStrict() - Method in class com.microsoft.semantickernel.orchestration.responseformat.JsonResponseSchema: Gets whether the schema is strict.
isWildcardKeyMatching() - Method in class com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions: Gets whether to use wildcard key matching.
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.
IVFFLAT - com.microsoft.semantickernel.data.vectorstorage.definition.IndexKind: Inverted file index, which performs an approximate nearest neighbour (ANN) search.

J

jacksonGenerator() - Static method in interface com.microsoft.semantickernel.orchestration.responseformat.ResponseSchemaGenerator: Load a response schema generator based on the Jackson library, requires that com.github.victools:jsonschema-generator has been added to the class path.
JSON_OBJECT - com.microsoft.semantickernel.orchestration.responseformat.ResponseFormat.Type: Only valid for openai chat completion, with GPT-4 and gpt-3.5-turbo-1106+ models.
JSON_SCHEMA - com.microsoft.semantickernel.orchestration.responseformat.ResponseFormat.Type: Only valid for openai chat completion, with GPT-4 and gpt-3.5-turbo-1106+ models.
JsonObjectResponseFormat - Class in com.microsoft.semantickernel.orchestration.responseformat: A response represented in a JSON format.
JsonObjectResponseFormat() - Constructor for class com.microsoft.semantickernel.orchestration.responseformat.JsonObjectResponseFormat: Used by Jackson deserialization to create a new instance of the JsonObjectResponseFormat class.
JsonResponseSchema - Class in com.microsoft.semantickernel.orchestration.responseformat: The schema for a response in JSON format.
JsonResponseSchema(String, String, boolean) - Constructor for class com.microsoft.semantickernel.orchestration.responseformat.JsonResponseSchema: Used by Jackson deserialization to create a new instance of the JsonResponseSchema class.
JsonSchemaResponseFormat - Class in com.microsoft.semantickernel.orchestration.responseformat: A response represented in a JSON schema format.
JsonSchemaResponseFormat(JsonResponseSchema) - Constructor for class com.microsoft.semantickernel.orchestration.responseformat.JsonSchemaResponseFormat: Used by Jackson deserialization to create a new instance of the JsonSchemaResponseFormat class.
JsonSchemaResponseFormat.Builder - Class in com.microsoft.semantickernel.orchestration.responseformat: A builder for the JsonSchemaResponseFormat class.

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> - Interface in com.microsoft.semantickernel.services: Base class which represents the content returned by an AI service.
KernelContentImpl<T> - Class in com.microsoft.semantickernel.services: Base class which represents the content returned by an AI service.
KernelContentImpl(T, String, FunctionResultMetadata) - Constructor for class com.microsoft.semantickernel.services.KernelContentImpl: Initializes a new instance of the KernelContentImpl 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<InputVariable>, OutputVariable<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.PostChatCompletionHook - Interface in com.microsoft.semantickernel.hooks: A hook that accepts PostChatCompletionEvent
KernelHook.PreChatCompletionHook - Interface in com.microsoft.semantickernel.hooks: A hook that accepts PreChatCompletionEvent
KernelHook.PreToolCallHook - Interface in com.microsoft.semantickernel.hooks: A hook that accepts PreToolCallEvent
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.
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: Initializes a new instance of the KernelPromptTemplateFactory class.
KernelSearchResults<T> - Class in com.microsoft.semantickernel.data.textsearch: The search results.
KernelSearchResults(List<T>) - Constructor for class com.microsoft.semantickernel.data.textsearch.KernelSearchResults: Creates a new instance of the KernelSearchResults class.
KernelSearchResults(List<T>, long, Map<String, Object>) - Constructor for class com.microsoft.semantickernel.data.textsearch.KernelSearchResults: Creates a new instance of the KernelSearchResults class.
keySet() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments

L

LAST_MESSAGE_ONLY - com.microsoft.semantickernel.orchestration.InvocationReturnMode: Function invocations that build upon a history of previous invocations, such as Chat Completions, will return only the last message generated by the given invocation.
loadGenerator(String) - Static method in interface com.microsoft.semantickernel.orchestration.responseformat.ResponseSchemaGenerator: Load a response schema generator based on the given class name.
localize(String, String) - Static method in class com.microsoft.semantickernel.localization.SemanticKernelResources: Get the string for the specified id from the resource bundle.
LOGGER - Static variable in interface com.microsoft.semantickernel.orchestration.responseformat.ResponseSchemaGenerator
LOW - com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.ImageDetail: Low detail

M

MAIN_KEY - Static variable in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments: Default key for the main input.
mapRecordToStorageModel(Record) - Method in class com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordMapper: Converts a record to a storage model.
mapStorageModelToRecord(StorageModel, GetRecordOptions) - Method in class com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordMapper: Converts a storage model to a record.
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(KernelHooks, KernelHooks) - Static method in class com.microsoft.semantickernel.hooks.KernelHooks: Builds the list of hooks to be invoked for the given context, by merging the hooks in this collection with the hooks in the context.
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<InputVariable>, OutputVariable<?>) - Constructor for class com.microsoft.semantickernel.semanticfunctions.MethodDetails: Constructor.
MODEL_NOT_AVAILABLE - com.microsoft.semantickernel.exceptions.AIException.ErrorCodes: Model not available.
multiply(List<Float>, float) - Static method in class com.microsoft.semantickernel.data.vectorsearch.VectorOperations: Multiplies the elements of the vector by the multiplier.

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.
NEW_MESSAGES_ONLY - com.microsoft.semantickernel.orchestration.InvocationReturnMode: Function invocations that build upon a history of previous invocations, such as Chat Completions, will return only new messages generated by the given invocation.
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.
normalize(List<Float>) - Static method in class com.microsoft.semantickernel.data.vectorsearch.VectorOperations: Normalizes the vector such that the Euclidean length is 1.
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.
OpenAiServiceBuilder<C,T extends AIService,U extends OpenAiServiceBuilder<C,T,U>> - Class in com.microsoft.semantickernel.services.openai: Builder for an OpenAI service.
OpenAiServiceBuilder() - Constructor for class com.microsoft.semantickernel.services.openai.OpenAiServiceBuilder
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<T> - Class in com.microsoft.semantickernel.semanticfunctions: Metadata for an output variable of a kernel function.
OutputVariable(String, Class<T>) - Constructor for class com.microsoft.semantickernel.semanticfunctions.OutputVariable: Constructor.
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.
PostChatCompletionEvent - Class in com.microsoft.semantickernel.hooks: Represents a KernelHookEvent that is raised after a chat completion is invoked.
PostChatCompletionEvent(ChatCompletions) - Constructor for class com.microsoft.semantickernel.hooks.PostChatCompletionEvent: Creates a new instance of the PostChatCompletionEvent class.
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.
PreToolCallEvent - Class in com.microsoft.semantickernel.hooks: Represents a KernelHookEvent that is raised before a tool call is invoked.
PreToolCallEvent(String, KernelFunctionArguments, KernelFunction<?>, ContextVariableTypes) - Constructor for class com.microsoft.semantickernel.hooks.PreToolCallEvent: Creates a new instance of the PreToolCallEvent class.
prettyPrint() - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments: Create formatted string of the variables
PrimitiveBooleanVariableContextVariableTypeConverter - Class in com.microsoft.semantickernel.contextvariables.converters: A ContextVariableTypeConverter for Boolean variables.
PrimitiveBooleanVariableContextVariableTypeConverter() - Constructor for class com.microsoft.semantickernel.contextvariables.converters.PrimitiveBooleanVariableContextVariableTypeConverter: Initializes a new instance of the PrimitiveBooleanVariableContextVariableTypeConverter class.
PrimitiveVariableContextVariableTypeConverter<T> - Class in com.microsoft.semantickernel.contextvariables.converters: A ContextVariableTypeConverter for primitive variables.
PrimitiveVariableContextVariableTypeConverter(Class<T>, Function<String, T>, Function<Object, T>, Function<T, String>) - Constructor for class com.microsoft.semantickernel.contextvariables.converters.PrimitiveVariableContextVariableTypeConverter: Creates a new instance of the PrimitiveVariableContextVariableTypeConverter class.
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>, ResponseFormat) - 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(PromptTemplateConfig) - Constructor for class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig: Copy constructor.
PromptTemplateConfig(Integer, String, String, String, Set<PromptTemplateOption>, String, List<InputVariable>, OutputVariable, Map<String, PromptExecutionSettings>) - Constructor for class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig: Constructor for a prompt template config
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.
PromptTemplateOption - Enum in com.microsoft.semantickernel.semanticfunctions: Options to customize the behavior of a prompt.
proxyGlobalType() - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.Builder: Make this builder a proxy for another type converter.
proxyType(ContextVariableTypeConverter<T>) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.Builder: Make this builder a proxy for another type converter.
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.
ResponseFormat - Class in com.microsoft.semantickernel.orchestration.responseformat: Base class for response formats.
ResponseFormat(ResponseFormat.Type) - Constructor for class com.microsoft.semantickernel.orchestration.responseformat.ResponseFormat: Creates a new instance of the ResponseFormat class.
ResponseFormat.Type - Enum in com.microsoft.semantickernel.orchestration.responseformat: The type of the response format.
ResponseSchema - Class in com.microsoft.semantickernel.orchestration.responseformat
ResponseSchema() - Constructor for class com.microsoft.semantickernel.orchestration.responseformat.ResponseSchema
ResponseSchemaGenerator - Interface in com.microsoft.semantickernel.orchestration.responseformat: Interface for generating json response schemas for a given class.
returnDescription() - Method in annotation type com.microsoft.semantickernel.semanticfunctions.annotations.DefineKernelFunction: The description of the return value of the function.
returnMode() - Method in class com.microsoft.semantickernel.orchestration.InvocationContext: Get the return mode for the invocation.
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. a function call threw an exception.

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.
searchAsync(String, TextSearchOptions) - Method in interface com.microsoft.semantickernel.data.textsearch.TextSearch: Perform a search for content related to the specified query and return String values representing the search results.
searchAsync(String, TextSearchOptions) - Method in class com.microsoft.semantickernel.data.VectorStoreTextSearch: Perform a search for content related to the specified query and return String values representing the search results.
searchAsync(String, VectorSearchOptions) - Method in interface com.microsoft.semantickernel.data.vectorsearch.VectorizableTextSearch: Vectorizable text search.
searchAsync(List<Float>, VectorSearchOptions) - Method in interface com.microsoft.semantickernel.data.vectorsearch.VectorizedSearch: Vectorized search.
searchAsync(List<Float>, VectorSearchOptions) - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Vectorized 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> - Interface in com.microsoft.semantickernel.builders: Interface for all builders.
SemanticKernelResources - Class in com.microsoft.semantickernel.localization: Provides access to the resources used by the Semantic Kernel.
SemanticKernelResources() - Constructor for class com.microsoft.semantickernel.localization.SemanticKernelResources
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.
setJsonResponseSchema(JsonResponseSchema) - Method in class com.microsoft.semantickernel.orchestration.responseformat.JsonSchemaResponseFormat.Builder: Sets the JSON response schema.
setJsonSchema(String) - Method in class com.microsoft.semantickernel.orchestration.responseformat.JsonSchemaResponseFormat.Builder: Sets the JSON schema.
setLocale(Locale) - Static method in class com.microsoft.semantickernel.localization.SemanticKernelResources: Set the locale for the Semantic Kernel.
setName(String) - Method in class com.microsoft.semantickernel.orchestration.responseformat.JsonSchemaResponseFormat.Builder: Sets the name of the JSON schema.
setResourceBundle(Locale) - Static method in class com.microsoft.semantickernel.localization.SemanticKernelResources: Load the localized resource bundle for the Semantic Kernel.
setResponseFormat(Class<?>) - Method in class com.microsoft.semantickernel.orchestration.responseformat.JsonSchemaResponseFormat.Builder: Sets the response format.
setResponseFormat(Class<?>, ResponseSchemaGenerator) - Method in class com.microsoft.semantickernel.orchestration.responseformat.JsonSchemaResponseFormat.Builder: Sets the response format.
setStrict(boolean) - Method in class com.microsoft.semantickernel.orchestration.responseformat.JsonSchemaResponseFormat.Builder: Sets whether the schema is strict.
setWildcardKeyMatching(boolean) - Method in class com.microsoft.semantickernel.data.vectorstorage.options.GetRecordOptions.Builder: Sets whether to use wildcard key matching.
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.
SKCheckedException(String) - Constructor for exception com.microsoft.semantickernel.exceptions.SKCheckedException: Initializes a new instance of the SKCheckedException class with its message set to message.
SKCheckedException(String, Throwable) - Constructor for exception com.microsoft.semantickernel.exceptions.SKCheckedException: Initializes a new instance of the SKCheckedException class with its message set to message.
SKCheckedException(Throwable) - Constructor for exception com.microsoft.semantickernel.exceptions.SKCheckedException: Initializes a new instance of the SKCheckedException class with its message set to null and the cause set to e.
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.
SKException(Throwable) - Constructor for exception com.microsoft.semantickernel.exceptions.SKException: Initializes a new instance of the SKException class with its message set to null and the cause set to e.
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
storageName() - Method in annotation type com.microsoft.semantickernel.data.vectorstorage.annotations.VectorStoreRecordData: Storage name of the field.
storageName() - Method in annotation type com.microsoft.semantickernel.data.vectorstorage.annotations.VectorStoreRecordKey: Storage name of the field.
storageName() - Method in annotation type com.microsoft.semantickernel.data.vectorstorage.annotations.VectorStoreRecordVector: Storage name of the field.
StreamingChatContent<T> - Interface in com.microsoft.semantickernel.services.chatcompletion: Base class which represents the content returned by a chat completion service.
StreamingKernelContent<T> - Interface in com.microsoft.semantickernel.services: Base class which represents the content returned by an AI service.
StreamingTextContent<T> - Class in com.microsoft.semantickernel.services: Base class which represents the content returned by a streaming AI service.
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 handles the reactive stream when the KernelFunction 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.
systemMessage(String) - Static method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent: Create a message with the author role set to AuthorRole.SYSTEM

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.PostChatCompletionHook
test(KernelHookEvent) - Method in interface com.microsoft.semantickernel.hooks.KernelHook.PreChatCompletionHook
test(KernelHookEvent) - Method in interface com.microsoft.semantickernel.hooks.KernelHook.PreToolCallHook
test(KernelHookEvent) - Method in interface com.microsoft.semantickernel.hooks.KernelHook.PromptRenderedHook
test(KernelHookEvent) - Method in interface com.microsoft.semantickernel.hooks.KernelHook.PromptRenderingHook
TEXT - com.microsoft.semantickernel.orchestration.responseformat.ResponseFormat.Type: The response is in text format.
TEXT - com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageContentType: The content is text
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.
TextEmbeddingGenerationService - Interface in com.microsoft.semantickernel.services.textembedding: Interface for text embedding generation services
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
TextResponseFormat - Class in com.microsoft.semantickernel.orchestration.responseformat: Represents a text response format.
TextResponseFormat() - Constructor for class com.microsoft.semantickernel.orchestration.responseformat.TextResponseFormat: Used by Jackson to creates a new instance of the TextResponseFormat class.
TextSearch - Interface in com.microsoft.semantickernel.data.textsearch
TextSearchFilter - Class in com.microsoft.semantickernel.data.textsearch: Represents a text search filter.
TextSearchFilter() - Constructor for class com.microsoft.semantickernel.data.textsearch.TextSearchFilter: Creates a new instance of the TextSearchFilter class.
TextSearchFilter(List<FilterClause>) - Constructor for class com.microsoft.semantickernel.data.textsearch.TextSearchFilter: Creates a new instance of the TextSearchFilter class.
TextSearchFilter.Builder - Class in com.microsoft.semantickernel.data.textsearch: The builder for the TextSearchFilter class.
TextSearchOptions - Class in com.microsoft.semantickernel.data.textsearch: Represents the options for a text search.
TextSearchOptions.Builder - Class in com.microsoft.semantickernel.data.textsearch: The builder for the TextSearchOptions class.
TextSearchResult - Class in com.microsoft.semantickernel.data.textsearch: Represents a text search result.
TextSearchResultLink - Annotation Type in com.microsoft.semantickernel.data.textsearch: Annotation to mark a property on a record class as the link to the source data.
TextSearchResultMapper - Interface in com.microsoft.semantickernel.data.textsearch: Maps a search result to a TextSearchResult.
TextSearchResultName - Annotation Type in com.microsoft.semantickernel.data.textsearch: Annotation to mark a property on a record class as the name of the source data.
TextSearchResultValue - Annotation Type in com.microsoft.semantickernel.data.textsearch: Annotation to mark a property on a record class as the value of the source data.
TextSearchStringMapper - Interface in com.microsoft.semantickernel.data.textsearch: Maps a search result to a string.
TextToAudioExecutionSettings - Class in com.microsoft.semantickernel.services.audio: Represents the settings for text to audio execution.
TextToAudioExecutionSettings(String, String, Double) - Constructor for class com.microsoft.semantickernel.services.audio.TextToAudioExecutionSettings: Creates a new instance of the settings.
TextToAudioExecutionSettings.Builder - Class in com.microsoft.semantickernel.services.audio: Represents a builder for text to audio execution settings.
TextToAudioService - Interface in com.microsoft.semantickernel.services.audio: Provides audio to text service.
TextToAudioService.Builder - Class in com.microsoft.semantickernel.services.audio: Builder for the TextToAudioService.
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(ContextVariableTypes, Object, Class) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter: Use this converter to convert the object to the type of the context variable.
toObject(ContextVariableTypes, Object, Class) - Method in class com.microsoft.semantickernel.contextvariables.converters.PrimitiveVariableContextVariableTypeConverter
toObject(ContextVariableTypes, Object, Class, boolean) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter: Use this converter to convert the object to the type of the context variable.
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 given ContextVariableTypeConverter to convert the value of this ContextVariable to a prompt string.
toPromptString(ContextVariableTypes) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariable: Use the given ContextVariableTypeConverter to convert the value of this ContextVariable to a prompt string.
toPromptString(ContextVariableTypes, 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(ContextVariableTypes, T) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter: Convert the type to a prompt string using the toPromptString function provided to the constructor.
toPromptString(ContextVariableTypes, T) - Method in interface com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.ToPromptStringFunction: Convert the type to a prompt string.
toPromptString(Function<T, String>) - Method in class com.microsoft.semantickernel.contextvariables.ContextVariableTypeConverter.Builder: Set the function to convert the type to a prompt string.
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

UNDEFINED - com.microsoft.semantickernel.data.vectorstorage.definition.DistanceFunction: No distance function specified.
UNDEFINED - com.microsoft.semantickernel.data.vectorstorage.definition.IndexKind: No index specified.
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.
upsertAsync(Record, UpsertRecordOptions) - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollection: Inserts or updates a record in the store.
upsertAsync(Record, UpsertRecordOptions) - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Inserts or updates a record in the store.
upsertBatchAsync(List<Record>, UpsertRecordOptions) - Method in interface com.microsoft.semantickernel.data.vectorstorage.VectorStoreRecordCollection: Inserts or updates a batch of records in the store.
upsertBatchAsync(List<Record>, UpsertRecordOptions) - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Inserts or updates a batch of records in the store.
UpsertRecordOptions - Class in com.microsoft.semantickernel.data.vectorstorage.options: Options for upserting a record.
UpsertRecordOptions() - Constructor for class com.microsoft.semantickernel.data.vectorstorage.options.UpsertRecordOptions
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.
userMessage(String) - Static method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent: Create a message with the author role set to AuthorRole.USER

V

validateSupportedTypes(List<VectorStoreRecordField>, Set<Class<?>>) - Static method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDefinition: Validate that the record class contains only supported field types.
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.data.vectorstorage.definition.DistanceFunction: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.data.vectorstorage.definition.IndexKind: Returns the enum constant of this type with the specified name.
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.orchestration.InvocationReturnMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.orchestration.responseformat.ResponseFormat.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.semanticfunctions.PromptTemplateOption: 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.services.chatcompletion.message.ChatMessageContentType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.ImageDetail: 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.data.vectorstorage.definition.DistanceFunction: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microsoft.semantickernel.data.vectorstorage.definition.IndexKind: 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.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() - Static method in enum com.microsoft.semantickernel.orchestration.InvocationReturnMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microsoft.semantickernel.orchestration.responseformat.ResponseFormat.Type: 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.semanticfunctions.PromptTemplateOption: Returns an array containing the constants of this enum type, in the order they are declared.
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.services.chatcompletion.message.ChatMessageContentType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.ImageDetail: 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.
VectorizableTextSearch<Record> - Interface in com.microsoft.semantickernel.data.vectorsearch: A vectorizable text search.
VectorizedSearch<Record> - Interface in com.microsoft.semantickernel.data.vectorsearch: A vectorized search.
VectorOperations - Class in com.microsoft.semantickernel.data.vectorsearch: Operations for working with vectors.
VectorOperations() - Constructor for class com.microsoft.semantickernel.data.vectorsearch.VectorOperations
VectorSearchFilter - Class in com.microsoft.semantickernel.data.vectorsearch: A vector search filter.
VectorSearchFilter() - Constructor for class com.microsoft.semantickernel.data.vectorsearch.VectorSearchFilter: Creates a new instance of the VectorSearchFilter class.
VectorSearchFilter(List<FilterClause>) - Constructor for class com.microsoft.semantickernel.data.vectorsearch.VectorSearchFilter: Creates a new instance of the VectorSearchFilter class.
VectorSearchFilter.Builder - Class in com.microsoft.semantickernel.data.vectorsearch: A builder for the VectorSearchFilter class.
VectorSearchOptions - Class in com.microsoft.semantickernel.data.vectorstorage.options: Options for a vector search.
VectorSearchOptions(VectorSearchFilter, String, int, int, boolean, boolean) - Constructor for class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions: Creates a new instance of the VectorSearchOptions class.
VectorSearchOptions.Builder - Class in com.microsoft.semantickernel.data.vectorstorage.options: A builder for the VectorSearchOptions class.
VectorSearchResult<Record> - Class in com.microsoft.semantickernel.data.vectorsearch: Represents a vector search result.
VectorSearchResult(Record, double) - Constructor for class com.microsoft.semantickernel.data.vectorsearch.VectorSearchResult: Creates a new instance of VectorSearchResult.
VectorSearchResults<Record> - Class in com.microsoft.semantickernel.data.vectorsearch: The search results.
VectorSearchResults(List<VectorSearchResult<Record>>) - Constructor for class com.microsoft.semantickernel.data.vectorsearch.VectorSearchResults: Creates a new instance of the VectorSearchResults class.
VectorSearchResults(List<VectorSearchResult<Record>>, long, Map<String, Object>) - Constructor for class com.microsoft.semantickernel.data.vectorsearch.VectorSearchResults: Creates a new instance of the VectorSearchResults class.
VectorStore - Interface in com.microsoft.semantickernel.data.vectorstorage: Represents a vector store.
VectorStoreRecordCollection<Key,Record> - Interface in com.microsoft.semantickernel.data.vectorstorage: Represents a collection of records in a vector store.
VectorStoreRecordCollectionOptions<Key,Record> - Interface in com.microsoft.semantickernel.data.vectorstorage: Represents the options for a collection of vector store records.
VectorStoreRecordData - Annotation Type in com.microsoft.semantickernel.data.vectorstorage.annotations: Represents a data field in a record.
VectorStoreRecordDataField - Class in com.microsoft.semantickernel.data.vectorstorage.definition: Represents a data field in a record.
VectorStoreRecordDataField(String, String, Class<?>, boolean, boolean) - Constructor for class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordDataField: Creates a new instance of the VectorStoreRecordDataField class.
VectorStoreRecordDataField.Builder - Class in com.microsoft.semantickernel.data.vectorstorage.definition: Builder for the VectorStoreRecordDataField class.
VectorStoreRecordDefinition - Class in com.microsoft.semantickernel.data.vectorstorage.definition: Represents a definition of a vector store record.
VectorStoreRecordField - Class in com.microsoft.semantickernel.data.vectorstorage.definition: Represents a field in a record.
VectorStoreRecordField(String, String, Class<?>) - Constructor for class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField: Creates a new instance of the VectorStoreRecordField class.
VectorStoreRecordField.Builder<T,U extends VectorStoreRecordField.Builder<T,U>> - Class in com.microsoft.semantickernel.data.vectorstorage.definition: A builder for the VectorStoreRecordField class.
VectorStoreRecordKey - Annotation Type in com.microsoft.semantickernel.data.vectorstorage.annotations: Represents the key field in a record.
VectorStoreRecordKeyField - Class in com.microsoft.semantickernel.data.vectorstorage.definition: Represents the key field in a record.
VectorStoreRecordKeyField(String, String, Class<?>) - Constructor for class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordKeyField: Creates a new instance of the VectorStoreRecordKeyField class.
VectorStoreRecordKeyField.Builder - Class in com.microsoft.semantickernel.data.vectorstorage.definition: A builder for the VectorStoreRecordKeyField class.
VectorStoreRecordMapper<Record,StorageModel> - Class in com.microsoft.semantickernel.data.vectorstorage: A mapper to convert between a record and a storage model.
VectorStoreRecordVector - Annotation Type in com.microsoft.semantickernel.data.vectorstorage.annotations: Represents a vector field in a record.
VectorStoreRecordVectorField - Class in com.microsoft.semantickernel.data.vectorstorage.definition: Represents a vector field in a record.
VectorStoreRecordVectorField(String, String, Class<?>, int, IndexKind, DistanceFunction) - Constructor for class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordVectorField: Creates a new instance of the VectorStoreRecordVectorField class.
VectorStoreRecordVectorField.Builder - Class in com.microsoft.semantickernel.data.vectorstorage.definition: A builder for the VectorStoreRecordVectorField class.
VectorStoreTextSearch<Record> - Class in com.microsoft.semantickernel.data: A text search implementation that uses a vector record collection to perform the search.
VectorStoreTextSearch(VectorizedSearch<Record>, TextEmbeddingGenerationService, TextSearchStringMapper, TextSearchResultMapper, VectorStoreTextSearchOptions) - Constructor for class com.microsoft.semantickernel.data.VectorStoreTextSearch: Create a new instance of VectorStoreTextSearch with VectorizedSearch to perform vectorized search and TextEmbeddingGenerationService to generate text embeddings.
VectorStoreTextSearch.Builder<Record> - Class in com.microsoft.semantickernel.data: A builder for the VectorStoreTextSearch class.
VectorStoreTextSearchOptions - Class in com.microsoft.semantickernel.data: Options for vector store text search.
VectorStoreTextSearchOptions() - Constructor for class com.microsoft.semantickernel.data.VectorStoreTextSearchOptions
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.
VolatileVectorStore - Class in com.microsoft.semantickernel.data: Represents a volatile vector store.
VolatileVectorStore() - Constructor for class com.microsoft.semantickernel.data.VolatileVectorStore: Creates a new instance of the volatile vector store.
VolatileVectorStoreCollectionSearchMapping - Class in com.microsoft.semantickernel.data: Provides methods to filter records based on a VectorSearchFilter.
VolatileVectorStoreCollectionSearchMapping() - Constructor for class com.microsoft.semantickernel.data.VolatileVectorStoreCollectionSearchMapping
VolatileVectorStoreRecordCollection<Record> - Class in com.microsoft.semantickernel.data: Represents a volatile vector store record collection.
VolatileVectorStoreRecordCollection(String, VolatileVectorStoreRecordCollectionOptions<Record>) - Constructor for class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollection: Creates a new instance of the volatile vector store record collection.
VolatileVectorStoreRecordCollectionOptions<Record> - Class in com.microsoft.semantickernel.data: Represents the options for a volatile vector store record collection.
VolatileVectorStoreRecordCollectionOptions(Class<Record>, VectorStoreRecordDefinition, ObjectMapper) - Constructor for class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollectionOptions: Creates a new instance of the Volatile vector store record collection options.
VolatileVectorStoreRecordCollectionOptions.Builder<Record> - Class in com.microsoft.semantickernel.data: Builder for Volatile vector store record collection options.

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.
withAuthorRole(AuthorRole) - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent.Builder: Set the author role of the message
withBestOf(int) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder: Set the best of setting for prompt execution.
withContent(String) - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent.Builder: Set the content of the message
withContextVariableConverter(ContextVariableTypeConverter<?>) - Method in class com.microsoft.semantickernel.orchestration.InvocationContext.Builder: Add a context variable type converter to the builder.
withContextVariableConverter(ContextVariableTypes) - Method in class com.microsoft.semantickernel.orchestration.InvocationContext.Builder: Add a context variable type converter to the builder.
withData(byte[]) - Method in class com.microsoft.semantickernel.services.audio.AudioContent.Builder: Sets the audio data.
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
withDeploymentName(String) - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings.Builder: Sets the deployment name to use for audio transcription.
withDeploymentName(String) - Method in class com.microsoft.semantickernel.services.openai.OpenAiServiceBuilder: Sets the deployment name for the service if required.
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.
withDetail(ChatMessageImageContent.ImageDetail) - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.Builder: Set the detail level of the image to include in the chat message.
withDimensions(int) - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordVectorField.Builder: Sets the number of dimensions in the vector.
withDistanceFunction(DistanceFunction) - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordVectorField.Builder: Sets the distance function.
withEncoding(Charset) - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent.Builder: Set the encoding of the message
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.
withFieldType(Class<?>) - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField.Builder: Sets the field type.
withFilename(String) - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings.Builder: Sets the filename or descriptive identifier to associate with the audio data.
withFilter(TextSearchFilter) - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions.Builder: Sets the search filter.
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.
withImage(String, byte[]) - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.Builder: Set the image content to include in the chat message.
withImageUrl(String) - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.Builder: Set the URL of the image to include in the chat message.
withImageUrl(URL) - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.Builder: Set the URL of the image to include in the chat message.
withIncludeTotalCount(boolean) - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions.Builder: Sets a value indicating whether to include the total count of search results.
withIncludeTotalCount(boolean) - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions.Builder: Sets a value indicating whether to include the total count of the results.
withIncludeVectors(boolean) - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions.Builder: Sets a value indicating whether to include vectors in the results.
withIndexKind(IndexKind) - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordVectorField.Builder: Sets the index kind.
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.
withJsonSchemaResponseFormat(Class<?>) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder: Set the response format to use a json schema generated for the given class.
withKernelHooks(KernelHooks) - Method in class com.microsoft.semantickernel.orchestration.InvocationContext.Builder: Add kernel hooks to the builder.
withLanguage(String) - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings.Builder: The language of the audio data as two-letter ISO-639-1 language code (e.g.
withMaxTokens(int) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder: Set the maximum number of tokens to generate in the output.
withMetadata(FunctionResultMetadata) - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent.Builder: Set the metadata associated with the content
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.audio.AudioContent.Builder: Sets the model ID.
withModelId(String) - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageImageContent.Builder: Set the model ID to use for the chat message.
withModelId(String) - Method in class com.microsoft.semantickernel.services.chatcompletion.message.ChatMessageTextContent.Builder: Set the model ID used to generate the content
withModelId(String) - Method in class com.microsoft.semantickernel.services.openai.OpenAiServiceBuilder: Sets the model ID for the service.
withName(String) - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField.Builder: Sets the name of the field.
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.
withObjectMapper(ObjectMapper) - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollectionOptions.Builder: Sets the object mapper.
withOpenAIAsyncClient(C) - Method in class com.microsoft.semantickernel.services.openai.OpenAiServiceBuilder: Sets the OpenAI client for the service
withOptions(VectorStoreTextSearchOptions) - Method in class com.microsoft.semantickernel.data.VectorStoreTextSearch.Builder: Sets the options.
withOutputVariable(OutputVariable<?>) - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig.Builder: Set the output variable of the prompt template config.
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(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<InputVariable>) - 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.
withPrompt(String) - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings.Builder: An optional hint to guide the model's style or continue from a prior audio segment.
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
withRecordClass(Class<Record>) - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollectionOptions.Builder: Sets the record class.
withRecordDefinition(VectorStoreRecordDefinition) - Method in class com.microsoft.semantickernel.data.VolatileVectorStoreRecordCollectionOptions.Builder: Sets the record definition.
withResponseFormat(ResponseFormat) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder: Set the response format to use for prompt execution.
withResponseFormat(ResponseFormat.Type) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder: Set the response format to use for prompt execution.
withResponseFormat(String) - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings.Builder: The requested format of the transcription response data, which will influence the content and detail of the result.
withResponseFormat(String) - Method in class com.microsoft.semantickernel.services.audio.TextToAudioExecutionSettings.Builder: Sets the response format, e.g "mp3", "opus", "aac", "flak"
withResultMapper(TextSearchResultMapper) - Method in class com.microsoft.semantickernel.data.VectorStoreTextSearch.Builder: Sets the result mapper.
withResultsPerPrompt(int) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder: Set the number of results to generate for each prompt.
withResultType(ContextVariableType) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation: Supply the result type of function invocation.
withResultType(Class) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation: Supply the result type of function invocation.
withResultTypeAutoConversion(Class) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation: Supply the result type of function invocation.
withReturnMode(InvocationReturnMode) - Method in class com.microsoft.semantickernel.orchestration.InvocationContext.Builder: Set the return mode for the invocation.
withReturnParameter(OutputVariable<?>) - 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.openai.OpenAiServiceBuilder: 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.
withSkip(int) - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions.Builder: Sets the offset of the results to return.
withSkip(int) - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions.Builder: Sets the offset of the results to return.
withSpeed(Double) - Method in class com.microsoft.semantickernel.services.audio.TextToAudioExecutionSettings.Builder: Sets the speed of the audio generation.
withStopSequences(List<String>) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder: Set the stop sequences to use for prompt execution.
withStorageName(String) - Method in class com.microsoft.semantickernel.data.vectorstorage.definition.VectorStoreRecordField.Builder: Sets the storage name of the field.
withStringMapper(TextSearchStringMapper) - Method in class com.microsoft.semantickernel.data.VectorStoreTextSearch.Builder: Sets the string mapper.
withTarget(Object) - Method in class com.microsoft.semantickernel.semanticfunctions.KernelFunctionFromMethod.Builder: Sets the target to use to build the function.
withTelemetry(SemanticKernelTelemetry) - Method in class com.microsoft.semantickernel.orchestration.FunctionInvocation: Supply a tracer to the function invocation.
withTelemetry(SemanticKernelTelemetry) - Method in class com.microsoft.semantickernel.orchestration.InvocationContext.Builder: Add a tracer to the builder.
withTemperature(double) - Method in class com.microsoft.semantickernel.orchestration.PromptExecutionSettings.Builder: Set the temperature setting for prompt execution.
withTemperature(Double) - Method in class com.microsoft.semantickernel.services.audio.AudioToTextExecutionSettings.Builder: The randomness of the generated text.
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.
withTextEmbeddingGenerationService(TextEmbeddingGenerationService) - Method in class com.microsoft.semantickernel.data.VectorStoreTextSearch.Builder: Sets the text embedding generation service.
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.
withTop(int) - Method in class com.microsoft.semantickernel.data.textsearch.TextSearchOptions.Builder: Sets the limit of the number of results to return.
withTop(int) - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions.Builder: Sets the limit of the number of results to return.
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
withVectorFieldName(String) - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions.Builder: Sets the name of the vector field.
withVectorizedSearch(VectorizedSearch<Record>) - Method in class com.microsoft.semantickernel.data.VectorStoreTextSearch.Builder: Sets the vectorized search.
withVectorSearchFilter(VectorSearchFilter) - Method in class com.microsoft.semantickernel.data.vectorstorage.options.VectorSearchOptions.Builder: Sets the vector search filter.
withVoice(String) - Method in class com.microsoft.semantickernel.services.audio.TextToAudioExecutionSettings.Builder: Sets the voice to use for the audio generation.

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