com.microsoft.semantickernel.hooks.FunctionInvokedEvent 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.orchestration.FunctionResult;
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 after a function is invoked.
 *
 * @param  The type of the function result
 */
public class FunctionInvokedEvent implements KernelHookEvent {

    private final KernelFunction function;
    @Nullable
    private final KernelFunctionArguments arguments;
    private final FunctionResult result;

    /**
     * Creates a new instance of the {@link FunctionInvokedEvent} class.
     *
     * @param function  the function
     * @param arguments the arguments
     * @param result    the result
     */
    public FunctionInvokedEvent(
        KernelFunction function,
        @Nullable KernelFunctionArguments arguments,
        FunctionResult result) {
        this.function = function;
        this.arguments = KernelFunctionArguments.builder().withVariables(arguments).build();
        this.result = result;
    }

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

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

    /**
     * Gets the result of the function invocation.
     *
     * @return the result
     */
    @SuppressFBWarnings("EI_EXPOSE_REP")
    public FunctionResult getResult() {
        return result;
    }
}