Known

public enum Known

Enum representing the known values for FinishReason.

Entries

Link copied to clipboard

The finish reason is unspecified.

Link copied to clipboard

Token generation reached a natural stopping point or a configured stop sequence.

Link copied to clipboard

Token generation reached the configured maximum output tokens.

Link copied to clipboard

Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, [content][] is empty if content filters blocks the output.

Link copied to clipboard

The token generation stopped because of potential recitation.

Link copied to clipboard

The token generation stopped because of using an unsupported language.

Link copied to clipboard

All other reasons that stopped the token generation.

Link copied to clipboard

Token generation stopped because the content contains forbidden terms.

Link copied to clipboard

Token generation stopped for potentially containing prohibited content.

Link copied to clipboard

Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).

Link copied to clipboard

The function call generated by the model is invalid.

Link copied to clipboard

Token generation stopped because generated images have safety violations.

Link copied to clipboard

The tool call generated by the model is invalid.

Link copied to clipboard

Image generation stopped because the generated images have prohibited content.

Link copied to clipboard

The model was expected to generate an image, but none was generated.

Link copied to clipboard

Image generation stopped because the generated image may be a recitation from a source.

Link copied to clipboard

Image generation stopped for a reason not otherwise specified.

Functions

Link copied to clipboard
public static FinishReason.Known valueOf(String name)

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.)

Link copied to clipboard
public static Array<FinishReason.Known> values()

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.