openai-core/com.aallam.openai.api.chat/ChatCompletionFunction

ChatCompletionFunction

@Serializable

data class ChatCompletionFunction(val name: String, val description: String? = null, val parameters: Parameters)

Constructors

ChatCompletionFunction

constructor(name: String, description: String? = null, parameters: Parameters)

Properties

@SerialName(value = "description")

val description: String? = null

The description of what the function does.

@SerialName(value = "name")

val name: String

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

@SerialName(value = "parameters")

val parameters: Parameters

The parameters the functions accept, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.