Class Message

Namespace

OpenAI.Chat

Assembly

OpenAI-DotNet.dll

public sealed class Message

Inheritance

object

Message

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Message()

public Message()

Message(Role, IEnumerable<Content>, string)

Creates a new message to insert into a chat conversation.

public Message(Role role, IEnumerable<Content> content, string name = null)

Parameters

role Role

The Role of the author of this message.

content IEnumerable<Content>

The contents of the message.

name string

Message(Role, string, string)

Creates a new message to insert into a chat conversation.

public Message(Role role, string content, string name = null)

Parameters

role Role

The Role of the author of this message.

content string

The contents of the message.

name string

Message(Tool, IEnumerable<Content>)

[Obsolete("use overload with ToolCall")]
public Message(Tool tool, IEnumerable<Content> content)

Parameters

tool Tool

content IEnumerable<Content>

Message(Tool, string)

[Obsolete("use overload with ToolCall")]
public Message(Tool tool, string content)

Parameters

tool Tool

content string

Message(ToolCall, IEnumerable<Content>)

Creates a new message to insert into a chat conversation.

public Message(ToolCall toolCall, IEnumerable<Content> content)

Parameters

toolCall ToolCall

ToolCall used for message.

content IEnumerable<Content>

Tool function response.

Message(ToolCall, string)

public Message(ToolCall toolCall, string content)

Parameters

toolCall ToolCall

content string

Message(string, string, IEnumerable<Content>)

Creates a new message to insert into a chat conversation.

public Message(string toolCallId, string toolFunctionName, IEnumerable<Content> content)

Parameters

toolCallId string

The tool_call_id to use for the message.

toolFunctionName string

Name of the function call.

content IEnumerable<Content>

Tool function response.

Properties

AudioOutput

If the audio output modality is requested, this object contains data about the audio response from the model.

[JsonInclude]
[JsonPropertyName("audio")]
public AudioOutput AudioOutput { get; }

Property Value

AudioOutput

Content

The contents of the message.

[JsonInclude]
[JsonPropertyName("content")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
public dynamic Content { get; }

Property Value

dynamic

Name

Optional, The name of the author of this message.
May contain a-z, A-Z, 0-9, and underscores, with a maximum length of 64 characters.

[JsonInclude]
[JsonPropertyName("name")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string Name { get; }

Property Value

string

Refusal

The refusal message generated by the model.

[JsonInclude]
[JsonPropertyName("refusal")]
public string Refusal { get; }

Property Value

string

Role

The Role of the author of this message.

[JsonInclude]
[JsonPropertyName("role")]
public Role Role { get; }

Property Value

Role

ToolCallId

[JsonInclude]
[JsonPropertyName("tool_call_id")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string ToolCallId { get; }

Property Value

string

ToolCalls

The tool calls generated by the model, such as function calls.

[JsonInclude]
[JsonPropertyName("tool_calls")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IReadOnlyList<ToolCall> ToolCalls { get; }

Property Value

IReadOnlyList<ToolCall>

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Operators

implicit operator string(Message)

public static implicit operator string(Message message)

Parameters

message Message

Returns

string