VoiceConversation interface

Package:

@azure/ai-projects

A persisted voice conversation. The Foundry envelope that owns a voice agent's stored transcript, responses, per-turn metrics, and audio. It is the parent, retention, and delete boundary: deleting it cascades to its responses, items, metrics, and audio. When finalization fails, any partial persisted responses, items, and item audio remain readable.

Properties

completed_at	The Unix timestamp (in seconds) for when session and persistence finalization reached the terminal completed or failed status. Absent while status is in_progress.
created_at	The Unix timestamp (in seconds) for when the conversation was created.
id	The unique id of the conversation.
last_error	The terminal error that prevented persistence finalization. Present only when status is failed.
metadata	A set of key-value pairs attached to the conversation.
object	The object type. Always voice.conversation.
status	The lifecycle status of the conversation.
usage	Final aggregate token usage across all responses in this conversation. Absent while status is in_progress and populated after successful completed finalization; it may be absent when status is failed, and values are not guaranteed to be reported incrementally.

Property Details

completed_at

The Unix timestamp (in seconds) for when session and persistence finalization reached the terminal completed or failed status. Absent while status is in_progress.

completed_at?: Date

Property Value

Date

created_at

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

created_at: Date

Property Value

Date

id

The unique id of the conversation.

id: string

Property Value

string

last_error

The terminal error that prevented persistence finalization. Present only when status is failed.

last_error?: ErrorModel

Property Value

ErrorModel

metadata

A set of key-value pairs attached to the conversation.

metadata?: Record<string, string>

Property Value

Record<string, string>

object

The object type. Always voice.conversation.

object: "voice.conversation"

Property Value

"voice.conversation"

status

The lifecycle status of the conversation.

status: VoiceConversationStatus

Property Value

VoiceConversationStatus

usage

Final aggregate token usage across all responses in this conversation. Absent while status is in_progress and populated after successful completed finalization; it may be absent when status is failed, and values are not guaranteed to be reported incrementally.

usage?: RealtimeResponseUsage

Property Value

RealtimeResponseUsage