Class MessageResponse

Namespace

OpenAI.ObjectModels.SharedModels

Assembly

AntRunnerLib.dll

Represents a message within a thread.

public class MessageResponse : BaseResponse, IEquatable<ObjectBaseResponse>, IEquatable<BaseResponse>, IOpenAiModels.IId, IOpenAiModels.ICreatedAt, IOpenAiModels.IMetaData, IOpenAiModels.IAssistantId, IEquatable<MessageResponse>

Inheritance

System.Object

ObjectBaseResponse

BaseResponse

MessageResponse

Implements

System.IEquatable<ObjectBaseResponse>

System.IEquatable<BaseResponse>

IOpenAiModels.IId

IOpenAiModels.ICreatedAt

IOpenAiModels.IMetaData

IOpenAiModels.IAssistantId

System.IEquatable<MessageResponse>

Inherited Members

BaseResponse.StreamEvent

BaseResponse.IsDelta

BaseResponse.Successful

BaseResponse.Error

BaseResponse.HttpStatusCode

BaseResponse.HeaderValues

ObjectBaseResponse.ObjectTypeName

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Properties

AssistantId

If applicable, the ID of the assistant that authored this message.

[JsonPropertyName("assistant_id")]
public string AssistantId { get; set; }

Property Value

System.String

Attachments

A list of file IDs that the assistant should use. Useful for tools like retrieval and code_interpreter that can access files. A maximum of 10 files can be attached to a message.

[JsonPropertyName("attachments")]
public List<Attachment> Attachments { get; set; }

Property Value

List<Attachment>

CompletedAt

The Unix timestamp (in seconds) for when the run was completed.

[JsonPropertyName("completed_at")]
public int? CompletedAt { get; set; }

Property Value

System.Nullable<System.Int32>

Content

The content of the message in array of text and/or images.

[JsonPropertyName("content")]
public List<MessageResponse.MessageContentResponse>? Content { get; set; }

Property Value

System.Nullable<List<MessageResponse.MessageContentResponse>>

CreatedAt

The Unix timestamp (in seconds) for when the message was created.

[JsonPropertyName("created_at")]
public int CreatedAt { get; set; }

Property Value

System.Int32

Delta

[JsonPropertyName("delta")]
public MessageResponse Delta { set; }

Property Value

MessageResponse

Id

The identifier, which can be referenced in API endpoints.

[JsonPropertyName("id")]
public string Id { get; set; }

Property Value

System.String

IncompleteAt

The Unix timestamp (in seconds) for when the run was completed.

[JsonPropertyName("incomplete_at")]
public int? IncompleteAt { get; set; }

Property Value

System.Nullable<System.Int32>

IncompleteDetails

On an incomplete message, details about why the message is incomplete.

[JsonPropertyName("incomplete_details")]
public IncompleteDetails IncompleteDetails { get; set; }

Property Value

IncompleteDetails

Metadata

Set of 16 key-value pairs that can be attached to an object.

[JsonPropertyName("metadata")]
public Dictionary<string, string>? Metadata { get; set; }

Property Value

System.Nullable<Dictionary<System.String, System.String>>

Role

The entity that produced the message. One of user or assistant.

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

Property Value

System.String

RunId

The ID of the run associated with the creation of this message. Value is null when messages are created manually using the create message or create thread endpoints.

[JsonPropertyName("run_id")]
public string RunId { get; set; }

Property Value

System.String

Status

The status of the message, which can be either in_progress, incomplete, or completed.

[JsonPropertyName("status")]
public string Status { get; set; }

Property Value

System.String

ThreadId

The thread ID that this message belongs to.

[JsonPropertyName("thread_id")]
public string ThreadId { get; set; }

Property Value

System.String