com.microsoft.semantickernel.semanticfunctions.OutputVariable 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.3.0

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

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.microsoft.semantickernel.plugin.KernelPluginFactory;
import java.util.Objects;
import javax.annotation.Nullable;

/**
 * Metadata for an output variable of a kernel function.
 * @param  The type of the output variable.
 */
public class OutputVariable {

    @Nullable
    private final String description;

    private final String type;

    /**
     * Constructor.
     *
     * @param type        The type of the output variable.
     * @param description The description of the output variable.
     */
    @JsonCreator
    public OutputVariable(
        @Nullable @JsonProperty(value = "type", defaultValue = "java.lang.String") String type,
        @Nullable @JsonProperty("description") String description) {
        this.description = description;
        if (type == null || type.isEmpty()) {
            type = "java.lang.String";
        }
        this.type = type;
    }

    /**
     * Constructor.
     *
     * @param type        The type of the output variable.
     * @param description The description of the output variable.
     */
    public OutputVariable(
        @Nullable String description,
        Class type) {
        this.description = description;
        this.type = type.getName();
    }

    /**
     * Get the description of the output variable.
     *
     * @return The description of the output variable.
     */
    @Nullable
    public String getDescription() {
        return description;
    }

    /**
     * Get the type of the output variable.
     *
     * @return The type of the output variable.
     */
    public Class getType() {
        return KernelPluginFactory.getTypeForName(type);
    }

    @Override
    public int hashCode() {
        return Objects.hash(type, description);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!getClass().isInstance(obj)) {
            return false;
        }

        OutputVariable that = (OutputVariable) obj;
        if (!Objects.equals(type, that.type)) {
            return false;
        }
        return Objects.equals(description, that.description);
    }
}