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

FunctionTool

@Serializable

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

A description of what the function does, used by the model to choose when and how to call the function.

Constructors

FunctionTool

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

Properties

description

val description: String? = null

A description of what the function does, used by the model to choose when and how to call the function.

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.

parameters

val parameters: Parameters? = null

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.