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

/**
 * Metadata for a method that can be used as a kernel function.
 */
public class MethodDetails {

    private final String name;
    @Nullable
    private final String description;
    private final ImplementationFunc function;
    private final List parameters;
    private final OutputVariable returnParameter;

    /**
     * Constructor.
     *
     * @param name            The name of the method.
     * @param description     The description of the method.
     * @param function        The function that implements the method.
     * @param parameters      The parameters of the method.
     * @param returnParameter The return parameter of the method.
     */
    public MethodDetails(
        String name,
        @Nullable String description,
        ImplementationFunc function,
        List parameters,
        OutputVariable returnParameter) {
        this.name = name;
        this.description = description;
        this.function = function;
        this.parameters = new ArrayList<>(parameters);
        this.returnParameter = returnParameter;
    }

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

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

    /**
     * Get the function that implements the method. This is an internal detail.
     *
     * @return The function that implements the method.
     */
    public ImplementationFunc getFunction() {
        return function;
    }

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

    /**
     * Get the return parameter of the method.
     *
     * @return The return parameter of the method.
     */
    public OutputVariable getReturnParameter() {
        return returnParameter;
    }
}