Struct RealtimeConversationItem

pub struct RealtimeConversationItem {
    pub id: Option<String>,
    pub type: Option<RealtimeConversationItemType>,
    pub object: Option<RealtimeConversationItemObject>,
    pub status: Option<RealtimeConversationItemStatus>,
    pub role: Option<RealtimeConversationItemRole>,
    pub content: Option<Vec<RealtimeConversationItemContent>>,
    pub call_id: Option<String>,
    pub name: Option<String>,
    pub arguments: Option<String>,
    pub output: Option<String>,
}

The item to add to the conversation.

Fields

id: Option<String>

The unique ID of the item, this can be generated by the client to help manage server-side context, but is not required because the server will generate one if not provided.

type: Option<RealtimeConversationItemType>

The type of the item (message, function_call, function_call_output).

object: Option<RealtimeConversationItemObject>

Identifier for the API object being returned - always realtime.item.

status: Option<RealtimeConversationItemStatus>

The status of the item (completed, incomplete). These have no effect on the conversation, but are accepted for consistency with the conversation.item.created event.

role: Option<RealtimeConversationItemRole>

The role of the message sender (user, assistant, system), only applicable for message items.

content: Option<Vec<RealtimeConversationItemContent>>

The content of the message, applicable for message items.

• Message items of role system support only input_text content
• Message items of role user support input_text and input_audio content
• Message items of role assistant support text content.

call_id: Option<String>

The ID of the function call (for function_call and function_call_output items). If passed on a function_call_output item, the server will check that a function_call item with the same ID exists in the conversation history.

name: Option<String>

The name of the function being called (for function_call items).

arguments: Option<String>

The arguments of the function call (for function_call items).

output: Option<String>

The output of the function call (for function_call_output items).

Implementations

impl RealtimeConversationItem

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

Create a builder for building RealtimeConversationItem. On the builder, call .id(...)(optional), .r#type(...)(optional), .object(...)(optional), .status(...)(optional), .role(...)(optional), .content(...)(optional), .call_id(...)(optional), .name(...)(optional), .arguments(...)(optional), .output(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RealtimeConversationItem.

Trait Implementations

impl Clone for RealtimeConversationItem

fn clone(&self) -> RealtimeConversationItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeConversationItem

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

Formats the value using the given formatter.

impl Default for RealtimeConversationItem

fn default() -> RealtimeConversationItem

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RealtimeConversationItem

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeConversationItem

fn eq(&self, other: &RealtimeConversationItem) -> 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 RealtimeConversationItem

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 RealtimeConversationItem