Serialized Form (chatgpt-java 1.1.5 API)

Package com.unfbx.chatgpt.entity.assistant
- Class com.unfbx.chatgpt.entity.assistant.Assistant extends Object implements Serializable
  - Serialized Fields
    - model
```
String model
```
      All models except gpt-3.5-turbo-0301 supported. retrieval tool requires gpt-4-1106-preview or gpt-3.5-turbo-1106.
      
      See Also:
      
      com.unfbx.chatgpt.entity.chat.ChatCompletion.Model
    - name
```
String name
```
      助理的名字。最大长度为 256 个字符。
    - description
```
String description
```
      助理的描述。最大长度为 512 个字符。
    - instructions
```
String instructions
```
      助手使用的系统指令。最大长度为 32768 个字符。
    - tools
```
List<E> tools
```
      助手上启用的工具列表。每个助手最多可以有 128 个工具。工具可以是 code_interpreter、retrieval或function。
    - fileIds
```
List<E> fileIds
```
      附加到该助手的文件 ID 列表。助手最多可以附加 20 个文件。文件按其创建日期升序排列。
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
- Class com.unfbx.chatgpt.entity.assistant.AssistantFile extends Object implements Serializable
  - Serialized Fields
    - fileId
```
String fileId
```
      文件id
- Class com.unfbx.chatgpt.entity.assistant.AssistantFileResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - createdAt
```
Long createdAt
```
    - assistantId
```
String assistantId
```
- Class com.unfbx.chatgpt.entity.assistant.AssistantListResponse extends Object implements Serializable
  - Serialized Fields
    - object
```
String object
```
    - firstId
```
String firstId
```
    - lastId
```
String lastId
```
    - data
```
List<E> data
```
    - hasMore
```
Boolean hasMore
```
- Class com.unfbx.chatgpt.entity.assistant.AssistantResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - model
```
String model
```
      All models except gpt-3.5-turbo-0301 supported. retrieval tool requires gpt-4-1106-preview or gpt-3.5-turbo-1106.
      
      See Also:
      
      com.unfbx.chatgpt.entity.chat.ChatCompletion.Model
    - name
```
String name
```
      助理的名字。最大长度为 256 个字符。
    - description
```
String description
```
      助理的描述。最大长度为 512 个字符。
    - instructions
```
String instructions
```
      助手使用的系统指令。最大长度为 32768 个字符。
    - tools
```
List<E> tools
```
      助手上启用的工具列表。每个助手最多可以有 128 个工具。工具可以是 code_interpreter、retrieval或function。
    - fileIds
```
List<E> fileIds
```
      附加到该助手的文件 ID 列表。助手最多可以附加 20 个文件。文件按其创建日期升序排列。
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
    - createdAt
```
Long createdAt
```
      创建时间戳
- Class com.unfbx.chatgpt.entity.assistant.Tool extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
    - function
```
Functions function
```
      type为function时，function参数必输
Package com.unfbx.chatgpt.entity.assistant.message
- Class com.unfbx.chatgpt.entity.assistant.message.MessageFileResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - createdAt
```
Long createdAt
```
    - messageId
```
String messageId
```
- Class com.unfbx.chatgpt.entity.assistant.message.MessageResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - createdAt
```
Long createdAt
```
      创建时间戳
    - threadId
```
String threadId
```
    - role
```
String role
```
    - content
```
List<E> content
```
      文本或图像数组中的消息内容
    - assistantId
```
String assistantId
```
    - runId
```
String runId
```
    - fileIds
```
List<E> fileIds
```
      附加到该助手的文件 ID 列表。助手最多可以附加 20 个文件。文件按其创建日期升序排列。
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
- Class com.unfbx.chatgpt.entity.assistant.message.ModifyMessage extends Object implements Serializable
  - Serialized Fields
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
Package com.unfbx.chatgpt.entity.assistant.run
- Class com.unfbx.chatgpt.entity.assistant.run.Action extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      1.1.3版本，始终是submit_tool_outputs。
      
      See Also:
      
      Action.Type
    - submitToolOutputs
```
SubmitToolOutputs submitToolOutputs
```
- Class com.unfbx.chatgpt.entity.assistant.run.CodeInterpreter extends Object implements Serializable
  - Serialized Fields
    - input
