com.plexpt.chatgpt.api

Interface Api

public interface Api

API接口 API interface

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_API_HOST

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<okhttp3.ResponseBody>	audioSpeech(SpeechRequest speechRequest) 生成语音 Create speech
io.reactivex.Single<AudioResponse>	audioTranscriptions(okhttp3.MultipartBody.Part audio, Transcriptions transcriptions) 音频转录 Audio transcriptions
io.reactivex.Single<AudioResponse>	audioTranslations(okhttp3.MultipartBody.Part audio, Transcriptions transcriptions) 音频翻译 Audio translations
io.reactivex.Single<ChatCompletionResponse>	chatCompletion(ChatCompletion chatCompletion) 聊天 Chat
io.reactivex.Single<EmbeddingResult>	createEmbeddings(EmbeddingRequest request) 生成向量 Create embeddings
io.reactivex.Single<CreditGrantsResponse>	creditGrants() 余额查询 Credit grants query
io.reactivex.Single<DeleteResponse>	deleteFile(String fileId) 删除文件 Delete file
io.reactivex.Single<ImagesRensponse>	imageEdits(okhttp3.MultipartBody.Part image, okhttp3.MultipartBody.Part mask, Edits edits) 图像编辑 Image edits
io.reactivex.Single<ImagesRensponse>	imageGenerations(Generations generations) 图像生成 Image generations
io.reactivex.Single<ImagesRensponse>	imageVariations(okhttp3.MultipartBody.Part image, Variations variations) 图像变体 Image variations
io.reactivex.Single<BaseResponse<FileResponse>>	listFiles() 列出文件 List files
io.reactivex.Single<FileResponse>	retrieveFile(String fileId) 检索文件 Retrieve file
io.reactivex.Single<okhttp3.ResponseBody>	retrieveFileContent(String fileId) 检索文件内容 Retrieve file content
io.reactivex.Single<SubscriptionData>	subscription() 订阅查询 Subscription query
io.reactivex.Single<FileResponse>	uploadFile(okhttp3.RequestBody purpose, okhttp3.MultipartBody.Part file) 上传文件 Upload file
io.reactivex.Single<UseageResponse>	usage(String startDate, String endDate) 使用情况查询 Usage query

Field Detail

DEFAULT_API_HOST

static final String DEFAULT_API_HOST

See Also:

Constant Field Values

Method Detail

chatCompletion

@POST(value="v1/chat/completions")
io.reactivex.Single<ChatCompletionResponse> chatCompletion(@Body
                                                                                              ChatCompletion chatCompletion)

聊天 Chat

imageGenerations

@POST(value="v1/images/generations")
io.reactivex.Single<ImagesRensponse> imageGenerations(@Body
                                                                                           Generations generations)

图像生成 Image generations

imageEdits

@Multipart
 @POST(value="v1/images/edits")
io.reactivex.Single<ImagesRensponse> imageEdits(@Part
                                                                                           okhttp3.MultipartBody.Part image,
                                                                                           @Part
                                                                                           okhttp3.MultipartBody.Part mask,
                                                                                           @PartMap
                                                                                           Edits edits)

图像编辑 Image edits

imageVariations

@Multipart
 @POST(value="v1/images/variations")
io.reactivex.Single<ImagesRensponse> imageVariations(@Part
                                                                                                     okhttp3.MultipartBody.Part image,
                                                                                                     @PartMap
                                                                                                     Variations variations)

图像变体 Image variations

audioSpeech

@POST(value="v1/audio/speech")
io.reactivex.Single<okhttp3.ResponseBody> audioSpeech(@Body
                                                                                     SpeechRequest speechRequest)

生成语音 Create speech

audioTranscriptions

@Multipart
 @POST(value="v1/audio/transcriptions")
io.reactivex.Single<AudioResponse> audioTranscriptions(@Part
                                                                                                          okhttp3.MultipartBody.Part audio,
                                                                                                          @PartMap
                                                                                                          Transcriptions transcriptions)

音频转录 Audio transcriptions

audioTranslations

@Multipart
 @POST(value="v1/audio/translations")
io.reactivex.Single<AudioResponse> audioTranslations(@Part
                                                                                                      okhttp3.MultipartBody.Part audio,
                                                                                                      @PartMap
                                                                                                      Transcriptions transcriptions)

音频翻译 Audio translations

creditGrants

@GET(value="dashboard/billing/credit_grants")
io.reactivex.Single<CreditGrantsResponse> creditGrants()

余额查询 Credit grants query

subscription

@GET(value="v1/dashboard/billing/subscription")
io.reactivex.Single<SubscriptionData> subscription()

订阅查询 Subscription query

usage

@GET(value="v1/dashboard/billing/usage")
io.reactivex.Single<UseageResponse> usage(@Query(value="start_date")
                                                                                   String startDate,
                                                                                   @Query(value="end_date")
                                                                                   String endDate)

使用情况查询 Usage query

createEmbeddings

@POST(value="v1/embeddings")
io.reactivex.Single<EmbeddingResult> createEmbeddings(@Body
                                                                                   EmbeddingRequest request)

生成向量 Create embeddings

listFiles

@GET(value="/v1/files")
io.reactivex.Single<BaseResponse<FileResponse>> listFiles()

列出文件 List files

uploadFile

@Multipart
 @POST(value="/v1/files")
io.reactivex.Single<FileResponse> uploadFile(@Part(value="purpose")
                                                                                  okhttp3.RequestBody purpose,
                                                                                  @Part
                                                                                  okhttp3.MultipartBody.Part file)

上传文件 Upload file

deleteFile

@DELETE(value="/v1/files/{file_id}")
io.reactivex.Single<DeleteResponse> deleteFile(@Path(value="file_id")
                                                                                    String fileId)

删除文件 Delete file

retrieveFile

@GET(value="/v1/files/{file_id}")
io.reactivex.Single<FileResponse> retrieveFile(@Path(value="file_id")
                                                                                 String fileId)

检索文件 Retrieve file

retrieveFileContent

@Streaming
 @GET(value="/v1/files/{file_id}/content")
io.reactivex.Single<okhttp3.ResponseBody> retrieveFileContent(@Path(value="file_id")
                                                                                                                    String fileId)

检索文件内容 Retrieve file content