Candidate_FinishReason class final

The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.

Inheritance
  • Object
  • ProtoEnum
  • Candidate_FinishReason

Constructors

Candidate_FinishReason(String value)
const
Candidate_FinishReason.fromJson(Object? json)
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
isNotDefault → bool
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value → String
finalinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → String
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

$default → const Candidate_FinishReason
The default value for Candidate_FinishReason.
blocklist → const Candidate_FinishReason
Token generation stopped because the content contains forbidden terms.
finishReasonUnspecified → const Candidate_FinishReason
The finish reason is unspecified.
malformedFunctionCall → const Candidate_FinishReason
The function call generated by the model is invalid.
maxTokens → const Candidate_FinishReason
Token generation reached the configured maximum output tokens.
modelArmor → const Candidate_FinishReason
The model response was blocked by Model Armor.
other → const Candidate_FinishReason
All other reasons that stopped the token generation.
prohibitedContent → const Candidate_FinishReason
Token generation stopped for potentially containing prohibited content.
recitation → const Candidate_FinishReason
Token generation stopped because the content potentially contains copyright violations.
safety → const Candidate_FinishReason
Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.
spii → const Candidate_FinishReason
Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).
stop → const Candidate_FinishReason
Token generation reached a natural stopping point or a configured stop sequence.