me.zhangjh.gemini.client.GeminiService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gemini.sdk Show documentation
A gemini java sdk
The newest version!
package me.zhangjh.gemini.client;

import me.zhangjh.gemini.pojo.ChatContent;
import me.zhangjh.gemini.request.*;
import me.zhangjh.gemini.response.TextResponse;
import me.zhangjh.gemini.response.VisionResponse;

import java.util.List;
import java.util.function.Function;

/**
 * @author [email protected]
 * @date 20:11 2023/12/22
 * @Description
 */
public interface GeminiService {

    /**
     * text only
     * @param request
     * @return TextResponse
     * */
    TextResponse generateByText(TextRequest request);

    /**
     * Text-and-image input
     * @param request
     * @return VisionResponse
     * */
    VisionResponse generateByMix(MixRequest request);

    /**
     * simplify interface of generateByText
     * @param text
     * @return TextResponse
     * */
    TextResponse generateByText(String text);

    /**
     * simplify interface of generateByMix
     * @param text
     * @param image format base64 of image
     * @param mimeType such as image/png, @link me.zhangjh.gemini.common.MimeTypeEnum
     * @return VisionResponse
     * */
    VisionResponse generateByMix(String text, String image, String mimeType);

    /**
     * conversations across multiple turns
     * only text input only support now by gemini
     * @param request
     * @return TextResponse
     * */
    TextResponse multiTurnChat(MultiTurnRequest request);

    /**
     * simplify interface of multiTurnChat
     * @param question
     * @param context
     * @return String
     * */
    String multiTurnChat(String question, List context);

    /**
     * Gemini returns a response after completing the entire generation process as default.
     * You can achieve faster interactions by not waiting for the entire result,
     * and instead use streaming to handle partial results.
     * @param request
     * @param cb callback function which receives a string per stream
     * no response returned, stream response data should be handled by HttpServletResponse
     * */
    void streamChat(StreamRequest request, Function cb);

    /**
     * simplify interface of streamChat
     * @param question
     * @param context
     * @param cb
     * */
    void streamChat(String question, List context, Function cb);
}