EasyInputMessage 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. Messages with the assistant role are presumed to have been generated by the model in previous interactions.

Extends

Properties

content

Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses.

role

The role of the message input. One of user, assistant, 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 message.

Property Details

content

Text, image, or audio input to the model, used to generate a response. Can also contain previous assistant responses.

content: string | InputContentUnion[]

Property Value

string | InputContentUnion[]

role

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

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

Property Value

"user" | "assistant" | "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 message.

type: "message"

Property Value

"message"