Struct CreateChatCompletionResponseChoice

pub struct CreateChatCompletionResponseChoice {
    pub finish_reason: CreateChatCompletionResponseChoiceFinishReason,
    pub index: u64,
    pub message: ChatCompletionResponseMessage,
    pub logprobs: Option<CreateChatCompletionResponseChoiceLogprobs>,
}

Fields

finish_reason: CreateChatCompletionResponseChoiceFinishReason

The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, content_filter if content was omitted due to a flag from our content filters, tool_calls if the model called a tool, or function_call (deprecated) if the model called a function.

index: u64

The index of the choice in the list of choices.

message: ChatCompletionResponseMessage

logprobs: Option<CreateChatCompletionResponseChoiceLogprobs>

Log probability information for the choice.

Implementations

impl CreateChatCompletionResponseChoice

pub fn builder() -> CreateChatCompletionResponseChoiceBuilder<((), (), (), ())>

Create a builder for building CreateChatCompletionResponseChoice. On the builder, call .finish_reason(...), .index(...), .message(...)(optional), .logprobs(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateChatCompletionResponseChoice.

Trait Implementations

impl Clone for CreateChatCompletionResponseChoice

fn clone(&self) -> CreateChatCompletionResponseChoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateChatCompletionResponseChoice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateChatCompletionResponseChoice

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateChatCompletionResponseChoice

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CreateChatCompletionResponseChoice

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateChatCompletionResponseChoice