DefaultOpenAiSession (chatgpt-sdk-java 1.0 API)

java.lang.Object
- plus.gaga.middleware.chatgpt.session.defaults.DefaultOpenAiSession

所有已实现的接口:: OpenAiSession

public class DefaultOpenAiSession
extends Object
implements OpenAiSession

作者:: 小傅哥，微信：fustack

构造器概要

构造器
构造器和说明

DefaultOpenAiSession(Configuration configuration)

构造器
构造器和说明
`DefaultOpenAiSession(Configuration configuration)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`BillingUsage`	`billingUsage(@NotNull java.time.LocalDate starDate, @NotNull java.time.LocalDate endDate)` 消耗查询
`okhttp3.sse.EventSource`	`chatCompletions(ChatCompletionRequest chatCompletionRequest, okhttp3.sse.EventSourceListener eventSourceListener)` 问答模型 GPT-3.5/4.0 & 流式反馈
`okhttp3.sse.EventSource`	`chatCompletions(String apiKey, ChatCompletionRequest chatCompletionRequest, okhttp3.sse.EventSourceListener eventSourceListener)` 问答模型 GPT-3.5/4.0 & 流式反馈
`okhttp3.sse.EventSource`	`chatCompletions(String apiHostByUser, String apiKeyByUser, ChatCompletionRequest chatCompletionRequest, okhttp3.sse.EventSourceListener eventSourceListener)` 问答模型 GPT-3.5/4.0 & 流式反馈
`ChatCompletionResponse`	`completions(ChatCompletionRequest chatCompletionRequest)` 问答模型 GPT-3.5/4.0
`QACompletionResponse`	`completions(QACompletionRequest qaCompletionRequest)` 文本问答
`okhttp3.sse.EventSource`	`completions(QACompletionRequest qaCompletionRequest, okhttp3.sse.EventSourceListener eventSourceListener)` 文本问答 & 流式反馈
`QACompletionResponse`	`completions(String question)` 文本问答；简单请求
`VisionCompletionResponse`	`completions(String apiHostByUser, String apiKeyByUser, VisionCompletionRequest visionCompletionRequest)` 多模态(图像识别) GPT-4-vision
`okhttp3.sse.EventSource`	`completions(String apiHostByUser, String apiKeyByUser, VisionCompletionRequest visionCompletionRequest, okhttp3.sse.EventSourceListener eventSourceListener)` 多模态(图像识别) GPT-4-vision & 流式
`VisionCompletionResponse`	`completions(VisionCompletionRequest visionCompletionRequest)` 多模态(图像识别) GPT-4-vision
`okhttp3.sse.EventSource`	`completions(VisionCompletionRequest visionCompletionRequest, okhttp3.sse.EventSourceListener eventSourceListener)` 多模态(图像识别) GPT-4-vision & 流式
`DeleteFileResponse`	`deleteFile(String fileId)` 删除文件
`EditResponse`	`edit(EditRequest editRequest)` 文本修复
`ImageResponse`	`editImages(File image, File mask, ImageEditRequest imageEditRequest)` 修改图片
`ImageResponse`	`editImages(File image, ImageEditRequest imageEditRequest)` 修改图片
`ImageResponse`	`editImages(File image, String prompt)` 修改图片
`EmbeddingResponse`	`embeddings(EmbeddingRequest embeddingRequest)` 向量计算；入参文本向量计算是一种在自然语言处理（NLP）领域中用于测量和比较文本相似性的技术。
`EmbeddingResponse`	`embeddings(List<String> inputs)` 向量计算；多个文本文本向量计算是一种在自然语言处理（NLP）领域中用于测量和比较文本相似性的技术。
`EmbeddingResponse`	`embeddings(String... inputs)` 向量计算；多个文本文本向量计算是一种在自然语言处理（NLP）领域中用于测量和比较文本相似性的技术。
`EmbeddingResponse`	`embeddings(String input)` 向量计算；单个文本文本向量计算是一种在自然语言处理（NLP）领域中用于测量和比较文本相似性的技术。
`OpenAiResponse<File>`	`files()` 获取文件
`ImageResponse`	`genImages(ImageRequest imageRequest)` 生成图片
`ImageResponse`	`genImages(String prompt)` 生成图片
`ImageResponse`	`genImages(String apiHostByUser, String apiKeyByUser, ImageRequest imageRequest)` 生成图片
`WhisperResponse`	`speed2TextTranscriptions(File file, TranscriptionsRequest transcriptionsRequest)` 语音转文字
`WhisperResponse`	`speed2TextTranslations(File file, TranslationsRequest translationsRequest)` 语音翻译
`Subscription`	`subscription()` 账单查询
`UploadFileResponse`	`uploadFile(File file)` 上传文件
`UploadFileResponse`	`uploadFile(String purpose, File file)` 上传文件

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - DefaultOpenAiSession
```
public DefaultOpenAiSession(Configuration configuration)
```
- 方法详细资料
  - completions
```
public QACompletionResponse completions(QACompletionRequest qaCompletionRequest)
```
    从接口复制的说明: OpenAiSession
    
    文本问答
    
    指定者:
    
    completions 在接口中 OpenAiSession
    
    参数:
    
    qaCompletionRequest - 请求信息
    
    返回:
    
    应答结果
  - completions
```
public okhttp3.sse.EventSource completions(QACompletionRequest qaCompletionRequest,
                                           okhttp3.sse.EventSourceListener eventSourceListener)
                                    throws com.fasterxml.jackson.core.JsonProcessingException
