ChatGPT-Java-API/com.cjcrafter.openai.chat.tool/Function/Builder

Builder

class Builder

Functions

Link copied to clipboard
@JvmOverloads
fun addBooleanParameter(name: String, description: String?, required: Boolean = false): Function.Builder

Boolean parameters are parameters that can be either true or false.

Link copied to clipboard
@JvmOverloads
fun addEnumParameter(name: String, enum: MutableList<String>, required: Boolean = false): Function.Builder

Enum parameters are parameters that can only be one of a few values. ChatGPT will be forces to select one of the values you provide here.

Link copied to clipboard
@JvmOverloads
fun addIntegerParameter(name: String, description: String?, required: Boolean = false): Function.Builder

Integer parameters are parameters that can be any integer.

Link copied to clipboard
@JvmOverloads
fun addNumberParameter(name: String, description: String?, required: Boolean = false): Function.Builder

Number parameters are parameters that can be any number (Usually a floating point number).

Link copied to clipboard
@ApiStatus.Experimental
@JvmOverloads
fun addParameter(name: String, type: String, description: String?, required: Boolean = false): Function.Builder

For any other type of parameter, use this method. In general, there is no strict list of types for you to choose from. Instead, ChatGPT will read the string and interpret what the type should be.

Link copied to clipboard
@JvmOverloads
fun addStringParameter(name: String, description: String?, required: Boolean = false): Function.Builder

String parameters are parameters that can be any string.

Link copied to clipboard
Link copied to clipboard
fun description(description: String?): Function.Builder
Link copied to clipboard
Link copied to clipboard
fun noParameters(): Function.Builder

Makes this function take no parameters.

Link copied to clipboard