ChatGPT-Java-API/com.cjcrafter.openai.chat.tool/FunctionParameters

FunctionParameters

data class FunctionParameters

Represents the parameters of the function. You can think of this like a method signature, where each property is a parameter to a method.

This class should not be used directly. Instead, use the FunctionTool.builder to add parameters.

Functions

operator fun get(name: String): FunctionProperty?

fun require(name: String)

Require that the given parameter is used by ChatGPT.

operator fun set(name: String, property: FunctionProperty)

Properties

var properties: MutableMap<String, FunctionProperty>

The map of method parameters.

var required: MutableSet<String>

var type: String

The type of the parameters. This should always be "object".