enum
ACP::Protocol::StopReason
Defined in:
acp/protocol/enums.crEnum Members
-
EndTurn =
0 -
The language model finishes responding without requesting more tools.
-
MaxTokens =
1 -
The maximum token limit is reached.
-
MaxTurnRequests =
2 -
The maximum number of model requests in a single turn is exceeded.
-
Refusal =
3 -
The Agent refuses to continue. The user prompt and everything that comes after it won't be included in the next prompt.
-
Cancelled =
4 -
The Client cancels the turn via
session/cancel.
Constructors
- .new(pull : JSON::PullParser) : self
-
.parse(value : String) : StopReason
Parses a wire-format string into a StopReason.
Class Method Summary
-
.parse?(value : String) : StopReason | Nil
Parses a wire-format string into a StopReason.
Instance Method Summary
-
#cancelled?
Returns
trueif this enum value equalsCancelled -
#end_turn?
Returns
trueif this enum value equalsEndTurn -
#max_tokens?
Returns
trueif this enum value equalsMaxTokens -
#max_turn_requests?
Returns
trueif this enum value equalsMaxTurnRequests -
#refusal?
Returns
trueif this enum value equalsRefusal -
#to_json(json : JSON::Builder) : Nil
Serializes this enum member by name.
-
#to_s : String
Returns the wire-format string for this stop reason.
Constructor Detail
Parses a wire-format string into a StopReason. Raises ArgumentError if the string is not recognized.
Class Method Detail
Parses a wire-format string into a StopReason. Returns nil if the string is not a recognized stop reason.
Instance Method Detail
Serializes this enum member by name.
For non-flags enums, the serialization is a JSON string. The value is the
member name (see #to_s) transformed with String#underscore.
enum Stages
INITIAL
SECOND_STAGE
end
Stages::INITIAL.to_json # => %("initial")
Stages::SECOND_STAGE.to_json # => %("second_stage")
For flags enums, the serialization is a JSON array including every flagged
member individually serialized in the same way as a member of a non-flags enum.
None is serialized as an empty array, All as an array containing
all members.
@[Flags]
enum Sides
LEFT
RIGHT
end
Sides::LEFT.to_json # => %(["left"])
(Sides::LEFT | Sides::RIGHT).to_json # => %(["left","right"])
Sides::All.to_json # => %(["left","right"])
Sides::None.to_json # => %([])
ValueConverter.to_json offers a different serialization strategy based on the
member value.