ChatCompletionResponse

Struct ChatCompletionResponse 

Source
pub struct ChatCompletionResponse {
    pub id: String,
    pub choices: Vec<CreateChatCompletionResponseChoicesInner>,
    pub created: i32,
    pub model: String,
    pub service_tier: Option<Option<ServiceTier>>,
    pub system_fingerprint: Option<String>,
    pub object: Object,
    pub usage: Option<Box<CompletionUsage>>,
}
Expand description

CreateChatCompletionResponse : Represents a chat completion response returned by model, based on the provided input.

Fields§

§id: String

A unique identifier for the chat completion.

§choices: Vec<CreateChatCompletionResponseChoicesInner>

A list of chat completion choices. Can be more than one if n is greater than 1.

§created: i32

The Unix timestamp (in seconds) of when the chat completion was created.

§model: String

The model used for the chat completion.

§service_tier: Option<Option<ServiceTier>>§system_fingerprint: Option<String>

This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.

§object: Object

The object type, which is always chat.completion.

§usage: Option<Box<CompletionUsage>>

Implementations§

Source§

impl CreateChatCompletionResponse

Source

pub fn builder() -> CreateChatCompletionResponseBuilder

Create an instance of CreateChatCompletionResponse using the builder syntax

Source§

impl CreateChatCompletionResponse

Source

pub fn new( id: String, choices: Vec<CreateChatCompletionResponseChoicesInner>, created: i32, model: String, object: Object, ) -> CreateChatCompletionResponse

Represents a chat completion response returned by model, based on the provided input.

Trait Implementations§

Source§

impl ChatCompletionResponseExt for CreateChatCompletionResponse

Source§

fn content(&self) -> Option<&str>

Get the content of the first choice, if available.
Source§

fn tool_calls(&self) -> Vec<&ChatCompletionMessageToolCallsInner>

Get the tool calls from the first choice, if available.
Source§

fn has_tool_calls(&self) -> bool

Check if the response has tool calls.
Source§

fn first_choice(&self) -> Option<&CreateChatCompletionResponseChoicesInner>

Get the first choice from the response.
Source§

fn first_message(&self) -> Option<&ChatCompletionResponseMessage>

Get the message from the first choice.
Source§

fn is_refusal(&self) -> bool

Check if the response was refused.
Source§

fn refusal(&self) -> Option<&str>

Get the refusal message if the response was refused.
Source§

fn finish_reason(&self) -> Option<String>

Get the finish reason for the first choice.
Source§

impl Clone for CreateChatCompletionResponse

Source§

fn clone(&self) -> CreateChatCompletionResponse

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CreateChatCompletionResponse

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CreateChatCompletionResponse

Source§

fn default() -> CreateChatCompletionResponse

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CreateChatCompletionResponse

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for CreateChatCompletionResponse

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CreateChatCompletionResponse

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for CreateChatCompletionResponse

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CreateChatCompletionResponse

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,