diff --git a/README.md b/README.md index 9bd8e5d6..715b979a 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,18 @@ +[![Builds](https://github.com/microsoft/semantic-kernel-java/actions/workflows/java-build.yml/badge.svg?branch=main)](https://github.com/microsoft/semantic-kernel-java/actions/workflows/java-build.yml) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.microsoft.semantic-kernel/semantickernel-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.microsoft.semantic-kernel/semantickernel-api) +[![License: MIT](https://img.shields.io/github/license/microsoft/semantic-kernel)](https://github.com/microsoft/semantic-kernel-java/blob/main/LICENSE) +[![Discord](https://img.shields.io/discord/1063152441819942922?label=Discord&logo=discord&logoColor=white&color=d82679)](https://aka.ms/SKDiscord) + # Semantic Kernel for Java -The [Semantic Kernel for Java](https://learn.microsoft.com/en-us/semantic-kernel/overview/?tabs=Java). For .NET, Python and other language support, see [https://github.com/semantic-kernel.](https://github.com/semantic-kernel). The remainder of this README is a summary focused on Java, please see the main repo for the full text for the Semantic Kernel. +Welcome to the Semantic Kernel for Java. For detailed documentation, visit [Microsoft Learn](https://learn.microsoft.com/en-us/semantic-kernel/overview/?tabs=Java). -[Maven Package](https://repo1.maven.org/maven2/com/microsoft/semantic-kernel/semantickernel-api/) -[![License: MIT](https://img.shields.io/github/license/microsoft/semantic-kernel)](https://github.com/microsoft/semantic-kernel/blob/main/LICENSE) -[![Discord](https://img.shields.io/discord/1063152441819942922?label=Discord&logo=discord&logoColor=white&color=d82679)](https://aka.ms/SKDiscord) +[Semantic Kernel](https://learn.microsoft.com/en-us/semantic-kernel/overview/) is an SDK that integrates Large Language Models (LLMs) like [OpenAI](https://platform.openai.com/docs/introduction), [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service), and [Hugging Face](https://huggingface.co/) +with conventional programming languages like C#, Python, and Java. Semantic Kernel achieves this by allowing you to define [plugins](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/plugins) that can be chained together in just a [few lines of code](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/chaining-functions?tabs=Java#using-the-runasync-method-to-simplify-your-code). -[Semantic Kernel](https://learn.microsoft.com/en-us/semantic-kernel/overview/) -is an SDK that integrates Large Language Models (LLMs) like -[OpenAI](https://platform.openai.com/docs/introduction), -[Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service), -and [Hugging Face](https://huggingface.co/) -with conventional programming languages like C#, Python, and Java. Semantic Kernel achieves this -by allowing you to define [plugins](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/plugins) -that can be chained together -in just a [few lines of code](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/chaining-functions?tabs=Csharp#using-the-runasync-method-to-simplify-your-code). - -What makes Semantic Kernel _special_, however, is its ability to _automatically_ orchestrate -plugins with AI. With Semantic Kernel -[planners](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/planner), you -can ask an LLM to generate a plan that achieves a user's unique goal. Afterwards, -Semantic Kernel will execute the plan for the user. +What makes Semantic Kernel _special_, however, is its ability to _automatically_ orchestrate plugins with AI. With Semantic Kernel [planners](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/planner), you can ask an LLM to generate a plan that achieves a user's unique goal. Afterwards, Semantic Kernel will execute the plan for the user. + +For C#, Python and other language support, see [microsoft/semantic-kernel](https://github.com/microsoft/semantic-kernel). #### Please star the repo to show your support for this project! @@ -28,29 +20,23 @@ Semantic Kernel will execute the plan for the user. ## Getting started with Semantic Kernel for Java -Java logoUsing Semantic Kernel in Java - -The quickest way to get started with the basics is to get an API key -from either OpenAI or Azure OpenAI and to run one of the C#, Python, and Java console applications/scripts below. - -### For Java: +The quickest way to get started with the basics is to get an API key from either OpenAI or Azure OpenAI and to run one of the Java console applications/scripts below. 1. Clone the repository: `git clone https://github.com/microsoft/semantic-kernel-java.git` - 1. To access the latest Java code, clone and checkout the Java development branch: `git clone https://github.com/microsoft/semantic-kernel-java.git` 2. Follow the instructions [Start learning how to use Semantic Kernel](https://learn.microsoft.com/en-us/semantic-kernel/get-started/quick-start-guide?tabs=Java). -## Learning how to use Semantic Kernel +## Documentation: Learning how to use Semantic Kernel The fastest way to learn how to use Semantic Kernel is with our walkthroughs on our Learn site. -1. 📖 [Overview of the kernel](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/) -1. 🔌 [Understanding AI plugins](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/plugins) -1. 👄 [Creating semantic functions](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/semantic-functions) -1. 💽 [Creating native functions](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/native-functions) -1. ⛓️ [Chaining functions together](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/chaining-functions) -1. 🤖 [Auto create plans with planner](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/planner) -1. 💡 [Create and run a ChatGPT plugin](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/chatgpt-plugins) +1. 📖 [Overview of the kernel](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/?tabs=Java) +1. 🔌 [Understanding AI plugins](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/plugins?tabs=Java) +1. 👄 [Creating semantic functions](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/semantic-functions?tabs=Java) +1. 💽 [Creating native functions](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/native-functions?tabs=Java) +1. ⛓️ [Chaining functions together](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/chaining-functions?tabs=Java) +1. 🤖 [Auto create plans with planner](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/planner?tabs=Java) +1. 💡 [Create and run a ChatGPT plugin](https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/chatgpt-plugins?tabs=Java) ## Join the community @@ -64,7 +50,7 @@ in a different direction, but also to consider the impact on the larger ecosyste To learn more and get started: -- Read the [documentation](https://aka.ms/sk/learn) +- Read the [documentation](https://learn.microsoft.com/en-us/semantic-kernel/overview/?tabs=Java) - Learn how to [contribute](https://learn.microsoft.com/en-us/semantic-kernel/get-started/contributing) to the project - Join the [Discord community](https://aka.ms/SKDiscord) - Attend [regular office hours and SK community events](COMMUNITY.md) @@ -72,7 +58,7 @@ To learn more and get started: ## Contributor Wall of Fame -[![semantic-kernel contributors](https://contrib.rocks/image?repo=microsoft/semantic-kernel)](https://github.com/microsoft/semantic-kernel/graphs/contributors) +[![semantic-kernel contributors](https://contrib.rocks/image?repo=microsoft/semantic-kernel-java)](https://github.com/microsoft/semantic-kernel-java/graphs/contributors) ## Code of Conduct