类class io.agentscope.extensions.model.openai.dto 2.x

OpenAIUsage

@JsonIgnoreProperties(ignoreUnknown = true) public class OpenAIUsage

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:35–201

OpenAI 用量，与模型服务通信并返回生成或向量化结果。位于 io.agentscope.extensions.model.openai.dto 包。核心成员包括 getPromptTokens、setPromptTokens、getCompletionTokens、setCompletionTokens、getTotalTokens、getPromptCacheHitTokens。

OpenAI usage statistics DTO.

This class represents token usage statistics in an OpenAI API response.

Example JSON:

`{
"prompt_tokens": 10,
"completion_tokens": 20,
"total_tokens": 30
}
`

嵌套类摘要Nested Class Summary

类Class	类型Kind	说明Description
`PromptTokensDetails`	类class	提示词令牌数详情，与模型服务通信并返回生成或向量化结果。 Detailed breakdown of prompt tokens.
`CompletionTokensDetails`	类class	补全令牌数详情，与模型服务通信并返回生成或向量化结果。 Detailed breakdown of completion tokens.

构造器摘要Constructor Summary

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

方法摘要Method Summary

方法Method	说明Description
`public Integer getPromptTokens()`	获取提示词令牌数。 Returns the prompt tokens.
`public void setPromptTokens(Integer promptTokens)`	设置提示词令牌数。 Sets the prompt tokens.
`public Integer getCompletionTokens()`	获取补全令牌数。 Returns the completion tokens.
`public void setCompletionTokens(Integer completionTokens)`	设置补全令牌数。 Sets the completion tokens.
`public Integer getTotalTokens()`	获取总数令牌数。 Returns the total tokens.
`public Integer getPromptCacheHitTokens()`	获取 `getPromptCacheHitTokens`。 Returns the prompt cache hit tokens.
`public void setPromptCacheHitTokens(Integer promptCacheHitTokens)`	设置 `setPromptCacheHitTokens`。 Sets the prompt cache hit tokens.
`public void setTotalTokens(Integer totalTokens)`	设置总数令牌数。 Sets the total tokens.
`public` `PromptTokensDetails getPromptTokensDetails()`	获取提示词令牌数详情。 Returns the prompt tokens details.
`public void setPromptTokensDetails(PromptTokensDetails promptTokensDetails)`	设置提示词令牌数详情。 Sets the prompt tokens details.
`public` `CompletionTokensDetails getCompletionTokensDetails()`	获取补全令牌数详情。 Returns the completion tokens details.
`public void setCompletionTokensDetails(CompletionTokensDetails completionTokensDetails)`	设置补全令牌数详情。 Sets the completion tokens details.

构造器详情Constructor Detail

OpenAIUsage

public OpenAIUsage()

初始化 OpenAIUsage 实例。

Creates a new instance.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:62

方法详情Method Detail

getPromptTokens

public Integer getPromptTokens()

获取提示词令牌数。

Returns the prompt tokens.

返回Returns Integer

返回数值结果。Returns a numeric result.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:64–66

setPromptTokens

public void setPromptTokens(Integer promptTokens)

设置提示词令牌数。

Sets the prompt tokens.

参数Parameters

名称Name	类型Type	说明Description
`promptTokens`	Integer	提示词令牌数（类型 `Integer`）。The prompt tokens.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:68–70

getCompletionTokens

public Integer getCompletionTokens()

获取补全令牌数。

Returns the completion tokens.

返回Returns Integer

返回数值结果。Returns a numeric result.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:72–74

setCompletionTokens

public void setCompletionTokens(Integer completionTokens)

设置补全令牌数。

Sets the completion tokens.

参数Parameters

名称Name	类型Type	说明Description
`completionTokens`	Integer	补全令牌数（类型 `Integer`）。The completion tokens.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:76–78

getTotalTokens

public Integer getTotalTokens()

获取总数令牌数。

Returns the total tokens.

返回Returns Integer

返回数值结果。Returns a numeric result.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:80–82

getPromptCacheHitTokens

public Integer getPromptCacheHitTokens()

获取 getPromptCacheHitTokens。

Returns the prompt cache hit tokens.

返回Returns Integer

返回数值结果。Returns a numeric result.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:84–86

setPromptCacheHitTokens

public void setPromptCacheHitTokens(Integer promptCacheHitTokens)

设置 setPromptCacheHitTokens。

Sets the prompt cache hit tokens.

参数Parameters

名称Name	类型Type	说明Description
`promptCacheHitTokens`	Integer	提示词缓存 Hit 令牌数（类型 `Integer`）。The prompt cache hit tokens.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:88–90

setTotalTokens

public void setTotalTokens(Integer totalTokens)

设置总数令牌数。

Sets the total tokens.

参数Parameters

名称Name	类型Type	说明Description
`totalTokens`	Integer	总数令牌数（类型 `Integer`）。The total tokens.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:92–94

getPromptTokensDetails

public PromptTokensDetails getPromptTokensDetails()

获取提示词令牌数详情。

Returns the prompt tokens details.

返回Returns PromptTokensDetails

返回PromptTokensDetails。Returns prompt tokens details.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:96–98

setPromptTokensDetails

public void setPromptTokensDetails(PromptTokensDetails promptTokensDetails)

设置提示词令牌数详情。

Sets the prompt tokens details.

参数Parameters

名称Name	类型Type	说明Description
`promptTokensDetails`	PromptTokensDetails	提示词令牌数详情（类型 `PromptTokensDetails`）。The prompt tokens details.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:100–102

getCompletionTokensDetails

public CompletionTokensDetails getCompletionTokensDetails()

获取补全令牌数详情。

Returns the completion tokens details.

返回Returns CompletionTokensDetails

返回CompletionTokensDetails。Returns completion tokens details.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:104–106

setCompletionTokensDetails

public void setCompletionTokensDetails(CompletionTokensDetails completionTokensDetails)

设置补全令牌数详情。

Sets the completion tokens details.

参数Parameters

名称Name	类型Type	说明Description
`completionTokensDetails`	CompletionTokensDetails	补全令牌数详情（类型 `CompletionTokensDetails`）。The completion tokens details.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIUsage.java:108–110

嵌套类详情Nested Class Detail

PromptTokensDetails

@JsonIgnoreProperties(ignoreUnknown = true) public static class PromptTokensDetails

提示词令牌数详情，与模型服务通信并返回生成或向量化结果。位于 io.agentscope.extensions.model.openai.dto 包。核心成员包括 getCachedTokens、setCachedTokens、getCacheWriteTokens、setCacheWriteTokens、getAudioTokens、setAudioTokens。

Detailed breakdown of prompt tokens.

CompletionTokensDetails

@JsonIgnoreProperties(ignoreUnknown = true) public static class CompletionTokensDetails

补全令牌数详情，与模型服务通信并返回生成或向量化结果。位于 io.agentscope.extensions.model.openai.dto 包。核心成员包括 getReasoningTokens、setReasoningTokens、getAudioTokens、setAudioTokens、getAcceptedPredictionTokens、setAcceptedPredictionTokens。

Detailed breakdown of completion tokens.