```
String input
```
      代码解释器工具调用的输入。
    - outputs
```
List<E> outputs
```
      代码解释器工具调用的输出。 Code Interpreter可以输出一项或多项，包括文本（log）或图像（image）。其中每一个都由不同的对象类型表示。
- Class com.unfbx.chatgpt.entity.assistant.run.Function extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the function.
    - arguments
```
String arguments
```
      The arguments passed to the function.
    - output
```
String output
```
      The output of the function. This will be null if the outputs have not been submitted yet. 函数的输出。如果尚未提交输出，则该值为空。
- Class com.unfbx.chatgpt.entity.assistant.run.Image extends Object implements Serializable
  - Serialized Fields
    - fileId
```
String fileId
```
- Class com.unfbx.chatgpt.entity.assistant.run.MessageCreation extends Object implements Serializable
  - Serialized Fields
    - messageId
```
String messageId
```
- Class com.unfbx.chatgpt.entity.assistant.run.ModifyRun extends Object implements Serializable
  - Serialized Fields
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
- Class com.unfbx.chatgpt.entity.assistant.run.Output extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      See Also:
      
      Output.Type
    - logs
```
String logs
```
    - image
```
Image image
```
- Class com.unfbx.chatgpt.entity.assistant.run.Run extends Object implements Serializable
  - Serialized Fields
    - assistantId
```
String assistantId
```
    - model
```
String model
```
      All models except gpt-3.5-turbo-0301 supported. retrieval tool requires gpt-4-1106-preview or gpt-3.5-turbo-1106.
      
      See Also:
      
      com.unfbx.chatgpt.entity.chat.ChatCompletion.Model
    - instructions
```
String instructions
```
      助手使用的系统指令。最大长度为 32768 个字符。
    - tools
```
List<E> tools
```
      助手上启用的工具列表。每个助手最多可以有 128 个工具。工具可以是 code_interpreter、retrieval或function。
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
- Class com.unfbx.chatgpt.entity.assistant.run.RunError extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      One of server_error or rate_limit_exceeded.
      
      See Also:
      
      RunError.Code
    - message
```
String message
```
- Class com.unfbx.chatgpt.entity.assistant.run.RunResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - createdAt
```
Long createdAt
```
      创建时间戳
    - threadId
```
String threadId
```
    - assistantId
```
String assistantId
```
    - status
```
String status
```
      See Also:
      
      RunResponse.Status
    - requiredAction
```
Action requiredAction
```
    - lastError
```
RunError lastError
```
      最有一个错误信息，没有错误为null
    - expiresAt
```
Long expiresAt
```
    - startedAt
```
Long startedAt
```
    - cancelledAt
```
Long cancelledAt
```
    - failedAt
```
Long failedAt
```
    - completedAt
```
Long completedAt
```
    - model
```
String model
```
      All models except gpt-3.5-turbo-0301 supported. retrieval tool requires gpt-4-1106-preview or gpt-3.5-turbo-1106.
      
      See Also:
      
      com.unfbx.chatgpt.entity.chat.ChatCompletion.Model
    - instructions
```
String instructions
```
      助手使用的系统指令。最大长度为 32768 个字符。
    - tools
```
List<E> tools
```
      助手上启用的工具列表。每个助手最多可以有 128 个工具。工具可以是 code_interpreter、retrieval或function。
    - fileIds
```
List<E> fileIds
```
      附加到该助手的文件 ID 列表。助手最多可以附加 20 个文件。文件按其创建日期升序排列。
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
- Class com.unfbx.chatgpt.entity.assistant.run.RunStepResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - createdAt
```
Long createdAt
```
      创建时间戳
    - assistantId
```
String assistantId
```
    - threadId
```
String threadId
```
    - runId
```
String runId
```
    - type
```
String type
```
      See Also:
      
      RunStepResponse.Type
    - status
```
String status
```
      See Also:
      
      RunStepResponse.Status
    - stepDetails
```
StepDetail stepDetails
```
    - lastError
```
RunError lastError
```
      最有一个错误信息，没有错误为null
    - expiresAt
```
Long expiresAt
```
    - cancelledAt
```
Long cancelledAt
```
    - failedAt
```
Long failedAt
```
    - completedAt
```
Long completedAt
```
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
- Class com.unfbx.chatgpt.entity.assistant.run.StepDetail extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      See Also:
      
      StepDetail.Type
    - messageCreation
