Class Message

Namespace

FoundationaLLM.Common.Models.Conversation

Assembly

FoundationaLLM.Common.dll

The message object.

public record Message : IEquatable<Message>

Inheritance

object

Message

Implements

IEquatable<Message>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

AnalysisResults

A list of results from the analysis.

public List<AnalysisResult>? AnalysisResults { get; set; }

Property Value

List<AnalysisResult>

AttachmentDetails

Contains the details of the attachments. This is not stored in the database.

[JsonIgnore]
public List<AttachmentDetail>? AttachmentDetails { get; set; }

Property Value

List<AttachmentDetail>

Attachments

One or more attachments included with the orchestration request. The values should be the Object ID of the attachment(s).

[JsonPropertyName("attachments")]
public List<string>? Attachments { get; init; }

Property Value

List<string>

CompletionPromptId

The identifier for the completion prompt associated with the message.

public string? CompletionPromptId { get; set; }

Property Value

string

Content

The content of the message.

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

Property Value

List<MessageContent>

ContentArtifacts

The sources associated with the completion prompt.

public ContentArtifact[]? ContentArtifacts { get; set; }

Property Value

ContentArtifact[]

Deleted

Deleted flag used for soft delete.

public bool Deleted { get; set; }

Property Value

bool

ExpectedCompletion

Stores the expected completion for the message and used for evaluating the actual vs. expected agent completion. This should be stored in the agent response.

public string? ExpectedCompletion { get; set; }

Property Value

string

Id

The unique identifier.

public string Id { get; set; }

Property Value

string

OperationId

The optional identifier of the long-running operation.

[JsonPropertyName("operation_id")]
public string? OperationId { get; set; }

Property Value

string

Remarks

The operation id will be set only for messages that are part of a long-running operation.

Rating

The rating associated with the message, if any.

public bool? Rating { get; set; }

Property Value

bool?

RatingComments

The comments associated with the rating.

public string? RatingComments { get; set; }

Property Value

string

Sender

The sender of the message.

public string Sender { get; set; }

Property Value

string

SenderDisplayName

The display name of the message sender. This could be the name of the signed in user or the name of the agent.

public string? SenderDisplayName { get; set; }

Property Value

string

SessionId

The Partition key.

public string SessionId { get; set; }

Property Value

string

Status

The status of the long-running operation.

[JsonPropertyName("status")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public OperationStatus Status { get; set; }

Property Value

OperationStatus

Text

The text content of the message.

public string Text { get; set; }

Property Value

string

TextRewrite

The optional rewrite of the text content of the message.

public string? TextRewrite { get; set; }

Property Value

string

TimeStamp

The timestamp when the message was created.

public DateTime TimeStamp { get; set; }

Property Value

DateTime

Tokens

The number of tokens associated with the message, if any.

public int Tokens { get; set; }

Property Value

int

Type

The type of the message.

public string Type { get; set; }

Property Value

string

UPN

The UPN of the user who created the chat session.

public string UPN { get; set; }

Property Value

string

Vector

The vector associated with the message.

public float[]? Vector { get; set; }

Property Value

float[]