Google Cloud Ai Platform V1 Client - Class FinishReason (1.31.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

  Value: 0 
 

The finish reason is unspecified.

Generated from protobuf enum FINISH_REASON_UNSPECIFIED = 0;

  Value: 1 
 

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

Generated from protobuf enum STOP = 1;

  Value: 2 
 

Token generation reached the configured maximum output tokens.

Generated from protobuf enum MAX_TOKENS = 2;

  Value: 3 
 

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

Generated from protobuf enum SAFETY = 3;

  Value: 4 
 

Token generation stopped because the content potentially contains copyright violations.

Generated from protobuf enum RECITATION = 4;

  Value: 5 
 

All other reasons that stopped the token generation.

Generated from protobuf enum OTHER = 5;

  Value: 6 
 

Token generation stopped because the content contains forbidden terms.

Generated from protobuf enum BLOCKLIST = 6;

  Value: 7 
 

Token generation stopped for potentially containing prohibited content.

Generated from protobuf enum PROHIBITED_CONTENT = 7;

  Value: 8 
 

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

Generated from protobuf enum SPII = 8;

  Value: 9 
 

The function call generated by the model is invalid.

Generated from protobuf enum MALFORMED_FUNCTION_CALL = 9;