```
MessageCreation messageCreation
```
    - toolCalls
```
List<E> toolCalls
```
- Class com.unfbx.chatgpt.entity.assistant.run.SubmitToolOutputs extends Object implements Serializable
  - Serialized Fields
    - toolCalls
```
List<E> toolCalls
```
- Class com.unfbx.chatgpt.entity.assistant.run.ThreadRun extends Object implements Serializable
  - Serialized Fields
    - assistantId
```
String assistantId
```
    - thread
```
Thread thread
```
    - model
```
String model
```
    - instructions
```
String instructions
```
      覆盖助手的默认系统消息。这对于修改每次运行的行为很有用。
    - tools
```
List<E> tools
```
      覆盖助手可用于此运行的工具。这对于修改每次运行的行为很有用。
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
- Class com.unfbx.chatgpt.entity.assistant.run.ToolCall extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the tool call.
    - type
```
String type
```
      The type of tool call.
      
      See Also:
      
      ToolCall.Type
    - codeInterpreter
```
CodeInterpreter codeInterpreter
```
      代码解释器工具调用定义。
    - retrieval
```
Map<K,V> retrieval
```
      当前版本始终为空
    - function
```
Function function
```
- Class com.unfbx.chatgpt.entity.assistant.run.ToolOutput extends Object implements Serializable
  - Serialized Fields
    - toolCallId
```
String toolCallId
```
    - output
```
String output
```
- Class com.unfbx.chatgpt.entity.assistant.run.ToolOutputBody extends Object implements Serializable
  - Serialized Fields
    - toolOutputs
```
List<E> toolOutputs
```
      为其提交输出的工具列表。
Package com.unfbx.chatgpt.entity.assistant.thread
- Class com.unfbx.chatgpt.entity.assistant.thread.ModifyThread extends Object implements Serializable
  - Serialized Fields
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
- Class com.unfbx.chatgpt.entity.assistant.thread.Thread extends Object implements Serializable
  - Serialized Fields
    - messages
```
List<E> messages
```
      用于启动线程的消息列表。
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
- Class com.unfbx.chatgpt.entity.assistant.thread.ThreadResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - metadata
```
Map<K,V> metadata
```
      Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
    - createdAt
```
Long createdAt
```
      创建时间戳
Package com.unfbx.chatgpt.entity.billing
- Class com.unfbx.chatgpt.entity.billing.CreditGrantsResponse extends Object implements Serializable
  - Serialized Fields
    - object
```
String object
```
    - totalGranted
```
BigDecimal totalGranted
```
      总金额：美元
    - totalUsed
```
BigDecimal totalUsed
```
      总使用金额：美元
    - totalAvailable
```
BigDecimal totalAvailable
```
      总剩余金额：美元
    - grants
```
Grants grants
```
      余额明细
Package com.unfbx.chatgpt.entity.chat
- Class com.unfbx.chatgpt.entity.chat.BaseChatCompletion extends Object implements Serializable
  - Serialized Fields
    - model
```
String model
```
    - responseFormat
```
ResponseFormat responseFormat
```
      指定模型必须输出的格式的对象。
      
      Since:
      
      1.1.2
    - functions
```
List<E> functions
```
      Deprecated.
      
      已过时
      
      See Also:
      
      BaseChatCompletion.tools
    - functionCall
```
Object functionCall
```
      Deprecated.
      
      取值：null,auto或者自定义 functions没有值的时候默认为：null functions存在值得时候默认为：auto 也可以自定义
      已过时
      
      See Also:
      
      BaseChatCompletion.toolChoice
    - tools
```
List<E> tools
```
      模型可能调用的工具列表。当前版本仅支持：functions
      
      Since:
      
      1.1.2
    - toolChoice
```
Object toolChoice
```
      取值：String或者ToolChoiceObj
      
      Since:
      
      1.1.2
      
      See Also:
      
      当取值为String时：ToolChoice.Choice, 当取值为ToolChoiceObj时：ToolChoiceObj
    - 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
