AS AgentScopeAPI 手册 / API Reference

OpenAIRequest

@JsonInclude(JsonInclude.Include.NON_NULL) public class OpenAIRequest
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:42–612

OpenAI 请求,与模型服务通信并返回生成或向量化结果。位于 io.agentscope.extensions.model.openai.dto 包。核心成员包括 getModel、setModel、getMessages、setMessages、getStream、setStream。

OpenAI Chat Completion API request DTO.

This class represents the request structure for OpenAI's Chat Completion API.

Example JSON:

`{
"model": "gpt-4o",
"messages": [...],
"stream": true,
"temperature": 0.7,
"max_tokens": 1000
}
`

嵌套类摘要Nested Class Summary

类Class类型Kind说明Description
Builder类class
构建器,用于构建并配置目标实例。
A class in io.agentscope.extensions.model.openai.dto that talks to model services and returns generated or embedded output.

构造器摘要Constructor Summary

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

方法摘要Method Summary

方法Method说明Description
public String getModel()
获取模型。
Returns the model.
public void setModel(String model)
设置模型。
Sets the model.
public List<OpenAIMessage> getMessages()
获取消息。
Returns the messages.
public void setMessages(List<OpenAIMessage> messages)
设置消息。
Sets the messages.
public Boolean getStream()
获取流。
Returns the stream.
public void setStream(Boolean stream)
设置流。
Sets the stream.
public OpenAIStreamOptions getStreamOptions()
获取流选项。
Returns the stream options.
public void setStreamOptions(OpenAIStreamOptions streamOptions)
设置流选项。
Sets the stream options.
public Double getTemperature()
获取 `getTemperature`。
Returns the temperature.
public void setTemperature(Double temperature)
设置 `setTemperature`。
Sets the temperature.
public Double getTopP()
获取 `getTopP`。
Returns the top p.
public void setTopP(Double topP)
设置 `setTopP`。
Sets the top p.
public Integer getMaxTokens()
获取最大令牌数。
Returns the max tokens.
public void setMaxTokens(Integer maxTokens)
设置最大令牌数。
Sets the max tokens.
public Integer getMaxCompletionTokens()
获取最大补全令牌数。
Returns the max completion tokens.
public void setMaxCompletionTokens(Integer maxCompletionTokens)
设置最大补全令牌数。
Sets the max completion tokens.
public Double getFrequencyPenalty()
获取 `getFrequencyPenalty`。
Returns the frequency penalty.
public void setFrequencyPenalty(Double frequencyPenalty)
设置 `setFrequencyPenalty`。
Sets the frequency penalty.
public Double getPresencePenalty()
获取 `getPresencePenalty`。
Returns the presence penalty.
public void setPresencePenalty(Double presencePenalty)
设置 `setPresencePenalty`。
Sets the presence penalty.
public Object getStop()
获取停止。
Returns the stop.
public void setStop(Object stop)
设置停止。
Sets the stop.
public Integer getSeed()
获取预置。
Returns the seed.
public void setSeed(Integer seed)
设置预置。
Sets the seed.
public Integer getN()
获取N。
Returns the n.
public void setN(Integer n)
设置N。
Sets the n.
public List<OpenAITool> getTools()
获取工具。
Returns the tools.
public void setTools(List<OpenAITool> tools)
设置工具。
Sets the tools.
public Object getToolChoice()
获取工具选项。
Returns the tool choice.
public void setToolChoice(Object toolChoice)
设置工具选项。
Sets the tool choice.
public String getUser()
获取用户。
Returns the user.
public void setUser(String user)
设置用户。
Sets the user.
public Object getResponseFormat()
获取响应格式。
Returns the response format.
public void setResponseFormat(Object responseFormat)
设置响应格式。
Sets the response format.
public Boolean getLogprobs()
获取 `getLogprobs`。
Returns the logprobs.
public void setLogprobs(Boolean logprobs)
设置 `setLogprobs`。
Sets the logprobs.
public Integer getTopLogprobs()
获取 `getTopLogprobs`。
Returns the top logprobs.
public void setTopLogprobs(Integer topLogprobs)
设置 `setTopLogprobs`。
Sets the top logprobs.
public String getReasoningEffort()
获取 `getReasoningEffort`。
Returns the reasoning effort.
public void setReasoningEffort(String reasoningEffort)
设置 `setReasoningEffort`。
Sets the reasoning effort.
public Integer getThinkingBudget()
获取 `getThinkingBudget`。
Returns the thinking budget.
public void setThinkingBudget(Integer thinkingBudget)
设置 `setThinkingBudget`。
Sets the thinking budget.
public Boolean getParallelToolCalls()
获取 `getParallelToolCalls`。
Returns the parallel tool calls.
public void setParallelToolCalls(Boolean parallelToolCalls)
设置 `setParallelToolCalls`。
Sets the parallel tool calls.
public String getServiceTier()
获取 `getServiceTier`。
Returns the service tier.
public void setServiceTier(String serviceTier)
设置 `setServiceTier`。
Sets the service tier.
public Boolean getStore()
获取存储。
Returns the store.
public void setStore(Boolean store)
设置存储。
Sets the store.
public Map<String, Object> getMetadata()
获取元数据。
Returns the metadata.
public void setMetadata(Map<String, Object> metadata)
设置元数据。
Sets the metadata.
public Map<String, Object> getPrediction()
获取 `getPrediction`。
Returns the prediction.
public void setPrediction(Map<String, Object> prediction)
设置 `setPrediction`。
Sets the prediction.
public List<String> getModalities()
获取 `getModalities`。
Returns the modalities.
public void setModalities(List<String> modalities)
设置 `setModalities`。
Sets the modalities.
public Map<String, Object> getAudio()
获取音频。
Returns the audio.
public void setAudio(Map<String, Object> audio)
设置音频。
Sets the audio.
public Boolean getIncludeReasoning()
获取 `getIncludeReasoning`。
Returns the include reasoning.
public void setIncludeReasoning(Boolean includeReasoning)
设置 `setIncludeReasoning`。
Sets the include reasoning.
public Map<String, Object> getExtraParams()
获取 `getExtraParams`。
Returns the extra params.
public void addExtraParam(String key, Object value)
添加 `addExtraParam`。
Adds the extra param.
public void setExtraParams(Map<String, Object> extraParams)
设置 `setExtraParams`。
Sets the extra params.
public static Builder builder()
static
返回构建器实例。
Returns the builder.

