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

OpenAIToolFunction

@JsonInclude(JsonInclude.Include.NON_NULL) public class OpenAIToolFunction

源码Source io/agentscope/extensions/model/openai/dto/OpenAIToolFunction.java:42–128

OpenAI 工具函数，与模型服务通信并返回生成或向量化结果。位于 io.agentscope.extensions.model.openai.dto 包。核心成员包括 getName、setName、getDescription、setDescription、getParameters、setParameters。

OpenAI tool function definition DTO.

This class represents the function definition in a tool.

Example:

`{
"name": "get_weather",
"description": "Get the current weather",
"parameters": {
"type": "object",
"properties": {
"location": {"type": "string"}
},
"required": ["location"]
}
}
`

嵌套类摘要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` `OpenAIToolFunction()`	初始化 `OpenAIToolFunction` 实例。 Creates a new instance.

方法摘要Method Summary

方法Method	说明Description
`public String getName()`	获取名称。 Returns the name.
`public void setName(String name)`	设置名称。 Sets the name.
`public String getDescription()`	获取 `getDescription`。 Returns the description.
`public void setDescription(String description)`	设置 `setDescription`。 Sets the description.
`public Map<String, Object> getParameters()`	获取参数。 Returns the parameters.
`public void setParameters(Map<String, Object> parameters)`	设置参数。 Sets the parameters.
`public Boolean getStrict()`	获取 `getStrict`。 Returns the strict.
`public void setStrict(Boolean strict)`	设置 `setStrict`。 Sets the strict.
`public static Builder builder()` static	返回构建器实例。 Returns the builder.

构造器详情Constructor Detail

OpenAIToolFunction

public OpenAIToolFunction()

初始化 OpenAIToolFunction 实例。

Creates a new instance.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIToolFunction.java:61

方法详情Method Detail

getName

public String getName()

获取名称。

Returns the name.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIToolFunction.java:63–65

setName

public void setName(String name)

设置名称。

Sets the name.

参数Parameters

名称Name	类型Type	说明Description
`name`	String	名称（类型 `String`）。The name.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIToolFunction.java:67–69

getDescription

public String getDescription()

获取 getDescription。

Returns the description.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIToolFunction.java:71–73

setDescription

public void setDescription(String description)

设置 setDescription。

Sets the description.

参数Parameters

名称Name	类型Type	说明Description
`description`	String	描述（类型 `String`）。The description.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIToolFunction.java:75–77

getParameters

public Map<String, Object> getParameters()

获取参数。

Returns the parameters.

返回Returns Map<String, Object>

返回映射。Returns map.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIToolFunction.java:79–81

setParameters

public void setParameters(Map<String, Object> parameters)

设置参数。

Sets the parameters.

参数Parameters

名称Name	类型Type	说明Description
`parameters`	Map<String, Object>	参数（类型 `Map`）。The parameters.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIToolFunction.java:83–85

getStrict

public Boolean getStrict()

获取 getStrict。

Returns the strict.

返回Returns Boolean

返回布尔值，表示判断结果。Returns a boolean result.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIToolFunction.java:87–89

setStrict

public void setStrict(Boolean strict)

设置 setStrict。

Sets the strict.

参数Parameters

名称Name	类型Type	说明Description
`strict`	Boolean	strict（类型 `Boolean`）。The strict.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIToolFunction.java:91–93

builder

public static Builder builder()

static

返回构建器实例。

Returns the builder.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/extensions/model/openai/dto/OpenAIToolFunction.java:95–97

嵌套类详情Nested Class Detail

Builder

public static class Builder

构建器，用于构建并配置目标实例。位于 io.agentscope.extensions.model.openai.dto 包。核心成员包括 name、description、parameters、strict、build。

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.