firebase-ai/com.google.firebase.ai.annotations/Guide

Guide

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class Guide(val description: String = "", val minimum: Double = -1.0, val maximum: Double = -1.0, val minItems: Int = -1, val maxItems: Int = -1, val format: String = "", val enumValues: Array<String> = [])(source)

This annotation is used with the firebase-ai-ksp-processor plugin to provide extra information on generated classes and fields.

Properties

description

val description: String

a description of the field

enumValues

val enumValues: Array<String>

format

val format: String

the format that a field must conform to

maximum

val maximum: Double

the maximum value (inclusive) which the numeric field may contain

maxItems

val maxItems: Int

the maximum number of items in a list

minimum

val minimum: Double

the minimum value (inclusive) which the numeric field may contain

minItems

val minItems: Int

the minimum number of items in a list