Share via


InputMessage interface

A message input to the model with a role indicating instruction following hierarchy. Instructions given with the developer or system role take precedence over instructions given with the user role.

Extends

Properties

content

The content of the message input.

role

The role of the message input. One of user, system, or developer.

status

The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

type

The type of the message input. Always set to message.

Property Details

content

The content of the message input.

content: InputContentUnion[]

Property Value

role

The role of the message input. One of user, system, or developer.

role: "user" | "system" | "developer"

Property Value

"user" | "system" | "developer"

status

The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

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

Property Value

"in_progress" | "completed" | "incomplete"

type

The type of the message input. Always set to message.

type: "message"

Property Value

"message"