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

FunctionCall

@Serializable

data class FunctionCall(val nameOrNull: String? = null, val argumentsOrNull: String? = null)

Represents a function invocation with its name and serialized arguments as generated by the model.

In scenarios such as a streaming variant of the chat API, both nameOrNull and argumentsOrNull can be null.

Constructors

FunctionCall

constructor(nameOrNull: String? = null, argumentsOrNull: String? = null)

Properties

arguments

val arguments: String

The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.

argumentsOrNull

@SerialName(value = "arguments")

val argumentsOrNull: String? = null

name

val name: String

The name of the function to call.

nameOrNull

@SerialName(value = "name")

val nameOrNull: String? = null

The name of the function to call.

Functions

argumentsAsJson

fun argumentsAsJson(json: Json = Json): JsonObject

Decodes the arguments JSON string into a JsonObject. If arguments is null, the function will return null.

argumentsAsJsonOrNull

fun argumentsAsJsonOrNull(json: Json = Json): JsonObject?

Decodes the arguments JSON string into a JsonObject. If arguments is null, the function will return null.