RealtimeClientEventConversationItemCreate interface

Package:

@azure/ai-projects

Add a new Item to the Conversation's context, including messages, function calls, and function call responses. This event can be used both to populate a "history" of the conversation and to add new items mid-stream, but has the current limitation that it cannot populate assistant audio messages. If successful, the server will respond with a conversation.item.created event, otherwise an error event will be sent.

Extends

RealtimeClientEvent

Properties

event_id	Optional client-generated ID used to identify this event.
item	The message, function call, or function result to add to the conversation.
previous_item_id	The ID of the preceding item after which the new item will be inserted. If not set, the new item will be appended to the end of the conversation. If set to root, the new item will be added to the beginning of the conversation. If set to an existing ID, it allows an item to be inserted mid-conversation. If the ID cannot be found, an error will be returned and the item will not be added.
type	The event type, must be conversation.item.create.

Property Details

event_id

Optional client-generated ID used to identify this event.

event_id?: string

Property Value

string

item

The message, function call, or function result to add to the conversation.

item: RealtimeConversationItemUnion

Property Value

RealtimeConversationItemUnion

previous_item_id

The ID of the preceding item after which the new item will be inserted. If not set, the new item will be appended to the end of the conversation. If set to root, the new item will be added to the beginning of the conversation. If set to an existing ID, it allows an item to be inserted mid-conversation. If the ID cannot be found, an error will be returned and the item will not be added.

previous_item_id?: string

Property Value

string

type

The event type, must be conversation.item.create.

type: "conversation.item.create"

Property Value

"conversation.item.create"