Share via


SystemMessageItem interface

A system message item within a conversation.

Extends

Properties

role

The discriminator possible values: assistant, system, user

Inherited Properties

content

The content parts of the message.

id
status

Processing status of the message item.

type

The type of the item; must be 'message' for message items.

Property Details

role

The discriminator possible values: assistant, system, user

role: "system"

Property Value

"system"

Inherited Property Details

content

The content parts of the message.

content: MessageContentPartUnion[]

Property Value

Inherited From MessageItem.content

id

id?: string

Property Value

string

Inherited From MessageItem.id

status

Processing status of the message item.

status?: string

Property Value

string

Inherited From MessageItem.status

type

The type of the item; must be 'message' for message items.

type: "message"

Property Value

"message"

Inherited From MessageItem.type