Package com.unfbx.chatgpt

Class OpenAiClient

  • public class OpenAiClient
extends Object
    描述： open ai 客户端
    Since:
    2023-02-11
    Author:
    https:www.unfbx.com

    • Method Detail

      • models

        public List<Model> models()
        openAi模型列表
        Returns:
        Model list

      • model

        public Model model​(String id)
        openAi模型详细信息
        Parameters:
        id - 模型主键
        Returns:
        Model 模型类

      • completions

        public CompletionResponse completions​(Completion completion)
        问答接口
        Parameters:
        completion - 问答参数
        Returns:
        CompletionResponse

      • completions

        public CompletionResponse completions​(String question)
        问答接口-简易版
        Parameters:
        question - 问题描述
        Returns:
        CompletionResponse

      • edit

        @Deprecated
public EditResponse edit​(Edit edit)
        Deprecated.
        文本修改
        Parameters:
        edit - 图片对象
        Returns:
        EditResponse

      • genImages

        public ImageResponse genImages​(String prompt)
        根据描述生成图片
        Parameters:
        prompt - 描述信息
        Returns:
        ImageResponse

      • genImages

        public ImageResponse genImages​(Image image)
        根据描述生成图片
        Parameters:
        image - 图片参数
        Returns:
        ImageResponse

      • editImages

        public List<Item> editImages​(File image,
                             String prompt)
        Creates an edited or extended image given an original image and a prompt. 根据描述修改图片
        Parameters:
        image - 图片对象
        prompt - 描述信息
        Returns:
        Item list

      • editImages

        public List<Item> editImages​(File image,
                             ImageEdit imageEdit)
        Creates an edited or extended image given an original image and a prompt. 根据描述修改图片
        Parameters:
        image - 图片对象
        imageEdit - 图片参数
        Returns:
        Item list

      • editImages

        public List<Item> editImages​(File image,
                             File mask,
                             ImageEdit imageEdit)
        Creates an edited or extended image given an original image and a prompt. 根据描述修改图片
        Parameters:
        image - png格式的图片，最大4MB
        mask - png格式的图片，最大4MB
        imageEdit - 图片参数
        Returns:
        Item list

      • variationsImages

        public ImageResponse variationsImages​(File image,
                                      ImageVariations imageVariations)
        Creates a variation of a given image.

        变化图片，类似ai重做图片

        Parameters:
        image - 图片对象
        imageVariations - 图片参数
        Returns:
        ImageResponse

      • variationsImages

        public ImageResponse variationsImages​(File image)
        Creates a variation of a given image.
        Parameters:
        image - 图片对象
        Returns:
        ImageResponse

      • embeddings

        public EmbeddingResponse embeddings​(String input)
        向量计算：单文本
        Parameters:
        input - 单文本
        Returns:
        EmbeddingResponse

      • embeddings

        public EmbeddingResponse embeddings​(List<String> input)
        向量计算：集合文本
        Parameters:
        input - 文本集合
        Returns:
        EmbeddingResponse

      • embeddings

        public EmbeddingResponse embeddings​(Embedding embedding)
        文本转换向量
        Parameters:
        embedding - 入参
        Returns:
        EmbeddingResponse

      • files

        public List<File> files()
        获取文件列表
        Returns:
        File list

      • deleteFile

        public DeleteResponse deleteFile​(String fileId)
        删除文件
        Parameters:
        fileId - 文件id
        Returns:
        DeleteResponse

      • uploadFile

        public UploadFileResponse uploadFile​(String purpose,
                                     File file)
        上传文件
        Parameters:
        purpose - purpose
        file - 文件对象
        Returns:
        UploadFileResponse

      • uploadFile

        public UploadFileResponse uploadFile​(File file)
        上传文件
        Parameters:
        file - 文件
        Returns:
        UploadFileResponse

      • retrieveFile

        public File retrieveFile​(String fileId)
        检索文件
        Parameters:
        fileId - 文件id
        Returns:
        File

      • moderations

        public ModerationResponse moderations​(String input)
        文本审核
        Parameters:
        input - 待检测数据
        Returns:
        ModerationResponse

      • moderations

        public ModerationResponse moderations​(List<String> input)
        文本审核
        Parameters:
        input - 待检测数据集合
        Returns:
        ModerationResponse

      • moderations

        public ModerationResponse moderations​(Moderation moderation)
        文本审核
        Parameters:
        moderation - 审核参数
        Returns:
        ModerationResponse

      • deleteFineTuneModel

        public FineTuneDeleteResponse deleteFineTuneModel​(String model)
        删除微调作业模型 Delete a fine-tuned model. You must have the Owner role in your organization.
        Parameters:
        model - 模型名称
        Returns:
        FineTuneDeleteResponse

      • engine

        @Deprecated
