Skip to content

PACKAGES.md

Latest commit

 

History

History
110 lines (88 loc) · 3.21 KB

PACKAGES.md

File metadata and controls

110 lines (88 loc) · 3.21 KB

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.

Services

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

semantickernel-aiservices-voyageai : Provides connectors for VoyageAI's embedding and reranking services, including text embeddings, contextualized embeddings, multimodal embeddings, and document reranking.

Example Configurations

Example: OpenAI + SQLite

POM XML for a simple project that uses OpenAI.

<project>
    <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-connectors-ai-openai</artifactId>
        </dependency>
    </dependencies>
</project>

Example: VoyageAI Embeddings and Reranking

POM XML for a project that uses VoyageAI for embeddings and reranking.

<project>
    <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-aiservices-voyageai</artifactId>
        </dependency>
    </dependencies>
</project>