com.microsoft.semantickernel.hooks.FunctionInvokingEvent 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.hooks;

import com.microsoft.semantickernel.semanticfunctions.KernelFunction;
import com.microsoft.semantickernel.semanticfunctions.KernelFunctionArguments;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import javax.annotation.Nullable;

/**
 * Represents a KernelHookEvent that is raised before a function is invoked. This event is raised
 * before the function is invoked, and can be used to by a {@code KernelHook} to modify the
 * arguments before the function is invoked.
 *
 * @param  The type of the KernelFunction being invoked
 */
public class FunctionInvokingEvent implements KernelHookEvent {

    private final KernelFunction function;
    private final KernelFunctionArguments arguments;

    /**
     * Creates a new instance of the FunctionInvokingEvent class.
     *
     * @param function  The function that is being invoked
     * @param arguments The arguments that are being passed to the function
     */
    public FunctionInvokingEvent(KernelFunction function,
        @Nullable KernelFunctionArguments arguments) {
        this.function = function;
        this.arguments = KernelFunctionArguments.builder().withVariables(arguments).build();
    }

    /**
     * Gets the function that is being invoked.
     *
     * @return the function
     */
    public KernelFunction getFunction() {
        return function;
    }

    /**
     * Gets the arguments that are being passed to the function.
     *
     * @return the arguments
     */
    @SuppressFBWarnings("EI_EXPOSE_REP")
    public KernelFunctionArguments getArguments() {
        return arguments;
    }
}