# Guide


```
@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD])
annotation Guide
```

<br />

*** ** * ** ***

Annotates a field to provide a additional information when generating the field.

This is an experimental feature.

## Summary

| ### Public constructors |
|---|
| `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/schema/annotations/Guide#Guide(kotlin.String,kotlin.Int,kotlin.Int,kotlin.Double,kotlin.Double,kotlin.Array)( description: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html, maxItems: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html, minItems: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html, maximum: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html, minimum: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html, enumValues: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html> )` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/schema/annotations/Guide#description()` Description of the field. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html>` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/schema/annotations/Guide#enumValues()` If the field is a String, this is the list of possible values for the field. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/schema/annotations/Guide#maxItems()` If the field is a list, this is the maximum number of items to generate for a list. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/schema/annotations/Guide#maximum()` If the field is a Int, Long, Float, or Double, this is the maximum value of the field. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/schema/annotations/Guide#minItems()` If the field is a list, this is the minimum number of items to generate for a list. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html` | `https://developers.google.com/android/reference/kotlin/com/google/mlkit/genai/schema/annotations/Guide#minimum()` If the field is a Int, Long, Float, or Double, this is the minimum value of the field. |

## Public constructors

### Guide

```
Guide(
    description: String = "",
    maxItems: Int = -1,
    minItems: Int = -1,
    maximum: Double = Double.NaN,
    minimum: Double = Double.NaN,
    enumValues: Array<String> = []
)
```

## Public properties

### description

```
val description: String
```

Description of the field.

### enumValues

```
val enumValues: Array<String>
```

If the field is a String, this is the list of possible values for the field.

### maxItems

```
val maxItems: Int
```

If the field is a list, this is the maximum number of items to generate for a list. This must be greater than or equal to 0. A negative value will be ignored.

### maximum

```
val maximum: Double
```

If the field is a Int, Long, Float, or Double, this is the maximum value of the field.

### minItems

```
val minItems: Int
```

If the field is a list, this is the minimum number of items to generate for a list. This must be greater than or equal to 0. A negative value will be ignored.

### minimum

```
val minimum: Double
```

If the field is a Int, Long, Float, or Double, this is the minimum value of the field.