```
      用户唯一值，确保接口不被重复调用
    - seed
```
Integer seed
```
      Since:
      
      1.1.2
- Class com.unfbx.chatgpt.entity.chat.BaseMessage extends Object implements Serializable
  - Serialized Fields
    - role
```
String role
```
      目前支持四个中角色参考官网，进行情景输入： https://platform.openai.com/docs/guides/chat/introduction
    - name
```
String name
```
    - toolCalls
```
List<E> toolCalls
```
      The tool calls generated by the model, such as function calls.
      
      Since:
      
      1.1.2
    - toolCallId
```
String toolCallId
```
      Since:
      
      1.1.2
    - functionCall
```
FunctionCall functionCall
```
      Deprecated.
- 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 BaseChatCompletion implements Serializable
  - Serialized Fields
    - messages
```
List<E> messages
```
      问题描述
- 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
```
    - warning
```
String warning
```
    - systemFingerprint
```
String systemFingerprint
```
- Class com.unfbx.chatgpt.entity.chat.ChatCompletionWithPicture extends BaseChatCompletion implements Serializable
  - Serialized Fields
    - messages
```
List<E> messages
```
      问题描述
- Class com.unfbx.chatgpt.entity.chat.Functions extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      方法名称
    - description
```
String description
```
      方法描述
    - parameters
```
Parameters parameters
```
      方法参数扩展参数可以继承Parameters自己实现，json格式的数据
- Class com.unfbx.chatgpt.entity.chat.Message extends BaseMessage implements Serializable
  - Serialized Fields
    - content
```
String content
```
      旧的content属性仅仅支持字符类型
- Class com.unfbx.chatgpt.entity.chat.MessagePicture extends BaseMessage implements Serializable
  - Serialized Fields
    - content
```
List<E> content
```
      Content数组支持多图片输入 https://platform.openai.com/docs/guides/vision
- Class com.unfbx.chatgpt.entity.chat.Parameters extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      参数类型
    - properties
```
Object properties
```
      参数属性、描述
    - required
```
List<E> required
```
      方法必输字段
Package com.unfbx.chatgpt.entity.chat.tool
- Class com.unfbx.chatgpt.entity.chat.tool.ToolCallFunction extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      方法名
    - arguments
```
String arguments
```
      方法参数
- Class com.unfbx.chatgpt.entity.chat.tool.ToolCalls extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the tool call.
    - type
```
String type
```
      The type of the tool. Currently, only function is supported.
    - function
```
ToolCallFunction function
```
- Class com.unfbx.chatgpt.entity.chat.tool.ToolChoice extends Object implements Serializable
- Class com.unfbx.chatgpt.entity.chat.tool.Tools extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      目前只支持：function
      
      See Also:
      
      Tools.Type
    - function
```
ToolsFunction function
```
- Class com.unfbx.chatgpt.entity.chat.tool.ToolsFunction extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      要调用的函数的名称。必须是 a-z、A-Z、0-9，或包含下划线和破折号，最大长度为 64
    - description
```
String description
```
      对函数功能的描述，模型使用它来选择何时以及如何调用该函数。
    - parameters
```
Parameters parameters
```
      函数接受的参数，描述为 JSON Schema 对象扩展参数可以继承Parameters自己实现，json格式的数据
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
```
Logprobs 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.Logprobs extends Object implements Serializable
  - Serialized Fields
    - textOffset
```
List<E> textOffset
```
    - tokenLogprobs
```
List<E> tokenLogprobs
```
    - tokens
```
List<E> tokens
```
    - top_logprobs
```
List<E> top_logprobs
```
- 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
```
    - seed
```
Integer seed
```
      Since:
      
      1.1.2
    - 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
```
List<E> choices
```
    - usage
```
Usage usage
```
    - warning
```
String warning
```
    - systemFingerprint
```
String systemFingerprint
```
Package com.unfbx.chatgpt.entity.edits
- Class com.unfbx.chatgpt.entity.edits.Edit extends Object implements Serializable
  - Serialized Fields
    - model
```
String model
```
      Deprecated.
      
      编辑模型，目前支持两种
    - input
```
String input
```
      Deprecated.
    - instruction
```
String instruction
```
      Deprecated.
      
      提示说明。告知模型如何修改。
    - temperature
```
double temperature
```
      Deprecated.
      
      使用什么取样温度，0到2之间。较高的值(如0.8)将使输出更加随机，而较低的值(如0.2)将使输出更加集中和确定。 We generally recommend altering this or but not both.top_p
    - topP