public Engine engine​(String engineId)
        Deprecated.
        引擎详细信息
        Parameters:
        engineId - 引擎id
        Returns:
        Engine

      • chatCompletion

        public <T extends BaseChatCompletion> ChatCompletionResponse chatCompletion​(T chatCompletion)
        最新版的GPT-3.5 chat completion 更加贴近官方网站的问答模型
        Parameters:
        chatCompletion - 问答参数
        Returns:
        答案

      • chatCompletion

        public ChatCompletionResponse chatCompletion​(List<Message> messages)
        简易版（不支持图片输入）
        Parameters:
        messages - 问答参数
        Returns:
        答案

      • chatCompletionWithPlugin

        public <R extends PluginParam,​T> ChatCompletionResponse chatCompletionWithPlugin​(ChatCompletion chatCompletion,
                                                                                       PluginAbstract<R,​T> plugin)
        插件问答简易版 默认取messages最后一个元素构建插件对话 默认模型：ChatCompletion.Model.GPT_3_5_TURBO_16K_0613
        Type Parameters:
        R - 插件自定义函数的请求值
        T - 插件自定义函数的返回值
        Parameters:
        chatCompletion - 参数
        plugin - 插件
        Returns:
        ChatCompletionResponse

      • chatCompletionWithPlugin

        public <R extends PluginParam,​T> ChatCompletionResponse chatCompletionWithPlugin​(List<Message> messages,
                                                                                       PluginAbstract<R,​T> plugin)
        插件问答简易版 默认取messages最后一个元素构建插件对话 默认模型：ChatCompletion.Model.GPT_3_5_TURBO_16K_0613
        Type Parameters:
        R - 插件自定义函数的请求值
        T - 插件自定义函数的返回值
        Parameters:
        messages - 问答参数
        plugin - 插件
        Returns:
        ChatCompletionResponse

      • chatCompletionWithPlugin

        public <R extends PluginParam,​T> ChatCompletionResponse chatCompletionWithPlugin​(List<Message> messages,
                                                                                       String model,
                                                                                       PluginAbstract<R,​T> plugin)
        插件问答简易版 默认取messages最后一个元素构建插件对话
        Type Parameters:
        R - 插件自定义函数的请求值
        T - 插件自定义函数的返回值
        Parameters:
        messages - 问答参数
        model - 模型
        plugin - 插件
        Returns:
        ChatCompletionResponse

      • speechToTextTranscriptions

        public WhisperResponse speechToTextTranscriptions​(File file,
                                                  Transcriptions transcriptions)
        语音转文字
        Parameters:
        transcriptions - 参数
        file - 语音文件 最大支持25MB mp3, mp4, mpeg, mpga, m4a, wav, webm
        Returns:
        语音文本

      • speechToTextTranscriptions

        public WhisperResponse speechToTextTranscriptions​(File file)
        简易版 语音转文字
        Parameters:
        file - 语音文件 最大支持25MB mp3, mp4, mpeg, mpga, m4a, wav, webm
        Returns:
        语音文本

      • speechToTextTranslations

        public WhisperResponse speechToTextTranslations​(File file,
                                                Translations translations)
        语音翻译：目前仅支持翻译为英文
        Parameters:
        translations - 参数
        file - 语音文件 最大支持25MB mp3, mp4, mpeg, mpga, m4a, wav, webm
        Returns:
        翻译后文本

      • speechToTextTranslations

        public WhisperResponse speechToTextTranslations​(File file)
        简易版 语音翻译：目前仅支持翻译为英文
        Parameters:
        file - 语音文件 最大支持25MB mp3, mp4, mpeg, mpga, m4a, wav, webm
        Returns:
        翻译后文本

      • subscription

        public Subscription subscription()
        账户信息查询：里面包含总金额等信息
        Returns:
        账户信息

      • billingUsage

        public BillingUsage billingUsage​(@NotNull
                                 @NotNull LocalDate starDate,
                                 @NotNull
                                 @NotNull LocalDate endDate)
        账户调用接口消耗金额信息查询 最多查询100天
        Parameters:
        starDate - 开始时间
        endDate - 结束时间
        Returns:
        消耗金额信息

      • fineTuneJob

        public FineTuneJobResponse fineTuneJob​(FineTuneJob fineTuneJob)
        创建微调job
        Parameters:
        fineTuneJob - 微调job
        Returns:
        FineTuneJobResponse
        Since:
        1.1.2

      • fineTuneJob

        public FineTuneJobResponse fineTuneJob​(String trainingFileId)
        创建微调job
        Parameters:
        trainingFileId - 文件id，文件上传返回的id
        Returns:
        FineTuneJobResponse
        Since:
        1.1.2

      • fineTuneJobs

        public FineTuneJobListResponse<FineTuneJobResponse> fineTuneJobs​(String after,
                                                                 Integer limit)
        微调job集合
        Parameters:
        after - 上一个分页请求中最后一个job id，默认值：null
        limit - 每次查询数量 默认值：20
        Returns:
        FineTuneJobListResponse #FineTuneResponse
        Since:
        1.1.2

      • retrieveFineTuneJob

        public FineTuneJobResponse retrieveFineTuneJob​(String fineTuneJobId)
        检索微调job
        Parameters:
        fineTuneJobId - 微调job id
        Returns:
        FineTuneResponse
        Since:
        1.1.2

      • cancelFineTuneJob

        public FineTuneJobResponse cancelFineTuneJob​(String fineTuneJobId)
        取消微调job
        Parameters:
        fineTuneJobId - 微调job id
        Returns:
        FineTuneJobResponse
        Since:
        1.1.2

      • fineTuneJobEvents

        public FineTuneJobListResponse<FineTuneJobEvent> fineTuneJobEvents​(String fineTuneJobId,
                                                                   String after,
                                                                   Integer limit)
        微调作业事件列表
        Parameters:
        fineTuneJobId - 微调job id
        after - 上一个分页请求中最后一个id，默认值：null
        limit - 每次查询数量 默认值：20
        Returns:
        Event List
        Since:
        1.1.2

      • textToSpeech

        public void textToSpeech​(TextToSpeech textToSpeech,
                         retrofit2.Callback callback)