Partager via


Microsoft.SemanticKernel Namespace

Classes

AggregatorPromptTemplateFactory

Provides a IPromptTemplateFactory which aggregates multiple prompt template factories.

AudioContent

Represents audio content.

AutoFunctionInvocationContext

Class with data related to automatic function invocation.

AzureAIInferenceKernelBuilderExtensions

Provides extension methods for IKernelBuilder to configure Azure AI Inference connectors.

AzureAIInferenceServiceCollectionExtensions

Provides extension methods for IServiceCollection to configure Azure AI Inference connectors.

AzureAISearchKernelBuilderExtensions

Extension methods to register Azure AI Search IVectorStore instances on the IKernelBuilder.

AzureAISearchServiceCollectionExtensions

Extension methods to register Azure AI Search IVectorStore instances on an IServiceCollection.

AzureCosmosDBMongoDBKernelBuilderExtensions

Extension methods to register Azure CosmosDB MongoDB IVectorStore instances on the IKernelBuilder.

AzureCosmosDBMongoDBServiceCollectionExtensions

Extension methods to register Azure CosmosDB MongoDB IVectorStore instances on an IServiceCollection.

AzureCosmosDBNoSQLKernelBuilderExtensions

Extension methods to register Azure CosmosDB NoSQL IVectorStore instances on the IKernelBuilder.

AzureCosmosDBNoSQLServiceCollectionExtensions

Extension methods to register Azure CosmosDB NoSQL IVectorStore instances on an IServiceCollection.

AzureOpenAIKernelBuilderExtensions

Provides extension methods for IKernelBuilder to configure Azure OpenAI connectors.

AzureOpenAIServiceCollectionExtensions

Provides extension methods for IServiceCollection to configure Azure OpenAI connectors.

BinaryContent

Provides access to binary content.

CancelKernelEventArgs

Provides an EventArgs for cancelable operations related to Kernel-based operations.

ChatMessageContent

Represents chat message content return from a IChatCompletionService service.

EchoPromptTemplateFactory

Provides an implementation of IPromptTemplateFactory which creates no operation instances of IPromptTemplate.

FileReferenceContent

Content type to support file references.

FromKernelServicesAttribute

Specifies that an argument to a KernelFunction should be supplied from the associated Kernel's Services rather than from KernelArguments.

FunctionCallContent

Represents a function call requested by AI model.

FunctionCallContentBuilder

A builder class for creating FunctionCallContent objects from incremental function call updates represented by StreamingFunctionCallUpdateContent.

FunctionChoiceBehavior

Represents the base class for different function choice behaviors. These behaviors define the way functions are chosen by AI model and various aspects of their invocation by AI connectors.

FunctionChoiceBehaviorConfiguration

Represents function choice behavior configuration produced by a FunctionChoiceBehavior.

FunctionChoiceBehaviorConfigurationContext

The context is to be provided by the choice behavior consumer – AI connector in order to obtain the choice behavior configuration.

FunctionChoiceBehaviorOptions

Represents the options for a function choice behavior. At the moment this is empty but it is being included for future use.

FunctionFilterContext

Base class with data related to function invocation.

FunctionInvocationContext

Class with data related to function invocation.

FunctionInvokedContext

Class with data related to function after invocation.

FunctionInvokedEventArgs

Provides a CancelKernelEventArgs used in events just after a function is invoked.

FunctionInvokingContext

Class with data related to function before invocation.

FunctionInvokingEventArgs

Provides a CancelKernelEventArgs used in events just before a function is invoked.

FunctionResult

Represents the result of a KernelFunction invocation.

FunctionResultContent

Represents the result of a function call.

GoogleAIKernelBuilderExtensions

Extensions for adding GoogleAI generation services to the application.

GoogleAIMemoryBuilderExtensions

Provides extension methods for the MemoryBuilder class to configure GoogleAI connector.

GoogleAIServiceCollectionExtensions

Extensions for adding GoogleAI generation services to the application.

HandlebarsKernelExtensions

Provides Kernel extensions methods for Handlebars functionality.

HttpOperationException

Represents an exception specific to HTTP operations.

HuggingFaceKernelBuilderExtensions

Provides extension methods for the IKernelBuilder class to configure Hugging Face connectors.

HuggingFaceServiceCollectionExtensions

Provides extension methods for the IServiceCollection interface to configure Hugging Face connectors.

ImageContent

Represents image content.

InputVariable

Represents an input variable for prompt functions.

Kernel

Provides state for use throughout a Semantic Kernel workload.

KernelArguments

Provides a collection of arguments for operations such as KernelFunction's InvokeAsync and IPromptTemplate's RenderAsync.

KernelBuilderExtensions

Extension methods to register Data services on the IKernelBuilder.

KernelContent

Base class for all AI non-streaming results

KernelEventArgs

Provides an EventArgs for operations related to Kernel-based operations.

KernelException

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

KernelExtensions

Provides extension methods for interacting with Kernel and related types.

KernelFunction

Represents a function that can be invoked as part of a Semantic Kernel workload.

KernelFunctionAttribute

Specifies that a method on a class imported as a plugin should be included as a KernelFunction in the resulting KernelPlugin.

KernelFunctionCanceledException

Provides an OperationCanceledException-derived exception type that's thrown from a KernelFunction invocation when a Kernel function filter (e.g. FunctionInvocationFilters) requests cancellation.

KernelFunctionFactory

Provides factory methods for creating commonly-used implementations of KernelFunction, such as those backed by a prompt to be submitted to an LLM or those backed by a .NET method.

KernelFunctionFromMethodOptions

Optional options that can be provided when creating a KernelFunction from a method.