```
    从接口复制的说明: OpenAiSession
    
    文本问答 & 流式反馈
    
    指定者:
    
    completions 在接口中 OpenAiSession
    
    参数:
    
    qaCompletionRequest - 请求信息
    
    eventSourceListener - 实现监听；通过监听的 onEvent 方法接收数据
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException
  - completions
```
public QACompletionResponse completions(String question)
```
    从接口复制的说明: OpenAiSession
    
    文本问答；简单请求
    
    指定者:
    
    completions 在接口中 OpenAiSession
    
    参数:
    
    question - 请求信息
    
    返回:
    
    应答结果
  - completions
```
public ChatCompletionResponse completions(ChatCompletionRequest chatCompletionRequest)
```
    从接口复制的说明: OpenAiSession
    
    问答模型 GPT-3.5/4.0
    
    指定者:
    
    completions 在接口中 OpenAiSession
    
    参数:
    
    chatCompletionRequest - 请求信息
    
    返回:
    
    应答结果
  - completions
```
public VisionCompletionResponse completions(VisionCompletionRequest visionCompletionRequest)
```
    从接口复制的说明: OpenAiSession
    
    多模态(图像识别) GPT-4-vision
    
    指定者:
    
    completions 在接口中 OpenAiSession
    
    参数:
    
    visionCompletionRequest - 请求信息
    
    返回:
    
    应答结果
  - completions
```
public VisionCompletionResponse completions(String apiHostByUser,
                                            String apiKeyByUser,
                                            VisionCompletionRequest visionCompletionRequest)
                                     throws IOException
```
    从接口复制的说明: OpenAiSession
    
    多模态(图像识别) GPT-4-vision
    
    指定者:
    
    completions 在接口中 OpenAiSession
    
    参数:
    
    apiHostByUser - 自定义host
    
    apiKeyByUser - 自定义Key
    
    visionCompletionRequest - 请求信息
    
    返回:
    
    应答结果
    
    抛出:
    
    IOException
  - completions
```
public okhttp3.sse.EventSource completions(VisionCompletionRequest visionCompletionRequest,
                                           okhttp3.sse.EventSourceListener eventSourceListener)
                                    throws IOException
```
    从接口复制的说明: OpenAiSession
    
    多模态(图像识别) GPT-4-vision & 流式
    
    指定者:
    
    completions 在接口中 OpenAiSession
    
    参数:
    
    visionCompletionRequest - 请求信息
    
    返回:
    
    应答结果
    
    抛出:
    
    IOException
  - completions
```
public okhttp3.sse.EventSource completions(String apiHostByUser,
                                           String apiKeyByUser,
                                           VisionCompletionRequest visionCompletionRequest,
                                           okhttp3.sse.EventSourceListener eventSourceListener)
                                    throws IOException
```
    从接口复制的说明: OpenAiSession
    
    多模态(图像识别) GPT-4-vision & 流式
    
    指定者:
    
    completions 在接口中 OpenAiSession
    
    参数:
    
    apiHostByUser - 自定义host
    
    apiKeyByUser - 自定义Key
    
    visionCompletionRequest - 请求信息
    
    返回:
    
    应答结果
    
    抛出:
    
    IOException
  - chatCompletions
```
public okhttp3.sse.EventSource chatCompletions(ChatCompletionRequest chatCompletionRequest,
                                               okhttp3.sse.EventSourceListener eventSourceListener)
                                        throws com.fasterxml.jackson.core.JsonProcessingException
```
    从接口复制的说明: OpenAiSession
    
    问答模型 GPT-3.5/4.0 & 流式反馈
    
    指定者:
    
    chatCompletions 在接口中 OpenAiSession
    
    参数:
    
    chatCompletionRequest - 请求信息
    
    eventSourceListener - 实现监听；通过监听的 onEvent 方法接收数据
    
    返回:
    
    应答结果
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException
  - chatCompletions
```
public okhttp3.sse.EventSource chatCompletions(String apiKey,
                                               ChatCompletionRequest chatCompletionRequest,
                                               okhttp3.sse.EventSourceListener eventSourceListener)
                                        throws com.fasterxml.jackson.core.JsonProcessingException
