Search
K
OpenAI API

Function message

object
rolestringrequired

The role of the messages author, in this case function.

Allowed values:function

contentstringrequired

The contents of the function message.

namestringrequired

The name of the function to call.

Example

ChatCompletionRequestMessage

One Of
contentOne Of
required

The contents of the developer message.

Text contentstring

The contents of the developer message.

rolestringrequired

The role of the messages author, in this case developer.

Allowed values:developer

namestring

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Example

Audio content part

object

Learn about audio inputs.

typestringrequired

The type of the content part. Always input_audio.

Allowed values:input_audio

input_audioobjectrequired
Show Child Parameters
Example

Image content part

object

Learn about image inputs.

typestringrequired

The type of the content part.

Allowed values:image_url

image_urlobjectrequired
Show Child Parameters
Example

Refusal content part

object
typestringrequired

The type of the content part.

Allowed values:refusal

refusalstringrequired

The refusal message generated by the model.

Example