Serialized Form (chatgpt-java 1.0.14 API)

Package com.unfbx.chatgpt.entity.billing
- Class com.unfbx.chatgpt.entity.billing.CreditGrantsResponse extends Object implements Serializable
  - Serialized Fields
    - grants
      
      Grants grants
      
      余额明细
    - object
      
      String object
    - totalAvailable
      
      BigDecimal totalAvailable
      
      总剩余金额：美元
    - totalGranted
      
      BigDecimal totalGranted
      
      总金额：美元
    - totalUsed
      
      BigDecimal totalUsed
      
      总使用金额：美元
Package com.unfbx.chatgpt.entity.chat
- Class com.unfbx.chatgpt.entity.chat.ChatChoice extends Object implements Serializable
  - Serialized Fields
    - delta
      
      Message delta
      
      请求参数stream为true返回是delta
    - finishReason
      
      String finishReason
    - index
      
      long index
    - message
      
      Message message
      
      请求参数stream为false返回是message
- Class com.unfbx.chatgpt.entity.chat.ChatCompletion extends Object implements Serializable
  - Serialized Fields
    - frequencyPenalty
      
      double frequencyPenalty
      
      -2.0 ~~ 2.0
    - functionCall
      
      Object functionCall
      
      取值：null,auto或者自定义 functions没有值的时候默认为：null functions存在值得时候默认为：auto 也可以自定义
    - functions
      
      List<Functions> functions
    - logitBias
      
      Map logitBias
    - maxTokens
      
      Integer maxTokens
      
      最大支持4096
    - messages
      
      @NonNull List<Message> messages
      
      问题描述
    - model
      
      @NonNull String model
    - n
      
      Integer n
      
      为每个提示生成的完成次数。
    - presencePenalty
      
      double presencePenalty
    - stop
      
      List<String> stop
      
      停止输出标识
    - stream
      
      boolean stream
      
      是否流式输出. default:false
      
      See Also:
      
      OpenAiStreamClient
    - temperature
      
      double temperature
      
      使用什么取样温度，0到2之间。较高的值(如0.8)将使输出更加随机，而较低的值(如0.2)将使输出更加集中和确定。
      We generally recommend altering this or but not both.top_p
    - topP
      
      Double topP
      
      使用温度采样的替代方法称为核心采样，其中模型考虑具有top_p概率质量的令牌的结果。因此，0.1 意味着只考虑包含前 10% 概率质量的代币。
      我们通常建议更改此设置，但不要同时更改两者。temperature
    - user
      
      String user
      
      用户唯一值，确保接口不被重复调用
- Class com.unfbx.chatgpt.entity.chat.ChatCompletionResponse extends Object implements Serializable
  - Serialized Fields
    - choices
      
      List<ChatChoice> choices
    - created
      
      long created
    - id
      
      String id
    - model
      
      String model
    - object
      
      String object
    - usage
      
      Usage usage
- Class com.unfbx.chatgpt.entity.chat.Functions extends Object implements Serializable
  - Serialized Fields
    - description
      
      String description
      
      方法描述
    - name
      
      String name
      
      方法名称
    - parameters
      
      Parameters parameters
      
      方法参数扩展参数可以继承Parameters自己实现，json格式的数据
- Class com.unfbx.chatgpt.entity.chat.Message extends Object implements Serializable
  - Serialized Fields
    - content
      
      String content
    - functionCall
      
      FunctionCall functionCall
    - name
      
      String name
    - role
      
      String role
      
      目前支持四个中角色参考官网，进行情景输入： https://platform.openai.com/docs/guides/chat/introduction
- Class com.unfbx.chatgpt.entity.chat.Parameters extends Object implements Serializable
  - Serialized Fields
    - properties
      
      Object properties
      
      参数属性、描述
    - required
      
      List<String> required
      
      方法必输字段
    - type
      
      String type
      
      参数类型
Package com.unfbx.chatgpt.entity.common
- Class com.unfbx.chatgpt.entity.common.Choice extends Object implements Serializable
  - Serialized Fields
    - finishReason
      
      String finishReason
    - index
      
      long index
    - logprobs
      
      Object logprobs
    - text
      
      String text
