com.composum.ai.backend.base.service.chat.GPTContentCreationService Maven / Gradle / Ivy

Go to download
package com.composum.ai.backend.base.service.chat;

import java.util.List;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.composum.ai.backend.base.service.GPTException;

/**
 * Service to generate content (keywords / descriptions from a text, and so forth.)
 */
public interface GPTContentCreationService {

    /**
     * Generates a list of keywords from the given text.
     *
     * @param text The text to generate keywords from.
     * @return A list of generated keywords, possibly empty.
     */
    @Nonnull
    List generateKeywords(@Nullable String text, @Nullable GPTConfiguration configuration) throws GPTException;

    /**
     * Generates a description from the given text.
     *
     * @param text     The text to generate a description from.
     * @param maxwords approximate maximum number of words in the description, if > 0
     * @return A generated description, possibly empty.
     */
    @Nonnull
    String generateDescription(@Nullable String text, int maxwords, @Nullable GPTConfiguration configuration) throws GPTException;

    /**
     * Executes a given prompt from the user using ChatGPT.
     *
     * @param prompt   the prompt text from the user
     * @param maxtokens used to hard limit text length to that many tokens. If < 1, no limit is set.
     */
    @Nonnull
    String executePrompt(@Nullable String prompt, @Nullable GPTChatRequest additionalParameters) throws GPTException;

    /**
     * Executes a given prompt from the user using ChatGPT.
     *
     * @param prompt   the prompt text from the user
     * @param maxtokens used to hard limit text length to that many tokens. If < 1, no limit is set.
     * @param callback the callback to use for streaming the result
     */
    void executePromptStreaming(@Nonnull String prompt, @Nullable GPTChatRequest additionalParameters, @Nonnull GPTCompletionCallback callback) throws GPTException;


    /**
     * Executes a given prompt from the user using ChatGPT, using the given text as context.
     *
     * @param prompt   the prompt text from the user
     * @param text     the text to use as context for the prompt
     * @param maxtokens used to hard limit text length to that many tokens. If < 1, no limit is set.
     */
    @Nonnull
    String executePromptOnText(@Nullable String prompt, @Nullable String text, @Nullable GPTChatRequest additionalParameters) throws GPTException;


    /**
     * Executes a given prompt from the user using ChatGPT, using the given text as context.
     *
     * @param prompt   the prompt text from the user
     * @param text     the text to use as context for the prompt
     * @param maxtokens used to hard limit text length to that many tokens. If < 1, no limit is set.
     * @param callback the callback to use for streaming the result
     */
    void executePromptOnTextStreaming(@Nonnull String prompt, @Nonnull String text, @Nullable GPTChatRequest additionalParameters, @Nonnull GPTCompletionCallback callback) throws GPTException;

}