构造器详情Constructor Detail

OpenAIRequest

public OpenAIRequest()

初始化 OpenAIRequest 实例。

Creates a new instance.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:183

方法详情Method Detail

getModel

public String getModel()

获取模型。

Returns the model.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:195–197

setModel

public void setModel(String model)

设置模型。

Sets the model.

参数Parameters
名称Name类型Type说明Description
modelString模型实例(类型 `String`)。The model.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:199–201

getMessages

public List<OpenAIMessage> getMessages()

获取消息。

Returns the messages.

返回Returns List<OpenAIMessage>
返回列出。Returns list.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:203–205

setMessages

public void setMessages(List<OpenAIMessage> messages)

设置消息。

Sets the messages.

参数Parameters
名称Name类型Type说明Description
messagesList<OpenAIMessage>消息列表(类型 `List`)。The messages.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:207–209

getStream

public Boolean getStream()

获取流。

Returns the stream.

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

setStream

public void setStream(Boolean stream)

设置流。

Sets the stream.

参数Parameters
名称Name类型Type说明Description
streamBoolean流(类型 `Boolean`)。The stream.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:215–217

getStreamOptions

public OpenAIStreamOptions getStreamOptions()

获取流选项。

Returns the stream options.

返回Returns OpenAIStreamOptions
返回OpenAIStreamOptions。Returns OpenAI stream options.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:219–221

