Language

VoiceConversation Class

Definition

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.

public class VoiceConversation : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.VoiceConversation>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.VoiceConversation>
type VoiceConversation = class
    interface IJsonModel<VoiceConversation>
    interface IPersistableModel<VoiceConversation>
Public Class VoiceConversation
Implements IJsonModel(Of VoiceConversation), IPersistableModel(Of VoiceConversation)
Inheritance
VoiceConversation
Implements

Properties

Name Description
CompletedOn

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

CreatedOn

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

Id

The unique id of the conversation.

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.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name Description
Explicit(ClientResult to VoiceConversation)

Explicit Interface Implementations

Name Description
IJsonModel<VoiceConversation>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<VoiceConversation>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<VoiceConversation>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<VoiceConversation>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<VoiceConversation>.Write(ModelReaderWriterOptions)

Applies to