Class Message

Namespace

OpenAI.Threads

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)

object.ToString()

Constructors

Message(IEnumerable<Content>, Role, IEnumerable<Attachment>, IReadOnlyDictionary<string, string>)

Constructor.

public Message(IEnumerable<Content> content, Role role = Role.User, IEnumerable<Attachment> attachments = null, IReadOnlyDictionary<string, string> metadata = null)

Parameters

content IEnumerable<Content>

The contents of the message.

role Role

The role of the entity that is creating the message.

attachments IEnumerable<Attachment>

A list of files attached to the message, and the tools they were added to.

metadata IReadOnlyDictionary<string, string>

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

Message(string, Role, IEnumerable<Attachment>, IReadOnlyDictionary<string, string>)

Constructor.

public Message(string content, Role role = Role.User, IEnumerable<Attachment> attachments = null, IReadOnlyDictionary<string, string> metadata = null)

Parameters

content string

The contents of the message.

role Role

The role of the entity that is creating the message.

attachments IEnumerable<Attachment>

A list of files attached to the message, and the tools they were added to.

metadata IReadOnlyDictionary<string, string>

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

Properties

Attachments

A list of files attached to the message, and the tools they were added to.

[JsonInclude]
[JsonPropertyName("attachments")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public IReadOnlyList<Attachment> Attachments { get; }

Property Value

IReadOnlyList<Attachment>

Content

The contents of the message.

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

Property Value

IReadOnlyList<Content>

Metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

[JsonPropertyName("metadata")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public IReadOnlyDictionary<string, string> Metadata { get; }

Property Value

IReadOnlyDictionary<string, string>

Role

The role of the entity that is creating the message.

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

Property Value

Role

Methods

PrintContent()

Formats all of the Content items into a single string, putting each item on a new line.

public string PrintContent()

Returns

string

string of all Content.

Operators

implicit operator Message(string)

public static implicit operator Message(string content)

Parameters

content string

Returns

Message