FinishReason

public final class FinishReason

Represents the reason why the model stopped generating content.

Summary

Nested types
`public static class FinishReason.Companion`

Public fields
`final @NonNull FinishReason`	`BLOCKLIST` Token generation stopped because the content contains forbidden terms.
`final @NonNull FinishReason`	`MALFORMED_FUNCTION_CALL` The function call generated by the model is invalid.
`final @NonNull FinishReason`	`MAX_TOKENS` Model hit the token limit.
`final @NonNull FinishReason`	`OTHER` Model stopped for another reason.
`final @NonNull FinishReason`	`PROHIBITED_CONTENT` Token generation stopped for potentially containing prohibited content.
`final @NonNull FinishReason`	`RECITATION` The token generation was stopped because the response was flagged for unauthorized citations.
`final @NonNull FinishReason`	`SAFETY` `SafetySetting` prevented the model from outputting content.
`final @NonNull FinishReason`	`SPII` Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).
`final @NonNull FinishReason`	`STOP` Model finished successfully and stopped.
`final @NonNull FinishReason`	`UNKNOWN` A new and not yet supported value.
`final @NonNull String`	`name` The name of the finish reason.
`final int`	`ordinal` The ordinal value of the finish reason.

public final @NonNull FinishReason BLOCKLIST

Token generation stopped because the content contains forbidden terms.

public final @NonNull FinishReason MALFORMED_FUNCTION_CALL

The function call generated by the model is invalid.

public final @NonNull FinishReason MAX_TOKENS

Model hit the token limit.

public final @NonNull FinishReason OTHER

Model stopped for another reason.

public final @NonNull FinishReason PROHIBITED_CONTENT

Token generation stopped for potentially containing prohibited content.

public final @NonNull FinishReason RECITATION

The token generation was stopped because the response was flagged for unauthorized citations.

public final @NonNull FinishReason SAFETY

SafetySetting prevented the model from outputting content.

public final @NonNull FinishReason SPII

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

public final @NonNull FinishReason STOP

Model finished successfully and stopped.

public final @NonNull FinishReason UNKNOWN

A new and not yet supported value.

public final @NonNull String name

The name of the finish reason.

public final int ordinal

The ordinal value of the finish reason.