Enum Candidate.FinishReason (3.47.0)

Version 3.47.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public enum Candidate.FinishReason extends Enum<Candidate.FinishReason> implements ProtocolMessageEnum

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

Protobuf enum google.cloud.aiplatform.v1.Candidate.FinishReason

Implements

ProtocolMessageEnum

Inherited Members

Enum.<T>valueOf(Class<T>,String)

Enum.clone()

Enum.compareTo(E)

Enum.equals(Object)

Enum.finalize()

Enum.getDeclaringClass()

Enum.hashCode()

Enum.name()

Enum.ordinal()

Enum.toString()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields
Name	Description
BLOCKLIST	The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist. BLOCKLIST = 6;
BLOCKLIST_VALUE	The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist. BLOCKLIST = 6;
FINISH_REASON_UNSPECIFIED	The finish reason is unspecified. FINISH_REASON_UNSPECIFIED = 0;
FINISH_REASON_UNSPECIFIED_VALUE	The finish reason is unspecified. FINISH_REASON_UNSPECIFIED = 0;
MALFORMED_FUNCTION_CALL	The function call generated by the model is invalid. MALFORMED_FUNCTION_CALL = 9;
MALFORMED_FUNCTION_CALL_VALUE	The function call generated by the model is invalid. MALFORMED_FUNCTION_CALL = 9;
MAX_TOKENS	The maximum number of tokens as specified in the request was reached. MAX_TOKENS = 2;
MAX_TOKENS_VALUE	The maximum number of tokens as specified in the request was reached. MAX_TOKENS = 2;
OTHER	All other reasons that stopped the token generation OTHER = 5;
OTHER_VALUE	All other reasons that stopped the token generation OTHER = 5;
PROHIBITED_CONTENT	The token generation was stopped as the response was flagged for the prohibited contents. PROHIBITED_CONTENT = 7;
PROHIBITED_CONTENT_VALUE	The token generation was stopped as the response was flagged for the prohibited contents. PROHIBITED_CONTENT = 7;
RECITATION	The token generation was stopped as the response was flagged for unauthorized citations. RECITATION = 4;
RECITATION_VALUE	The token generation was stopped as the response was flagged for unauthorized citations. RECITATION = 4;
SAFETY	The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output. SAFETY = 3;
SAFETY_VALUE	The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output. SAFETY = 3;
SPII	The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents. SPII = 8;
SPII_VALUE	The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents. SPII = 8;
STOP	Natural stop point of the model or provided stop sequence. STOP = 1;
STOP_VALUE	Natural stop point of the model or provided stop sequence. STOP = 1;
UNRECOGNIZED

Static Methods
Name	Description
forNumber(int value)
getDescriptor()
internalGetValueMap()
valueOf(Descriptors.EnumValueDescriptor desc)
valueOf(int value)	Deprecated. Use #forNumber(int) instead.
valueOf(String name)
values()

Methods
Name	Description
getDescriptorForType()
getNumber()
getValueDescriptor()