Package com.unfbx.chatgpt

Interface OpenAiApi

  • public interface OpenAiApi
    描述： open ai官方api接口
    Author:
    https:www.unfbx.com 2023-02-15

    • Method Detail

      • models

        @GET("v1/models")
io.reactivex.Single<ModelResponse> models()
        模型列表
        Returns:
        Single ModelResponse

      • model

        @GET("v1/models/{id}")
io.reactivex.Single<Model> model​(@Path("id")
                                 String id)
        models 返回的数据id
        Parameters:
        id - 模型主键
        Returns:
        Single Model

      • completions

        @POST("v1/completions")
io.reactivex.Single<CompletionResponse> completions​(@Body
                                                    Completion completion)
        文本问答 Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position.
        Parameters:
        completion - 问答参数
        Returns:
        Single CompletionResponse

      • edits

        @Deprecated
@POST("v1/edits")
io.reactivex.Single<EditResponse> edits​(@Body
                                        Edit edit)
        Deprecated.
        Creates a new edit for the provided input, instruction, and parameters. 文本修复
        Parameters:
        edit - 编辑参数
        Returns:
        Single EditResponse

      • genImages

        @POST("v1/images/generations")
io.reactivex.Single<ImageResponse> genImages​(@Body
                                             Image image)
        Creates an image given a prompt. 根据描述生成图片
        Parameters:
        image - 图片对象
        Returns:
        Single ImageResponse

      • editImages

        @Multipart
@POST("v1/images/edits")
io.reactivex.Single<ImageResponse> editImages​(@Part
                                              okhttp3.MultipartBody.Part image,
                                              @Part
                                              okhttp3.MultipartBody.Part mask,
                                              @PartMap
                                              Map<String,​okhttp3.RequestBody> requestBodyMap)
        Creates an edited or extended image given an original image and a prompt. 根据描述修改图片
        Parameters:
        image - 图片对象
        mask - 图片对象
        requestBodyMap - 请求参数
        Returns:
        Single ImageResponse

      • variationsImages

        @Multipart
@POST("v1/images/variations")
io.reactivex.Single<ImageResponse> variationsImages​(@Part
                                                    okhttp3.MultipartBody.Part image,
                                                    @PartMap
                                                    Map<String,​okhttp3.RequestBody> requestBodyMap)
        Creates a variation of a given image.
        Parameters:
        image - 图片对象
        requestBodyMap - 请求参数
        Returns:
        Single ImageResponse

      • embeddings

        @POST("v1/embeddings")
io.reactivex.Single<EmbeddingResponse> embeddings​(@Body
                                                  Embedding embedding)
        文本向量计算
        Parameters:
        embedding - 向量参数
        Returns:
        Single EmbeddingResponse

      • files

        @GET("/v1/files")
io.reactivex.Single<OpenAiResponse<File>> files()
        Returns a list of files that belong to the user's organization.
        Returns:
        Single OpenAiResponse File

      • deleteFile

        @DELETE("v1/files/{file_id}")
io.reactivex.Single<DeleteResponse> deleteFile​(@Path("file_id")
                                               String fileId)
        删除文件
        Parameters:
        fileId - 文件id
        Returns:
        Single DeleteResponse

      • uploadFile

        @Multipart
@POST("v1/files")
io.reactivex.Single<UploadFileResponse> uploadFile​(@Part
                                                   okhttp3.MultipartBody.Part file,
                                                   @Part("purpose")
                                                   okhttp3.RequestBody purpose)
        上传文件
        Parameters:
        purpose - purpose
        file - 文件对象
        Returns:
        Single UploadFileResponse

      • retrieveFile

        @GET("v1/files/{file_id}")
io.reactivex.Single<File> retrieveFile​(@Path("file_id")
                                       String fileId)
        检索文件
        Parameters:
        fileId - 文件id
        Returns:
        Single File

      • retrieveFileContent

        @Streaming
@GET("v1/files/{file_id}/content")
io.reactivex.Single<okhttp3.ResponseBody> retrieveFileContent​(@Path("file_id")
                                                              String fileId)
        检索文件内容 ###不对免费用户开放### ###不对免费用户开放### ###不对免费用户开放###
        Parameters:
        fileId - 文件id
        Returns:
        Single ResponseBody

      • moderations

        @POST("v1/moderations")
io.reactivex.Single<ModerationResponse> moderations​(@Body
                                                    Moderation moderation)
        文本审核
        Parameters:
        moderation - 文本审核参数
        Returns:
        Single ModerationResponse

      • deleteFineTuneModel

        @DELETE("v1/models/{model}")
io.reactivex.Single<FineTuneDeleteResponse> deleteFineTuneModel​(@Path("model")
                                                                String model)
        删除微调作业模型 Delete a fine-tuned model. You must have the Owner role in your organization.
        Returns:
        Single DeleteResponse

      • engines

        @Deprecated
@GET("v1/engines")
io.reactivex.Single<OpenAiResponse<Engine>> engines()
        Deprecated.
        引擎列表 官方已废弃此接口
        Returns:
        Single OpenAiResponse Engine

      • engine

        @Deprecated
@GET("v1/engines/{engine_id}")
io.reactivex.Single<Engine> engine​(@Path("engine_id")
                                   String engineId)
        Deprecated.
        检索引擎 官方已废弃此接口
        Parameters:
        engineId - 引擎id
        Returns:
        Engine

      • chatCompletion

        @POST("v1/chat/completions")
