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

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;

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()