OpenAIChoice
@JsonIgnoreProperties(ignoreUnknown = true) public class OpenAIChoice源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:51–127OpenAI 选项，保存相关配置项。位于 io.agentscope.extensions.model.openai.dto 包。核心成员包括 getIndex、setIndex、getMessage、setMessage、getDelta、setDelta。
OpenAI choice DTO.
This class represents a single choice in an OpenAI API response. For non-streaming responses, use "message" field. For streaming responses, use "delta" field.
Example non-streaming:
`{
"index": 0,
"message": {
"role": "assistant",
"content": "Hello!"
},
"finish_reason": "stop"
}
`
Example streaming:
`{
"index": 0,
"delta": {
"content": "Hello"
},
"finish_reason": null
}
`
构造器摘要Constructor Summary
| 构造器Constructor | 说明Description |
|---|---|
public OpenAIChoice() | 初始化 `OpenAIChoice` 实例。 Creates a new instance. |
方法摘要Method Summary
| 方法Method | 说明Description |
|---|---|
public Integer getIndex() | 获取索引。 Returns the index. |
public void setIndex(Integer index) | 设置索引。 Sets the index. |
public OpenAIMessage getMessage() | 获取消息。 Returns the message. |
public void setMessage(OpenAIMessage message) | 设置消息。 Sets the message. |
public OpenAIMessage getDelta() | 获取增量。 Returns the delta. |
public void setDelta(OpenAIMessage delta) | 设置增量。 Sets the delta. |
public String getFinishReason() | 获取 `getFinishReason`。 Returns the finish reason. |
public void setFinishReason(String finishReason) | 设置 `setFinishReason`。 Sets the finish reason. |
public Object getLogprobs() | 获取 `getLogprobs`。 Returns the logprobs. |
public void setLogprobs(Object logprobs) | 设置 `setLogprobs`。 Sets the logprobs. |
public OpenAIMessage getEffectiveMessage() | 获取 `getEffectiveMessage`。 Get the effective message (either message or delta). |
构造器详情Constructor Detail
OpenAIChoice
public OpenAIChoice()初始化 OpenAIChoice 实例。
Creates a new instance.
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:77方法详情Method Detail
getIndex
public Integer getIndex()获取索引。
Returns the index.
Integer返回数值结果。Returns a numeric result.
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:79–81setIndex
public void setIndex(Integer index)设置索引。
Sets the index.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
index | Integer | 索引（类型 `Integer`）。The index. |
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:83–85getMessage
public OpenAIMessage getMessage()获取消息。
Returns the message.
OpenAIMessage返回OpenAIMessage。Returns OpenAI message.
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:87–89setMessage
public void setMessage(OpenAIMessage message)设置消息。
Sets the message.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
message | OpenAIMessage | 消息（类型 `OpenAIMessage`）。The message. |
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:91–93getDelta
public OpenAIMessage getDelta()获取增量。
Returns the delta.
OpenAIMessage返回OpenAIMessage。Returns OpenAI message.
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:95–97setDelta
public void setDelta(OpenAIMessage delta)设置增量。
Sets the delta.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
delta | OpenAIMessage | 增量（类型 `OpenAIMessage`）。The delta. |
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:99–101getFinishReason
public String getFinishReason()获取 getFinishReason。
Returns the finish reason.
String返回字符串结果。Returns a string.
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:103–105setFinishReason
public void setFinishReason(String finishReason)设置 setFinishReason。
Sets the finish reason.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
finishReason | String | finish 推理（类型 `String`）。The finish reason. |
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:107–109getLogprobs
public Object getLogprobs()获取 getLogprobs。
Returns the logprobs.
Object返回对象。Returns object.
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:111–113setLogprobs
public void setLogprobs(Object logprobs)设置 setLogprobs。
Sets the logprobs.
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
logprobs | Object | logprobs（类型 `Object`）。The logprobs. |
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:115–117getEffectiveMessage
public OpenAIMessage getEffectiveMessage()获取 getEffectiveMessage。
Get the effective message (either message or delta).
OpenAIMessage返回OpenAIMessage。the message for non-streaming, delta for streaming
源码Source
io/agentscope/extensions/model/openai/dto/OpenAIChoice.java:124–126