TypedCandidate.TypedFinishReason

Kotlin |Java

@IntDef(value = [0, 1, -100])
annotation TypedCandidate.TypedFinishReason

The reason why this TypedCandidate is returned. Note: values from this class is populated from Candidate.FinishReason. Any updates to the Candidate.FinishReason should be reflected in this class as well.

Summary

Constants
`const Int`	`MAX_TOKENS` The maximum number of output tokens as specified in the request was reached.
`const Int`	`OTHER` All other reasons that stopped the generation.
`const Int`	`STOP` Natural stop point of the model.

Public constructors
`TypedFinishReason()`

const val MAX_TOKENS: Int

The maximum number of output tokens as specified in the request was reached.

const val OTHER: Int

All other reasons that stopped the generation.

const val STOP: Int

Natural stop point of the model.

TypedFinishReason()

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-07-15 UTC.