setStreamOptions

public void setStreamOptions(OpenAIStreamOptions streamOptions)

设置流选项。

Sets the stream options.

参数Parameters
名称Name类型Type说明Description
streamOptionsOpenAIStreamOptions流选项(类型 `OpenAIStreamOptions`)。The stream options.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:223–225

getTemperature

public Double getTemperature()

获取 getTemperature。

Returns the temperature.

返回Returns Double
返回数值结果。Returns a numeric result.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:227–229

setTemperature

public void setTemperature(Double temperature)

设置 setTemperature。

Sets the temperature.

参数Parameters
名称Name类型Type说明Description
temperatureDoubletemperature(类型 `Double`)。The temperature.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:231–233

getTopP

public Double getTopP()

获取 getTopP。

Returns the top p.

返回Returns Double
返回数值结果。Returns a numeric result.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:235–237

setTopP

public void setTopP(Double topP)

设置 setTopP。

Sets the top p.

参数Parameters
名称Name类型Type说明Description
topPDoubletop P(类型 `Double`)。The top p.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:239–241

getMaxTokens

public Integer getMaxTokens()

获取最大令牌数。

Returns the max tokens.

返回Returns Integer
返回数值结果。Returns a numeric result.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:243–245

setMaxTokens

public void setMaxTokens(Integer maxTokens)

设置最大令牌数。

Sets the max tokens.

参数Parameters
名称Name类型Type说明Description
maxTokensInteger最大令牌数(类型 `Integer`)。The max tokens.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:247–249

getMaxCompletionTokens

public Integer getMaxCompletionTokens()

获取最大补全令牌数。

Returns the max completion tokens.

返回Returns Integer
返回数值结果。Returns a numeric result.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:251–253

setMaxCompletionTokens

public void setMaxCompletionTokens(Integer maxCompletionTokens)

设置最大补全令牌数。

Sets the max completion tokens.

参数Parameters
名称Name类型Type说明Description
maxCompletionTokensInteger最大补全令牌数(类型 `Integer`)。The max completion tokens.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:255–257

getFrequencyPenalty

public Double getFrequencyPenalty()

获取 getFrequencyPenalty。

Returns the frequency penalty.

返回Returns Double
返回数值结果。Returns a numeric result.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:259–261

setFrequencyPenalty

public void setFrequencyPenalty(Double frequencyPenalty)

设置 setFrequencyPenalty。

Sets the frequency penalty.

参数Parameters
名称Name类型Type说明Description
frequencyPenaltyDoublefrequency Penalty(类型 `Double`)。The frequency penalty.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:263–265

getPresencePenalty

public Double getPresencePenalty()

获取 getPresencePenalty。

Returns the presence penalty.

返回Returns Double
返回数值结果。Returns a numeric result.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:267–269

setPresencePenalty

public void setPresencePenalty(Double presencePenalty)

设置 setPresencePenalty。

Sets the presence penalty.

参数Parameters
名称Name类型Type说明Description
presencePenaltyDouble在线状态 Penalty(类型 `Double`)。The presence penalty.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:271–273

getStop

public Object getStop()

获取停止。

Returns the stop.

返回Returns Object
返回对象。Returns object.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:275–277

setStop

public void setStop(Object stop)

设置停止。

Sets the stop.

参数Parameters
名称Name类型Type说明Description
stopObject停止(类型 `Object`)。The stop.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:279–281

getSeed

public Integer getSeed()

获取预置。

Returns the seed.

返回Returns Integer
返回数值结果。Returns a numeric result.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:283–285

setSeed

public void setSeed(Integer seed)

设置预置。

Sets the seed.

参数Parameters
名称Name类型Type说明Description
seedInteger预置(类型 `Integer`)。The seed.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:287–289

getN

public Integer getN()

获取N。

Returns the n.

返回Returns Integer
返回数值结果。Returns a numeric result.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:291–293

setN

