Enum Candidate.FinishReason (3.54.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.v1beta1.Candidate.FinishReason

Implements

ProtocolMessageEnum

Static Fields

Name Description
BLOCKLIST

Token generation stopped because the content contains forbidden terms.

BLOCKLIST = 6;

BLOCKLIST_VALUE

Token generation stopped because the content contains forbidden terms.

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

Token generation reached the configured maximum output tokens.

MAX_TOKENS = 2;

MAX_TOKENS_VALUE

Token generation reached the configured maximum output tokens.

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

Token generation stopped for potentially containing prohibited content.

PROHIBITED_CONTENT = 7;

PROHIBITED_CONTENT_VALUE

Token generation stopped for potentially containing prohibited content.

PROHIBITED_CONTENT = 7;

RECITATION

Token generation stopped because the content potentially contains copyright violations.

RECITATION = 4;

RECITATION_VALUE

Token generation stopped because the content potentially contains copyright violations.

RECITATION = 4;

SAFETY

Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.

SAFETY = 3;

SAFETY_VALUE

Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.

SAFETY = 3;

SPII

Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).

SPII = 8;

SPII_VALUE

Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).

SPII = 8;

STOP

Token generation reached a natural stopping point or a configured stop sequence.

STOP = 1;

STOP_VALUE

Token generation reached a natural stopping point or a configured 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()