com.unfbx.chatgpt

Interface OpenAiApi

public interface OpenAiApi

描述： open ai官方api接口

Author:

https:www.unfbx.com 2023-02-15

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<FineTuneResponse>	cancelFineTune(String fineTuneId) 取消微调作业
io.reactivex.Single<ChatCompletionResponse>	chatCompletion(ChatCompletion chatCompletion) 最新版的GPT-3.5 chat completion 更加贴近官方网站的问答模型
io.reactivex.Single<CompletionResponse>	completions(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.
io.reactivex.Single<CreditGrantsResponse>	creditGrants() 余额查询
io.reactivex.Single<DeleteResponse>	deleteFile(String fileId) 删除文件
io.reactivex.Single<DeleteResponse>	deleteFineTuneModel(String model) 删除微调作业模型 Delete a fine-tuned model.
io.reactivex.Single<ImageResponse>	editImages(okhttp3.MultipartBody.Part image, okhttp3.MultipartBody.Part mask, Map<String,okhttp3.RequestBody> requestBodyMap) Creates an edited or extended image given an original image and a prompt.
io.reactivex.Single<EditResponse>	edits(Edit edit) Creates a new edit for the provided input, instruction, and parameters.
io.reactivex.Single<EmbeddingResponse>	embeddings(Embedding embedding) Creates an embedding vector representing the input text.
io.reactivex.Single<Engine>	engine(String engineId) Deprecated.
io.reactivex.Single<OpenAiResponse<Engine>>	engines() Deprecated.
io.reactivex.Single<OpenAiResponse<File>>	files() Returns a list of files that belong to the user's organization.
io.reactivex.Single<FineTuneResponse>	fineTune(FineTune fineTune) 创建微调作业
io.reactivex.Single<OpenAiResponse<Event>>	fineTuneEvents(String fineTuneId) 微调作业事件列表
io.reactivex.Single<OpenAiResponse<FineTuneResponse>>	fineTunes() 微调作业集合
io.reactivex.Single<ImageResponse>	genImages(Image image) Creates an image given a prompt.
io.reactivex.Single<Model>	model(String id) models 返回的数据id
io.reactivex.Single<ModelResponse>	models() 模型列表
io.reactivex.Single<ModerationResponse>	moderations(Moderation moderation) 文本审核
io.reactivex.Single<File>	retrieveFile(String fileId) 检索文件
io.reactivex.Single<okhttp3.ResponseBody>	retrieveFileContent(String fileId) 检索文件内容 ###不对免费用户开放### ###不对免费用户开放### ###不对免费用户开放###
io.reactivex.Single<FineTuneResponse>	retrieveFineTune(String fineTuneId) 检索微调作业
io.reactivex.Single<WhisperResponse>	speechToTextTranscriptions(okhttp3.MultipartBody.Part file, okhttp3.RequestBody model) 语音转文字
io.reactivex.Single<WhisperResponse>	speechToTextTranslations(okhttp3.MultipartBody.Part file, okhttp3.RequestBody model) 语音翻译：目前仅支持翻译为英文
io.reactivex.Single<UploadFileResponse>	uploadFile(okhttp3.MultipartBody.Part file, okhttp3.RequestBody purpose) 上传文件
io.reactivex.Single<ImageResponse>	variationsImages(okhttp3.MultipartBody.Part image, Map<String,okhttp3.RequestBody> requestBodyMap) Creates a variation of a given image.

Method Detail

models

@GET(value="v1/models")
io.reactivex.Single<ModelResponse> models()

模型列表

Returns:

Single ModelResponse

model

@GET(value="v1/models/{id}")
io.reactivex.Single<Model> model(@Path(value="id")
                                                               String id)

models 返回的数据id

Parameters:

id -

Returns:

Single Model

completions

@POST(value="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

@POST(value="v1/edits")
io.reactivex.Single<EditResponse> edits(@Body
                                                                 Edit edit)

Creates a new edit for the provided input, instruction, and parameters. 文本修复

Parameters:

edit -

Returns:

Single EditResponse

genImages

@POST(value="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(value="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(value="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(value="v1/embeddings")
io.reactivex.Single<EmbeddingResponse> embeddings(@Body
                                                                                Embedding embedding)

Creates an embedding vector representing the input text.

Parameters:

embedding -

Returns:

Single EmbeddingResponse

files

@GET(value="/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(value="v1/files/{file_id}")
io.reactivex.Single<DeleteResponse> deleteFile(@Path(value="file_id")
                                                                                    String fileId)

删除文件

Parameters:

fileId -

Returns:

Single DeleteResponse

uploadFile

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

上传文件

Parameters:

purpose -

file -

Returns:

Single UploadFileResponse

retrieveFile

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

检索文件

Parameters:

fileId -

Returns:

Single File

retrieveFileContent

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

检索文件内容 ###不对免费用户开放### ###不对免费用户开放### ###不对免费用户开放###

Parameters:

fileId -

Returns:

Single ResponseBody

moderations

@POST(value="v1/moderations")
io.reactivex.Single<ModerationResponse> moderations(@Body
                                                                                   Moderation moderation)

文本审核

Parameters:

moderation -

Returns:

Single ModerationResponse

fineTune

@POST(value="v1/fine-tunes")
io.reactivex.Single<FineTuneResponse> fineTune(@Body
                                                                             FineTune fineTune)

创建微调作业

Parameters:

fineTune -

Returns:

Single FineTuneResponse

fineTunes

@GET(value="v1/fine-tunes")
io.reactivex.Single<OpenAiResponse<FineTuneResponse>> fineTunes()

微调作业集合

Returns:

Single OpenAiResponse FineTuneResponse

retrieveFineTune

@GET(value="v1/fine-tunes/{fine_tune_id}")
io.reactivex.Single<FineTuneResponse> retrieveFineTune(@Path(value="fine_tune_id")
                                                                                                   String fineTuneId)

检索微调作业

Returns:

Single FineTuneResponse

cancelFineTune

@POST(value="v1/fine-tunes/{fine_tune_id}/cancel")
io.reactivex.Single<FineTuneResponse> cancelFineTune(@Path(value="fine_tune_id")
                                                                                                         String fineTuneId)

取消微调作业

Returns:

Single FineTuneResponse

fineTuneEvents

@GET(value="v1/fine-tunes/{fine_tune_id}/events")
io.reactivex.Single<OpenAiResponse<Event>> fineTuneEvents(@Path(value="fine_tune_id")
                                                                                                             String fineTuneId)

微调作业事件列表

Returns:

Single OpenAiResponse Event

deleteFineTuneModel

@GET(value="v1/models/{model}")
io.reactivex.Single<DeleteResponse> deleteFineTuneModel(@Path(value="model")
                                                                                         String model)

删除微调作业模型 Delete a fine-tuned model. You must have the Owner role in your organization.

Returns:

Single DeleteResponse

engines

@Deprecated
 @GET(value="v1/engines")
io.reactivex.Single<OpenAiResponse<Engine>> engines()

Deprecated.

引擎列表 官方已废弃此接口

Returns:

Single OpenAiResponse Engine

engine

@Deprecated
 @GET(value="v1/engines/{engine_id}")
io.reactivex.Single<Engine> engine(@Path(value="engine_id")
                                                                                       String engineId)

Deprecated.

检索引擎 官方已废弃此接口

Parameters:

engineId -

Returns:

Engine

chatCompletion

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

最新版的GPT-3.5 chat completion 更加贴近官方网站的问答模型

Parameters:

chatCompletion - chat completion

Returns:

返回答案

speechToTextTranscriptions

@Multipart
 @POST(value="v1/audio/transcriptions")
io.reactivex.Single<WhisperResponse> speechToTextTranscriptions(@Part
                                                                                                                     okhttp3.MultipartBody.Part file,
                                                                                                                     @Part(value="model")
                                                                                                                     okhttp3.RequestBody model)

语音转文字

Parameters:

model - 模型

file - 语音文件

Returns:

文本

speechToTextTranslations

@Multipart
 @POST(value="v1/audio/translations")
io.reactivex.Single<WhisperResponse> speechToTextTranslations(@Part
                                                                                                                 okhttp3.MultipartBody.Part file,
                                                                                                                 @Part(value="model")
                                                                                                                 okhttp3.RequestBody model)

语音翻译：目前仅支持翻译为英文

Parameters:

model - 模型

file - 语音文件

Returns:

文本

creditGrants

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

余额查询

Returns:

余额结果