Struct RealtimeConversationItemWithReference

pub struct RealtimeConversationItemWithReference {
    pub id: Option<String>,
    pub type: Option<RealtimeConversationItemWithReferenceType>,
    pub object: Option<RealtimeConversationItemWithReferenceObject>,
    pub status: Option<RealtimeConversationItemWithReferenceStatus>,
    pub role: Option<RealtimeConversationItemWithReferenceRole>,
    pub content: Option<Vec<RealtimeConversationItemWithReferenceContent>>,
    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>

For an item of type (message | function_call | function_call_output) this field allows the client to assign the unique ID of the item. It is not required because the server will generate one if not provided.

For an item of type item_reference, this field is required and is a reference to any item that has previously existed in the conversation.

type: Option<RealtimeConversationItemWithReferenceType>

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

object: Option<RealtimeConversationItemWithReferenceObject>

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

status: Option<RealtimeConversationItemWithReferenceStatus>

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<RealtimeConversationItemWithReferenceRole>

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

content: Option<Vec<RealtimeConversationItemWithReferenceContent>>

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 RealtimeConversationItemWithReference

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

Create a builder for building RealtimeConversationItemWithReference. 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 RealtimeConversationItemWithReference.

Trait Implementations

impl Clone for RealtimeConversationItemWithReference

fn clone(&self) -> RealtimeConversationItemWithReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeConversationItemWithReference

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

Formats the value using the given formatter.

impl Default for RealtimeConversationItemWithReference

fn default() -> RealtimeConversationItemWithReference

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RealtimeConversationItemWithReference

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeConversationItemWithReference

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

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 RealtimeConversationItemWithReference