Java: Update to Service registry pattern (microsoft#1923)

Resolves microsoft#1628 

Also setKernelConfig -> withKernelConfig, to be in keeping with other
builder functions

java/api-test/api-usage-example/src/main/java/InlineFunctionExample.java

@@ -107,7 +107,7 @@ public static void main(String[] args) {
                         .addTextCompletionService(MODEL, kernel -> textCompletion)
                         .build();
 
-        Kernel kernel = SKBuilders.kernel().setKernelConfig(kernelConfig).build();
+        Kernel kernel = SKBuilders.kernel().withKernelConfig(kernelConfig).build();
 
         CompletionSKFunction summarize =
                 kernel.getSemanticFunctionBuilder()

java/api-test/api-usage-example/src/main/java/InlineFunctionWithPreBuiltSkillExample.java

@@ -108,7 +108,7 @@ public static void main(String[] args) {
                         .addTextCompletionService(MODEL, kernel -> textCompletion)
                         .build();
 
-        Kernel kernel = SKBuilders.kernel().setKernelConfig(kernelConfig).build();
+        Kernel kernel = SKBuilders.kernel().withKernelConfig(kernelConfig).build();
 
         CompletionSKFunction summarize =
                 SKBuilders.completionFunctions(kernel)

java/api-test/integration-tests/src/test/java/com/microsoft/semantickernel/e2e/AbstractKernelTest.java

@@ -41,7 +41,7 @@ public static Kernel buildTextCompletionKernel() throws IOException {
                         .build();
 
         return SKBuilders.kernel()
-                .setKernelConfig(kernelConfig)
+                .withKernelConfig(kernelConfig)
                 .withMemoryStore(new VolatileMemoryStore())
                 .build();
     }

java/api-test/integration-tests/src/test/java/com/microsoft/semantickernel/e2e/KernelTest.java

@@ -57,7 +57,7 @@ public static Kernel buildKernel(OpenAIAsyncClient client, String model) {
                         .addTextCompletionService(model, kernel -> textCompletion)
                         .build();
 
-        return SKBuilders.kernel().setKernelConfig(kernelConfig).build();
+        return SKBuilders.kernel().withKernelConfig(kernelConfig).build();
     }
 
     @Test

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/Example00_GettingStarted.java

@@ -36,7 +36,7 @@ public static Kernel getKernel(OpenAIAsyncClient client) {
                 .build();
 
         Kernel kernel = SKBuilders.kernel()
-                .setKernelConfig(config)
+                .withKernelConfig(config)
                 .build();
 
         return kernel;

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/Example06_MemoryAndEmbeddings.java

@@ -16,7 +16,7 @@ public static Kernel getKernel(OpenAIAsyncClient client) {
     // TODO: Add Volatile memory
 
     Kernel kernel = SKBuilders.kernel()
-        .setKernelConfig(config)
+        .withKernelConfig(config)
         .build();
 
     return kernel;

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example02_Pipeline.java

@@ -11,7 +11,7 @@
 public class Example02_Pipeline {
     public static void main(String[] args) {
         KernelConfig kernelConfig = SKBuilders.kernelConfig().build();
-        Kernel kernel = SKBuilders.kernel().setKernelConfig(kernelConfig).build();
+        Kernel kernel = SKBuilders.kernel().withKernelConfig(kernelConfig).build();
 
         // Load native skill
         ReadOnlyFunctionCollection text = kernel.importSkill(new TextSkill(), null);

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example03_Variables.java

@@ -37,7 +37,7 @@ public Mono<String> appendDay(
 
     public static void main(String[] args) {
         KernelConfig kernelConfig = SKBuilders.kernelConfig().build();
-        Kernel kernel = SKBuilders.kernel().setKernelConfig(kernelConfig).build();
+        Kernel kernel = SKBuilders.kernel().withKernelConfig(kernelConfig).build();
 
         // Load native skill
         ReadOnlyFunctionCollection functionCollection =

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example04_CombineLLMPromptsAndNativeCode.java

@@ -36,7 +36,7 @@ public static void main(String[] args) throws IOException {
                 .addTextCompletionService("text-davinci-003", kernel -> textCompletion)
                 .build();
 
-        Kernel kernel = SKBuilders.kernel().setKernelConfig(kernelConfig).build();
+        Kernel kernel = SKBuilders.kernel().withKernelConfig(kernelConfig).build();
         kernel.importSkill(new SearchEngineSkill(), null);
         kernel.importSkillFromDirectory("SummarizeSkill", "./samples/skills", "SummarizeSkill");
 

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example05_InlineFunctionDefinition.java

@@ -25,7 +25,7 @@ public static void main(String[] args) throws IOException {
                 .addTextCompletionService("text-davinci-003", kernel -> textCompletion)
                 .build();
 
-        Kernel kernel = SKBuilders.kernel().setKernelConfig(kernelConfig).build();
+        Kernel kernel = SKBuilders.kernel().withKernelConfig(kernelConfig).build();
 
         System.out.println("======== Inline Function Definition ========");
 

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example06_TemplateLanguage.java

@@ -29,7 +29,7 @@ public static void main(String[] args) throws IOException {
                 .build();
 
         Kernel kernel = SKBuilders.kernel()
-                .setKernelConfig(kernelConfig)
+                .withKernelConfig(kernelConfig)
                 .build();
 
         // Load native skill into the kernel skill collection, sharing its functions

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example08_RetryHandler.java

@@ -77,7 +77,7 @@ public static void main(String[] args) throws IOException {
 
         Kernel kernel = SKBuilders
                 .kernel()
-                .setKernelConfig(kernelConfig)
+                .withKernelConfig(kernelConfig)
                 .build();
 
         CompletionSKFunction summarizeFunc = SKBuilders.completionFunctions(kernel)
@@ -89,7 +89,6 @@ public static void main(String[] args) throws IOException {
                         new PromptTemplateConfig.CompletionConfig(
                                 0.2, 0.5, 0, 0, 2000));
 
-
         kernel.registerSemanticFunction(summarizeFunc);
 
         SKContext context = summarizeFunc.invokeAsync(text).block();

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example09_FunctionTypes.java

@@ -25,7 +25,7 @@ public static void main(String[] args) throws IOException {
                 .addTextCompletionService("text-davinci-003", kernel -> textCompletion)
                 .build();
 
-        Kernel kernel = SKBuilders.kernel().setKernelConfig(kernelConfig).build();
+        Kernel kernel = SKBuilders.kernel().withKernelConfig(kernelConfig).build();
 
         System.out.println("======== Native function types ========");
 

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example12_SequentialPlanner.java

@@ -175,7 +175,7 @@ private static void memorySampleAsync() throws IOException {
     private static Kernel initializeKernel() throws IOException {
         OpenAIAsyncClient client = Config.getClient();
         var kernel = SKBuilders.kernel()
-                .setKernelConfig(SKBuilders
+                .withKernelConfig(SKBuilders
                         .kernelConfig()
                         .addTextCompletionService("text-davinci-003", kernel1 -> SKBuilders.textCompletionService()
                                 .build(client, "text-davinci-003"))

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example13_ConversationSummarySkill.java

@@ -186,9 +186,10 @@ private static Kernel initializeKernel(Config.ClientType clientType) throws IOEx
 
         KernelConfig kernelConfig =
                 new KernelConfig.Builder()
-                        .addTextCompletionService("text-davinci-003", kernel -> textCompletion)
                         .build();
 
-        return SKBuilders.kernel().setKernelConfig(kernelConfig).build();
+        return SKBuilders.kernel()
+                .withKernelConfig(kernelConfig)
+                .withAIService("text-davinci-003", textCompletion, true, TextCompletion.class).build();
     }
 }

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example14_SemanticMemory.java

@@ -5,7 +5,6 @@
 import com.microsoft.semantickernel.Kernel;
 import com.microsoft.semantickernel.builders.SKBuilders;
 import com.microsoft.semantickernel.connectors.memory.azurecognitivesearch.AzureCognitiveSearchMemory;
-import com.microsoft.semantickernel.memory.SemanticTextMemory;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
@@ -42,7 +41,7 @@ public static void main(String[] args) throws Exception
         var kernelConfig = SKBuilders.kernelConfig().build();
 
         var kernelWithACS = SKBuilders.kernel()
-                .setKernelConfig(kernelConfig)
+                .withKernelConfig(kernelConfig)
                 .withMemory(new AzureCognitiveSearchMemory(System.getenv("ACS_ENDPOINT"), System.getenv("ACS_API_KEY")))
                 .build();
 
@@ -69,7 +68,7 @@ public static void main(String[] args) throws Exception
                 .build();
 
         var kernelWithCustomDb = SKBuilders.kernel()
-                .setKernelConfig(kernelConfigWithTextEmbedding)
+                .withKernelConfig(kernelConfigWithTextEmbedding)
                 .withMemoryStore(SKBuilders.memoryStore().build())
                 .build();
 

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example17_ChatGPT.java

@@ -4,7 +4,6 @@
 import com.azure.ai.openai.OpenAIAsyncClient;
 import com.microsoft.semantickernel.Config;
 import com.microsoft.semantickernel.Kernel;
-import com.microsoft.semantickernel.KernelConfig;
 import com.microsoft.semantickernel.builders.SKBuilders;
 import com.microsoft.semantickernel.chatcompletion.ChatCompletion;
 import com.microsoft.semantickernel.chatcompletion.ChatHistory;
@@ -21,14 +20,17 @@ public class Example17_ChatGPT {
     public static void main(String[] args) throws IOException {
         OpenAIAsyncClient client = Config.ClientType.AZURE_OPEN_AI.getClient();
 
-        KernelConfig kernelConfig = SKBuilders.kernelConfig()
-                .addChatCompletionService(
+        Kernel kernel = SKBuilders.kernel()
+                .withKernelConfig(SKBuilders.kernelConfig()
+                        .build())
+                .withAIService(
                         "chat-test",
-                        kernel -> SKBuilders.chatCompletion().build(client, "chat-test"))
+                        SKBuilders.chatCompletion().build(client, "chat-test"),
+                        true,
+                        ChatCompletion.class
+                )
                 .build();
 
-        Kernel kernel = SKBuilders.kernel().setKernelConfig(kernelConfig).build();
-
         ChatCompletion<OpenAIChatHistory> chatGPT = kernel.getService(null, ChatCompletion.class);
 
         OpenAIChatHistory chatHistory = chatGPT.createNewChat("You are a librarian, expert about books");

java/samples/sample-code/src/main/java/com/microsoft/semantickernel/syntaxexamples/Example28_ActionPlanner.java

@@ -16,7 +16,7 @@ public static void main(String[] args) throws IOException {
         System.out.println("======== Action Planner ========");
 
         var kernel = SKBuilders.kernel()
-                .setKernelConfig(SKBuilders
+                .withKernelConfig(SKBuilders
                         .kernelConfig()
                         .addTextCompletionService("text-davinci-002", kernel1 -> SKBuilders.textCompletionService()
                                 .build(client, "text-davinci-002"))

java/semantickernel-api/src/main/java/com/microsoft/semantickernel/Kernel.java

@@ -7,11 +7,17 @@
 import com.microsoft.semantickernel.orchestration.ContextVariables;
 import com.microsoft.semantickernel.orchestration.SKContext;
 import com.microsoft.semantickernel.orchestration.SKFunction;
+import com.microsoft.semantickernel.services.AIService;
+import com.microsoft.semantickernel.services.AIServiceCollection;
+import com.microsoft.semantickernel.services.AIServiceProvider;
 import com.microsoft.semantickernel.templateengine.PromptTemplateEngine;
 import com.microsoft.semantickernel.textcompletion.CompletionSKFunction;
 
 import reactor.core.publisher.Mono;
 
+import java.util.function.Function;
+import java.util.function.Supplier;
+
 import javax.annotation.Nullable;
 
 /** Interface for the semantic kernel. */
@@ -66,7 +72,8 @@ public interface Kernel extends SkillExecutor {
     CompletionSKFunction.Builder getSemanticFunctionBuilder();
 
     /** Obtains the service with the given name and type */
-    <T> T getService(@Nullable String name, Class<T> clazz) throws KernelException;
+    <T extends AIService> T getService(@Nullable String name, Class<T> clazz)
+            throws KernelException;
 
     /** Registers a semantic functon on this kernel */
     <RequestConfiguration, FunctionType extends SKFunction<RequestConfiguration>>
@@ -80,14 +87,15 @@ class Builder {
         @Nullable private KernelConfig kernelConfig = null;
         @Nullable private PromptTemplateEngine promptTemplateEngine = null;
         @Nullable private MemoryStore memoryStore = null;
+        @Nullable private AIServiceCollection aiServices = new AIServiceCollection();
         @Nullable private SemanticTextMemory memory = null;
 
-        public Builder setKernelConfig(KernelConfig kernelConfig) {
+        public Builder withKernelConfig(KernelConfig kernelConfig) {
             this.kernelConfig = kernelConfig;
             return this;
         }
 
-        public Builder setPromptTemplateEngine(PromptTemplateEngine promptTemplateEngine) {
+        public Builder withPromptTemplateEngine(PromptTemplateEngine promptTemplateEngine) {
             this.promptTemplateEngine = promptTemplateEngine;
             return this;
         }
@@ -97,6 +105,65 @@ public Builder withMemoryStore(MemoryStore memoryStore) {
             return this;
         }
 
+        /**
+         * Adds an instance to the services collection
+         *
+         * @param instance The instance.
+         * @param clazz The class of the instance.
+         * @return The builder.
+         */
+        public <T extends AIService> Builder withDefaultAIService(T instance, Class<T> clazz) {
+            this.aiServices.setService(instance, clazz);
+            return this;
+        }
+
+        /**
+         * Adds an instance to the services collection
+         *
+         * @param serviceId The service ID
+         * @param instance The instance.
+         * @param setAsDefault Optional: set as the default AI service for type T
+         * @param clazz The class of the instance.
+         */
+        public <T extends AIService> Builder withAIService(
+                @Nullable String serviceId, T instance, boolean setAsDefault, Class<T> clazz) {
+            this.aiServices.setService(serviceId, instance, setAsDefault, clazz);
+            return this;
+        }
+
+        /**
+         * Adds a factory method to the services collection
+         *
+         * @param factory The factory method that creates the AI service instances of type T.
+         * @param clazz The class of the instance.
+         */
+        public <T extends AIService> Builder withDefaultAIService(
+                Supplier<T> factory, Class<T> clazz) {
+            this.aiServices.setService(factory, clazz);
+            return this;
+        }
+
+        /**
+         * Adds a factory method to the services collection
+         *
+         * @param serviceId The service ID
+         * @param factory The factory method that creates the AI service instances of type T.
+         * @param setAsDefault Optional: set as the default AI service for type T
+         * @param clazz The class of the instance.
+         */
+        public <T extends AIService> Builder withAIService(
+                @Nullable String serviceId,
+                Function<KernelConfig, T> factory,
+                boolean setAsDefault,
+                Class<T> clazz) {
+            this.aiServices.setService(
+                    serviceId,
+                    (Supplier<T>) () -> factory.apply(this.kernelConfig),
+                    setAsDefault,
+                    clazz);
+            return this;
+        }
+
         public Builder withMemory(SemanticTextMemory memory) {
             this.memory = memory;
             return this;
@@ -109,7 +176,12 @@ public Kernel build() {
 
             return BuildersSingleton.INST
                     .getKernelBuilder()
-                    .build(kernelConfig, promptTemplateEngine, memory, memoryStore);
+                    .build(
+                            kernelConfig,
+                            promptTemplateEngine,
+                            memory,
+                            memoryStore,
+                            aiServices.build());
         }
     }
 
@@ -118,6 +190,7 @@ Kernel build(
                 KernelConfig kernelConfig,
                 @Nullable PromptTemplateEngine promptTemplateEngine,
                 @Nullable SemanticTextMemory memory,
-                @Nullable MemoryStore memoryStore);
+                @Nullable MemoryStore memoryStore,
+                @Nullable AIServiceProvider aiServiceProvider);
     }
 }

java/semantickernel-api/src/main/java/com/microsoft/semantickernel/ai/embeddings/EmbeddingGeneration.java

@@ -2,13 +2,14 @@
 package com.microsoft.semantickernel.ai.embeddings;
 
 import com.azure.ai.openai.OpenAIAsyncClient;
+import com.microsoft.semantickernel.services.AIService;
 
 import reactor.core.publisher.Mono;
 
 import java.util.List;
 
 /** Interface for text embedding generation services */
-public interface EmbeddingGeneration<TValue, TEmbedding extends Number> {
+public interface EmbeddingGeneration<TValue, TEmbedding extends Number> extends AIService {
     /**
      * Generates a list of embeddings associated to the data
      *

java/semantickernel-api/src/main/java/com/microsoft/semantickernel/chatcompletion/ChatCompletion.java

@@ -2,12 +2,13 @@
 package com.microsoft.semantickernel.chatcompletion;
 
 import com.azure.ai.openai.OpenAIAsyncClient;
+import com.microsoft.semantickernel.services.AIService;
 
 import reactor.core.publisher.Mono;
 
 import javax.annotation.Nullable;
 
-public interface ChatCompletion<ChatHistoryType extends ChatHistory> {
+public interface ChatCompletion<ChatHistoryType extends ChatHistory> extends AIService {
     /**
      * Generate a new chat message
      *

java/semantickernel-api/src/main/java/com/microsoft/semantickernel/services/AIService.java

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft. All rights reserved.
+package com.microsoft.semantickernel.services;
+
+/** Marker interface for AI services */
+public interface AIService {}