stopReason property

String? get stopReason

The reason why sampling stopped, if known.

Standard values:

• "endTurn": Natural end of the assistant's turn
• "stopSequence": A stop sequence was encountered
• "maxTokens": Maximum token limit was reached
• "toolUse": The model wants to use one or more tools

This field is an open string to allow for provider-specific stop reasons.

Implementation

String? get stopReason => $optional('stopReason', $string);