Enum google_api_proto::google::cloud::aiplatform::v1::candidate::FinishReason

#[repr(i32)]
pub enum FinishReason {
    Unspecified = 0,
    Stop = 1,
    MaxTokens = 2,
    Safety = 3,
    Recitation = 4,
    Other = 5,
    Blocklist = 6,
    ProhibitedContent = 7,
    Spii = 8,
    MalformedFunctionCall = 9,
}

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

Variants

Unspecified = 0

The finish reason is unspecified.

Stop = 1

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

MaxTokens = 2

Token generation reached the configured maximum output tokens.

Safety = 3

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

Recitation = 4

Token generation stopped because the content potentially contains copyright violations.

Other = 5

All other reasons that stopped the token generation.

Blocklist = 6

Token generation stopped because the content contains forbidden terms.

ProhibitedContent = 7

Token generation stopped for potentially containing prohibited content.

Spii = 8

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

MalformedFunctionCall = 9

The function call generated by the model is invalid.

Implementations

impl FinishReason

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of FinishReason.

pub fn from_i32(value: i32) -> Option<FinishReason>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a FinishReason, or None if value is not a valid variant.

impl FinishReason

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for FinishReason

fn clone(&self) -> FinishReason

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FinishReason

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FinishReason

fn default() -> FinishReason

Returns the “default value” for a type.

impl From<FinishReason> for i32

fn from(value: FinishReason) -> i32

Converts to this type from the input type.

impl Hash for FinishReason

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FinishReason

fn cmp(&self, other: &FinishReason) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for FinishReason

fn eq(&self, other: &FinishReason) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FinishReason

fn partial_cmp(&self, other: &FinishReason) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for FinishReason

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<FinishReason, UnknownEnumValue>

Performs the conversion.

impl Copy for FinishReason

impl Eq for FinishReason

impl StructuralPartialEq for FinishReason