io.reactivex.Single<ChatCompletionResponse> chatCompletion​(@Body
                                                           ChatCompletion chatCompletion)
        最新版的GPT-3.5 chat completion 更加贴近官方网站的问答模型
        Parameters:
        chatCompletion - chat completion
        Returns:
        返回答案

      • chatCompletionWithPicture

        @POST("v1/chat/completions")
io.reactivex.Single<ChatCompletionResponse> chatCompletionWithPicture​(@Body
                                                                      ChatCompletionWithPicture chatCompletion)
        最新版的GPT-4 chat completion 支持图片输入
        Parameters:
        chatCompletion - chat completion
        Returns:
        返回答案

      • speechToTextTranscriptions

        @Multipart
@POST("v1/audio/transcriptions")
io.reactivex.Single<WhisperResponse> speechToTextTranscriptions​(@Part
                                                                okhttp3.MultipartBody.Part file,
                                                                @PartMap
                                                                Map<String,​okhttp3.RequestBody> requestBodyMap)
        语音转文字
        Parameters:
        file - 语音文件
        requestBodyMap - 参数
        Returns:
        文本

      • speechToTextTranslations

        @Multipart
@POST("v1/audio/translations")
io.reactivex.Single<WhisperResponse> speechToTextTranslations​(@Part
                                                              okhttp3.MultipartBody.Part file,
                                                              @PartMap
                                                              Map<String,​okhttp3.RequestBody> requestBodyMap)
        语音翻译：目前仅支持翻译为英文
        Parameters:
        file - 语音文件
        requestBodyMap - 参数
        Returns:
        文本

      • creditGrants

        @GET("dashboard/billing/credit_grants")
@Deprecated
io.reactivex.Single<CreditGrantsResponse> creditGrants()
        Deprecated.
        余额查询 官方禁止访问此接口
        Returns:
        余额结果

      • subscription

        @GET("v1/dashboard/billing/subscription")
io.reactivex.Single<Subscription> subscription()
        账户信息查询：里面包含总金额（美元）等信息
        Returns:
        账户信息

      • billingUsage

        @GET("v1/dashboard/billing/usage")
io.reactivex.Single<BillingUsage> billingUsage​(@Query("start_date")
                                               LocalDate starDate,
                                               @Query("end_date")
                                               LocalDate endDate)
        账户调用接口消耗金额信息查询 totalUsage = 账户总使用金额（美分）
        Parameters:
        starDate - 开始时间
        endDate - 结束时间
        Returns:
        消耗金额信息

      • textToSpeech

        @POST("v1/audio/speech")
@Streaming
retrofit2.Call<okhttp3.ResponseBody> textToSpeech​(@Body
                                                  TextToSpeech textToSpeech)
        文本转语音
        Parameters:
        textToSpeech - 参数
        Returns:
        ResponseBody body
        Since:
        1.1.2

      • fineTuneJob

        @POST("v1/fine_tuning/jobs")
io.reactivex.Single<FineTuneJobResponse> fineTuneJob​(@Body
                                                     FineTuneJob fineTuneJob)
        创建微调job
        Parameters:
        fineTuneJob - 微调
        Returns:
        Single FineTuneJobResponse
        Since:
        1.1.2

      • fineTuneJobs

        @GET("v1/fine_tuning/jobs")
io.reactivex.Single<FineTuneJobListResponse<FineTuneJobResponse>> fineTuneJobs​(@Query("after")
                                                                               String after,
                                                                               @Query("limit")
                                                                               Integer limit)
        微调job集合
        Parameters:
        after - 上一个分页请求中最后一个job id
        limit - 每次查询数量
        Returns:
        FineTuneJobListResponse #FineTuneResponse
        Since:
        1.1.2

      • retrieveFineTuneJob

        @GET("v1/fine_tuning/jobs/{fine_tuning_job_id}")
io.reactivex.Single<FineTuneJobResponse> retrieveFineTuneJob​(@Path("fine_tuning_job_id")
                                                             String fineTuneJobId)
        检索微调job
        Parameters:
        fineTuneJobId - JobId
        Returns:
        FineTuneJobResponse
        Since:
        1.1.2

      • cancelFineTuneJob

        @POST("v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel")
io.reactivex.Single<FineTuneJobResponse> cancelFineTuneJob​(@Path("fine_tuning_job_id")
                                                           String fineTuneJobId)
        取消微调job
        Parameters:
        fineTuneJobId - JobId
        Returns:
        FineTuneJobResponse
        Since:
        1.1.2

      • fineTuneJobEvents

        @GET("v1/fine_tuning/jobs/{fine_tuning_job_id}/events")
io.reactivex.Single<FineTuneJobListResponse<FineTuneJobEvent>> fineTuneJobEvents​(@Path("fine_tuning_job_id")
                                                                                 String fineTuneJobId,
                                                                                 @Query("after")
                                                                                 String after,
                                                                                 @Query("limit")
                                                                                 Integer limit)
        微调job事件列表
        Parameters:
        fineTuneJobId - JobId
        after - 上一个分页请求中最后一个id，默认值：null
        limit - 每次查询数量 默认值：20
        Returns:
        FineTuneJobListResponse #FineTuneResponse
        Since:
        1.1.2