AS AgentScopeAPI 手册 / API Reference

Usage

@JsonInclude(JsonInclude.Include.NON_NULL) public static class Usage
源码Source io/agentscope/core/chat/completions/model/ChatCompletionsResponse.java:160–206

用量,与模型服务通信并返回生成或向量化结果。位于 io.agentscope.core.chat.completions.model 包。核心成员包括 getPromptTokens、setPromptTokens、getCompletionTokens、setCompletionTokens、getTotalTokens、setTotalTokens。

Token usage statistics following OpenAI's format.

All fields use snake_case per OpenAI specification.

构造器摘要Constructor Summary

构造器Constructor说明Description
public Usage()
初始化 `Usage` 实例。
Creates a new instance.
public Usage(Integer promptTokens, Integer completionTokens, Integer totalTokens)
初始化 `Usage` 实例。
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 void setTotalTokens(Integer totalTokens)
设置总数令牌数。
Sets the total tokens.

构造器详情Constructor Detail

Usage

public Usage()

初始化 Usage 实例。

Creates a new instance.

源码Source io/agentscope/core/chat/completions/model/ChatCompletionsResponse.java:175

Usage

public Usage(Integer promptTokens, Integer completionTokens, Integer totalTokens)

初始化 Usage 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
promptTokensInteger提示词令牌数(类型 `Integer`)。The prompt tokens.
completionTokensInteger补全令牌数(类型 `Integer`)。The completion tokens.
totalTokensInteger总数令牌数(类型 `Integer`)。The total tokens.
源码Source io/agentscope/core/chat/completions/model/ChatCompletionsResponse.java:177–181

方法详情Method Detail

getPromptTokens

public Integer getPromptTokens()

获取提示词令牌数。

Returns the prompt tokens.

返回Returns Integer
返回数值结果。Returns a numeric result.
源码Source io/agentscope/core/chat/completions/model/ChatCompletionsResponse.java:183–185

setPromptTokens

public void setPromptTokens(Integer promptTokens)

设置提示词令牌数。

Sets the prompt tokens.

参数Parameters
名称Name类型Type说明Description
promptTokensInteger提示词令牌数(类型 `Integer`)。The prompt tokens.
源码Source io/agentscope/core/chat/completions/model/ChatCompletionsResponse.java:187–189

getCompletionTokens

public Integer getCompletionTokens()

获取补全令牌数。

Returns the completion tokens.

返回Returns Integer
返回数值结果。Returns a numeric result.
源码Source io/agentscope/core/chat/completions/model/ChatCompletionsResponse.java:191–193

setCompletionTokens

public void setCompletionTokens(Integer completionTokens)

设置补全令牌数。

Sets the completion tokens.

参数Parameters
名称Name类型Type说明Description
completionTokensInteger补全令牌数(类型 `Integer`)。The completion tokens.
源码Source io/agentscope/core/chat/completions/model/ChatCompletionsResponse.java:195–197

getTotalTokens

public Integer getTotalTokens()

获取总数令牌数。

Returns the total tokens.

返回Returns Integer
返回数值结果。Returns a numeric result.
源码Source io/agentscope/core/chat/completions/model/ChatCompletionsResponse.java:199–201

setTotalTokens

public void setTotalTokens(Integer totalTokens)

设置总数令牌数。

Sets the total tokens.

参数Parameters
名称Name类型Type说明Description
totalTokensInteger总数令牌数(类型 `Integer`)。The total tokens.
源码Source io/agentscope/core/chat/completions/model/ChatCompletionsResponse.java:203–205
基于官方固定版本源码静态生成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.