com.microsoft.semantickernel.services.StreamingKernelContent 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.services;

import com.microsoft.semantickernel.contextvariables.ContextVariable;
import java.util.Map;
import javax.annotation.Nullable;

/**
 * Base class which represents the content returned by a streaming AI service.
 *
 * @param  The type of the content.
 */
public abstract class StreamingKernelContent extends KernelContent {

    /**
     * In a scenario of multiple choices per request, this represents the zero-based index of the
     * choice in the streaming sequence
     */
    private final int choiceIndex;

    /**
     * Initializes a new instance of the {@link StreamingKernelContent} class.
     *
     * @param innerContent The inner content representation.
     * @param choiceIndex  The zero-based index of the choice in the streaming sequence.
     * @param modelId      The model identifier used to generate the content.
     * @param metadata     The metadata associated with the content.
     */
    protected StreamingKernelContent(
        @Nullable T innerContent,
        int choiceIndex,
        @Nullable String modelId,
        @Nullable Map> metadata) {
        super(innerContent, modelId, null);
        this.choiceIndex = choiceIndex;
    }

    /**
     * Gets the zero-based index of the choice in the streaming sequence.
     *
     * @return The zero-based index of the choice in the streaming sequence.
     */
    public int getChoiceIndex() {
        return choiceIndex;
    }
}