```
Double topP
```
      Deprecated.
      
      使用温度采样的替代方法称为核心采样，其中模型考虑具有top_p概率质量的令牌的结果。因此，0.1 意味着只考虑包含前 10% 概率质量的代币。我们通常建议更改此设置，但不要同时更改两者。temperature
    - n
```
Integer n
```
      Deprecated.
      
      为每个提示生成的完成次数。
- 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
```
List<E> input
```
      必选项：长度不能超过：8192
    - user
```
String user
```
    - encodingFormat
```
String encodingFormat
```
      Can be either float or base64.
      
      See Also:
      
      Embedding.EncodingFormat
- 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
```
    - bytes
```
Long bytes
```
    - createdAt
```
Long createdAt
```
    - filename
```
String filename
```
    - object
```
String object
```
    - purpose
```
String purpose
```
    - status
```
String status
```
      Deprecated.
    - statusDetails
```
String statusDetails
```
      Deprecated.
- 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.FineTuneDeleteResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - object
```
String object
```
    - deleted
```
boolean deleted
```
- 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.fineTune.job
- Class com.unfbx.chatgpt.entity.fineTune.job.FineTuneJob extends Object implements Serializable
  - Serialized Fields
    - model
```
String model
```
      参考
      
      See Also:
      
      FineTuneJob.Model
    - trainingFile
```
String trainingFile
```
      上传的文件ID
    - hyperParameters
```
HyperParameters hyperParameters
```
      用于微调工作的参数
    - suffix
```
String suffix
```
    - validationFile
```
String validationFile
```
- Class com.unfbx.chatgpt.entity.fineTune.job.FineTuneJobEvent extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - createdAt
```
Long createdAt
```
    - level
```
String level
```
    - message
```
String message
```
    - object
```
String object
```
- Class com.unfbx.chatgpt.entity.fineTune.job.FineTuneJobListResponse extends Object implements Serializable
  - Serialized Fields
    - object
```
String object
```
    - data
```
List<E> data
```
    - hasMore
```
Boolean hasMore
```
- Class com.unfbx.chatgpt.entity.fineTune.job.FineTuneJobResponse extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - createdAt
```
Long createdAt
```
    - error
```
FineTuneError error
```
    - fineTunedModel
```
String fineTunedModel
```
    - finishedAt
```
Long finishedAt
```
    - hyperparameters
```
HyperParameters hyperparameters
```
    - model
```
String model
```
    - object
```
String object
```
    - organizationId
```
String organizationId
```
    - resultFiles
```
List<E> resultFiles
```
    - status
```
String status
```
    - trainedTokens
```
Integer trainedTokens
```
    - trainingFile
```
String trainingFile
```
    - validationFile
```
String validationFile
```
    - data
```
String data
```
- Class com.unfbx.chatgpt.entity.fineTune.job.HyperParameters extends Object implements Serializable
  - Serialized Fields
    - batchSize
```
String batchSize
```
    - learningRateMultiplier
```
String learningRateMultiplier
```
    - nEpochs
```
String nEpochs
```
Package com.unfbx.chatgpt.entity.images
- Class com.unfbx.chatgpt.entity.images.Image extends Object implements Serializable
  - Serialized Fields
    - prompt
```
String prompt
```
      提示词：dall-e-2支持1000字符、dall-e-3支持4000字符
    - model
```
String model
```
      支持dall-e-2、dall-e-3
      
      See Also:
      
      Image.Model
    - quality
```
String quality
```
      此参数仅仅dall-e-3,默认值：standard
      
      See Also:
      
      Image.Quality
    - n
```
Integer n
```
      为每个提示生成的个数，dall-e-3只能为1。
    - size
```
String size
```
      图片尺寸，默认值：1024x1024 dall-e-2支持：256x256, 512x512, or 1024x1024 dall-e-3支持：1024x1024, 1792x1024, or 1024x1792
      
      See Also:
      
      SizeEnum
    - style
```
String style
```
      此参数仅仅dall-e-3,取值范围：vivid、natural 默认值：vivid
      
      See Also:
      
      Image.Style
    - responseFormat
```
String responseFormat
```
      生成图片格式：url、b64_json
      
      See Also:
      
      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
```
    - b64Json
```
String b64Json
```
    - revisedPrompt