public void setN(Integer n)

设置N。

Sets the n.

参数Parameters
名称Name类型Type说明Description
nIntegern(类型 `Integer`)。The n.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:295–297

getTools

public List<OpenAITool> getTools()

获取工具。

Returns the tools.

返回Returns List<OpenAITool>
返回列出。Returns list.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:299–301

setTools

public void setTools(List<OpenAITool> tools)

设置工具。

Sets the tools.

参数Parameters
名称Name类型Type说明Description
toolsList<OpenAITool>工具列表(类型 `List`)。The tools.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:303–305

getToolChoice

public Object getToolChoice()

获取工具选项。

Returns the tool choice.

返回Returns Object
返回对象。Returns object.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:307–309

setToolChoice

public void setToolChoice(Object toolChoice)

设置工具选项。

Sets the tool choice.

参数Parameters
名称Name类型Type说明Description
toolChoiceObject工具选项(类型 `Object`)。The tool choice.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:311–313

getUser

public String getUser()

获取用户。

Returns the user.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:315–317

setUser

public void setUser(String user)

设置用户。

Sets the user.

参数Parameters
名称Name类型Type说明Description
userString用户(类型 `String`)。The user.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:319–321

getResponseFormat

public Object getResponseFormat()

获取响应格式。

Returns the response format.

返回Returns Object
返回对象。Returns object.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:323–325

setResponseFormat

public void setResponseFormat(Object responseFormat)

设置响应格式。

Sets the response format.

参数Parameters
名称Name类型Type说明Description
responseFormatObject响应格式(类型 `Object`)。The response format.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:327–329

getLogprobs

public Boolean getLogprobs()

获取 getLogprobs。

Returns the logprobs.

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

setLogprobs

public void setLogprobs(Boolean logprobs)

设置 setLogprobs。

Sets the logprobs.

参数Parameters
名称Name类型Type说明Description
logprobsBooleanlogprobs(类型 `Boolean`)。The logprobs.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:335–337

getTopLogprobs

public Integer getTopLogprobs()

获取 getTopLogprobs。

Returns the top logprobs.

返回Returns Integer
返回数值结果。Returns a numeric result.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:339–341

setTopLogprobs

public void setTopLogprobs(Integer topLogprobs)

设置 setTopLogprobs。

Sets the top logprobs.

参数Parameters
名称Name类型Type说明Description
topLogprobsIntegertop Logprobs(类型 `Integer`)。The top logprobs.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:343–345

getReasoningEffort

public String getReasoningEffort()

获取 getReasoningEffort。

Returns the reasoning effort.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:347–349

setReasoningEffort

public void setReasoningEffort(String reasoningEffort)

设置 setReasoningEffort。

Sets the reasoning effort.

参数Parameters
名称Name类型Type说明Description
reasoningEffortString推理 Effort(类型 `String`)。The reasoning effort.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:351–353

getThinkingBudget

public Integer getThinkingBudget()

获取 getThinkingBudget。

Returns the thinking budget.

返回Returns Integer
返回数值结果。Returns a numeric result.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:355–357

setThinkingBudget

public void setThinkingBudget(Integer thinkingBudget)

设置 setThinkingBudget。

Sets the thinking budget.

参数Parameters
名称Name类型Type说明Description
thinkingBudgetIntegerthinking 预算(类型 `Integer`)。The thinking budget.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:359–361

getParallelToolCalls

public Boolean getParallelToolCalls()

获取 getParallelToolCalls。

Returns the parallel tool calls.

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

setParallelToolCalls

public void setParallelToolCalls(Boolean parallelToolCalls)

设置 setParallelToolCalls。

Sets the parallel tool calls.

参数Parameters
名称Name类型Type说明Description
parallelToolCallsBooleanparallel 工具调用(类型 `Boolean`)。The parallel tool calls.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:367–369

getServiceTier

public String getServiceTier()

获取 getServiceTier。

Returns the service tier.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:371–373

