Serialized Form (chatgpt-java 1.0.8 API)

Package com.unfbx.chatgpt.entity.chat
- Class com.unfbx.chatgpt.entity.chat.ChatChoice extends Object implements Serializable
  - Serialized Fields
    - index
```
long index
```
    - delta
```
Message delta
```
      请求参数stream为true返回是delta
    - message
```
Message message
```
      请求参数stream为false返回是message
    - finishReason
```
String finishReason
```
- Class com.unfbx.chatgpt.entity.chat.ChatCompletion extends Object implements Serializable
  - Serialized Fields
    - model
```
String model
```
    - messages
```
List<E> messages
```
      问题描述
    - 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
    - n
```
Integer n
```
      为每个提示生成的完成次数。
    - stream
```
boolean stream
```
      是否流式输出. default:false
      
      See Also:
      
      OpenAiStreamClient
    - stop
```
List<E> stop
```
      停止输出标识
    - maxTokens
```
Integer maxTokens
```
      最大支持4096
    - presencePenalty
```
double presencePenalty
```
    - frequencyPenalty
```
double frequencyPenalty
```
      -2.0 ~~ 2.0
    - logitBias
```
Map<K,V> logitBias
```
    - user
```
String user
```
      用户唯一值，确保接口不被重复调用
- Class com.unfbx.chatgpt.entity.chat.ChatCompletionResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - created
```
long created
```
    - model
```
String model
```
    - choices
```
List<E> choices
```
    - usage
```
Usage usage
```
- Class com.unfbx.chatgpt.entity.chat.Message extends Object implements Serializable
  - Serialized Fields
    - role
```
String role
```
    - content
```
String content
```
Package com.unfbx.chatgpt.entity.common
- Class com.unfbx.chatgpt.entity.common.Choice extends Object implements Serializable
  - Serialized Fields
    - text
```
String text
```
    - index
```
long index
```
    - logprobs
```
Object logprobs
```
    - finishReason
```
String finishReason
```
- Class com.unfbx.chatgpt.entity.common.DeleteResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - deleted
```
boolean deleted
```
- Class com.unfbx.chatgpt.entity.common.OpenAiResponse extends Object implements Serializable
  - Serialized Fields
    - object
```
String object
```
    - data
```
List<E> data
```
    - error
```
OpenAiResponse.Error error
```
- Class com.unfbx.chatgpt.entity.common.Usage extends Object implements Serializable
  - Serialized Fields
    - promptTokens
```
long promptTokens
```
    - completionTokens
```
long completionTokens
```
    - totalTokens
```
long totalTokens
```
Package com.unfbx.chatgpt.entity.completions
- Class com.unfbx.chatgpt.entity.completions.Completion extends Object implements Serializable
  - Serialized Fields
    - model
```
String model
```
    - prompt
```
String prompt
```
      问题描述
    - suffix
```
String suffix
```
      完成输出后的后缀，用于格式化输出结果
    - maxTokens
```
Integer maxTokens
```
      最大支持4096
    - 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
    - n
```
Integer n
```
      为每个提示生成的完成次数。
    - stream
```
boolean stream
```
    - logprobs
```
Integer logprobs
```
      最大值：5
    - echo
```
boolean echo
```
    - stop
```
List<E> stop
```
    - presencePenalty
```
double presencePenalty
```
    - frequencyPenalty
```
double frequencyPenalty
```
      -2.0 ~~ 2.0
    - bestOf
```
Integer bestOf
```
    - logitBias
```
Map<K,V> logitBias
```
    - user
```
String user
```
      用户唯一值，确保接口不被重复调用
- Class com.unfbx.chatgpt.entity.completions.CompletionResponse extends OpenAiResponse implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - created
```
long created
```
    - model
```
String model
```
    - choices
```
Choice[] choices
```
    - usage
```
Usage usage
```
Package com.unfbx.chatgpt.entity.edits
- Class com.unfbx.chatgpt.entity.edits.Edit extends Object implements Serializable
  - Serialized Fields
    - model
```
String model
```
      编辑模型，目前支持两种
    - input
```
String input
```
    - instruction
```
String instruction
```
      提示说明。告知模型如何修改。
    - 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
    - n
```
Integer n
```
      为每个提示生成的完成次数。
- Class com.unfbx.chatgpt.entity.edits.EditResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - created
```
long created
```
    - model
```
String model
```
    - choices
```
Choice[] choices
```
    - usage
```
Usage usage
```
Package com.unfbx.chatgpt.entity.embeddings
- Class com.unfbx.chatgpt.entity.embeddings.Embedding extends Object implements Serializable
  - Serialized Fields
    - model
```
String model
```
    - input
```
String input
```
      必选项：长度不能超过：8192
    - user
```
String user
```
- Class com.unfbx.chatgpt.entity.embeddings.EmbeddingResponse extends Object implements Serializable
  - Serialized Fields
    - object
```
String object
```
    - data
```
List<E> data
```
    - model
```
String model
```
    - usage
```
Usage usage
```
- Class com.unfbx.chatgpt.entity.embeddings.Item extends Object implements Serializable
  - Serialized Fields
    - object
```
String object
```
    - embedding
```
List<E> embedding
```
    - index
```
Integer index
```
Package com.unfbx.chatgpt.entity.engines
- Class com.unfbx.chatgpt.entity.engines.Engine extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - owner
```
String owner
```
    - ready
```
boolean ready
```
    - permissions
```
Object permissions
```
    - created