```
String revisedPrompt
```
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
```
      以极端血腥细节描绘死亡、暴力或严重身体伤害的暴力内容。
    - harassment
```
boolean harassment
```
      对任何目标表达、煽动或宣扬骚扰性语言的内容。
    - harassmentThreatening
```
boolean harassmentThreatening
```
      骚扰内容还包括对任何目标的暴力或严重伤害。
    - selfHarmIntent
```
boolean selfHarmIntent
```
      说话者表示他们正在或打算进行自残行为的内容，例如自杀、割伤和饮食失调。
    - selfHarmInstructions
```
boolean selfHarmInstructions
```
      鼓励进行自残行为（例如自杀、割伤和饮食失调）的内容，或者提供有关如何实施此类行为的说明或建议的内容。
- 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
```
    - harassment
```
BigDecimal harassment
```
      对任何目标表达、煽动或宣扬骚扰性语言的内容。
    - harassmentThreatening
```
BigDecimal harassmentThreatening
```
      骚扰内容还包括对任何目标的暴力或严重伤害。
    - selfHarmIntent
```
BigDecimal selfHarmIntent
```
      说话者表示他们正在或打算进行自残行为的内容，例如自杀、割伤和饮食失调。
    - selfHarmInstructions
```
BigDecimal selfHarmInstructions
```
      鼓励进行自残行为（例如自杀、割伤和饮食失调）的内容，或者提供有关如何实施此类行为的说明或建议的内容。
- Class com.unfbx.chatgpt.entity.moderations.Moderation extends Object implements Serializable
  - Serialized Fields
    - input
```
List<E> 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.Transcriptions extends Whisper implements Serializable
  - Serialized Fields
    - model
```
String model
```
      模型目前只支持这一种：WHISPER_1
    - prompt
```
String prompt
```
      提示语，需要与语音语言匹配
    - responseFormat
```
String responseFormat
```
      输出的格式，采用以下选项之一：json、text、srt、verbose_json 或 vtt。默认值：json
    - temperature
```
Double temperature
```
      温度控制随机效果：0-1，值越大输出更加随机默认值：0
    - language
```
String language
```
      输入音频的语言,以 ISO-639-1 格式提供输入语言将提高准确性和延迟。参考：ISO-639-1
- 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.assistant

Class com.unfbx.chatgpt.entity.assistant.Assistant extends Object implements Serializable

Serialized Fields

model

name

description

instructions

tools

fileIds

metadata

Class com.unfbx.chatgpt.entity.assistant.AssistantFile extends Object implements Serializable

Serialized Fields

fileId

Class com.unfbx.chatgpt.entity.assistant.AssistantFileResponse extends Object implements Serializable

Serialized Fields

id

object

createdAt

assistantId

Class com.unfbx.chatgpt.entity.assistant.AssistantListResponse extends Object implements Serializable

Serialized Fields

object

firstId

lastId

data

hasMore

Class com.unfbx.chatgpt.entity.assistant.AssistantResponse extends Object implements Serializable

Serialized Fields

id

object

model

name

description

instructions

tools

fileIds

metadata

createdAt

Class com.unfbx.chatgpt.entity.assistant.Tool extends Object implements Serializable

Serialized Fields

type

function

Package com.unfbx.chatgpt.entity.assistant.message

Class com.unfbx.chatgpt.entity.assistant.message.MessageFileResponse extends Object implements Serializable

Serialized Fields

id

object

createdAt

messageId

Class com.unfbx.chatgpt.entity.assistant.message.MessageResponse extends Object implements Serializable

Serialized Fields

id

object

createdAt

threadId

role

content

assistantId

runId

fileIds

metadata

Class com.unfbx.chatgpt.entity.assistant.message.ModifyMessage extends Object implements Serializable

Serialized Fields

metadata

Package com.unfbx.chatgpt.entity.assistant.run

Class com.unfbx.chatgpt.entity.assistant.run.Action extends Object implements Serializable

Serialized Fields

type

submitToolOutputs

Class com.unfbx.chatgpt.entity.assistant.run.CodeInterpreter extends Object implements Serializable

Serialized Fields

input

outputs

Class com.unfbx.chatgpt.entity.assistant.run.Function extends Object implements Serializable

Serialized Fields

name

arguments

output

Class com.unfbx.chatgpt.entity.assistant.run.Image extends Object implements Serializable