Vertex AI v1beta1 API - Enum Candidate.Types.FinishReason (1.0.0-beta43) 

public enum Candidate.Types.FinishReason

Reference documentation and code samples for the Vertex AI v1beta1 API enum Candidate.Types.FinishReason.

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

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Fields

Name Description
Blocklist

Token generation stopped because the content contains forbidden terms.
MalformedFunctionCall

The function call generated by the model is invalid.
MaxTokens

Token generation reached the configured maximum output tokens.
ModelArmor

The model response was blocked by Model Armor.
Other

All other reasons that stopped the token generation.
ProhibitedContent

Token generation stopped for potentially containing prohibited content.
Recitation

Token generation stopped because the content potentially contains copyright violations.
Safety

Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, [content][google.cloud.aiplatform.v1beta1.Candidate.content] is empty if content filters blocks the output.
Spii

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

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

The finish reason is unspecified.