Index (Semantic Kernel API 0.2.13-alpha API)

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

A

AbstractSKContext - Class in com.microsoft.semantickernel.orchestration: Semantic Kernel context
AbstractSkFunction<RequestConfiguration> - Class in com.microsoft.semantickernel.orchestration: Abstract implementation of the SKFunction interface.
AbstractSkFunction(List<ParameterView>, String, String, String, List<ParameterView>, KernelSkillsSupplier) - Constructor for class com.microsoft.semantickernel.orchestration.AbstractSkFunction: Constructor.
ACCESS_DENIED - com.microsoft.semantickernel.ai.AIException.ErrorCodes: Access denied.
addMessage(ChatHistory.AuthorRoles, String) - Method in class com.microsoft.semantickernel.chatcompletion.ChatHistory: Add a message to the chat history
aggregatePartitionedResultsAsync(List<String>, SKContext) - Method in interface com.microsoft.semantickernel.textcompletion.CompletionSKFunction: Method to aggregate partitioned results of a semantic function.
AIException - Exception in com.microsoft.semantickernel.ai: AI logic exception
AIException(AIException.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.ai.AIException: Initializes a new instance of the AIException class.
AIException(AIException.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.ai.AIException: Initializes a new instance of the AIException class.
AIException(AIException.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.ai.AIException: Initializes a new instance of the AIException class.
AIException.ErrorCodes - Enum in com.microsoft.semantickernel.ai: Error codes
AIFunction<RequestConfiguration extends AIRequestSettings> - Class in com.microsoft.semantickernel.orchestration
AIFunction(List<ParameterView>, String, String, String, List<ParameterView>, KernelSkillsSupplier, AIServiceSupplier) - Constructor for class com.microsoft.semantickernel.orchestration.AIFunction: Constructor.
AIRequestSettings - Class in com.microsoft.semantickernel.ai: Request settings for an AI request.
AIRequestSettings(String, String) - Constructor for class com.microsoft.semantickernel.ai.AIRequestSettings
AIService - Interface in com.microsoft.semantickernel.services: Marker interface for AI services
AIServiceCollection - Class in com.microsoft.semantickernel.services: A collection that can hold AI services
AIServiceCollection() - Constructor for class com.microsoft.semantickernel.services.AIServiceCollection
AIServiceProvider - Interface in com.microsoft.semantickernel.services
AIServiceSupplier - Interface in com.microsoft.semantickernel.services
appendToVariable(String, String) - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
appendToVariable(String, String) - Method in interface com.microsoft.semantickernel.orchestration.SKContext: Appends data to the given key
appendToVariable(String, String) - Method in interface com.microsoft.semantickernel.orchestration.WritableContextVariables
asMap() - Method in interface com.microsoft.semantickernel.orchestration.ContextVariables: Get variables as a map
asMap() - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlySkillCollection: Get this collection as an unmodifiable map
Assistant - com.microsoft.semantickernel.chatcompletion.ChatHistory.AuthorRoles
ATTEMPTED_TO_ACCESS_NONEXISTENT_COLLECTION - com.microsoft.semantickernel.memory.MemoryException.ErrorCodes: Attempted to access a memory collection that does not exist.

B

bestOf(int) - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
Block - Class in com.microsoft.semantickernel.templateengine.blocks: Base class for blocks parsed from a prompt template
Block(String, BlockTypes) - Constructor for class com.microsoft.semantickernel.templateengine.blocks.Block: Base constructor
BlockTypes - Enum in com.microsoft.semantickernel.templateengine.blocks
build() - Method in interface com.microsoft.semantickernel.builders.SemanticKernelBuilder: Build the object.
build() - Method in class com.microsoft.semantickernel.KernelConfig.Builder
build() - Method in class com.microsoft.semantickernel.services.AIServiceCollection: Builds an AIServiceProvider from the registered services and default names.
build() - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
build(ContextVariables, SemanticTextMemory, ReadOnlySkillCollection) - Method in interface com.microsoft.semantickernel.orchestration.SKContext
build(Map<String, String>) - Method in interface com.microsoft.semantickernel.orchestration.WritableContextVariables.Builder: Builds an instance with the given variables
Buildable - Interface in com.microsoft.semantickernel.builders: A marker interface for all classes that are buildable, typically via obtaining a builder from SKBuilders.
builder() - Static method in interface com.microsoft.semantickernel.chatcompletion.ChatCompletion
builder() - Static method in interface com.microsoft.semantickernel.Kernel
builder() - Static method in class com.microsoft.semantickernel.KernelConfig
builder() - Static method in interface com.microsoft.semantickernel.memory.MemoryStore
builder() - Static method in interface com.microsoft.semantickernel.memory.SemanticTextMemory
builder() - Static method in interface com.microsoft.semantickernel.orchestration.ContextVariables
builder() - Static method in interface com.microsoft.semantickernel.orchestration.SKContext
builder() - Static method in interface com.microsoft.semantickernel.semanticfunctions.PromptTemplate
builder() - Static method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlySkillCollection
builder() - Static method in interface com.microsoft.semantickernel.templateengine.PromptTemplateEngine
builder() - Static method in interface com.microsoft.semantickernel.textcompletion.CompletionSKFunction
builder() - Static method in interface com.microsoft.semantickernel.textcompletion.TextCompletion
Builder() - Constructor for class com.microsoft.semantickernel.KernelConfig.Builder
Builder() - Constructor for class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
Builder(CompletionRequestSettings) - Constructor for class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
BuildersSingleton - Enum in com.microsoft.semantickernel.builders: Enum singleton that service loads builder implementations

C

chatCompletion() - Static method in class com.microsoft.semantickernel.SKBuilders
ChatCompletion<ChatHistoryType extends ChatHistory> - Interface in com.microsoft.semantickernel.chatcompletion
ChatCompletion.Builder<ChatHistoryType extends ChatHistory> - Interface in com.microsoft.semantickernel.chatcompletion
ChatHistory - Class in com.microsoft.semantickernel.chatcompletion: Provides a history of messages between the User, Assistant and System
ChatHistory() - Constructor for class com.microsoft.semantickernel.chatcompletion.ChatHistory
ChatHistory.AuthorRoles - Enum in com.microsoft.semantickernel.chatcompletion: Role of the author of a chat message
ChatHistory.Message - Class in com.microsoft.semantickernel.chatcompletion: Chat message representation
ChatRequestSettings - Class in com.microsoft.semantickernel.chatcompletion: Settings for a chat completion request
ChatRequestSettings() - Constructor for class com.microsoft.semantickernel.chatcompletion.ChatRequestSettings
ChatRequestSettings(CompletionRequestSettings) - Constructor for class com.microsoft.semantickernel.chatcompletion.ChatRequestSettings
CLASSPATH - com.microsoft.semantickernel.util.EmbeddedResourceLoader.ResourceLocation
CLASSPATH_ROOT - com.microsoft.semantickernel.util.EmbeddedResourceLoader.ResourceLocation
clone(SKContext) - Method in interface com.microsoft.semantickernel.orchestration.SKContext.Builder
Code - com.microsoft.semantickernel.templateengine.blocks.BlockTypes: Code block type
com.microsoft.semantickernel - package com.microsoft.semantickernel
com.microsoft.semantickernel.ai - package com.microsoft.semantickernel.ai
com.microsoft.semantickernel.ai.embeddings - package com.microsoft.semantickernel.ai.embeddings
com.microsoft.semantickernel.builders - package com.microsoft.semantickernel.builders
com.microsoft.semantickernel.chatcompletion - package com.microsoft.semantickernel.chatcompletion
com.microsoft.semantickernel.exceptions - package com.microsoft.semantickernel.exceptions
com.microsoft.semantickernel.extensions - package com.microsoft.semantickernel.extensions
com.microsoft.semantickernel.memory - package com.microsoft.semantickernel.memory
com.microsoft.semantickernel.orchestration - package com.microsoft.semantickernel.orchestration
com.microsoft.semantickernel.planner - package com.microsoft.semantickernel.planner
com.microsoft.semantickernel.semanticfunctions - package com.microsoft.semantickernel.semanticfunctions
com.microsoft.semantickernel.services - package com.microsoft.semantickernel.services
com.microsoft.semantickernel.skilldefinition - package com.microsoft.semantickernel.skilldefinition
com.microsoft.semantickernel.skilldefinition.annotations - package com.microsoft.semantickernel.skilldefinition.annotations
com.microsoft.semantickernel.templateengine - package com.microsoft.semantickernel.templateengine
com.microsoft.semantickernel.templateengine.blocks - package com.microsoft.semantickernel.templateengine.blocks
com.microsoft.semantickernel.textcompletion - package com.microsoft.semantickernel.textcompletion
com.microsoft.semantickernel.util - package com.microsoft.semantickernel.util
completeAsync(String, CompletionRequestSettings) - Method in interface com.microsoft.semantickernel.textcompletion.TextCompletion: Creates a completion for the prompt and settings.
completeStreamAsync(String, CompletionRequestSettings) - Method in interface com.microsoft.semantickernel.textcompletion.TextCompletion: Creates a completion for the prompt and settings.
completionFunctions() - Static method in class com.microsoft.semantickernel.SKBuilders
completionRequestSettings() - Static method in class com.microsoft.semantickernel.SKBuilders
CompletionRequestSettings - Class in com.microsoft.semantickernel.textcompletion: Settings for a text completion request
CompletionRequestSettings() - Constructor for class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings: Create a new settings object with default values.
CompletionRequestSettings(double, double, double, double, int) - Constructor for class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings: Create a new settings object with the given values.
CompletionRequestSettings(double, double, double, double, int, int, String, List<String>, String, String) - Constructor for class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings: Create a new settings object with the given values.
CompletionRequestSettings(CompletionRequestSettings) - Constructor for class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings
CompletionRequestSettings.Builder - Class in com.microsoft.semantickernel.textcompletion: Builder for CompletionRequestSettings
CompletionSKFunction - Interface in com.microsoft.semantickernel.textcompletion: Semantic function for text completion
CompletionSKFunction.Builder - Interface in com.microsoft.semantickernel.textcompletion: Builder for completion functions
CompletionType - Enum in com.microsoft.semantickernel.textcompletion: Defines if an AI service supports streaming or non-streaming completion requests.
CONFIGURATION_NOT_FOUND - com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes
ConfigurationException - Exception in com.microsoft.semantickernel.exceptions: Kernel logic exception
ConfigurationException(ConfigurationException.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.exceptions.ConfigurationException
ConfigurationException(ConfigurationException.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.exceptions.ConfigurationException
ConfigurationException(ConfigurationException.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.exceptions.ConfigurationException
ConfigurationException.ErrorCodes - Enum in com.microsoft.semantickernel.exceptions
context() - Static method in class com.microsoft.semantickernel.SKBuilders
ContextVariables - Interface in com.microsoft.semantickernel.orchestration: Context Variables is a data structure that holds temporary data while a task is being performed.
ContextVariables.Builder - Interface in com.microsoft.semantickernel.orchestration: Builder for ContextVariables
copy() - Method in class com.microsoft.semantickernel.memory.NullMemory
copy() - Method in interface com.microsoft.semantickernel.memory.SemanticTextMemory
copy() - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
copy() - Method in interface com.microsoft.semantickernel.orchestration.SKContext: Clones the context
copy() - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlyFunctionCollection
copy() - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlySkillCollection
cosineSimilarity(Embedding) - Method in class com.microsoft.semantickernel.ai.embeddings.Embedding: Calculates the cosine similarity of this vector with another.
COULD_NOT_READ_CONFIGURATION - com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes
createCollectionAsync(String) - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Creates a new collection in the data store.
createNewChat(String) - Method in interface com.microsoft.semantickernel.chatcompletion.ChatCompletion: Create a new empty chat instance

D

DataEntryBase - Class in com.microsoft.semantickernel.memory: A base class for data entries.
DataEntryBase(String, ZonedDateTime) - Constructor for class com.microsoft.semantickernel.memory.DataEntryBase: Creates an instance of a DataEntryBase.
DefaultAIServiceProvider - Class in com.microsoft.semantickernel.services: Default implementation of AIServiceProvider
DefaultAIServiceProvider(Map<Class<? extends AIService>, Map<String, Supplier<? extends AIService>>>, Map<Class<? extends AIService>, String>) - Constructor for class com.microsoft.semantickernel.services.DefaultAIServiceProvider
defaultCompletionType() - Method in interface com.microsoft.semantickernel.textcompletion.TextCompletion: Returns the default completion type for this service.
DefaultNamedServiceProvider<T> - Class in com.microsoft.semantickernel.services: Default implementation of NamedServiceProvider
DefaultNamedServiceProvider(Map<Class<? extends T>, Map<String, Supplier<? extends T>>>, Map<Class<? extends T>, String>) - Constructor for class com.microsoft.semantickernel.services.DefaultNamedServiceProvider
defaultValue() - Method in annotation type com.microsoft.semantickernel.skilldefinition.annotations.SKFunctionParameters
DefineSKFunction - Annotation Type in com.microsoft.semantickernel.skilldefinition.annotations: Annotation that defines a method that can be invoked as a native function
deleteCollectionAsync(String) - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Deletes a collection from the data store.
describe() - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: Returns a description of the function, including parameters.
description() - Method in annotation type com.microsoft.semantickernel.skilldefinition.annotations.DefineSKFunction
description() - Method in annotation type com.microsoft.semantickernel.skilldefinition.annotations.SKFunctionInputAttribute
description() - Method in annotation type com.microsoft.semantickernel.skilldefinition.annotations.SKFunctionParameters
divide(float) - Method in class com.microsoft.semantickernel.ai.embeddings.Embedding: Divide the Embedding vector by a divisor.
doesCollectionExistAsync(String) - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Determines if a collection exists in the data store.
dot(Embedding) - Method in class com.microsoft.semantickernel.ai.embeddings.Embedding: Calculates the dot product of this Embedding with another.

E

EmbeddedResourceLoader - Class in com.microsoft.semantickernel.util
EmbeddedResourceLoader() - Constructor for class com.microsoft.semantickernel.util.EmbeddedResourceLoader
EmbeddedResourceLoader.ResourceLocation - Enum in com.microsoft.semantickernel.util
Embedding - Class in com.microsoft.semantickernel.ai.embeddings: Represents a strongly typed vector of numeric data.
Embedding() - Constructor for class com.microsoft.semantickernel.ai.embeddings.Embedding: Initializes a new instance of the Embedding class.
Embedding(List<Float>) - Constructor for class com.microsoft.semantickernel.ai.embeddings.Embedding: Initializes a new instance of the Embedding class that contains numeric elements copied from the specified collection
EmbeddingGeneration<TValue> - Interface in com.microsoft.semantickernel.ai.embeddings: Interface for text embedding generation services
EmbeddingGeneration.Builder<T,E extends EmbeddingGeneration<T>> - Interface in com.microsoft.semantickernel.ai.embeddings
empty() - Static method in class com.microsoft.semantickernel.ai.embeddings.Embedding
equals(Object) - Method in class com.microsoft.semantickernel.memory.MemoryRecord
equals(Object) - Method in class com.microsoft.semantickernel.memory.MemoryRecordMetadata
euclideanLength() - Method in class com.microsoft.semantickernel.ai.embeddings.Embedding: Calculates the Euclidean length of this vector.
extractBlocks(String) - Method in interface com.microsoft.semantickernel.templateengine.PromptTemplateEngine: Given a prompt template string, extract all the blocks (text, variables, function calls)

F

failed(SKContext, String, Exception) - Method in interface com.microsoft.semantickernel.orchestration.SKContext.Builder: Clones the given context and sets its result to the given error
FAILED_TO_CREATE_COLLECTION - com.microsoft.semantickernel.memory.MemoryException.ErrorCodes: Failed to create collection.
FAILED_TO_DELETE_COLLECTION - com.microsoft.semantickernel.memory.MemoryException.ErrorCodes: Failed to delete collection.
FILESYSTEM - com.microsoft.semantickernel.util.EmbeddedResourceLoader.ResourceLocation
findServiceLoader(Class<T>, String) - Static method in class com.microsoft.semantickernel.builders.ServiceLoadUtil
frequencyPenalty(double) - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
fromJsonMetadata(String, Embedding, String, ZonedDateTime) - Static method in class com.microsoft.semantickernel.memory.MemoryRecord
fromMetadata(MemoryRecordMetadata, Embedding, String, ZonedDateTime) - Static method in class com.microsoft.semantickernel.memory.MemoryRecord: Create a memory record from a memory record's metadata.
FUNCTION_CONFIGURATION_ERROR - com.microsoft.semantickernel.KernelException.ErrorCodes
FUNCTION_INVOCATION_ERROR - com.microsoft.semantickernel.KernelException.ErrorCodes
FUNCTION_NOT_AVAILABLE - com.microsoft.semantickernel.KernelException.ErrorCodes
FUNCTION_NOT_FOUND - com.microsoft.semantickernel.skilldefinition.FunctionNotFound.ErrorCodes
FUNCTION_NOT_REGISTERED - com.microsoft.semantickernel.orchestration.FunctionNotRegisteredException.ErrorCodes
FUNCTION_OVERLOAD_NOT_SUPPORTED - com.microsoft.semantickernel.KernelException.ErrorCodes
FUNCTION_TYPE_NOT_SUPPORTED - com.microsoft.semantickernel.ai.AIException.ErrorCodes: Function type not supported.
FUNCTION_TYPE_NOT_SUPPORTED - com.microsoft.semantickernel.KernelException.ErrorCodes
FunctionId - com.microsoft.semantickernel.templateengine.blocks.BlockTypes: Function block type
FunctionNotFound - Exception in com.microsoft.semantickernel.skilldefinition
FunctionNotFound(FunctionNotFound.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.skilldefinition.FunctionNotFound
FunctionNotFound(FunctionNotFound.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.skilldefinition.FunctionNotFound
FunctionNotFound(FunctionNotFound.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.skilldefinition.FunctionNotFound
FunctionNotFound.ErrorCodes - Enum in com.microsoft.semantickernel.skilldefinition
FunctionNotRegisteredException - Exception in com.microsoft.semantickernel.orchestration
FunctionNotRegisteredException(FunctionNotRegisteredException.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.orchestration.FunctionNotRegisteredException
FunctionNotRegisteredException(FunctionNotRegisteredException.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.orchestration.FunctionNotRegisteredException
FunctionNotRegisteredException(FunctionNotRegisteredException.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.orchestration.FunctionNotRegisteredException
FunctionNotRegisteredException.ErrorCodes - Enum in com.microsoft.semantickernel.orchestration
FunctionView - Class in com.microsoft.semantickernel.skilldefinition: Class used to copy and export data from the skill collection.
FunctionView(String, String, String, List<ParameterView>, boolean, boolean) - Constructor for class com.microsoft.semantickernel.skilldefinition.FunctionView: Create a function view.

G

generateEmbeddingsAsync(List<TValue>) - Method in interface com.microsoft.semantickernel.ai.embeddings.EmbeddingGeneration: Generates a list of embeddings associated to the data
generateMessageAsync(ChatHistoryType, ChatRequestSettings) - Method in interface com.microsoft.semantickernel.chatcompletion.ChatCompletion: Generate a new chat message
generateMessageStream(ChatHistoryType, ChatRequestSettings) - Method in interface com.microsoft.semantickernel.chatcompletion.ChatCompletion
get(String) - Method in interface com.microsoft.semantickernel.orchestration.ContextVariables: Return the variable with the given name
get(String, Class<T>) - Method in interface com.microsoft.semantickernel.services.AIServiceSupplier
getAdditionalMetadata() - Method in class com.microsoft.semantickernel.memory.MemoryRecordMetadata: Custom metadata associated with a memory.
getAll() - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlyFunctionCollection
getAllFunctions() - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlySkillCollection
getAsync(String, String, boolean) - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Gets a memory record from the data store.
getAsync(String, String, boolean) - Method in class com.microsoft.semantickernel.memory.NullMemory
getAsync(String, String, boolean) - Method in interface com.microsoft.semantickernel.memory.SemanticTextMemory: Fetch a memory by key.
getAuthorRoles() - Method in class com.microsoft.semantickernel.chatcompletion.ChatHistory.Message: Get the role of the message author
getBatchAsync(String, Collection<String>, boolean) - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Gets a batch of memory records from the data store.
getBestOf() - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings: The maximum number of completions to generate for each prompt.
getCollectionsAsync() - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Gets all collection names in the data store.
getCollectionsAsync() - Method in class com.microsoft.semantickernel.memory.NullMemory
getCollectionsAsync() - Method in interface com.microsoft.semantickernel.memory.SemanticTextMemory: Gets a group of all available collection names.
getCompletionRequestSettings() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig: A returns the configuration for the text completion
getConfig() - Method in interface com.microsoft.semantickernel.Kernel: Settings required to execute functions, including details about AI dependencies, e.g.
getConfig() - Method in class com.microsoft.semantickernel.semanticfunctions.SemanticFunctionConfig
getContent() - Method in class com.microsoft.semantickernel.chatcompletion.ChatHistory.Message: Get the message content
getContent() - Method in class com.microsoft.semantickernel.templateengine.blocks.Block: Get the block content
getDefaultValue() - Method in class com.microsoft.semantickernel.semanticfunctions.InputParameter: Default value when nothing is provided
getDefaultValue() - Method in class com.microsoft.semantickernel.skilldefinition.ParameterView
getDescription() - Method in class com.microsoft.semantickernel.memory.MemoryRecordMetadata: Optional title describing the content.
getDescription() - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
getDescription() - Method in interface com.microsoft.semantickernel.orchestration.SKFunction
getDescription() - Method in class com.microsoft.semantickernel.semanticfunctions.InputParameter: Parameter description for UI apps and planner.
getDescription() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig: Description
getDescription() - Method in class com.microsoft.semantickernel.skilldefinition.FunctionView
getDescription() - Method in class com.microsoft.semantickernel.skilldefinition.ParameterView
getEmbedding() - Method in class com.microsoft.semantickernel.memory.MemoryRecord: Gets the source content embeddings.
getErrorCode() - Method in exception com.microsoft.semantickernel.ai.AIException: Gets the error code.
getErrorCode() - Method in exception com.microsoft.semantickernel.exceptions.ConfigurationException
getErrorCode() - Method in exception com.microsoft.semantickernel.exceptions.NotSupportedException
getErrorCode() - Method in exception com.microsoft.semantickernel.exceptions.SkillsNotFoundException
getErrorCode() - Method in exception com.microsoft.semantickernel.KernelException
getErrorCode() - Method in exception com.microsoft.semantickernel.memory.MemoryException: Gets the error code for this exception.
getErrorCode() - Method in exception com.microsoft.semantickernel.orchestration.FunctionNotRegisteredException
getErrorCode() - Method in exception com.microsoft.semantickernel.planner.PlanningException: Gets the error code
getErrorCode() - Method in exception com.microsoft.semantickernel.skilldefinition.FunctionNotFound
getErrorMessage() - Method in enum com.microsoft.semantickernel.orchestration.FunctionNotRegisteredException.ErrorCodes
getExternalSourceName() - Method in class com.microsoft.semantickernel.memory.MemoryRecordMetadata: A value used to understand which external service owns the data, to avoid storing the information inside the URI.
getFrequencyPenalty() - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings: Number between -2.0 and 2.0.
getFunction(String) - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlyFunctionCollection
getFunction(String, Class<T>) - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlyFunctionCollection: Get function with the given SKFunction type argument.
getFunction(String, Class<T>) - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlySkillCollection: Get function with name from the global scope
getFunction(String, String) - Method in interface com.microsoft.semantickernel.Kernel: Obtains a semantic function with the given name
getFunction(String, String, Class<T>) - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlySkillCollection
getFunctions(String) - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlySkillCollection
getId() - Method in class com.microsoft.semantickernel.memory.MemoryRecordMetadata: Unique identifier.
getInput() - Method in interface com.microsoft.semantickernel.orchestration.ContextVariables: Get the input (entry in the MAIN_KEY slot)
getInput() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig
getInstance() - Static method in class com.microsoft.semantickernel.memory.NullMemory: Gets the singleton instance of NullMemory}.
getInstance(Kernel) - Static method in interface com.microsoft.semantickernel.skilldefinition.KernelSkillsSupplier
getInstance(Class<T>) - Method in enum com.microsoft.semantickernel.builders.BuildersSingleton
getKey() - Method in class com.microsoft.semantickernel.memory.DataEntryBase: Gets the key of the data.
getLastErrorDescription() - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
getLastException() - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
getLastMessage() - Method in class com.microsoft.semantickernel.chatcompletion.ChatHistory: Get last message
getMaxTokens() - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings: The maximum number of tokens to generate in the completion.
getMemory() - Method in interface com.microsoft.semantickernel.Kernel: Get the SemanticTextMemory in use.
getMessage() - Method in enum com.microsoft.semantickernel.ai.AIException.ErrorCodes: Gets the error message.
getMessage() - Method in enum com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes
getMessage() - Method in enum com.microsoft.semantickernel.KernelException.ErrorCodes
getMessage() - Method in enum com.microsoft.semantickernel.memory.MemoryException.ErrorCodes: Gets the error message.
getMessage() - Method in enum com.microsoft.semantickernel.planner.PlanningException.ErrorCodes
getMessage(String) - Method in enum com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes
getMessages() - Method in class com.microsoft.semantickernel.chatcompletion.ChatHistory: Get the chat history
getMetadata() - Method in class com.microsoft.semantickernel.memory.MemoryQueryResult
getMetadata() - Method in class com.microsoft.semantickernel.memory.MemoryRecord: Gets the metadata associated with a Semantic Kernel memory.
getModelId() - Method in class com.microsoft.semantickernel.ai.AIRequestSettings
getName() - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
getName() - Method in interface com.microsoft.semantickernel.orchestration.SKFunction
getName() - Method in class com.microsoft.semantickernel.semanticfunctions.InputParameter: Name of the parameter to pass to the function.
getName() - Method in class com.microsoft.semantickernel.skilldefinition.FunctionView
getName() - Method in class com.microsoft.semantickernel.skilldefinition.ParameterView
getNearestMatchAsync(String, Embedding, float, boolean) - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Gets the nearest match to the Embedding of type Float.
getNearestMatchesAsync(String, Embedding, int, float, boolean) - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Gets the nearest matches to the Embedding of type Float.
getParameters() - Method in class com.microsoft.semantickernel.semanticfunctions.InputConfig
getParameters() - Method in interface com.microsoft.semantickernel.semanticfunctions.PromptTemplate: Get the list of parameters required by the template, using configuration and template info
getParameters() - Method in class com.microsoft.semantickernel.skilldefinition.FunctionView: List of function parameters
getParametersView() - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction: The parameters of the function.
getPresencePenalty() - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings: Number between -2.0 and 2.0.
getPromptTemplateEngine() - Method in interface com.microsoft.semantickernel.Kernel: Reference to the engine rendering prompt templates
getRelevance() - Method in class com.microsoft.semantickernel.memory.MemoryQueryResult
getResult() - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
getResult() - Method in interface com.microsoft.semantickernel.orchestration.SKContext: Obtain the result of the execution that produced this context.
getSchema() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig
getSemanticFunctionBuilder() - Method in interface com.microsoft.semantickernel.Kernel: Get a completion function builder, functions created with this builder will be registered on the kernel
getSemanticMemory() - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
getSemanticMemory() - Method in interface com.microsoft.semantickernel.orchestration.SKContext: Provides access to the context's semantic memory
getSerializedEmbedding() - Method in class com.microsoft.semantickernel.memory.MemoryRecord
getSerializedMetadata() - Method in class com.microsoft.semantickernel.memory.MemoryRecord
getService(String, Class<T>) - Method in interface com.microsoft.semantickernel.Kernel: Obtains the service with the given name and type
getService(String, Class<U>) - Method in class com.microsoft.semantickernel.services.DefaultNamedServiceProvider: Gets the service of the specified type and name, or null if not found.
getService(String, Class<U>) - Method in interface com.microsoft.semantickernel.services.NamedServiceProvider: Gets the service of the specified type and name, or null if not found.
getServiceId() - Method in class com.microsoft.semantickernel.ai.AIRequestSettings
getSkill(String) - Method in interface com.microsoft.semantickernel.SkillExecutor: Get function collection with the skill name
getSkillName() - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
getSkillName() - Method in interface com.microsoft.semantickernel.orchestration.SKFunction
getSkillName() - Method in class com.microsoft.semantickernel.skilldefinition.FunctionView
getSkillName() - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlyFunctionCollection
getSkills() - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
getSkills() - Method in interface com.microsoft.semantickernel.orchestration.SKContext: Provides access to the skills within this context
getSkills() - Method in interface com.microsoft.semantickernel.SkillExecutor
getSkillsSupplier() - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction: Gets the skill supplier.
getStopSequences() - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings: Sequences where the completion will stop generating further tokens.
getStreamingChatCompletionsAsync(ChatHistoryType, ChatRequestSettings) - Method in interface com.microsoft.semantickernel.chatcompletion.ChatCompletion
getTemperature() - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings: Temperature controls the randomness of the completion.
getTemplate() - Method in class com.microsoft.semantickernel.semanticfunctions.SemanticFunctionConfig
getText() - Method in class com.microsoft.semantickernel.memory.MemoryRecordMetadata: Source text, available only when the memory is not an external source.
getTimestamp() - Method in class com.microsoft.semantickernel.memory.DataEntryBase: Gets the timestamp of the data.
getTopP() - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings: TopP controls the diversity of the completion.
getType() - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: The type of the configuration argument that will be provided when the function is invoked
getType() - Method in class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig
getType() - Method in class com.microsoft.semantickernel.templateengine.blocks.Block: Get the block type
getUser() - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings: A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse
getVariables() - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
getVariables() - Method in interface com.microsoft.semantickernel.orchestration.SKContext: Return a copy of all variables within the context
getVector() - Method in class com.microsoft.semantickernel.ai.embeddings.Embedding: Return the embedding vector as a read-only list.
GlobalSkill - Static variable in interface com.microsoft.semantickernel.skilldefinition.ReadOnlySkillCollection

H

hasFunction(String) - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlySkillCollection
hasFunction(String, String) - Method in interface com.microsoft.semantickernel.skilldefinition.ReadOnlySkillCollection
hashCode() - Method in class com.microsoft.semantickernel.memory.MemoryRecord
hashCode() - Method in class com.microsoft.semantickernel.memory.MemoryRecordMetadata

I

importSemanticSkillFromDirectory(String, String, PromptTemplateEngine) - Static method in class com.microsoft.semantickernel.extensions.KernelExtensions
importSemanticSkillFromResourcesDirectory(String, String, String, Class, PromptTemplateEngine) - Static method in class com.microsoft.semantickernel.extensions.KernelExtensions
importSkill(Object, String) - Method in interface com.microsoft.semantickernel.SkillExecutor: Imports the native functions annotated on the given object as a skill.
importSkill(String, Map<String, SemanticFunctionConfig>) - Method in interface com.microsoft.semantickernel.SkillExecutor: Import a set of skills
importSkillFromDirectory(String, String) - Method in interface com.microsoft.semantickernel.SkillExecutor: Imports the native functions annotated on the given object as a skill.
importSkillFromDirectory(String, String, String) - Method in interface com.microsoft.semantickernel.SkillExecutor: Imports the native functions annotated on the given object as a skill.
importSkillFromResources(String, String, String) - Method in interface com.microsoft.semantickernel.SkillExecutor: Imports a skill using ClassLoader.getResourceAsStream to load skills from the classpath.
importSkillFromResources(String, String, String, Class) - Method in interface com.microsoft.semantickernel.SkillExecutor: Imports a skill using clazz.getResourceAsStream to load skills from the classpath.
importSkillsFromDirectory(String, String...) - Method in interface com.microsoft.semantickernel.SkillExecutor: Imports the native functions annotated on the given object as a skill.
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
InputParameter - Class in com.microsoft.semantickernel.semanticfunctions: Input parameter for semantic functions
InputParameter(String, String, String) - Constructor for class com.microsoft.semantickernel.semanticfunctions.InputParameter
INST - com.microsoft.semantickernel.builders.BuildersSingleton
INVALID_CONFIGURATION - com.microsoft.semantickernel.ai.AIException.ErrorCodes: Invalid configuration.
INVALID_CONFIGURATION - com.microsoft.semantickernel.planner.PlanningException.ErrorCodes
INVALID_FUNCTION_DESCRIPTION - com.microsoft.semantickernel.KernelException.ErrorCodes
INVALID_FUNCTION_TYPE - com.microsoft.semantickernel.KernelException.ErrorCodes
INVALID_GOAL - com.microsoft.semantickernel.planner.PlanningException.ErrorCodes
INVALID_PLAN - com.microsoft.semantickernel.planner.PlanningException.ErrorCodes
INVALID_REQUEST - com.microsoft.semantickernel.ai.AIException.ErrorCodes: Invalid request.
INVALID_RESPONSE_CONTENT - com.microsoft.semantickernel.ai.AIException.ErrorCodes: Invalid response.
INVALID_SERVICE_CONFIGURATION - com.microsoft.semantickernel.KernelException.ErrorCodes
invokeAsync() - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
invokeAsync() - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: Invokes the function
invokeAsync(SKContext) - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
invokeAsync(SKContext) - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: Invokes the function with the given context and settings
invokeAsync(SKContext, RequestConfiguration) - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
invokeAsync(SKContext, RequestConfiguration) - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: Invokes the function with the given context and settings
invokeAsync(String) - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
invokeAsync(String) - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: Invokes the function with the given input
invokeAsync(String, SKContext, RequestConfiguration) - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
invokeAsync(String, SKContext, RequestConfiguration) - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: Invokes the function with the given input, context and settings
invokeAsync(String, RequestConfiguration) - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
invokeAsync(String, RequestConfiguration) - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: Invokes the function with the given context and settings
invokeWithCustomInputAsync(ContextVariables, SemanticTextMemory, ReadOnlySkillCollection) - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
invokeWithCustomInputAsync(ContextVariables, SemanticTextMemory, ReadOnlySkillCollection) - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: Invokes the function with the given input, context and settings
isErrorOccurred() - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
isNullOrEmpty(String) - Static method in class com.microsoft.semantickernel.Verify
isNullOrWhiteSpace(String) - Static method in class com.microsoft.semantickernel.Verify
isReference() - Method in class com.microsoft.semantickernel.memory.MemoryRecordMetadata: Whether the source data used to calculate embeddings are stored in the local storage provider or is available through and external service, such as web site, MS Graph, etc.
isValid() - Method in class com.microsoft.semantickernel.templateengine.blocks.Block: Check if the block content is valid.

K

kernel() - Static method in class com.microsoft.semantickernel.SKBuilders
Kernel - Interface in com.microsoft.semantickernel: Interface for the semantic kernel.
Kernel.Builder - Interface in com.microsoft.semantickernel
kernelConfig() - Static method in class com.microsoft.semantickernel.SKBuilders
KernelConfig - Class in com.microsoft.semantickernel
KernelConfig() - Constructor for class com.microsoft.semantickernel.KernelConfig
KernelConfig.Builder - Class in com.microsoft.semantickernel
KernelException - Exception in com.microsoft.semantickernel: Kernel logic exception
KernelException(KernelException.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.KernelException
KernelException(KernelException.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.KernelException
KernelException(KernelException.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.KernelException
KernelException.ErrorCodes - Enum in com.microsoft.semantickernel
KernelExtensions - Class in com.microsoft.semantickernel.extensions
KernelSkillsSupplier - Interface in com.microsoft.semantickernel.skilldefinition

L

localRecord(String, String, String, Embedding, String, String, ZonedDateTime) - Static method in class com.microsoft.semantickernel.memory.MemoryRecord: Prepare an instance for a memory stored in the internal storage provider.

M

MAIN_KEY - Static variable in interface com.microsoft.semantickernel.orchestration.ContextVariables: Default key for the main input
maxTokens(int) - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
MEMORY_NOT_FOUND - com.microsoft.semantickernel.memory.MemoryException.ErrorCodes: Attempted to access a memory that does not exist.
MemoryException - Exception in com.microsoft.semantickernel.memory: Exception thrown for errors related to memory logic.
MemoryException(MemoryException.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.memory.MemoryException: Initializes a new instance of the MemoryException class with a provided error code.
MemoryException(MemoryException.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.memory.MemoryException: Initializes a new instance of the MemoryException class with a provided error code and message.
MemoryException(MemoryException.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.memory.MemoryException: Initializes a new instance of the MemoryException class with a provided error code, message, and inner exception.
MemoryException.ErrorCodes - Enum in com.microsoft.semantickernel.memory: Semantic kernel memory error codes.
MemoryQueryResult - Class in com.microsoft.semantickernel.memory: Copy of metadata associated with a memory entry.
MemoryQueryResult(MemoryRecordMetadata, double) - Constructor for class com.microsoft.semantickernel.memory.MemoryQueryResult: Create a new instance of MemoryQueryResult
MemoryRecord - Class in com.microsoft.semantickernel.memory: A record in a Semantic Kernel memory.
MemoryRecord(MemoryRecordMetadata, Embedding, String, ZonedDateTime) - Constructor for class com.microsoft.semantickernel.memory.MemoryRecord: Creates an instance of a MemoryRecord.
MemoryRecordMetadata - Class in com.microsoft.semantickernel.memory: Class representing the metadata associated with a Semantic Kernel memory.
MemoryRecordMetadata(boolean, String, String, String, String, String) - Constructor for class com.microsoft.semantickernel.memory.MemoryRecordMetadata: Constructor.
memoryStore() - Static method in class com.microsoft.semantickernel.SKBuilders
MemoryStore - Interface in com.microsoft.semantickernel.memory: An interface for storing and retrieving indexed MemoryRecord objects in a data store.
MemoryStore.Builder<T extends MemoryStore> - Interface in com.microsoft.semantickernel.memory
Message(ChatHistory.AuthorRoles, String) - Constructor for class com.microsoft.semantickernel.chatcompletion.ChatHistory.Message: Create a new instance
MODEL_NOT_AVAILABLE - com.microsoft.semantickernel.ai.AIException.ErrorCodes: Model not available.
modelId(String) - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
multiply(float) - Method in class com.microsoft.semantickernel.ai.embeddings.Embedding: Multiply the Embedding vector by a multiplier.

N

name() - Method in annotation type com.microsoft.semantickernel.skilldefinition.annotations.DefineSKFunction
name() - Method in annotation type com.microsoft.semantickernel.skilldefinition.annotations.SKFunctionParameters
NamedServiceProvider<T> - Interface in com.microsoft.semantickernel.services
NO_DEFAULT_VALUE - Static variable in annotation type com.microsoft.semantickernel.skilldefinition.annotations.SKFunctionParameters
NO_RESPONSE - com.microsoft.semantickernel.ai.AIException.ErrorCodes: No response.
NO_VALID_CONFIGURATIONS_FOUND - com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes
NON_STREAMING - com.microsoft.semantickernel.textcompletion.CompletionType
normalize() - Method in class com.microsoft.semantickernel.ai.embeddings.Embedding: Normalizes the underlying vector, such that the Euclidean length is 1.
NOT_SUPPORTED - com.microsoft.semantickernel.exceptions.NotSupportedException.ErrorCodes
notNull(Object) - Static method in class com.microsoft.semantickernel.Verify
NotSupportedException - Exception in com.microsoft.semantickernel.exceptions
NotSupportedException(NotSupportedException.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.exceptions.NotSupportedException
NotSupportedException(NotSupportedException.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.exceptions.NotSupportedException
NotSupportedException(NotSupportedException.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.exceptions.NotSupportedException
NotSupportedException.ErrorCodes - Enum in com.microsoft.semantickernel.exceptions
NullMemory - Class in com.microsoft.semantickernel.memory: Implementation of SemanticTextMemory that stores nothing.
NullMemory() - Constructor for class com.microsoft.semantickernel.memory.NullMemory

P

parameters - Variable in class com.microsoft.semantickernel.semanticfunctions.InputConfig
ParameterView - Class in com.microsoft.semantickernel.skilldefinition
ParameterView(String) - Constructor for class com.microsoft.semantickernel.skilldefinition.ParameterView
ParameterView(String, String, String) - Constructor for class com.microsoft.semantickernel.skilldefinition.ParameterView
PLAN_EXECUTION_PRODUCED_NO_RESULTS - com.microsoft.semantickernel.planner.PlanningException.ErrorCodes
PlanningException - Exception in com.microsoft.semantickernel.planner: Exception thrown for errors related to planning.
PlanningException(PlanningException.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.planner.PlanningException
PlanningException(PlanningException.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.planner.PlanningException: Initializes a new instance of the PlanningException class with a provided error code and message
PlanningException(PlanningException.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.planner.PlanningException: Initializes a new instance of the PlanningException class with a provided error code, message, and inner exception.
PlanningException.ErrorCodes - Enum in com.microsoft.semantickernel.planner: Error codes for PlanningException
presencePenalty(double) - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
prettyPrint() - Method in interface com.microsoft.semantickernel.orchestration.ContextVariables: Create formatted string of the variables
promptTemplate() - Static method in class com.microsoft.semantickernel.SKBuilders
PromptTemplate - Interface in com.microsoft.semantickernel.semanticfunctions: Interface for prompt template
PromptTemplate.Builder - Interface in com.microsoft.semantickernel.semanticfunctions
PromptTemplateConfig - Class in com.microsoft.semantickernel.semanticfunctions: Prompt template configuration
PromptTemplateConfig() - Constructor for class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig
PromptTemplateConfig(int, String, String, CompletionRequestSettings, InputConfig) - Constructor for class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig
PromptTemplateConfig(CompletionRequestSettings) - Constructor for class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig
PromptTemplateConfig(String, String, CompletionRequestSettings) - Constructor for class com.microsoft.semantickernel.semanticfunctions.PromptTemplateConfig
promptTemplateEngine() - Static method in class com.microsoft.semantickernel.SKBuilders
PromptTemplateEngine - Interface in com.microsoft.semantickernel.templateengine: Prompt template engine interface
PromptTemplateEngine.Builder - Interface in com.microsoft.semantickernel.templateengine

R

readFile(String, Class<?>) - Static method in class com.microsoft.semantickernel.util.EmbeddedResourceLoader: Loads a file to a string from the classpath using getResourceAsStream
readFile(String, Class<?>, EmbeddedResourceLoader.ResourceLocation...) - Static method in class com.microsoft.semantickernel.util.EmbeddedResourceLoader: Loads a file to a string from the classpath, classpath root or filesystem
ReadOnlyFunctionCollection - Interface in com.microsoft.semantickernel.skilldefinition
ReadOnlySkillCollection - Interface in com.microsoft.semantickernel.skilldefinition: Skill collection interface.
ReadOnlySkillCollection.Builder - Interface in com.microsoft.semantickernel.skilldefinition
referenceRecord(String, String, String, Embedding, String, String, ZonedDateTime) - Static method in class com.microsoft.semantickernel.memory.MemoryRecord: Prepare an instance about a memory which source is stored externally.
registerOnKernel(Kernel) - Method in interface com.microsoft.semantickernel.orchestration.RegistrableSkFunction
registerSemanticFunction(FunctionType) - Method in interface com.microsoft.semantickernel.Kernel: Registers a semantic function on this kernel
registerSemanticFunction(String, String, SemanticFunctionConfig) - Method in interface com.microsoft.semantickernel.Kernel: Register a semantic function on this kernel
RegistrableSkFunction - Interface in com.microsoft.semantickernel.orchestration
remove(String) - Method in interface com.microsoft.semantickernel.orchestration.WritableContextVariables
removeAsync(String, String) - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Removes a memory record from the data store.
removeAsync(String, String) - Method in class com.microsoft.semantickernel.memory.NullMemory
removeAsync(String, String) - Method in interface com.microsoft.semantickernel.memory.SemanticTextMemory: Remove a memory by key.
removeBatchAsync(String, Collection<String>) - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Removes a batch of memory records from the data store.
renderAsync(SKContext) - Method in interface com.microsoft.semantickernel.semanticfunctions.PromptTemplate: Render the template using the information in the context
renderAsync(String, SKContext) - Method in interface com.microsoft.semantickernel.templateengine.PromptTemplateEngine: Given a prompt template, replace the variables with their values and execute the functions replacing their reference with the function result
REQUEST_TIMEOUT - com.microsoft.semantickernel.ai.AIException.ErrorCodes: Request timeout.
required() - Method in annotation type com.microsoft.semantickernel.skilldefinition.annotations.SKFunctionParameters: If required is false, no value is set, and no default value is provided, null will be passed as this argument.
returnDescription() - Method in annotation type com.microsoft.semantickernel.skilldefinition.annotations.DefineSKFunction
returnType() - Method in annotation type com.microsoft.semantickernel.skilldefinition.annotations.DefineSKFunction
runAsync(ContextVariables, SKFunction<?>...) - Method in interface com.microsoft.semantickernel.Kernel: Run a pipeline composed of synchronous and asynchronous functions.
runAsync(SKFunction<?>...) - Method in interface com.microsoft.semantickernel.Kernel: Run a pipeline composed of synchronous and asynchronous functions.
runAsync(String, SKFunction<?>...) - Method in interface com.microsoft.semantickernel.Kernel: Run a pipeline composed of synchronous and asynchronous functions.

S

saveInformationAsync(String, String, String, String, String) - Method in class com.microsoft.semantickernel.memory.NullMemory
saveInformationAsync(String, String, String, String, String) - Method in interface com.microsoft.semantickernel.memory.SemanticTextMemory: Save some information into the semantic memory, keeping a copy of the source information.
saveReferenceAsync(String, String, String, String, String, String) - Method in class com.microsoft.semantickernel.memory.NullMemory
saveReferenceAsync(String, String, String, String, String, String) - Method in interface com.microsoft.semantickernel.memory.SemanticTextMemory: Save some information into the semantic memory, keeping only a reference to the source information.
searchAsync(String, String, int, float, boolean) - Method in class com.microsoft.semantickernel.memory.NullMemory
searchAsync(String, String, int, float, boolean) - Method in interface com.microsoft.semantickernel.memory.SemanticTextMemory: Find some information in memory
SemanticFunctionConfig - Class in com.microsoft.semantickernel.semanticfunctions: Semantic function configuration
SemanticFunctionConfig(PromptTemplateConfig, PromptTemplate) - Constructor for class com.microsoft.semantickernel.semanticfunctions.SemanticFunctionConfig: Constructor for SemanticFunctionConfig.
SemanticKernelBuilder<T extends Buildable> - Interface in com.microsoft.semantickernel.builders: Interface for all builders that create Buildable objects.
semanticTextMemory() - Static method in class com.microsoft.semantickernel.SKBuilders
SemanticTextMemory - Interface in com.microsoft.semantickernel.memory: An interface for semantic memory that creates and recalls memories associated with text.
SemanticTextMemory.Builder - Interface in com.microsoft.semantickernel.memory
SERVICE_ERROR - com.microsoft.semantickernel.ai.AIException.ErrorCodes: Service error.
SERVICE_NOT_FOUND - com.microsoft.semantickernel.KernelException.ErrorCodes
serviceId(String) - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
ServiceLoadUtil - Class in com.microsoft.semantickernel.builders
setService(String, Supplier<T>, boolean, Class<T>) - Method in class com.microsoft.semantickernel.services.AIServiceCollection: Registers a transient service factory with an optional name and default flag.
setService(String, T, boolean, Class<T>) - Method in class com.microsoft.semantickernel.services.AIServiceCollection: Registers a singleton service instance with an optional name and default flag.
setService(Supplier<T>, Class<T>) - Method in class com.microsoft.semantickernel.services.AIServiceCollection: Registers a transient service factory with the default name.
setService(T, Class<T>) - Method in class com.microsoft.semantickernel.services.AIServiceCollection: Registers a singleton service instance with the default name.
setVariable(String, String) - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
setVariable(String, String) - Method in interface com.microsoft.semantickernel.orchestration.SKContext: Sets the given variable
setVariable(String, String) - Method in interface com.microsoft.semantickernel.orchestration.WritableContextVariables: Set the value
SKBuilders - Class in com.microsoft.semantickernel
SKCheckedException - Exception in com.microsoft.semantickernel: Provides the base exception from which all CHECKED Semantic Kernel exceptions derive.
SKContext - Interface in com.microsoft.semantickernel.orchestration: Semantic Kernel context.
SKContext.Builder - Interface in com.microsoft.semantickernel.orchestration
SKException - Exception in com.microsoft.semantickernel: Provides the base exception from which all Semantic Kernel exceptions derive.
SKFunction<RequestConfiguration> - Interface in com.microsoft.semantickernel.orchestration: Semantic Kernel callable function interface
SKFunctionInputAttribute - Annotation Type in com.microsoft.semantickernel.skilldefinition.annotations: Annotates a parameter binding it to the "input" context variable
SKFunctionParameters - Annotation Type in com.microsoft.semantickernel.skilldefinition.annotations: Annotates a parameter to a native function
SKILL_COLLECTION_NOT_SET - com.microsoft.semantickernel.KernelException.ErrorCodes
skillCollection() - Static method in class com.microsoft.semantickernel.SKBuilders
SkillExecutor - Interface in com.microsoft.semantickernel
SKILLS_NOT_FOUND - com.microsoft.semantickernel.exceptions.SkillsNotFoundException.ErrorCodes
SkillsNotFoundException - Exception in com.microsoft.semantickernel.exceptions
SkillsNotFoundException(SkillsNotFoundException.ErrorCodes) - Constructor for exception com.microsoft.semantickernel.exceptions.SkillsNotFoundException
SkillsNotFoundException(SkillsNotFoundException.ErrorCodes, String) - Constructor for exception com.microsoft.semantickernel.exceptions.SkillsNotFoundException
SkillsNotFoundException(SkillsNotFoundException.ErrorCodes, String, Throwable) - Constructor for exception com.microsoft.semantickernel.exceptions.SkillsNotFoundException
SkillsNotFoundException.ErrorCodes - Enum in com.microsoft.semantickernel.exceptions
stopSequences(List<String>) - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
STREAMING - com.microsoft.semantickernel.textcompletion.CompletionType
System - com.microsoft.semantickernel.chatcompletion.ChatHistory.AuthorRoles

T

temperature(double) - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
Text - com.microsoft.semantickernel.templateengine.blocks.BlockTypes: Text block type
textCompletion() - Static method in class com.microsoft.semantickernel.SKBuilders
TextCompletion - Interface in com.microsoft.semantickernel.textcompletion: Interface for text completion services
TextCompletion.Builder - Interface in com.microsoft.semantickernel.textcompletion
textEmbeddingGeneration() - Static method in class com.microsoft.semantickernel.SKBuilders
TextEmbeddingGeneration - Interface in com.microsoft.semantickernel.ai.embeddings: Interface for text embedding generation services
TextEmbeddingGeneration.Builder - Interface in com.microsoft.semantickernel.ai.embeddings
THROTTLING - com.microsoft.semantickernel.ai.AIException.ErrorCodes: Throttling.
toEmbeddingString() - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
toEmbeddingString() - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: Create a string for generating an embedding for a function.
toFullyQualifiedName() - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction: The function to create a fully qualified name for
toFullyQualifiedName() - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: The function to create a fully qualified name for
toManualString(boolean) - Method in class com.microsoft.semantickernel.orchestration.AbstractSkFunction
toManualString(boolean) - Method in interface com.microsoft.semantickernel.orchestration.SKFunction: Create a manual-friendly string for a function.
topP(double) - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
toString() - Method in class com.microsoft.semantickernel.memory.MemoryRecord
toString() - Method in class com.microsoft.semantickernel.memory.MemoryRecordMetadata
type() - Method in annotation type com.microsoft.semantickernel.skilldefinition.annotations.SKFunctionParameters

U

UNABLE_TO_BUILD_MEMORY - com.microsoft.semantickernel.memory.MemoryException.ErrorCodes: Unable to build memory.
UNABLE_TO_DESERIALIZE_MEMORY - com.microsoft.semantickernel.memory.MemoryException.ErrorCodes: Unable to construct memory from serialized metadata.
UNABLE_TO_SERIALIZE_MEMORY - com.microsoft.semantickernel.memory.MemoryException.ErrorCodes: Unable to serialize a memory .
Undefined - com.microsoft.semantickernel.templateengine.blocks.BlockTypes: Undefined block type
Unknown - com.microsoft.semantickernel.chatcompletion.ChatHistory.AuthorRoles
UNKNOWN - com.microsoft.semantickernel.memory.MemoryException.ErrorCodes: Unknown error.
UNKNOWN_ERROR - com.microsoft.semantickernel.ai.AIException.ErrorCodes: Unknown error.
UNKNOWN_ERROR - com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes
UNKNOWN_ERROR - com.microsoft.semantickernel.KernelException.ErrorCodes
UNKNOWN_ERROR - com.microsoft.semantickernel.planner.PlanningException.ErrorCodes
update(ContextVariables) - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
update(ContextVariables) - Method in interface com.microsoft.semantickernel.orchestration.SKContext: Merges in the given variables.
update(ContextVariables, boolean) - Method in interface com.microsoft.semantickernel.orchestration.WritableContextVariables: Updates the variables merging or overwriting in the new values.
update(String) - Method in class com.microsoft.semantickernel.orchestration.AbstractSKContext
update(String) - Method in interface com.microsoft.semantickernel.orchestration.SKContext: Updates the input entry with the given data
update(String) - Method in interface com.microsoft.semantickernel.orchestration.WritableContextVariables: Updates the main input text with the new value after a function is complete.
upsertAsync(String, MemoryRecord) - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Upserts a memory record into the data store.
upsertBatchAsync(String, Collection<MemoryRecord>) - Method in interface com.microsoft.semantickernel.memory.MemoryStore: Upserts a group of memory records into the data store.
user(String) - Method in class com.microsoft.semantickernel.textcompletion.CompletionRequestSettings.Builder
User - com.microsoft.semantickernel.chatcompletion.ChatHistory.AuthorRoles

V

Value - com.microsoft.semantickernel.templateengine.blocks.BlockTypes: Value block type
VALUE_NOT_FOUND - com.microsoft.semantickernel.exceptions.ConfigurationException.ErrorCodes
valueOf(String) - Static method in enum com.microsoft.semantickernel.ai.AIException.ErrorCodes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.builders.BuildersSingleton: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.chatcompletion.ChatHistory.AuthorRoles: 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.exceptions.NotSupportedException.ErrorCodes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.exceptions.SkillsNotFoundException.ErrorCodes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.KernelException.ErrorCodes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.memory.MemoryException.ErrorCodes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.orchestration.FunctionNotRegisteredException.ErrorCodes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.planner.PlanningException.ErrorCodes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.skilldefinition.FunctionNotFound.ErrorCodes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.templateengine.blocks.BlockTypes: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.textcompletion.CompletionType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.microsoft.semantickernel.util.EmbeddedResourceLoader.ResourceLocation: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.microsoft.semantickernel.ai.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.builders.BuildersSingleton: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microsoft.semantickernel.chatcompletion.ChatHistory.AuthorRoles: 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.exceptions.NotSupportedException.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.SkillsNotFoundException.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.KernelException.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.memory.MemoryException.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.FunctionNotRegisteredException.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.planner.PlanningException.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.skilldefinition.FunctionNotFound.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.templateengine.blocks.BlockTypes: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microsoft.semantickernel.textcompletion.CompletionType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.microsoft.semantickernel.util.EmbeddedResourceLoader.ResourceLocation: Returns an array containing the constants of this enum type, in the order they are declared.
Variable - com.microsoft.semantickernel.templateengine.blocks.BlockTypes: Variable block type
variables() - Static method in class com.microsoft.semantickernel.SKBuilders
Verify - Class in com.microsoft.semantickernel
Verify() - Constructor for class com.microsoft.semantickernel.Verify

W

withAIService(String, T, boolean, Class<T>) - Method in interface com.microsoft.semantickernel.Kernel.Builder: Adds an instance to the services collection
withAIServiceFactory(String, Function<KernelConfig, T>, boolean, Class<T>) - Method in interface com.microsoft.semantickernel.Kernel.Builder: Adds a factory method to the services collection
withConfiguration(KernelConfig) - Method in interface com.microsoft.semantickernel.Kernel.Builder: Set the kernel configuration
withDefaultAIService(Supplier<T>, Class<T>) - Method in interface com.microsoft.semantickernel.Kernel.Builder: Adds a factory method to the services collection
withDefaultAIService(T) - Method in interface com.microsoft.semantickernel.Kernel.Builder: Adds an instance to the services collection
withDefaultAIService(T, Class<T>) - Method in interface com.microsoft.semantickernel.Kernel.Builder: Adds an instance to the services collection
withDefaultCompletionType(CompletionType) - Method in interface com.microsoft.semantickernel.textcompletion.TextCompletion.Builder: Sets the default completion type for this service.
withDescription(String) - Method in interface com.microsoft.semantickernel.textcompletion.CompletionSKFunction.Builder
withEmbeddingGenerator(EmbeddingGeneration<String>) - Method in interface com.microsoft.semantickernel.memory.SemanticTextMemory.Builder
withFunctionName(String) - Method in interface com.microsoft.semantickernel.textcompletion.CompletionSKFunction.Builder
withInput(String) - Method in interface com.microsoft.semantickernel.orchestration.ContextVariables.Builder: Builds an instance with the given content in the default main key
withKernel(Kernel) - Method in interface com.microsoft.semantickernel.orchestration.SKContext.Builder: Builds a context from the given kernel.
withKernel(Kernel) - Method in interface com.microsoft.semantickernel.textcompletion.CompletionSKFunction.Builder
withMemory(SemanticTextMemory) - Method in interface com.microsoft.semantickernel.Kernel.Builder: Add a semantic text memory entity to the kernel to be built.
withMemory(SemanticTextMemory) - Method in interface com.microsoft.semantickernel.orchestration.SKContext.Builder: Sets the memory
withMemoryStorage(MemoryStore) - Method in interface com.microsoft.semantickernel.Kernel.Builder: Add memory storage to the kernel to be built.
withMemoryStorage(Supplier<MemoryStore>) - Method in interface com.microsoft.semantickernel.Kernel.Builder: Add memory storage factory to the kernel.
withMemoryStorageAndTextEmbeddingGeneration(MemoryStore, TextEmbeddingGeneration) - Method in interface com.microsoft.semantickernel.Kernel.Builder: Add memory storage and an embedding generator to the kernel to be built.
withModelId(String) - Method in interface com.microsoft.semantickernel.ai.embeddings.EmbeddingGeneration.Builder
withModelId(String) - Method in interface com.microsoft.semantickernel.chatcompletion.ChatCompletion.Builder
withModelId(String) - Method in interface com.microsoft.semantickernel.textcompletion.TextCompletion.Builder
withOpenAIClient(OpenAIAsyncClient) - Method in interface com.microsoft.semantickernel.ai.embeddings.EmbeddingGeneration.Builder
withOpenAIClient(OpenAIAsyncClient) - Method in interface com.microsoft.semantickernel.chatcompletion.ChatCompletion.Builder
withOpenAIClient(OpenAIAsyncClient) - Method in interface com.microsoft.semantickernel.textcompletion.TextCompletion.Builder
withPromptTemplate(String) - Method in interface com.microsoft.semantickernel.semanticfunctions.PromptTemplate.Builder
withPromptTemplate(String) - Method in interface com.microsoft.semantickernel.textcompletion.CompletionSKFunction.Builder
withPromptTemplateConfig(PromptTemplateConfig) - Method in interface com.microsoft.semantickernel.semanticfunctions.PromptTemplate.Builder
withPromptTemplateConfig(PromptTemplateConfig) - Method in interface com.microsoft.semantickernel.textcompletion.CompletionSKFunction.Builder
withPromptTemplateEngine(PromptTemplateEngine) - Method in interface com.microsoft.semantickernel.Kernel.Builder: Add prompt template engine to the kernel to be built.
withPromptTemplateEngine(PromptTemplateEngine) - Method in interface com.microsoft.semantickernel.semanticfunctions.PromptTemplate.Builder
withRequestSettings(CompletionRequestSettings) - Method in interface com.microsoft.semantickernel.textcompletion.CompletionSKFunction.Builder
withSemanticFunctionConfig(SemanticFunctionConfig) - Method in interface com.microsoft.semantickernel.textcompletion.CompletionSKFunction.Builder
withSkillName(String) - Method in interface com.microsoft.semantickernel.textcompletion.CompletionSKFunction.Builder
withSkills(ReadOnlySkillCollection) - Method in interface com.microsoft.semantickernel.orchestration.SKContext.Builder: Sets the skills
withStorage(MemoryStore) - Method in interface com.microsoft.semantickernel.memory.SemanticTextMemory.Builder
withVariable(String, String) - Method in interface com.microsoft.semantickernel.orchestration.ContextVariables.Builder: Set variable
withVariables(ContextVariables) - Method in interface com.microsoft.semantickernel.orchestration.SKContext.Builder
withVariables(Map<String, String>) - Method in interface com.microsoft.semantickernel.orchestration.ContextVariables.Builder: Builds an instance with the given variables
writableClone() - Method in interface com.microsoft.semantickernel.orchestration.ContextVariables: Get a clone of the variables that can be modified
WritableContextVariables - Interface in com.microsoft.semantickernel.orchestration: Context Variables is a data structure that holds temporary data while a task is being performed.
WritableContextVariables.Builder - Interface in com.microsoft.semantickernel.orchestration

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