- Class com.unfbx.chatgpt.entity.common.DeleteResponse extends Object implements Serializable
  - Serialized Fields
    - deleted
      
      boolean deleted
    - id
      
      String id
    - object
      
      String object
- Class com.unfbx.chatgpt.entity.common.OpenAiResponse extends Object implements Serializable
  - Serialized Fields
    - data
      
      List<T> data
    - error
      
      OpenAiResponse.Error error
    - object
      
      String object
- Class com.unfbx.chatgpt.entity.common.Usage extends Object implements Serializable
  - Serialized Fields
    - completionTokens
      
      long completionTokens
    - promptTokens
      
      long promptTokens
    - totalTokens
      
      long totalTokens
Package com.unfbx.chatgpt.entity.completions
- Class com.unfbx.chatgpt.entity.completions.Completion extends Object implements Serializable
  - Serialized Fields
    - bestOf
      
      Integer bestOf
    - echo
      
      boolean echo
    - frequencyPenalty
      
      double frequencyPenalty
      
      -2.0 ~~ 2.0
    - logitBias
      
      Map logitBias
    - logprobs
      
      Integer logprobs
      
      最大值：5
    - maxTokens
      
      Integer maxTokens
      
      最大支持4096
    - model
      
      @NonNull String model
    - n
      
      Integer n
      
      为每个提示生成的完成次数。
    - presencePenalty
      
      double presencePenalty
    - prompt
      
      @NonNull String prompt
      
      问题描述
    - stop
      
      List<String> stop
    - stream
      
      boolean stream
    - suffix
      
      String suffix
      
      完成输出后的后缀，用于格式化输出结果
    - temperature
      
      double temperature
      
      使用什么取样温度，0到2之间。较高的值(如0.8)将使输出更加随机，而较低的值(如0.2)将使输出更加集中和确定。
      We generally recommend altering this or but not both.top_p
    - topP
      
      Double topP
      
      使用温度采样的替代方法称为核心采样，其中模型考虑具有top_p概率质量的令牌的结果。因此，0.1 意味着只考虑包含前 10% 概率质量的代币。
      我们通常建议更改此设置，但不要同时更改两者。temperature
    - user
      
      String user
      
      用户唯一值，确保接口不被重复调用
- Class com.unfbx.chatgpt.entity.completions.CompletionResponse extends OpenAiResponse implements Serializable
  - Serialized Fields
    - choices
      
      Choice[] choices
    - created
      
      long created
    - id
      
      String id
    - model
      
      String model
    - object
      
      String object
    - usage
      
      Usage usage
Package com.unfbx.chatgpt.entity.edits
- Class com.unfbx.chatgpt.entity.edits.Edit extends Object implements Serializable
  - Serialized Fields
    - input
      
      @NonNull String input
    - instruction
      
      @NonNull String instruction
      
      提示说明。告知模型如何修改。
    - model
      
      @NonNull String model
      
      编辑模型，目前支持两种
    - n
      
      Integer n
      
      为每个提示生成的完成次数。
    - temperature
      
      double temperature
      
      使用什么取样温度，0到2之间。较高的值(如0.8)将使输出更加随机，而较低的值(如0.2)将使输出更加集中和确定。 We generally recommend altering this or but not both.top_p
    - topP
      
      Double topP
      
      使用温度采样的替代方法称为核心采样，其中模型考虑具有top_p概率质量的令牌的结果。因此，0.1 意味着只考虑包含前 10% 概率质量的代币。我们通常建议更改此设置，但不要同时更改两者。temperature
- Class com.unfbx.chatgpt.entity.edits.EditResponse extends Object implements Serializable
  - Serialized Fields
    - choices
      
      Choice[] choices
    - created
      
      long created
    - id
      
      String id
    - model
      
      String model
    - object
      
      String object
    - usage
      
      Usage usage
Package com.unfbx.chatgpt.entity.embeddings
- Class com.unfbx.chatgpt.entity.embeddings.Embedding extends Object implements Serializable
  - Serialized Fields
    - input
      
      @NonNull List<String> input
      
      必选项：长度不能超过：8192
    - model
      
      @NonNull String model
    - user
      
      String user
