```
public interface OpenAiApi
```
描述： open ai官方api接口

Author:

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

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`io.reactivex.Single<BillingUsage>`	`billingUsage(LocalDate starDate, LocalDate endDate)`	账户调用接口消耗金额信息查询 totalUsage = 账户总使用金额（美分）
`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()`	Deprecated.
`io.reactivex.Single<DeleteResponse>`	`deleteFile(String fileId)`	删除文件
`io.reactivex.Single<FineTuneDeleteResponse>`	`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)`	文本向量计算
`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, Map<String,okhttp3.RequestBody> requestBodyMap)`	语音转文字
`io.reactivex.Single<WhisperResponse>`	`speechToTextTranslations(okhttp3.MultipartBody.Part file, Map<String,okhttp3.RequestBody> requestBodyMap)`	语音翻译：目前仅支持翻译为英文
`io.reactivex.Single<Subscription>`	`subscription()`	账户信息查询：里面包含总金额（美元）等信息
`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("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

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

fineTune

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

创建微调作业

Parameters:: fineTune - 微调
Returns:: Single FineTuneResponse

fineTunes

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

微调作业集合

Returns:: Single OpenAiResponse FineTuneResponse

retrieveFineTune

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

检索微调作业

Returns:: Single FineTuneResponse

cancelFineTune

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

取消微调作业

Returns:: Single FineTuneResponse

fineTuneEvents

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

微调作业事件列表

Returns:: Single OpenAiResponse Event

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:: 返回答案

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()