Candidate_FinishReason class final

Defines the reason why the model stopped generating 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
Default value. This value is unused.
imageOther → const Candidate_FinishReason
Image generation stopped because of other miscellaneous issue.
imageProhibitedContent → const Candidate_FinishReason
Image generation stopped because generated images has other prohibited content.
imageRecitation → const Candidate_FinishReason
Image generation stopped due to recitation.
imageSafety → const Candidate_FinishReason
Token generation stopped because generated images contain safety violations.
language → const Candidate_FinishReason
The response candidate content was flagged for using an unsupported language.
malformedFunctionCall → const Candidate_FinishReason
The function call generated by the model is invalid.
maxTokens → const Candidate_FinishReason
The maximum number of tokens as specified in the request was reached.
noImage → const Candidate_FinishReason
The model was expected to generate an image, but none was generated.
other → const Candidate_FinishReason
Unknown reason.
prohibitedContent → const Candidate_FinishReason
Token generation stopped for potentially containing prohibited content.
recitation → const Candidate_FinishReason
The response candidate content was flagged for recitation reasons.
safety → const Candidate_FinishReason
The response candidate content was flagged for safety reasons.
spii → const Candidate_FinishReason
Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).
stop → const Candidate_FinishReason
Natural stop point of the model or provided stop sequence.
tooManyToolCalls → const Candidate_FinishReason
Model called too many tools consecutively, thus the system exited execution.
unexpectedToolCall → const Candidate_FinishReason
Model generated a tool call but no tools were enabled in the request.