- Class com.unfbx.chatgpt.entity.embeddings.EmbeddingResponse extends Object implements Serializable
  - Serialized Fields
    - data
      
      List<Item> data
    - model
      
      String model
    - object
      
      String object
    - usage
      
      Usage usage
- Class com.unfbx.chatgpt.entity.embeddings.Item extends Object implements Serializable
  - Serialized Fields
    - embedding
      
      List<BigDecimal> embedding
    - index
      
      Integer index
    - object
      
      String object
Package com.unfbx.chatgpt.entity.engines
- Class com.unfbx.chatgpt.entity.engines.Engine extends Object implements Serializable
  - Serialized Fields
    - created
      
      long created
    - id
      
      String id
    - object
      
      String object
    - owner
      
      String owner
    - permissions
      
      Object permissions
    - ready
      
      boolean ready
Package com.unfbx.chatgpt.entity.files
- Class com.unfbx.chatgpt.entity.files.File extends Object implements Serializable
  - Serialized Fields
    - bytes
      
      long bytes
    - created_at
      
      long created_at
    - filename
      
      String filename
    - id
      
      String id
    - object
      
      String object
    - purpose
      
      String purpose
    - status
      
      String status
    - statusDetails
      
      String statusDetails
- Class com.unfbx.chatgpt.entity.files.UploadFileResponse extends File implements Serializable
Package com.unfbx.chatgpt.entity.fineTune
- Class com.unfbx.chatgpt.entity.fineTune.Event extends Object implements Serializable
  - Serialized Fields
    - createdAt
      
      long createdAt
    - level
      
      String level
    - message
      
      String message
    - object
      
      String object
- Class com.unfbx.chatgpt.entity.fineTune.FineTune extends Object implements Serializable
  - Serialized Fields
    - batchSize
      
      Integer batchSize
    - classificationBetas
      
      List classificationBetas
    - classificationNClasses
      
      Integer classificationNClasses
    - computeClassificationMetrics
      
      boolean computeClassificationMetrics
    - learningRateMultiplier
      
      Double learningRateMultiplier
    - model
      
      String model
      
      参考
      
      See Also:
      
      FineTune.Model
    - n_epochs
      
      Integer n_epochs
    - promptLossWeight
      
      Double promptLossWeight
    - suffix
      
      String suffix
    - trainingFile
      
      @NonNull String trainingFile
      
      上传的文件ID
    - validationFile
      
      String validationFile
- Class com.unfbx.chatgpt.entity.fineTune.FineTuneDeleteResponse extends Object implements Serializable
  - Serialized Fields
    - deleted
      
      boolean deleted
    - id
      
      String id
    - object
      
      String object
- Class com.unfbx.chatgpt.entity.fineTune.FineTuneResponse extends Object implements Serializable
  - Serialized Fields
    - createdAt
      
      long createdAt
    - events
      
      List<Event> events
    - fineTunedModel
      
      String fineTunedModel
    - hyperParams
      
      HyperParam hyperParams
    - id
      
      String id
    - model
      
      String model
    - object
      
      String object
    - organizationId
      
      String organizationId
    - resultFiles
      
      List resultFiles
    - status
      
      String status
    - trainingFiles
      
      List<TrainingFile> trainingFiles
    - updatedAt
      
      long updatedAt
    - validationFiles
      
      List validationFiles
- Class com.unfbx.chatgpt.entity.fineTune.HyperParam extends Object implements Serializable
  - Serialized Fields
    - batchSize
      
      Integer batchSize
    - learningRateMultiplier
      
      Double learningRateMultiplier
    - nEpochs
      
      Integer nEpochs
    - promptLossWeight
      
      Double promptLossWeight
- Class com.unfbx.chatgpt.entity.fineTune.TrainingFile extends Object implements Serializable
  - Serialized Fields
    - bytes
      
      long bytes
    - createdAt
      
      long createdAt
    - filename
      
      String filename
    - id
      
      String id
    - object
      
      String object
    - purpose
      
      String purpose
    - status
      
      String status
    - statusDetails
      
      String statusDetails
