# Guide


```
@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD])
public 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/com/google/mlkit/genai/schema/annotations/Guide#Guide(kotlin.String,kotlin.Int,kotlin.Int,kotlin.Double,kotlin.Double,kotlin.Array)( @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/String.html description, int maxItems, int minItems, double maximum, double minimum, @https://developer.android.com/reference/androidx/annotation/NonNull.html String[] enumValues )` |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/annotations/Guide#getDescription()()` Description of the field. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull.html String[]` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/annotations/Guide#getEnumValues()()` If the field is a String, this is the list of possible values for the field. |
| `final int` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/annotations/Guide#getMaxItems()()` If the field is a list, this is the maximum number of items to generate for a list. |
| `final double` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/annotations/Guide#getMaximum()()` If the field is a Int, Long, Float, or Double, this is the maximum value of the field. |
| `final int` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/annotations/Guide#getMinItems()()` If the field is a list, this is the minimum number of items to generate for a list. |
| `final double` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/annotations/Guide#getMinimum()()` If the field is a Int, Long, Float, or Double, this is the minimum value of the field. |

## Public constructors

### Guide

```
public Guide(
    @NonNull String description,
    int maxItems,
    int minItems,
    double maximum,
    double minimum,
    @NonNull String[] enumValues
)
```

## Public methods

### getDescription

```
public final @NonNull String getDescription()
```

Description of the field.

### getEnumValues

```
public final @NonNull String[] getEnumValues()
```

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

### getMaxItems

```
public final int getMaxItems()
```

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.

### getMaximum

```
public final double getMaximum()
```

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

### getMinItems

```
public final int getMinItems()
```

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.

### getMinimum

```
public final double getMinimum()
```

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