OpenAiClient (chatgpt-java 1.0.8 API)

java.lang.Object
- com.unfbx.chatgpt.OpenAiClient

```
public class OpenAiClient
extends Object
```
描述： open ai 客户端

Since:

2023-02-11

Author:

https:www.unfbx.com

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OpenAiClient.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`OpenAiClient.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static OpenAiClient.Builder`	`builder()` 构造器
`FineTuneResponse`	`cancelFineTune(String fineTuneId)` 取消微调作业
`ChatCompletionResponse`	`chatCompletion(ChatCompletion chatCompletion)` 最新版的GPT-3.5 chat completion 更加贴近官方网站的问答模型
`ChatCompletionResponse`	`chatCompletion(List<Message> messages)` 简易版
`CompletionResponse`	`completions(Completion completion)` 问答接口
`CompletionResponse`	`completions(String question)` 问答接口-简易版
`CreditGrantsResponse`	`creditGrants()` OpenAi账户余额查询
`DeleteResponse`	`deleteFile(String fileId)` 删除文件
`DeleteResponse`	`deleteFineTuneModel(String model)` 删除微调作业模型 Delete a fine-tuned model.
`EditResponse`	`edit(Edit edit)` 文本修改
`List<Item>`	`editImages(File image, File mask, ImageEdit imageEdit)` Creates an edited or extended image given an original image and a prompt.
`List<Item>`	`editImages(File image, ImageEdit imageEdit)` Creates an edited or extended image given an original image and a prompt.
`List<Item>`	`editImages(File image, String prompt)` Creates an edited or extended image given an original image and a prompt.
`EmbeddingResponse`	`embeddings(Embedding embedding)` Creates an embedding vector representing the input text.
`EmbeddingResponse`	`embeddings(String input)` Creates an embedding vector representing the input text.
`Engine`	`engine(String engineId)` Deprecated.
`List<Engine>`	`engines()` Deprecated.
`List<File>`	`files()` 获取文件列表
`FineTuneResponse`	`fineTune(FineTune fineTune)` 创建微调模型
`FineTuneResponse`	`fineTune(String trainingFileId)` 创建微调模型
`List<Event>`	`fineTuneEvents(String fineTuneId)` 微调作业事件列表
`List<FineTuneResponse>`	`fineTunes()` 微调模型列表
`ImageResponse`	`genImages(Image image)` 根据描述生成图片
`ImageResponse`	`genImages(String prompt)` 根据描述生成图片
`Model`	`model(String id)` openAi模型详细信息
`List<Model>`	`models()` openAi模型列表
`ModerationResponse`	`moderations(Moderation moderation)` 文本审核
`ModerationResponse`	`moderations(String input)` 文本审核
`File`	`retrieveFile(String fileId)` 检索文件
`FineTuneResponse`	`retrieveFineTune(String fineTuneId)` 检索微调作业
`WhisperResponse`	`speechToTextTranscriptions(File file)` 简易版语音转文字
`WhisperResponse`	`speechToTextTranscriptions(File file, Whisper.Model model)` 语音转文字
`WhisperResponse`	`speechToTextTranslations(File file)` 简易版语音翻译：目前仅支持翻译为英文
`WhisperResponse`	`speechToTextTranslations(File file, Whisper.Model model)` 语音翻译：目前仅支持翻译为英文
`UploadFileResponse`	`uploadFile(File file)` 上传文件
`UploadFileResponse`	`uploadFile(String purpose, File file)` 上传文件
`ImageResponse`	`variationsImages(File image)` Creates a variation of a given image.
`ImageResponse`	`variationsImages(File image, ImageVariations imageVariations)` Creates a variation of a given image.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static OpenAiClient.Builder builder()
```
    构造器
    
    Returns:
  - 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
```
public EditResponse edit(Edit edit)
```
    文本修改
    
    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)
```
    Creates an embedding vector representing the input text.
    
    Parameters:
    
    input -
    
    Returns:
    
    EmbeddingResponse
  - embeddings
```
public EmbeddingResponse embeddings(Embedding embedding)
```
    Creates an embedding vector representing the input text.
    
    Parameters:
    
    embedding -
    
    Returns:
    
    EmbeddingResponse
  - files
```
public List<File> files()
```
    获取文件列表
    
    Returns:
    
    File list
  - deleteFile
```
public DeleteResponse deleteFile(String fileId)
```
    删除文件
    
    Parameters:
    
    fileId -
    
    Returns:
    
    DeleteResponse
  - uploadFile
