Share via

ThreadMessageOutput interface

  • Reference
Package:
@azure/ai-projects

A single, existing message within an agent thread.

Properties

assistantId

If applicable, the ID of the agent that authored this message.
attachments

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

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

The list of content items associated with the agent thread message.
createdAt

The Unix timestamp, in seconds, representing when this object was created.
id

The identifier, which can be referenced in API endpoints.
incompleteAt

The Unix timestamp (in seconds) for when the message was marked as incomplete.
incompleteDetails

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

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
object

The object type, which is always 'thread.message'.
role

The role associated with the agent thread message.

Possible values: "user", "assistant"
runId

If applicable, the ID of the run associated with the authoring of this message.
status

The status of the message.

Possible values: "in_progress", "incomplete", "completed"
threadId

The ID of the thread that this message belongs to.

Property Details

assistantId

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

assistantId: null | string

Property Value

null | string

attachments

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

attachments: null | MessageAttachmentOutput[]

Property Value

null | MessageAttachmentOutput[]

completedAt

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

completedAt: null | Date

Property Value

null | Date

content

The list of content items associated with the agent thread message.

content: MessageContentOutput[]

Property Value

MessageContentOutput[]

createdAt

The Unix timestamp, in seconds, representing when this object was created.

createdAt: Date

Property Value

Date

id

The identifier, which can be referenced in API endpoints.

id: string

Property Value

string

incompleteAt

The Unix timestamp (in seconds) for when the message was marked as incomplete.

incompleteAt: null | Date

Property Value

null | Date

incompleteDetails

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

incompleteDetails: null | MessageIncompleteDetailsOutput

Property Value

null | MessageIncompleteDetailsOutput

metadata

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

metadata: null | Record<string, string>

Property Value

null | Record<string, string>

object

The object type, which is always 'thread.message'.

object: "thread.message"

Property Value

"thread.message"

role

The role associated with the agent thread message.

Possible values: "user", "assistant"

role: string

Property Value

string

runId

If applicable, the ID of the run associated with the authoring of this message.

runId: null | string

Property Value

null | string

status

The status of the message.

Possible values: "in_progress", "incomplete", "completed"

status: string

Property Value

string

threadId

The ID of the thread that this message belongs to.

threadId: string

Property Value

string