```
long created
```
Package com.unfbx.chatgpt.entity.files
- Class com.unfbx.chatgpt.entity.files.File extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - bytes
```
long bytes
```
    - created_at
```
long created_at
```
    - filename
```
String filename
```
    - 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
    - object
```
String object
```
    - createdAt
```
long createdAt
```
    - level
```
String level
```
    - message
```
String message
```
- Class com.unfbx.chatgpt.entity.fineTune.FineTune extends Object implements Serializable
  - Serialized Fields
    - trainingFile
```
String trainingFile
```
      上传的文件ID
    - validationFile
```
String validationFile
```
    - model
```
String model
```
      参考
      
      See Also:
      
      FineTune.Model
    - n_epochs
```
Integer n_epochs
```
    - batchSize
```
Integer batchSize
```
    - learningRateMultiplier
```
Double learningRateMultiplier
```
    - promptLossWeight
```
Double promptLossWeight
```
    - computeClassificationMetrics
```
boolean computeClassificationMetrics
```
    - classificationNClasses
```
Integer classificationNClasses
```
    - classificationBetas
```
List<E> classificationBetas
```
    - suffix
```
String suffix
```
- Class com.unfbx.chatgpt.entity.fineTune.FineTuneResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - model
```
String model
```
    - createdAt
```
long createdAt
```
    - events
```
List<E> events
```
    - fineTunedModel
```
String fineTunedModel
```
    - hyperParams
```
HyperParam hyperParams
```
    - organizationId
```
String organizationId
```
    - resultFiles
```
List<E> resultFiles
```
    - status
```
String status
```
    - validationFiles
```
List<E> validationFiles
```
    - trainingFiles
```
List<E> trainingFiles
```
    - updatedAt
```
long updatedAt
```
- 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
    - id
```
String id
```
    - object
```
String object
```
    - bytes
```
long bytes
```
    - createdAt
```
long createdAt
```
    - filename
```
String filename
```
    - 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
    - prompt
```
String prompt
```
    - n
```
Integer n
```
      为每个提示生成的完成次数。
    - size
```
String size
```
      256x256 512x512 1024x1024
    - responseFormat
```
String responseFormat
```
    - user
```
String user
```
- Class com.unfbx.chatgpt.entity.images.ImageEdit extends Object implements Serializable
  - Serialized Fields
    - prompt
```
String prompt
```
      必选项：描述文字，最多1000字符
    - n
```
Integer n
```
      为每个提示生成的完成次数。
    - size
```
String size
```
      256x256 512x512 1024x1024
    - responseFormat
```
String responseFormat
```
    - user
```
String user
```
- Class com.unfbx.chatgpt.entity.images.ImageResponse extends Object implements Serializable
  - Serialized Fields
    - created
```
long created
```
    - data
```
List<E> data
```
- Class com.unfbx.chatgpt.entity.images.ImageVariations extends Object implements Serializable
  - Serialized Fields
    - n
```
Integer n
```
      为每个提示生成的完成次数。
    - size
```
String size
```
      256x256 512x512 1024x1024
    - responseFormat
```
String responseFormat
```
    - user
```
String user
```
- Class com.unfbx.chatgpt.entity.images.Item extends Object implements Serializable
  - Serialized Fields
    - url
```
String url
```
Package com.unfbx.chatgpt.entity.models
- Class com.unfbx.chatgpt.entity.models.Model extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - created
```
long created
```
    - ownedBy
```
String ownedBy
```
    - permission
```
List<E> permission
```
    - root
```
String root
```
    - parent
```
Object parent
```
- Class com.unfbx.chatgpt.entity.models.ModelResponse extends Object implements Serializable
  - Serialized Fields
    - object
```
String object
```
    - data
```
List<E> data
```
- Class com.unfbx.chatgpt.entity.models.Permission extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - created
```
long created
```
    - allowCreateEngine
```
boolean allowCreateEngine
```
    - allowSampling
```
boolean allowSampling
```
    - allowLogprobs
```
boolean allowLogprobs
```
    - allowSearchIndices
```
boolean allowSearchIndices
```
    - allowView
```
boolean allowView
```
    - allowFineTuning
```
boolean allowFineTuning
```
    - organization
```
String organization
```
    - group
```
Object group
```
      不知道是什么类型的数据
    - isBlocking
```
boolean isBlocking
```
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
```
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<E> 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.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
    - msg
```
String msg
```
    - code
```
int code
```

Serialized Form

Package com.unfbx.chatgpt.entity.chat

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

Serialized Fields

index

delta

message

finishReason

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

Serialized Fields

model

messages

temperature

topP

n

stream

stop

maxTokens

presencePenalty

frequencyPenalty

logitBias

user

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

Serialized Fields

id

object

created

model

choices

usage

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

Serialized Fields

role

content

Package com.unfbx.chatgpt.entity.common

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

Serialized Fields

text

index

logprobs

finishReason

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

Serialized Fields

id

object

deleted

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

Serialized Fields

object

data

error

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

Serialized Fields

promptTokens

completionTokens

totalTokens

Package com.unfbx.chatgpt.entity.completions

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

Serialized Fields

model

prompt

suffix

maxTokens

temperature

topP

n

stream

logprobs

echo

stop

presencePenalty

frequencyPenalty

bestOf

logitBias

user

Class com.unfbx.chatgpt.entity.completions.CompletionResponse extends OpenAiResponse implements Serializable

Serialized Fields

id

object

created