```
    从接口复制的说明: OpenAiSession
    
    问答模型 GPT-3.5/4.0 & 流式反馈
    
    指定者:
    
    chatCompletions 在接口中 OpenAiSession
    
    参数:
    
    apiKey - 自定义Key
    
    chatCompletionRequest - 请求信息
    
    eventSourceListener - 实现监听；通过监听的 onEvent 方法接收数据
    
    返回:
    
    应答结果
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException
  - chatCompletions
```
public okhttp3.sse.EventSource chatCompletions(String apiHostByUser,
                                               String apiKeyByUser,
                                               ChatCompletionRequest chatCompletionRequest,
                                               okhttp3.sse.EventSourceListener eventSourceListener)
                                        throws com.fasterxml.jackson.core.JsonProcessingException
```
    从接口复制的说明: OpenAiSession
    
    问答模型 GPT-3.5/4.0 & 流式反馈
    
    指定者:
    
    chatCompletions 在接口中 OpenAiSession
    
    参数:
    
    apiHostByUser - 自定义host
    
    apiKeyByUser - 自定义Key
    
    chatCompletionRequest - 请求信息
    
    eventSourceListener - 实现监听；通过监听的 onEvent 方法接收数据
    
    返回:
    
    应答结果
    
    抛出:
    
    com.fasterxml.jackson.core.JsonProcessingException
  - edit
```
public EditResponse edit(EditRequest editRequest)
```
    从接口复制的说明: OpenAiSession
    
    文本修复
    
    指定者:
    
    edit 在接口中 OpenAiSession
    
    参数:
    
    editRequest - 请求信息
    
    返回:
    
    应答结果
  - genImages
```
public ImageResponse genImages(String prompt)
```
    从接口复制的说明: OpenAiSession
    
    生成图片
    
    指定者:
    
    genImages 在接口中 OpenAiSession
    
    参数:
    
    prompt - 图片描述
    
    返回:
    
    应答结果
  - genImages
```
public ImageResponse genImages(ImageRequest imageRequest)
```
    从接口复制的说明: OpenAiSession
    
    生成图片
    
    指定者:
    
    genImages 在接口中 OpenAiSession
    
    参数:
    
    imageRequest - 图片描述
    
    返回:
    
    应答结果
  - genImages
```
public ImageResponse genImages(String apiHostByUser,
                               String apiKeyByUser,
                               ImageRequest imageRequest)
                        throws IOException
```
    从接口复制的说明: OpenAiSession
    
    生成图片
    
    指定者:
    
    genImages 在接口中 OpenAiSession
    
    参数:
    
    apiHostByUser - 自定义host
    
    apiKeyByUser - 自定义Key
    
    imageRequest - 图片请求
    
    返回:
    
    应答结果
    
    抛出:
    
    IOException
  - editImages
```
public ImageResponse editImages(File image,
                                String prompt)
```
    从接口复制的说明: OpenAiSession
    
    修改图片
    
    指定者:
    
    editImages 在接口中 OpenAiSession
    
    参数:
    
    image - 图片对象
    
    prompt - 修改描述
    
    返回:
    
    应答结果
  - editImages
```
public ImageResponse editImages(File image,
                                ImageEditRequest imageEditRequest)
```
    从接口复制的说明: OpenAiSession
    
    修改图片
    
    指定者:
    
    editImages 在接口中 OpenAiSession
    
    参数:
    
    image - 图片对象
    
    imageEditRequest - 图片参数
    
    返回:
    
    应答结果
  - editImages
```
public ImageResponse editImages(File image,
                                File mask,
                                ImageEditRequest imageEditRequest)
