Enum openai_api::api::FinishReason

#[non_exhaustive]pub enum FinishReason {
    MaxTokensReached,
    StopSequenceReached,
}

Reason a prompt completion finished.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MaxTokensReached

The maximum length was reached

StopSequenceReached

The stop token was encountered

Trait Implementations

impl Clone for FinishReason

pub fn clone(&self) -> FinishReason

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FinishReason

impl Debug for FinishReason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FinishReason

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for FinishReason

impl PartialEq<FinishReason> for FinishReason

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for FinishReason

impl StructuralPartialEq for FinishReason