KernelFunctionMarkdown

Factory methods for creating instances.

KernelFunctionMetadata

Provides read-only metadata for a KernelFunction.

KernelFunctionYaml

Factory methods for creating instances.

KernelJsonSchema

Represents JSON Schema for describing types used in KernelFunctions.

KernelJsonSchema.JsonConverter

Converter for reading/writing the schema.

KernelParameterMetadata

Provides read-only metadata for a KernelFunction parameter.

KernelPlugin

Represents a plugin that may be registered with a Kernel.

KernelPluginCollection

Provides a collection of KernelPlugins.

KernelPluginExtensions

Provides extension methods for working with KernelPlugins and collections of them.

KernelPluginFactory

Provides static factory methods for creating commonly-used plugin implementations.

KernelPromptTemplateFactory

Provides an implementation of IPromptTemplateFactory for the SemanticKernelTemplateFormat template format.

KernelReturnParameterMetadata

Provides read-only metadata for a KernelFunction's return parameter.

MarkdownKernelExtensions

Class for extensions methods to define functions using prompt markdown format.

MistralAIKernelBuilderExtensions

Provides extension methods for the IKernelBuilder class to configure Mistral connectors.

MistralAIServiceCollectionExtensions

Provides extension methods for the IServiceCollection interface to configure Mistral connectors.

OnnxKernelBuilderExtensions

Provides extension methods for the IKernelBuilder class to configure ONNX connectors.

OnnxServiceCollectionExtensions

Provides extension methods for the IServiceCollection interface to configure ONNX connectors.

OpenAIChatHistoryExtensions

Chat history extensions.

OpenAIKernelBuilderExtensions

Sponsor extensions class for IKernelBuilder.

OpenAIServiceCollectionExtensions

Sponsor extensions class for IServiceCollection.

OutputVariable

Represents an output variable returned from a prompt function.

PineconeKernelBuilderExtensions

Extension methods to register Pinecone IVectorStore instances on the IKernelBuilder.

PineconeServiceCollectionExtensions

Extension methods to register Pinecone IVectorStore instances on an IServiceCollection.

PromptExecutionSettings

Provides execution settings for an AI request.

PromptFilterContext

Base class with data related to prompt rendering.

PromptRenderContext

Class with data related to prompt rendering.

PromptRenderedContext

Class with data related to prompt after rendering.

PromptRenderedEventArgs

Provides a CancelKernelEventArgs used in events raised just after a prompt has been rendered.

PromptRenderingContext

Class with data related to prompt before rendering.

PromptRenderingEventArgs

Provides a KernelEventArgs used in events raised just before a prompt is rendered.

PromptTemplateConfig

Provides the configuration information necessary to create a prompt template.

PromptTemplateFactoryExtensions

Provides extension methods for operating on IPromptTemplateFactory instances.

PromptYamlKernelExtensions

Class for extensions methods to define functions using prompt YAML format.

PromptyKernelExtensions

Provides extension methods for creating KernelFunctions from the Prompty template format.

QdrantKernelBuilderExtensions

Extension methods to register Qdrant IVectorStore instances on the IKernelBuilder.

QdrantServiceCollectionExtensions

Extension methods to register Qdrant IVectorStore instances on an IServiceCollection.

RedisKernelBuilderExtensions

Extension methods to register Redis IVectorStore instances on the IKernelBuilder.

RedisServiceCollectionExtensions

Extension methods to register Redis IVectorStore instances on an IServiceCollection.

RestApiOperationResponse

The REST API operation response.

RestApiOperationResponseConverter

Converts a object of RestApiOperationResponse type to string type.

ServiceCollectionExtensions

Extension methods to register Data services on an IServiceCollection.

StreamingChatMessageContent

Abstraction of chat message content chunks when using streaming from IChatCompletionService interface.

StreamingFileReferenceContent

Content type to support file references.

StreamingFunctionCallUpdateContent

Represents a function streaming call requested by LLM.

StreamingKernelContent

Represents a single update to a streaming content.

StreamingMethodContent

Represents a manufactured streaming content from a single function result.

StreamingTextContent

Abstraction of text content chunks when using streaming from ITextGenerationService interface.

TextContent

Represents text content return from a ITextGenerationService service.

VertexAIKernelBuilderExtensions

Extensions for adding VertexAI generation services to the application.

VertexAIMemoryBuilderExtensions

Provides extension methods for the MemoryBuilder class to configure VertexAI connector.

VertexAIServiceCollectionExtensions

Extensions for adding VertexAI generation services to the application.

WeaviateKernelBuilderExtensions

Extension methods to register Weaviate IVectorStore instances on the IKernelBuilder.

WeaviateServiceCollectionExtensions

Extension methods to register Weaviate IVectorStore instances on an IServiceCollection

Structs

FunctionChoice

Represents an AI model's decision-making strategy for calling functions, offering predefined choices: Auto, Required, and None. Auto allows the model to decide if and which functions to call, Required enforces calling one or more functions, and None prevents any function calls, generating only a user-facing message.

Interfaces

IAIServiceSelector

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

IAutoFunctionInvocationFilter

Interface for filtering actions during automatic function invocation.

IFunctionInvocationFilter

Interface for filtering actions during function invocation.

IKernelBuilder

Provides a builder for constructing instances of Kernel.

IKernelBuilderPlugins

Provides a builder for adding plugins as singletons to a service collection.

IPromptRenderFilter

Interface for filtering actions during prompt rendering.

IPromptTemplate

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

IPromptTemplateFactory

Represents a factory for prompt templates for one or more prompt template formats.

IReadOnlyKernelPluginCollection

Provides a read-only collection of KernelPlugins.