Struct ChatCompletionResponse

pub struct ChatCompletionResponse {
    pub id: Uuid,
    pub message: Option<String>,
    pub tool_calls: Option<Vec<ToolCall>>,
    pub usage: Option<Usage>,
    pub delta: Option<ChatCompletionResponseDelta>,
}

A generic response from chat completions

When streaming, the delta is available. Every response will have the accumulated message if present. The final message will also have the final tool calls.

Fields

id: Uuid

An identifier for the response

Useful when streaming to make sure chunks can be mapped to the right response

message: Option<String>

tool_calls: Option<Vec<ToolCall>>

usage: Option<Usage>

delta: Option<ChatCompletionResponseDelta>

Streaming response

Implementations

impl ChatCompletionResponse

pub fn builder() -> ChatCompletionResponseBuilder

pub fn message(&self) -> Option<&str>

pub fn tool_calls(&self) -> Option<&[ToolCall]>

pub fn append_message_delta(&mut self, message_delta: Option<&str>) -> &mut Self

Adds a streaming chunk to the message and also the delta

pub fn append_tool_call_delta( &mut self, index: usize, id: Option<&str>, name: Option<&str>, arguments: Option<&str>, ) -> &mut Self

Adds a streaming chunk to the tool calls, if it can be build, the tool call will be build, otherwise it will remain in the delta and retried on the next call

pub fn append_usage_delta( &mut self, prompt_tokens: u32, completion_tokens: u32, total_tokens: u32, ) -> &mut Self

Trait Implementations

impl Clone for ChatCompletionResponse

fn clone(&self) -> ChatCompletionResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletionResponse

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

Formats the value using the given formatter.

impl Default for ChatCompletionResponse

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChatCompletionResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatCompletionResponse

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

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

const 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 ChatCompletionResponse

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 ChatCompletionResponse