Package com.unfbx.chatgpt.entity.images
- Class com.unfbx.chatgpt.entity.images.Image extends Object implements Serializable
  - Serialized Fields
    - n
      
      Integer n
      
      为每个提示生成的完成次数。
    - prompt
      
      @NonNull String prompt
    - responseFormat
      
      String responseFormat
    - size
      
      String size
      
      256x256 512x512 1024x1024
    - user
      
      String user
- Class com.unfbx.chatgpt.entity.images.ImageEdit extends Object implements Serializable
  - Serialized Fields
    - n
      
      Integer n
      
      为每个提示生成的完成次数。
    - prompt
      
      @NonNull String prompt
      
      必选项：描述文字，最多1000字符
    - responseFormat
      
      String responseFormat
    - size
      
      String size
      
      256x256 512x512 1024x1024
    - user
      
      String user
- Class com.unfbx.chatgpt.entity.images.ImageResponse extends Object implements Serializable
  - Serialized Fields
    - created
      
      long created
    - data
      
      List<Item> data
- Class com.unfbx.chatgpt.entity.images.ImageVariations extends Object implements Serializable
  - Serialized Fields
    - n
      
      Integer n
      
      为每个提示生成的完成次数。
    - responseFormat
      
      String responseFormat
    - size
      
      String size
      
      256x256 512x512 1024x1024
    - user
      
      String user
- Class com.unfbx.chatgpt.entity.images.Item extends Object implements Serializable
  - Serialized Fields
    - b64Json
      
      String b64Json
    - url
      
      String url
Package com.unfbx.chatgpt.entity.models
- Class com.unfbx.chatgpt.entity.models.Model extends Object implements Serializable
  - Serialized Fields
    - created
      
      long created
    - id
      
      String id
    - object
      
      String object
    - ownedBy
      
      String ownedBy
    - parent
      
      Object parent
    - permission
      
      List<Permission> permission
    - root
      
      String root
- Class com.unfbx.chatgpt.entity.models.ModelResponse extends Object implements Serializable
  - Serialized Fields
    - data
      
      List<Model> data
    - object
      
      String object
- Class com.unfbx.chatgpt.entity.models.Permission extends Object implements Serializable
  - Serialized Fields
    - allowCreateEngine
      
      boolean allowCreateEngine
    - allowFineTuning
      
      boolean allowFineTuning
    - allowLogprobs
      
      boolean allowLogprobs
    - allowSampling
      
      boolean allowSampling
    - allowSearchIndices
      
      boolean allowSearchIndices
    - allowView
      
      boolean allowView
    - created
      
      long created
    - group
      
      Object group
      
      不知道是什么类型的数据
    - id
      
      String id
    - isBlocking
      
      boolean isBlocking
    - object
      
      String object
    - organization
      
      String organization
Package com.unfbx.chatgpt.entity.moderations
- Class com.unfbx.chatgpt.entity.moderations.Categories extends Object implements Serializable
  - Serialized Fields
    - hate
      
      boolean hate
      
      表达、煽动或宣扬基于种族、性别、民族、宗教、国籍、性取向、残疾状况或种姓的仇恨的内容。
    - hateThreatening
      
      boolean hateThreatening
      
      仇恨内容，还包括对目标群体的暴力或严重伤害。
    - selfHarm
      
      boolean selfHarm
      
      宣扬、鼓励或描绘自残行为（例如自杀、割伤和饮食失调）的内容。
    - sexual
      
      boolean sexual
      
      旨在引起性兴奋的内容，例如对性活动的描述，或宣传性服务（不包括性教育和健康）的内容。
    - sexualMinors
      
      boolean sexualMinors
      
      包含未满 18 周岁的个人的色情内容。
    - violence
      
      boolean violence
      
      宣扬或美化暴力或歌颂他人遭受苦难或羞辱的内容。
    - violenceGraphic
      
      boolean violenceGraphic
      
      以极端血腥细节描绘死亡、暴力或严重身体伤害的暴力内容。
- Class com.unfbx.chatgpt.entity.moderations.CategoryScores extends Object implements Serializable
  - Serialized Fields
    - hate
      
      BigDecimal hate
    - hateThreatening
      
      BigDecimal hateThreatening
    - selfHarm
      
      BigDecimal selfHarm
    - sexual
      
      BigDecimal sexual
    - sexualMinors
      
      BigDecimal sexualMinors
    - violence
      
      BigDecimal violence
    - violenceGraphic
      
      BigDecimal violenceGraphic
