{"id":2675,"date":"2024-05-17T10:38:02","date_gmt":"2024-05-17T17:38:02","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/semantic-kernel\/?p=2675"},"modified":"2024-05-17T10:38:02","modified_gmt":"2024-05-17T17:38:02","slug":"using-semantic-kernel-to-create-a-time-plugin-with-java","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/agent-framework\/using-semantic-kernel-to-create-a-time-plugin-with-java\/","title":{"rendered":"Using Semantic Kernel to create a Time Plugin with Java"},"content":{"rendered":"

Plugins are one of the most powerful features of Semantic Kernel and in this demo <\/span>we show how you can easily use Plugins with the power of Auto Function Calling from AI Models with Java here<\/a>.<\/span><\/p>\n

A Glimpse into the Demonstration\u00a0<\/strong><\/p>\n

Time Information Plugin\u00a0<\/strong><\/p>\n

In the demo we implement a simple class TimePlugin with one function to retrieve the UTC time in String format.<\/span>\u00a0<\/span><\/p>\n

public class TimePlugin {\r\n    public static final String DAY_MONTH_DAY_YEAR = \"EEEE, MMMM d, yyyy\";\r\n\r\n    \/**\r\n     * Get the current date and time for the system default timezone.\r\n     *\r\n     * @return a ZonedDateTime object with the current date and time.\r\n     *\/\r\n    public ZonedDateTime now() {\r\n        return ZonedDateTime.now(ZoneId.systemDefault());\r\n    }\r\n\r\n    \/**\r\n     * Get the current date.\r\n     *\r\n     * <p>Example: {{time.date}} => Sunday, January 12, 2025\r\n     *\r\n     * @return The current date.\r\n     *\/\r\n    @DefineKernelFunction(\r\n          name = \"date\", \r\n          description = \"Get the current date\")\r\n    public String date(\r\n        @KernelFunctionParameter(\r\n           name = \"locale\", \r\n           description = \"Locale to use when formatting the date\",\r\n           required = false) \r\n        String locale) {\r\n        \/\/ Example: Sunday, 12 January, 2025\r\n        return DateTimeFormatter.ofPattern(DAY_MONTH_DAY_YEAR)\r\n            .withLocale(parseLocale(locale))\r\n            .format(now());\r\n    }\r\n\r\n    \/**\r\n     * Get the current time.\r\n     *\r\n     * <p>Example: {{time.time}} => 9:15:00 AM\r\n     *\r\n     * @return The current time.\r\n     *\/\r\n    @DefineKernelFunction(\r\n        name = \"time\", \r\n        description = \"Get the current time\")\r\n    public String time(\r\n        @KernelFunctionParameter(\r\n             name = \"locale\", \r\n             description = \"Locale to use when formatting the date\", \r\n             required = false) \r\n        String locale) {\r\n        \/\/ Example: 09:15:07 PM\r\n        return DateTimeFormatter.ofPattern(\"hh:mm:ss a\")\r\n            .withLocale(parseLocale(locale))\r\n            .format(now());\r\n    }\r\n}<\/code><\/pre>\n
The above code provides a Time Plugin, that allows retrieving the current time so that an agent may relay it to a user.<\/p>\n
This plugin can then be added to a Kernel.<\/p>\n
KernelPlugin timePlugin = KernelPluginFactory.createFromObject(new TimePlugin(),\"TimePlugin\");\r\n\r\nvar kernel = Kernel.builder()\r\n    .withAIService(ChatCompletionService.class, openAIChatCompletion)\r\n    .withPlugin(timePlugin)\r\n    .build();\r\n\r\n<\/pre>\n
Once added to a Kernel its functions can be invoked from a prompt to add dynamic content to your prompt.<\/p>\n
\u00a0KernelFunction<String> prompt = KernelFunctionFromPrompt\r\n    .<String>createFromPrompt(\"\"\"\r\n        Translate the date {{TimePlugin.date locale=\"English\"}} to French.\r\n    \"\"\")\r\n    .build();\r\n\r\n    FunctionResult<String> timeInFrench = prompt.invokeAsync(kernel).block();\r\n\r\n    System.out.println(timeInFrench.getResult());<\/pre>\n
Produces<\/p>\n
Translate the date Wed, May 15, 2024 to French.\r\nMercredi, 15 mai 2024.\r\n\r\n<\/pre>\n
Plugins also can be invoked by the Kernel as part of a tool call<\/p>\n
\/\/ What is the current time at UTC?\r\nKernelFunction<String> promptWithToolCall = KernelFunctionFromPrompt\r\n    .<String>createFromPrompt(\"\"\"\r\n        Quelle est l'heure actuelle \u00e0 UTC.\r\n    \"\"\")\r\n    .build();\r\n\r\nFunctionResult<String> timeAtUtcInFrench = promptWithToolCall\r\n    .invokeAsync(kernel)\r\n    .withToolCallBehavior(ToolCallBehavior.allowAllKernelFunctions(true))\r\n    .block();\r\n\r\nSystem.out.println(timeAtUtcInFrench.getResult());<\/pre>\n
Produces:<\/p>\n
Quelle est l'heure actuelle \u00e0 UTC.\r\nL'heure actuelle \u00e0 UTC est 01:58:50 PM.<\/pre>\n
Due to passing withToolCallBehavior(ToolCallBehavior.allowAllKernelFunctions(true))<\/code> to our invocation, this allows the kernel to invoke functions it needs to achieve a task, in this case it made the choice to obtain the current time via invoking TimePlugin.time(\"utc\")<\/code>.<\/p>\n
 <\/p>\n
Dive Deeper<\/span><\/b>\u202f<\/span>\u00a0<\/span><\/p>\n
Please reach out if you have any questions or feedback through our Semantic Kernel GitHub Discussion Channel<\/span><\/span><\/a><\/span>. We look forward to hearing from you!<\/span>\u202f\u00a0<\/span><\/span><\/p>\n","protected":false},"excerpt":{"rendered":"
Plugins are one of the most powerful features of Semantic Kernel and in this demo we show how you can easily use Plugins with the power of Auto Function Calling from AI Models with Java here. A Glimpse into the Demonstration\u00a0 Time Information Plugin\u00a0 In the demo we implement a simple class TimePlugin with one […]<\/p>\n","protected":false},"author":149071,"featured_media":2365,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[24,2,1],"tags":[48,20,63,9],"class_list":["post-2675","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-java","category-samples","category-semantic-kernel","tag-ai","tag-java","tag-microsoft-semantic-kernel","tag-semantic-kernel"],"acf":[],"blog_post_summary":"
Plugins are one of the most powerful features of Semantic Kernel and in this demo we show how you can easily use Plugins with the power of Auto Function Calling from AI Models with Java here. A Glimpse into the Demonstration\u00a0 Time Information Plugin\u00a0 In the demo we implement a simple class TimePlugin with one […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/posts\/2675","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/users\/149071"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/comments?post=2675"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/posts\/2675\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/media\/2365"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/media?parent=2675"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/categories?post=2675"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/agent-framework\/wp-json\/wp\/v2\/tags?post=2675"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}