com.microsoft.semantickernel.semanticfunctions.KernelFunctionMetadata 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 java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import javax.annotation.Nullable;

/**
 * Metadata about a kernel function.
 *
 * @param  The type of the return value of the function.
 */
public class KernelFunctionMetadata {

    private final String name;
    @Nullable
    private final String pluginName;
    @Nullable
    private final String description;
    private final List parameters;
    private final OutputVariable returnParameterType;

    /**
     * Create a new instance of KernelFunctionMetadata.
     *
     * @param pluginName      The name of the plugin to which the function belongs
     * @param name            The name of the function.
     * @param description     The description of the function.
     * @param parameters      The parameters of the function.
     * @param returnParameterType   The return parameter type of the function.
     */
    public KernelFunctionMetadata(
        @Nullable String pluginName,
        String name,
        @Nullable String description,
        @Nullable List parameters,
        OutputVariable returnParameterType) {
        this.pluginName = pluginName;
        this.name = name;
        this.description = description;
        if (parameters == null) {
            this.parameters = new ArrayList<>();
        } else {
            this.parameters = new ArrayList<>(parameters);
        }

        this.returnParameterType = returnParameterType;
    }

    /**
     * Get the name of the plugin to which the function belongs
     *
     * @return The name of the function.
     */
    @Nullable
    public String getPluginName() {
        return pluginName;
    }

    /**
     * Get the name of the function.
     *
     * @return The name of the function.
     */
    public String getName() {
        return name;
    }

    /**
     * Get the parameters of the function.
     *
     * @return The parameters of the function.
     */
    public List getParameters() {
        return Collections.unmodifiableList(parameters);
    }

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

    /**
     * Get the return parameter of the function.
     *
     * @return The return parameter of the function.
     */
    public OutputVariable getOutputVariableType() {
        return returnParameterType;
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, pluginName, description, parameters, returnParameterType);
    }

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

        KernelFunctionMetadata other = (KernelFunctionMetadata) obj;
        if (!Objects.equals(name, other.name))
            return false;
        if (!Objects.equals(pluginName, other.pluginName))
            return false;
        if (!Objects.equals(description, other.description))
            return false;
        if (!Objects.equals(parameters, other.parameters))
            return false;
        return Objects.equals(returnParameterType, other.returnParameterType);
    }

}