AS AgentScopeAPI 手册 / API Reference

OpenAIStreamOptions

@JsonInclude(JsonInclude.Include.NON_NULL) public class OpenAIStreamOptions
源码Source io/agentscope/extensions/model/openai/dto/OpenAIStreamOptions.java:33–62

OpenAI 流选项,保存相关配置项。位于 io.agentscope.extensions.model.openai.dto 包。核心成员包括 getIncludeUsage、setIncludeUsage、withUsage、OpenAIStreamOptions。

OpenAI stream options DTO.

This class represents options for streaming responses.

Example:

`{
"include_usage": true
}
`

构造器摘要Constructor Summary

构造器Constructor说明Description
public OpenAIStreamOptions()
初始化 `OpenAIStreamOptions` 实例。
Creates a new instance.
public OpenAIStreamOptions(Boolean includeUsage)
初始化 `OpenAIStreamOptions` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public Boolean getIncludeUsage()
获取 `getIncludeUsage`。
Returns the include usage.
public void setIncludeUsage(Boolean includeUsage)
设置 `setIncludeUsage`。
Sets the include usage.
public static OpenAIStreamOptions withUsage()
static
创建流选项使用 include_用量已启用。
Create a stream options with include_usage enabled.

构造器详情Constructor Detail

OpenAIStreamOptions

public OpenAIStreamOptions()

初始化 OpenAIStreamOptions 实例。

Creates a new instance.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIStreamOptions.java:40

OpenAIStreamOptions

public OpenAIStreamOptions(Boolean includeUsage)

初始化 OpenAIStreamOptions 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
includeUsageBooleaninclude 用量(类型 `Boolean`)。The include usage.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIStreamOptions.java:42–44

方法详情Method Detail

getIncludeUsage

public Boolean getIncludeUsage()

获取 getIncludeUsage。

Returns the include usage.

返回Returns Boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIStreamOptions.java:46–48

setIncludeUsage

public void setIncludeUsage(Boolean includeUsage)

设置 setIncludeUsage。

Sets the include usage.

参数Parameters
名称Name类型Type说明Description
includeUsageBooleaninclude 用量(类型 `Boolean`)。The include usage.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIStreamOptions.java:50–52

withUsage

public static OpenAIStreamOptions withUsage()
static

创建流选项使用 include_用量已启用。

Create a stream options with include_usage enabled.

返回Returns OpenAIStreamOptions
返回OpenAIStreamOptions。a new OpenAIStreamOptions with includeUsage=true
源码Source io/agentscope/extensions/model/openai/dto/OpenAIStreamOptions.java:59–61
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.