com.microsoft.semantickernel.services.openai.OpenAiServiceBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of semantickernel-api Show documentation

Defines the public interface for the Semantic Kernel

There is a newer version: 1.4.2

// Copyright (c) Microsoft. All rights reserved.
package com.microsoft.semantickernel.services.openai;

import com.microsoft.semantickernel.services.AIService;
import com.microsoft.semantickernel.builders.SemanticKernelBuilder;
import javax.annotation.Nullable;

/**
 * Builder for an OpenAI service.
 * @param  The client type
 * @param  The service type
 * @param  The builder type
*/
public abstract class OpenAiServiceBuilder>
    implements

    SemanticKernelBuilder {

    @Nullable
    protected String modelId;
    @Nullable
    protected C client;
    @Nullable
    protected String serviceId;
    @Nullable
    protected String deploymentName;

    /**
     * Sets the model ID for the service.
     * 
     * If no deployment name is provided, it will be assumed that this model ID is also the
     * deployment name.
     *
     * @param modelId The model ID
     * @return The builder
     */
    public U withModelId(String modelId) {
        this.modelId = modelId;
        return (U) this;
    }

    /**
     * Sets the deployment name for the service if required.
     *
     * @param deploymentName The deployment name
     * @return The builder
     */
    public U withDeploymentName(String deploymentName) {
        this.deploymentName = deploymentName;
        return (U) this;
    }

    /**
     * Sets the OpenAI client for the service
     *
     * @param client The OpenAI client
     * @return The builder
     */
    public U withOpenAIAsyncClient(C client) {
        this.client = client;
        return (U) this;
    }

    /**
     * Sets the service ID for the service
     *
     * @param serviceId The service ID
     * @return The builder
     */
    public U withServiceId(String serviceId) {
        this.serviceId = serviceId;
        return (U) this;
    }

    /**
     * Builds the service.
     * @return The service
     */
    @Override
    public abstract T build();

}