IKernelBuilder Interface

Reference

Definition

Namespace:: Microsoft.SemanticKernel

Assembly:: Microsoft.SemanticKernel.Abstractions.dll

Package:: Microsoft.SemanticKernel.Abstractions v1.20.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a builder for constructing instances of Kernel.

public interface IKernelBuilder

type IKernelBuilder = interface

Public Interface IKernelBuilder

Properties

Plugins	Gets a builder for adding collections as singletons to Services.
Services	Gets the collection of services to be built into the Kernel.

Extension Methods

AddAzureAIInferenceChatCompletion(IKernelBuilder, String, ChatCompletionsClient, String)	Adds the AzureAIInferenceChatCompletionService to the Services.
AddAzureAIInferenceChatCompletion(IKernelBuilder, String, TokenCredential, Uri, HttpClient, String)	Adds the AzureAIInferenceChatCompletionService to the Services.
AddAzureAIInferenceChatCompletion(IKernelBuilder, String, String, Uri, HttpClient, String)	Adds the AzureAIInferenceChatCompletionService to the Services.
AddAzureAISearchVectorStore(IKernelBuilder, AzureAISearchVectorStoreOptions, String)	Register an Azure AI Search IVectorStore with the specified service ID and where SearchIndexClient is retrieved from the dependency injection container.
AddAzureAISearchVectorStore(IKernelBuilder, Uri, AzureKeyCredential, AzureAISearchVectorStoreOptions, String)	Register an Azure AI Search IVectorStore with the provided Uri and AzureKeyCredential and the specified service ID.
AddAzureAISearchVectorStore(IKernelBuilder, Uri, TokenCredential, AzureAISearchVectorStoreOptions, String)	Register an Azure AI Search IVectorStore with the provided Uri and TokenCredential and the specified service ID.
AddAzureCosmosDBMongoDBVectorStore(IKernelBuilder, AzureCosmosDBMongoDBVectorStoreOptions, String)	Register a Azure CosmosDB MongoDB IVectorStore with the specified service ID and where the Azure CosmosDB MongoDB MongoDB.Driver.IMongoDatabase is retrieved from the dependency injection container.
AddAzureCosmosDBMongoDBVectorStore(IKernelBuilder, String, String, AzureCosmosDBMongoDBVectorStoreOptions, String)	Register a Azure CosmosDB MongoDB IVectorStore with the specified service ID and where the Azure CosmosDB MongoDB MongoDB.Driver.IMongoDatabase is constructed using the provided `connectionString` and `databaseName`.
AddAzureCosmosDBNoSQLVectorStore(IKernelBuilder, AzureCosmosDBNoSQLVectorStoreOptions, String)	Register an Azure CosmosDB NoSQL IVectorStore with the specified service ID and where the Azure CosmosDB NoSQL Database is retrieved from the dependency injection container.
AddAzureCosmosDBNoSQLVectorStore(IKernelBuilder, String, String, AzureCosmosDBNoSQLVectorStoreOptions, String)	Register an Azure CosmosDB NoSQL IVectorStore with the specified service ID and where the Azure CosmosDB NoSQL Database is constructed using the provided `connectionString` and `databaseName`.
AddAzureOpenAIAudioToText(IKernelBuilder, String, AzureOpenAIClient, String, String)	Adds the AzureOpenAIAudioToTextService to the Services.
AddAzureOpenAIAudioToText(IKernelBuilder, String, String, TokenCredential, String, String, HttpClient)	Adds the AzureOpenAIAudioToTextService to the Services.
AddAzureOpenAIAudioToText(IKernelBuilder, String, String, String, String, String, HttpClient)	Adds the AzureOpenAIAudioToTextService to the Services.
AddAzureOpenAIChatCompletion(IKernelBuilder, String, AzureOpenAIClient, String, String)	Adds the AzureOpenAIChatCompletionService to the Services.
AddAzureOpenAIChatCompletion(IKernelBuilder, String, String, TokenCredential, String, String, HttpClient)	Adds the AzureOpenAIChatCompletionService to the Services.
AddAzureOpenAIChatCompletion(IKernelBuilder, String, String, String, String, String, HttpClient)	Adds the AzureOpenAIChatCompletionService to the Services.
AddAzureOpenAITextEmbeddingGeneration(IKernelBuilder, String, AzureOpenAIClient, String, String, Nullable<Int32>)	Adds the AzureOpenAITextEmbeddingGenerationService to the Services.
AddAzureOpenAITextEmbeddingGeneration(IKernelBuilder, String, String, TokenCredential, String, String, HttpClient, Nullable<Int32>)	Adds the AzureOpenAITextEmbeddingGenerationService to the Services.
AddAzureOpenAITextEmbeddingGeneration(IKernelBuilder, String, String, String, String, String, HttpClient, Nullable<Int32>)	Adds the AzureOpenAITextEmbeddingGenerationService to the Services.
AddAzureOpenAITextToAudio(IKernelBuilder, String, String, TokenCredential, String, String, HttpClient)	Adds the AzureOpenAITextToAudioService to the Services.
AddAzureOpenAITextToAudio(IKernelBuilder, String, String, String, String, String, HttpClient)	Adds the AzureOpenAITextToAudioService to the Services.
AddAzureOpenAITextToImage(IKernelBuilder, String, AzureOpenAIClient, String, String)	Adds the AzureOpenAITextToImageService to the Services.
AddAzureOpenAITextToImage(IKernelBuilder, String, String, TokenCredential, String, String, String)	Adds the AzureOpenAITextToImageService to the Services.
AddAzureOpenAITextToImage(IKernelBuilder, String, String, String, String, String, String, HttpClient)	Adds the AzureOpenAITextToImageService to the Services.
AddGoogleAIEmbeddingGeneration(IKernelBuilder, String, String, GoogleAIVersion, String, HttpClient)	Add Google AI embeddings generation service to the kernel builder.
AddGoogleAIGeminiChatCompletion(IKernelBuilder, String, String, GoogleAIVersion, String, HttpClient)	Add Google AI Gemini Chat Completion and Text Generation services to the kernel builder.
AddHuggingFaceChatCompletion(IKernelBuilder, String, Uri, String, String, HttpClient)	Adds an Hugging Face chat completion service with the specified configuration.
AddHuggingFaceChatCompletion(IKernelBuilder, Uri, String, String, HttpClient)	Adds an Hugging Face chat completion service with the specified configuration.
AddHuggingFaceImageToText(IKernelBuilder, String, Uri, String, String, HttpClient)	Adds an Hugging Face image-to-text service with the specified configuration.
AddHuggingFaceImageToText(IKernelBuilder, Uri, String, String, HttpClient)	Adds an Hugging Face image-to-text service with the specified configuration.
AddHuggingFaceTextEmbeddingGeneration(IKernelBuilder, String, Uri, String, String, HttpClient)	Adds an Hugging Face text embedding generation service with the specified configuration.
AddHuggingFaceTextEmbeddingGeneration(IKernelBuilder, Uri, String, String, HttpClient)	Adds an Hugging Face text embedding generation service with the specified configuration.
AddHuggingFaceTextGeneration(IKernelBuilder, String, Uri, String, String, HttpClient)	Adds an Hugging Face text generation service with the specified configuration.
AddHuggingFaceTextGeneration(IKernelBuilder, Uri, String, String, HttpClient)	Adds an Hugging Face text generation service with the specified configuration.
AddVolatileVectorStore(IKernelBuilder, String)	Register a Volatile IVectorStore with the specified service ID.
Build(IKernelBuilder)	Constructs a new instance of Kernel using all of the settings configured on the builder.
AddMistralChatCompletion(IKernelBuilder, String, String, Uri, String, HttpClient)	Adds an Mistral chat completion service with the specified configuration.
AddMistralTextEmbeddingGeneration(IKernelBuilder, String, String, Uri, String, HttpClient)	Adds an Mistral text embedding generation service with the specified configuration.
AddBertOnnxTextEmbeddingGeneration(IKernelBuilder, Stream, Stream, BertOnnxOptions, String)	Adds a text embedding generation service using a BERT ONNX model.
AddBertOnnxTextEmbeddingGeneration(IKernelBuilder, String, String, BertOnnxOptions, String)	Adds a text embedding generation service using a BERT ONNX model.
AddOnnxRuntimeGenAIChatCompletion(IKernelBuilder, String, String, String)	Add OnnxRuntimeGenAI Chat Completion services to the kernel builder.
AddOpenAIAudioToText(IKernelBuilder, String, OpenAIClient, String)	Adds the OpenAI audio-to-text service to the list.
AddOpenAIAudioToText(IKernelBuilder, String, String, String, String, HttpClient)	Adds the OpenAI audio-to-text service to the list.
AddOpenAIChatCompletion(IKernelBuilder, String, OpenAIClient, String)	Adds the OpenAI chat completion service to the list.
AddOpenAIChatCompletion(IKernelBuilder, String, String, String, String, HttpClient)	Adds the OpenAI chat completion service to the list.
AddOpenAIChatCompletion(IKernelBuilder, String, Uri, String, String, String, HttpClient)	Adds the Custom Endpoint OpenAI chat completion service to the list.
AddOpenAIFiles(IKernelBuilder, String, String, String, HttpClient)	Obsolete. Adds the OpenAIFileService to the IServiceCollection.
AddOpenAITextEmbeddingGeneration(IKernelBuilder, String, OpenAIClient, String, Nullable<Int32>)	Adds the OpenAITextEmbeddingGenerationService to the Services.
AddOpenAITextEmbeddingGeneration(IKernelBuilder, String, String, String, String, HttpClient, Nullable<Int32>)	Adds OpenAITextEmbeddingGenerationService to the Services.
AddOpenAITextToAudio(IKernelBuilder, String, String, String, String, HttpClient)	Adds the OpenAI text-to-audio service to the list.
AddOpenAITextToImage(IKernelBuilder, String, String, String, String, HttpClient)	Add the OpenAI Dall-E text to image service to the list
AddPineconeVectorStore(IKernelBuilder, PineconeVectorStoreOptions, String)	Register a Pinecone IVectorStore with the specified service ID and where Pinecone.PineconeClient is retrieved from the dependency injection container.
AddPineconeVectorStore(IKernelBuilder, String, PineconeVectorStoreOptions, String)	Register a Pinecone IVectorStore with the specified service ID and where Pinecone.PineconeClient is constructed using the provided apikey.
AddQdrantVectorStore(IKernelBuilder, QdrantVectorStoreOptions, String)	Register a Qdrant IVectorStore with the specified service ID and where Qdrant.Client.QdrantClient is retrieved from the dependency injection container.
AddQdrantVectorStore(IKernelBuilder, String, Int32, Boolean, String, QdrantVectorStoreOptions, String)	Register a Qdrant IVectorStore with the specified service ID and where Qdrant.Client.QdrantClient is constructed using the provided parameters.
AddRedisVectorStore(IKernelBuilder, RedisVectorStoreOptions, String)	Register a Redis IVectorStore with the specified service ID and where the Redis StackExchange.Redis.IDatabase is retrieved from the dependency injection container.
AddRedisVectorStore(IKernelBuilder, String, RedisVectorStoreOptions, String)	Register a Redis IVectorStore with the specified service ID and where the Redis StackExchange.Redis.IDatabase is constructed using the provided `redisConnectionConfiguration`.
AddVertexAIEmbeddingGeneration(IKernelBuilder, String, Func<ValueTask<String>>, String, String, VertexAIVersion, String, HttpClient)	Adds Vertex AI embeddings generation service to the kernel builder.
AddVertexAIEmbeddingGeneration(IKernelBuilder, String, String, String, String, VertexAIVersion, String, HttpClient)	Adds Vertex AI embeddings generation service to the kernel builder.
AddVertexAIGeminiChatCompletion(IKernelBuilder, String, Func<ValueTask<String>>, String, String, VertexAIVersion, String, HttpClient)	Adds Vertex AI Gemini Chat Completion and Text Generation services to the kernel builder.
AddVertexAIGeminiChatCompletion(IKernelBuilder, String, String, String, String, VertexAIVersion, String, HttpClient)	Adds Vertex AI Gemini Chat Completion and Text Generation services to the kernel builder.
AddWeaviateVectorStore(IKernelBuilder, HttpClient, WeaviateVectorStoreOptions, String)	Register a Weaviate IVectorStore with the specified service ID.

Applies to

Share via

IKernelBuilder Interface

Definition

Properties

Extension Methods

Applies to

Additional resources