mirror of https://github.com/microsoft/semantic-kernel.git synced 2026-10-12 02:19:06 +00:00

Files

T

John Oliver 73da9bc5b6 Java: Fix doc link (#3373 )

### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [ ] The code builds clean without any errors or warnings
- [ ] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

2023-11-02 14:57:55 +00:00

5.2 KiB

Raw Blame History

Semantic Kernel for Java Packages

The Semantic Kernel has the packages below, all are under the groupId com.microsoft.semantic-kernel, and can be imported to maven.

    <dependency>
        <groupId>com.microsoft.semantic-kernel</groupId>
        <artifactId>semantickernel-api</artifactId>
    </dependency>

A BOM is provided that can be used to define the versions of all Semantic Kernel packages.

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.microsoft.semantic-kernel</groupId>
                <artifactId>semantickernel-bom</artifactId>
                <version>${semantickernel.version}</version>
                <scope>import</scope>
                <type>pom</type>
            </dependency>
        </dependencies>
    </dependencyManagement>

Common Packages

semantickernel-bom: A Maven project BOM that can be used to define the versions of all Semantic Kernel packages.
semantickernel-api: Package that defines the core public API for the Semantic Kernel for a Maven project.
semantickernel-core: The internal implementation of the Semantic Kernel API. This package contains the core implementation of the Semantic Kernel. This must be made available to the application at runtime. Note that these classes are considered internal and should not be used directly by the application. Should they be used directly, it could cause instability in the application as they may change without notice over time.

Connectors

semantickernel-connectors-ai-openai: Provides a connector that can be used to interact with the OpenAI API.

Memory Connectors

JDBC Memory Connectors

semantickernel-connectors-memory-jdbc: A package that serves as a parent for all JDBC based connectors, adding a new JDBC database should be a matter of extending the classes within this module.

Provides a memory connector that can be used to interact with a JDBC database.

semantickernel-connectors-memory-sqlite
semantickernel-connectors-memory-postgresql
semantickernel-connectors-memory-mysql

semantickernel-connectors-memory-azurecognitivesearch: Provides a memory connector for using Azure Cognitive Search as the memory provider for an application.

Miscellaneous Packages

semantickernel-planners: Implementations of various planners that can be used in the execution of semantic functions.
semantickernel-plugin-core: Several example plugins, many of which are used in the Semantic Kernel for Java samples.
semantickernel-gpt3-tokenizer: A tokenizer that can be used to tokenize text for use with GPT-3. Can be used to estimate cost.

Example Configurations

Example: OpenAI + SQLite

POM XML for a simple project that uses OpenAI for text or chat completion with an SQLite database as the memory provider.

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.microsoft.semantic-kernel</groupId>
            <artifactId>semantickernel-bom</artifactId>
            <version>${semantickernel.version}</version>
            <scope>import</scope>
            <type>pom</type>
        </dependency>
    </dependencies>
</dependencyManagement>
<dependencies>
    <dependency>
        <groupId>com.microsoft.semantic-kernel</groupId>
        <artifactId>semantickernel-api</artifactId>
    </dependency>
    <dependency>
        <groupId>com.microsoft.semantic-kernel</groupId>
        <artifactId>semantickernel-core</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>com.microsoft.semantic-kernel</groupId>
        <artifactId>semantickernel-connectors-ai-openai</artifactId>
    </dependency>
    <dependency>
        <groupId>com.microsoft.semantic-kernel</groupId>
        <artifactId>semantickernel-connectors-memory-sqlite</artifactId>
    </dependency>
</dependencies>

Example: Planner using Open AI + Cognitive Search

The POM XML content for a project that uses Open AI for planning, using Azure Cognitive Search as the memory provider.

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.microsoft.semantic-kernel</groupId>
            <artifactId>semantickernel-bom</artifactId>
            <version>${semantickernel.version}</version>
            <scope>import</scope>
            <type>pom</type>
        </dependency>
    </dependencies>
</dependencyManagement>
<dependencies>
    <dependency>
        <groupId>com.microsoft.semantic-kernel</groupId>
        <artifactId>semantickernel-api</artifactId>
    </dependency>
    <dependency>
        <groupId>com.microsoft.semantic-kernel</groupId>
        <artifactId>semantickernel-core</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>com.microsoft.semantic-kernel</groupId>
        <artifactId>semantickernel-connectors-ai-openai</artifactId>
    </dependency>
    <dependency>
        <groupId>com.microsoft.semantic-kernel</groupId>
        <artifactId>semantickernel-connectors-memory-azurecognitivesearch</artifactId>
    </dependency>
    <dependency>
        <groupId>com.microsoft.semantic-kernel</groupId>
        <artifactId>semantickernel-planners</artifactId>
    </dependency>
</dependencies>

5.2 KiB Raw Blame History