```
public UploadFileResponse uploadFile(String purpose,
                                     File file)
```
    上传文件
    
    Parameters:
    
    purpose -
    
    file -
    
    Returns:
    
    UploadFileResponse
  - uploadFile
```
public UploadFileResponse uploadFile(File file)
```
    上传文件
    
    Parameters:
    
    file -
    
    Returns:
    
    UploadFileResponse
  - retrieveFile
```
public File retrieveFile(String fileId)
```
    检索文件
    
    Parameters:
    
    fileId -
    
    Returns:
    
    File
  - moderations
```
public ModerationResponse moderations(String input)
```
    文本审核
    
    Parameters:
    
    input -
    
    Returns:
    
    ModerationResponse
  - moderations
```
public ModerationResponse moderations(Moderation moderation)
```
    文本审核
    
    Parameters:
    
    moderation -
    
    Returns:
    
    ModerationResponse
  - fineTune
```
public FineTuneResponse fineTune(FineTune fineTune)
```
    创建微调模型
    
    Parameters:
    
    fineTune -
    
    Returns:
    
    FineTuneResponse
  - fineTune
```
public FineTuneResponse fineTune(String trainingFileId)
```
    创建微调模型
    
    Parameters:
    
    trainingFileId - 文件id，文件上传返回的id
    
    Returns:
    
    FineTuneResponse
  - fineTunes
```
public List<FineTuneResponse> fineTunes()
```
    微调模型列表
    
    Returns:
    
    FineTuneResponse list
  - retrieveFineTune
```
public FineTuneResponse retrieveFineTune(String fineTuneId)
```
    检索微调作业
    
    Parameters:
    
    fineTuneId -
    
    Returns:
    
    FineTuneResponse
  - cancelFineTune
```
public FineTuneResponse cancelFineTune(String fineTuneId)
```
    取消微调作业
    
    Parameters:
    
    fineTuneId -
    
    Returns:
    
    FineTuneResponse
  - fineTuneEvents
```
public List<Event> fineTuneEvents(String fineTuneId)
```
    微调作业事件列表
    
    Parameters:
    
    fineTuneId -
    
    Returns:
    
    Event List
  - deleteFineTuneModel
```
public DeleteResponse deleteFineTuneModel(String model)
```
    删除微调作业模型 Delete a fine-tuned model. You must have the Owner role in your organization.
    
    Parameters:
    
    model -
    
    Returns:
    
    DeleteResponse
  - engines
```
@Deprecated
public List<Engine> engines()
```
    Deprecated.
    
    引擎列表
    
    Returns:
    
    Engine List
  - engine
```
@Deprecated
public Engine engine(String engineId)
```
    Deprecated.
    
    引擎详细信息
    
    Parameters:
    
    engineId - 引擎id
    
    Returns:
    
    Engine
  - chatCompletion
```
public ChatCompletionResponse chatCompletion(ChatCompletion chatCompletion)
```
    最新版的GPT-3.5 chat completion 更加贴近官方网站的问答模型
    
    Parameters:
    
    chatCompletion - 问答参数
    
    Returns:
    
    答案
  - chatCompletion
```
public ChatCompletionResponse chatCompletion(List<Message> messages)
```
    简易版
    
    Parameters:
    
    messages - 问答参数
    
    Returns:
    
    答案
  - speechToTextTranscriptions
```
public WhisperResponse speechToTextTranscriptions(File file,
                                                  Whisper.Model model)
```
    语音转文字
    
    Parameters:
    
    model - 模型 Whisper.Model
    
    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,
                                                Whisper.Model model)
```
    语音翻译：目前仅支持翻译为英文
    
    Parameters:
    
    model - 模型 Whisper.Model
    
    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:
    
    翻译后文本
  - creditGrants
```
public CreditGrantsResponse creditGrants()
```
    OpenAi账户余额查询
    
    Returns:

Class OpenAiClient

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

models

model

completions

completions

edit

genImages

genImages

editImages

editImages

editImages

variationsImages

variationsImages

embeddings

embeddings

files

deleteFile

uploadFile

uploadFile

retrieveFile

moderations

moderations

fineTune

fineTune

fineTunes

retrieveFineTune

cancelFineTune

fineTuneEvents

deleteFineTuneModel

engines

engine

chatCompletion

chatCompletion

speechToTextTranscriptions

speechToTextTranscriptions

speechToTextTranslations

speechToTextTranslations

creditGrants