google-genai-kotlin/com.google.genai.kotlin/Describe

Describe

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.CLASS])

annotation class Describe(val value: String)

Describes a function parameter to the model, so it knows what to pass.

Put it on a property to describe that parameter, or on a class to describe the object it stands for.

@Serializable
data class PlanTripArgs(
  @Describe("Departure city.") val origin: String,
  @Describe("Number of nights to stay.") val nights: Int = 2,
)

To describe the function itself, pass a description when you build the CallableFunction.

Properties

value

val value: String