RealtimeConversationItemMessageSystem interface

Package:

@azure/ai-projects

A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. "the user is now asking about a different topic"), use system messages.

Extends

RealtimeConversationItemMessage

Properties

content	The content of the message.
created_at	The Unix timestamp (in seconds) for when the item was persisted.
id	The unique ID of the item. This may be provided by the client or generated by the server.
object	Identifier for the API object being returned - always realtime.item. Optional when creating a new item.
response_id	The id of the response that produced this item, when applicable.
role	The role of the message sender. Always system.
status	The status of the item. Has no effect on the conversation.
type	The type of the item. Always message.

Property Details

content

The content of the message.

content: RealtimeConversationItemMessageSystemContent[]

Property Value

RealtimeConversationItemMessageSystemContent[]

created_at

The Unix timestamp (in seconds) for when the item was persisted.

created_at?: Date

Property Value

Date

id

The unique ID of the item. This may be provided by the client or generated by the server.

id?: string

Property Value

string

object

Identifier for the API object being returned - always realtime.item. Optional when creating a new item.

object?: "realtime.item"

Property Value

"realtime.item"

response_id

The id of the response that produced this item, when applicable.

response_id?: string

Property Value

string

role

The role of the message sender. Always system.

role: "system"

Property Value

"system"

status

The status of the item. Has no effect on the conversation.

status?: "in_progress" | "completed" | "incomplete"

Property Value

"in_progress" | "completed" | "incomplete"

type

The type of the item. Always message.

type: "message"

Property Value

"message"