Google Cloud Ai Platform V1 Client - Class FinishReason (0.38.0)

Version 0.38.0

• 1.12.0 (latest)
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class FinishReason.

The reason why the model stopped generating tokens.

If empty, the model has not stopped generating the tokens.

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

Namespace

Google \ Cloud \ AIPlatform \ V1 \ Candidate

Methods

static::name

Parameter
Name	Description
value	mixed

static::value

Parameter
Name	Description
name	mixed

Constants

FINISH_REASON_UNSPECIFIED

Value: 0

The finish reason is unspecified.

Generated from protobuf enum FINISH_REASON_UNSPECIFIED = 0;

STOP

Value: 1

Natural stop point of the model or provided stop sequence.

Generated from protobuf enum STOP = 1;

MAX_TOKENS

Value: 2

The maximum number of tokens as specified in the request was reached.

Generated from protobuf enum MAX_TOKENS = 2;

SAFETY

Value: 3

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.

Generated from protobuf enum SAFETY = 3;

RECITATION

Value: 4

The token generation was stopped as the response was flagged for unauthorized citations.

Generated from protobuf enum RECITATION = 4;

OTHER

Value: 5

All other reasons that stopped the token generation

Generated from protobuf enum OTHER = 5;

BLOCKLIST

Value: 6

The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.

Generated from protobuf enum BLOCKLIST = 6;

PROHIBITED_CONTENT

Value: 7

The token generation was stopped as the response was flagged for the prohibited contents.

Generated from protobuf enum PROHIBITED_CONTENT = 7;

SPII

Value: 8

The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents.

Generated from protobuf enum SPII = 8;