VoiceGeneratedAudioItem interface

Package:

@azure/ai-projects

Metadata for a conversation item's generated audio. For bring-your-own-storage (BYOS), the response includes blob_uri, a direct customer-storage URI without a SAS token, that the customer accesses with their own credentials. For Foundry-managed storage, blob_uri is absent and the bytes are streamed through the item's /audio/generated/content route.

Properties

blob_uri	For bring-your-own-storage (BYOS) recordings only: the URI of the generated audio in the customer's own storage, without a SAS token. The customer downloads it using their own storage credentials. Absent for Foundry-managed storage, where the bytes are streamed via the item's /audio/generated/content route instead.
channels	The number of audio channels.
codec	The audio codec.
conversation_id	The id of the conversation the item belongs to.
duration_ms	The duration of the audio segment.
format	The container format of the audio.
item_id	The id of the item this audio belongs to.
role	The role the audio belongs to.
sample_rate	The sample rate in Hz.
start_offset_ms	The offset from the session start at which this segment begins.

Property Details

blob_uri

For bring-your-own-storage (BYOS) recordings only: the URI of the generated audio in the customer's own storage, without a SAS token. The customer downloads it using their own storage credentials. Absent for Foundry-managed storage, where the bytes are streamed via the item's /audio/generated/content route instead.

blob_uri?: string

Property Value

string

channels

The number of audio channels.

channels?: number

Property Value

number

codec

The audio codec.

codec?: VoiceAudioCodec

Property Value

VoiceAudioCodec

conversation_id

The id of the conversation the item belongs to.

conversation_id: string

Property Value

string

duration_ms

The duration of the audio segment.

duration_ms?: number

Property Value

number

format

The container format of the audio.

format?: "wav"

Property Value

"wav"

item_id

The id of the item this audio belongs to.

item_id: string

Property Value

string

role

The role the audio belongs to.

role?: VoiceAudioRole

Property Value

VoiceAudioRole

sample_rate

The sample rate in Hz.

sample_rate?: number

Property Value

number

start_offset_ms

The offset from the session start at which this segment begins.

start_offset_ms?: number

Property Value

number