FinishReason

enum FinishReason : Enum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.firebase.vertexai.type.FinishReason

The reason for content finishing.

Summary

Enum Values
`MAX_TOKENS`	Model hit the token limit.
`OTHER`	Model stopped for another reason.
`RECITATION`	Model began looping.
`SAFETY`	`SafetySetting` prevented the model from outputting content.
`STOP`	Model finished successfully and stopped.
`UNKNOWN`	A new and not yet supported value.
`UNSPECIFIED`	Reason is unspecified.

Public functions
`FinishReason`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.
`Array<FinishReason>`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

MAX_TOKENS

val FinishReason.MAX_TOKENS: FinishReason

Model hit the token limit.

OTHER

val FinishReason.OTHER: FinishReason

Model stopped for another reason.

RECITATION

val FinishReason.RECITATION: FinishReason

Model began looping.

SAFETY

val FinishReason.SAFETY: FinishReason

SafetySetting prevented the model from outputting content.

STOP

val FinishReason.STOP: FinishReason

Model finished successfully and stopped.

UNKNOWN

val FinishReason.UNKNOWN: FinishReason

A new and not yet supported value.

UNSPECIFIED

val FinishReason.UNSPECIFIED: FinishReason

Reason is unspecified.

Public functions

valueOf

fun valueOf(value: String): FinishReason

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
`kotlin.IllegalArgumentException: kotlin.IllegalArgumentException`	if this enum type has no constant with the specified name

values

fun values(): Array<FinishReason>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.