com.microsoft.semantickernel.services.KernelContent 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.4.2

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

import com.microsoft.semantickernel.orchestration.FunctionResultMetadata;
import javax.annotation.Nullable;

/**
 * Base class which represents the content returned by an AI service.
 *
 * @param  The type of the content.
 */
public interface KernelContent {

    /**
     * The inner content representation. Use this to bypass the current
     * abstraction. The usage of this property is considered "unsafe".
     * Use it only if strictly necessary.
     * @return The inner content.
     */
    @Nullable
    T getInnerContent();

    /**
     * The metadata associated with the content.
     * @return The metadata.
     */
    @Nullable
    FunctionResultMetadata getMetadata();

    /**
     * Gets the content returned by the AI service.
     *
     * @return The content.
     */
    @Nullable
    String getContent();
}