- Class com.unfbx.chatgpt.entity.moderations.Moderation extends Object implements Serializable
  - Serialized Fields
    - input
      
      @NonNull List<String> input
    - model
      
      String model
- Class com.unfbx.chatgpt.entity.moderations.ModerationResponse extends Object implements Serializable
  - Serialized Fields
    - id
      
      String id
    - model
      
      String model
    - results
      
      List<Result> results
- Class com.unfbx.chatgpt.entity.moderations.Result extends Object implements Serializable
  - Serialized Fields
    - categories
      
      Categories categories
    - categoryScores
      
      CategoryScores categoryScores
    - flagged
      
      boolean flagged
Package com.unfbx.chatgpt.entity.whisper
- Class com.unfbx.chatgpt.entity.whisper.Transcriptions extends Whisper implements Serializable
  - Serialized Fields
    - language
      
      String language
      
      输入音频的语言,以 ISO-639-1 格式提供输入语言将提高准确性和延迟。参考：ISO-639-1
    - model
      
      String model
      
      模型目前只支持这一种：WHISPER_1
    - prompt
      
      String prompt
      
      提示语，需要与语音语言匹配
    - responseFormat
      
      String responseFormat
      
      输出的格式，采用以下选项之一：json、text、srt、verbose_json 或 vtt。默认值：json
    - temperature
      
      Double temperature
      
      温度控制随机效果：0-1，值越大输出更加随机默认值：0
- Class com.unfbx.chatgpt.entity.whisper.Whisper extends Object implements Serializable
- Class com.unfbx.chatgpt.entity.whisper.WhisperResponse extends Object implements Serializable
  - Serialized Fields
    - text
      
      String text
Package com.unfbx.chatgpt.exception
- Class com.unfbx.chatgpt.exception.BaseException extends RuntimeException implements Serializable
  - Serialized Fields
    - code
      
      int code
    - msg
      
      String msg

Serialized Form

Package com.unfbx.chatgpt.entity.billing

Class com.unfbx.chatgpt.entity.billing.CreditGrantsResponse extends Object implements Serializable

Serialized Fields

grants

object

totalAvailable

totalGranted

totalUsed

Package com.unfbx.chatgpt.entity.chat

Class com.unfbx.chatgpt.entity.chat.ChatChoice extends Object implements Serializable

Serialized Fields

delta

finishReason

index

message

Class com.unfbx.chatgpt.entity.chat.ChatCompletion extends Object implements Serializable

Serialized Fields

frequencyPenalty

functionCall

functions

logitBias

maxTokens

messages

model

n

presencePenalty

stop

stream

temperature

topP

user

Class com.unfbx.chatgpt.entity.chat.ChatCompletionResponse extends Object implements Serializable

Serialized Fields

choices

created

id

model

object

usage

Class com.unfbx.chatgpt.entity.chat.Functions extends Object implements Serializable

Serialized Fields

description

name

parameters

Class com.unfbx.chatgpt.entity.chat.Message extends Object implements Serializable

Serialized Fields

content

functionCall

name

role

Class com.unfbx.chatgpt.entity.chat.Parameters extends Object implements Serializable

Serialized Fields

properties

required

type

Package com.unfbx.chatgpt.entity.common

Class com.unfbx.chatgpt.entity.common.Choice extends Object implements Serializable

Serialized Fields

finishReason

index

logprobs

text

Class com.unfbx.chatgpt.entity.common.DeleteResponse extends Object implements Serializable

Serialized Fields

deleted

id

object

Class com.unfbx.chatgpt.entity.common.OpenAiResponse extends Object implements Serializable

Serialized Fields

data

error

object

Class com.unfbx.chatgpt.entity.common.Usage extends Object implements Serializable

Serialized Fields

completionTokens

promptTokens

totalTokens

Package com.unfbx.chatgpt.entity.completions

Class com.unfbx.chatgpt.entity.completions.Completion extends Object implements Serializable