setServiceTier

public void setServiceTier(String serviceTier)

设置 setServiceTier。

Sets the service tier.

参数Parameters
名称Name类型Type说明Description
serviceTierString服务 Tier(类型 `String`)。The service tier.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:375–377

getStore

public Boolean getStore()

获取存储。

Returns the store.

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

setStore

public void setStore(Boolean store)

设置存储。

Sets the store.

参数Parameters
名称Name类型Type说明Description
storeBoolean存储实例(类型 `Boolean`)。The store.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:383–385

getMetadata

public Map<String, Object> getMetadata()

获取元数据。

Returns the metadata.

返回Returns Map<String, Object>
返回映射。Returns map.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:387–389

setMetadata

public void setMetadata(Map<String, Object> metadata)

设置元数据。

Sets the metadata.

参数Parameters
名称Name类型Type说明Description
metadataMap<String, Object>元数据(类型 `Map`)。The metadata.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:391–393

getPrediction

public Map<String, Object> getPrediction()

获取 getPrediction。

Returns the prediction.

返回Returns Map<String, Object>
返回映射。Returns map.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:395–397

setPrediction

public void setPrediction(Map<String, Object> prediction)

设置 setPrediction。

Sets the prediction.

参数Parameters
名称Name类型Type说明Description
predictionMap<String, Object>prediction(类型 `Map`)。The prediction.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:399–401

getModalities

public List<String> getModalities()

获取 getModalities。

Returns the modalities.

返回Returns List<String>
返回列出。Returns list.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:403–405

setModalities

public void setModalities(List<String> modalities)

设置 setModalities。

Sets the modalities.

参数Parameters
名称Name类型Type说明Description
modalitiesList<String>modalities(类型 `List`)。The modalities.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:407–409

getAudio

public Map<String, Object> getAudio()

获取音频。

Returns the audio.

返回Returns Map<String, Object>
返回映射。Returns map.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:411–413

setAudio

public void setAudio(Map<String, Object> audio)

设置音频。

Sets the audio.

参数Parameters
名称Name类型Type说明Description
audioMap<String, Object>音频(类型 `Map`)。The audio.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:415–417

getIncludeReasoning

public Boolean getIncludeReasoning()

获取 getIncludeReasoning。

Returns the include reasoning.

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

setIncludeReasoning

public void setIncludeReasoning(Boolean includeReasoning)

设置 setIncludeReasoning。

Sets the include reasoning.

参数Parameters
名称Name类型Type说明Description
includeReasoningBooleaninclude 推理(类型 `Boolean`)。The include reasoning.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:423–425

getExtraParams

public Map<String, Object> getExtraParams()

获取 getExtraParams。

Returns the extra params.

返回Returns Map<String, Object>
返回映射。Returns map.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:427–430

addExtraParam

public void addExtraParam(String key, Object value)

添加 addExtraParam。

Adds the extra param.

参数Parameters
名称Name类型Type说明Description
keyString键(类型 `String`)。The key.
valueObject值(类型 `Object`)。The value.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:432–438

setExtraParams

public void setExtraParams(Map<String, Object> extraParams)

设置 setExtraParams。

Sets the extra params.

参数Parameters
名称Name类型Type说明Description
extraParamsMap<String, Object>extra 参数(类型 `Map`)。The extra params.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:440–442

builder

public static Builder builder()
static

返回构建器实例。

Returns the builder.

返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/extensions/model/openai/dto/OpenAIRequest.java:444–446

嵌套类详情Nested Class Detail

Builder

public static class Builder

构建器,用于构建并配置目标实例。位于 io.agentscope.extensions.model.openai.dto 包。核心成员包括 model、messages、stream、streamOptions、temperature、topP。

A class in io.agentscope.extensions.model.openai.dto that talks to model services and returns generated or embedded output. Declared in io.agentscope.extensions.model.openai.dto.

基于官方固定版本源码静态生成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.