IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

FinishReason

class FinishReason

Represents the reason why the model stopped generating content.

Summary

Public companion properties
`FinishReason`	`BLOCKLIST` Token generation stopped because the content contains forbidden terms.
`FinishReason`	`IMAGE_OTHER` Image generation stopped because of other miscellaneous issue.
`FinishReason`	`IMAGE_PROHIBITED_CONTENT` Image generation stopped because generated images have other prohibited content.
`FinishReason`	`IMAGE_RECITATION` Image generation stopped due to recitation.
`FinishReason`	`IMAGE_SAFETY` Token generation stopped because generated images contain safety violations.
`FinishReason`	`LANGUAGE` The response candidate content was flagged for using an unsupported language.
`FinishReason`	`MALFORMED_FUNCTION_CALL` The function call generated by the model is invalid.
`FinishReason`	`MALFORMED_RESPONSE` Finished due to malformed response.
`FinishReason`	`MAX_TOKENS` Model hit the token limit.
`FinishReason`	`MISSING_THOUGHT_SIGNATURE` Request has at least one thought signature missing.
`FinishReason`	`NO_IMAGE` The model was expected to generate an image, but none was generated.
`FinishReason`	`OTHER` Model stopped for another reason.
`FinishReason`	`PROHIBITED_CONTENT` Token generation stopped for potentially containing prohibited content.
`FinishReason`	`RECITATION` The token generation was stopped because the response was flagged for unauthorized citations.
`FinishReason`	`SAFETY` `SafetySetting` prevented the model from outputting content.
`FinishReason`	`SPII` Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).
`FinishReason`	`STOP` Model finished successfully and stopped.
`FinishReason`	`TOO_MANY_TOOL_CALLS` Model called too many tools consecutively, thus the system exited execution.
`FinishReason`	`UNEXPECTED_TOOL_CALL` Model generated a tool call but no tools were enabled in the request.
`FinishReason`	`UNKNOWN` A new and not yet supported value.

Public properties
`String`	`name` The name of the finish reason.
`Int`	`ordinal` The ordinal value of the finish reason.

Public companion properties

BLOCKLIST

val BLOCKLIST: FinishReason

Token generation stopped because the content contains forbidden terms.

IMAGE_OTHER

val IMAGE_OTHER: FinishReason

Image generation stopped because of other miscellaneous issue.

IMAGE_PROHIBITED_CONTENT

val IMAGE_PROHIBITED_CONTENT: FinishReason

Image generation stopped because generated images have other prohibited content.

IMAGE_RECITATION

val IMAGE_RECITATION: FinishReason

Image generation stopped due to recitation.

IMAGE_SAFETY

val IMAGE_SAFETY: FinishReason

Token generation stopped because generated images contain safety violations.

LANGUAGE

val LANGUAGE: FinishReason

The response candidate content was flagged for using an unsupported language.

MALFORMED_FUNCTION_CALL

val MALFORMED_FUNCTION_CALL: FinishReason

The function call generated by the model is invalid.

MALFORMED_RESPONSE

val MALFORMED_RESPONSE: FinishReason

Finished due to malformed response.

MAX_TOKENS

val MAX_TOKENS: FinishReason

Model hit the token limit.

MISSING_THOUGHT_SIGNATURE

val MISSING_THOUGHT_SIGNATURE: FinishReason

Request has at least one thought signature missing.

NO_IMAGE

val NO_IMAGE: FinishReason

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

OTHER

val OTHER: FinishReason

Model stopped for another reason.

PROHIBITED_CONTENT

val PROHIBITED_CONTENT: FinishReason

Token generation stopped for potentially containing prohibited content.

RECITATION

val RECITATION: FinishReason

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

SAFETY

val SAFETY: FinishReason

SafetySetting prevented the model from outputting content.

SPII

val SPII: FinishReason

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

STOP

val STOP: FinishReason

Model finished successfully and stopped.

TOO_MANY_TOOL_CALLS

val TOO_MANY_TOOL_CALLS: FinishReason

Model called too many tools consecutively, thus the system exited execution.

UNEXPECTED_TOOL_CALL

val UNEXPECTED_TOOL_CALL: FinishReason

Model generated a tool call but no tools were enabled in the request.

UNKNOWN

val UNKNOWN: FinishReason

A new and not yet supported value.

Public properties

name

val name: String

The name of the finish reason.

ordinal

val ordinal: Int

The ordinal value of the finish reason.