```
    从接口复制的说明: OpenAiSession
    
    修改图片
    
    指定者:
    
    editImages 在接口中 OpenAiSession
    
    参数:
    
    image - 图片对象，小于4M的PNG图片
    
    mask - 图片对象，小于4M的PNG图片
    
    imageEditRequest - 图片参数
    
    返回:
    
    应答结果
  - embeddings
```
public EmbeddingResponse embeddings(String input)
```
    从接口复制的说明: OpenAiSession
    
    向量计算；单个文本文本向量计算是一种在自然语言处理（NLP）领域中用于测量和比较文本相似性的技术。在这种方法中，每个单词或短语都被转换为一个向量，可以使用这些向量来比较不同文本之间的相似性，并在需要时进行推荐或分类
    
    指定者:
    
    embeddings 在接口中 OpenAiSession
    
    参数:
    
    input - 文本信息
    
    返回:
    
    应答结果
  - embeddings
```
public EmbeddingResponse embeddings(String... inputs)
```
    从接口复制的说明: OpenAiSession
    
    向量计算；多个文本文本向量计算是一种在自然语言处理（NLP）领域中用于测量和比较文本相似性的技术。在这种方法中，每个单词或短语都被转换为一个向量，可以使用这些向量来比较不同文本之间的相似性，并在需要时进行推荐或分类
    
    指定者:
    
    embeddings 在接口中 OpenAiSession
    
    参数:
    
    inputs - 多个文本
    
    返回:
    
    应答结果
  - embeddings
```
public EmbeddingResponse embeddings(List<String> inputs)
```
    从接口复制的说明: OpenAiSession
    
    向量计算；多个文本文本向量计算是一种在自然语言处理（NLP）领域中用于测量和比较文本相似性的技术。在这种方法中，每个单词或短语都被转换为一个向量，可以使用这些向量来比较不同文本之间的相似性，并在需要时进行推荐或分类
    
    指定者:
    
    embeddings 在接口中 OpenAiSession
    
    参数:
    
    inputs - 多个文本
    
    返回:
    
    应答结果
  - embeddings
```
public EmbeddingResponse embeddings(EmbeddingRequest embeddingRequest)
```
    从接口复制的说明: OpenAiSession
    
    向量计算；入参文本向量计算是一种在自然语言处理（NLP）领域中用于测量和比较文本相似性的技术。在这种方法中，每个单词或短语都被转换为一个向量，可以使用这些向量来比较不同文本之间的相似性，并在需要时进行推荐或分类
    
    指定者:
    
    embeddings 在接口中 OpenAiSession
    
    参数:
    
    embeddingRequest - 请求结果
    
    返回:
    
    应答结果
  - files
```
public OpenAiResponse<File> files()
```
    从接口复制的说明: OpenAiSession
    
    获取文件
    
    指定者:
    
    files 在接口中 OpenAiSession
    
    返回:
    
    应答结果
  - uploadFile
```
public UploadFileResponse uploadFile(File file)
```
    从接口复制的说明: OpenAiSession
    
    上传文件
    
    指定者:
    
    uploadFile 在接口中 OpenAiSession
    
    参数:
    
    file - 文件
    
    返回:
    
    应答结果
  - uploadFile
```
public UploadFileResponse uploadFile(String purpose,
                                     File file)
```
    从接口复制的说明: OpenAiSession
    
    上传文件
    
    指定者:
    
    uploadFile 在接口中 OpenAiSession
    
    参数:
    
    purpose - Use "fine-tune" for Fine-tuning. This allows us to validate the format of the uploaded file.
    
    file - 文件
    
    返回:
    
    应答结果
  - deleteFile
```
public DeleteFileResponse deleteFile(String fileId)
```
    从接口复制的说明: OpenAiSession
    
    删除文件
    
    指定者:
    
    deleteFile 在接口中 OpenAiSession
    
    参数:
    
    fileId - 文件ID
    
    返回:
    
    应答结果
  - speed2TextTranscriptions
```
public WhisperResponse speed2TextTranscriptions(File file,
                                                TranscriptionsRequest transcriptionsRequest)
```
    从接口复制的说明: OpenAiSession
    
    语音转文字
    
    指定者:
    
    speed2TextTranscriptions 在接口中 OpenAiSession
    
    参数:
    
    file - 语音文件
    
    transcriptionsRequest - 请求信息
    
    返回:
    
    应答结果
  - speed2TextTranslations
```
public WhisperResponse speed2TextTranslations(File file,
                                              TranslationsRequest translationsRequest)
```
    从接口复制的说明: OpenAiSession
    
    语音翻译
    
    指定者:
    
    speed2TextTranslations 在接口中 OpenAiSession
    
    参数:
    
    file - 语音文件
    
    translationsRequest - 请求信息
    
    返回:
    
    应答结果
  - subscription
```
public Subscription subscription()
```
    从接口复制的说明: OpenAiSession
    
    账单查询
    
    指定者:
    
    subscription 在接口中 OpenAiSession
    
    返回:
    
    应答结果
  - billingUsage
```
public BillingUsage billingUsage(@NotNull
                                 @NotNull java.time.LocalDate starDate,
                                 @NotNull
                                 @NotNull java.time.LocalDate endDate)
```
    从接口复制的说明: OpenAiSession
    
    消耗查询
    
    指定者:
    
    billingUsage 在接口中 OpenAiSession
    
    参数:
    
    starDate - 开始时间
    
    endDate - 结束时间
    
    返回:
    
    应答数据

类 DefaultOpenAiSession

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

DefaultOpenAiSession

方法详细资料

completions

completions

completions

completions

completions

completions

completions

completions

chatCompletions

chatCompletions

chatCompletions

edit

genImages

genImages

genImages

editImages

editImages

editImages

embeddings

embeddings

embeddings

embeddings

files

uploadFile

uploadFile

deleteFile

speed2TextTranscriptions

speed2TextTranslations

subscription

billingUsage