Vertex AI V1 API - Module Google::Cloud::AIPlatform::V1::Candidate::FinishReason (v0.39.0)

Version latest

• 0.39.0 (latest)
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 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.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API module Google::Cloud::AIPlatform::V1::Candidate::FinishReason.

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

Constants

FINISH_REASON_UNSPECIFIED

value: 0
The finish reason is unspecified.

STOP

value: 1
Natural stop point of the model or provided stop sequence.

MAX_TOKENS

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

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.

RECITATION

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

OTHER

value: 5
All other reasons that stopped the token generation

BLOCKLIST

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

PROHIBITED_CONTENT

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

SPII

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