ProjectsAgentsModelFactory.VoiceRecording Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Metadata for the merged, whole-call stereo recording of a voice conversation (user audio on the left channel,
agent audio on the right). Built once from the per-turn segments after the session ends and durably cached.
The common metadata (format, sample rate, channels, channel layout, duration) is returned for both
Foundry-managed and bring-your-own-storage (BYOS) recordings. For BYOS the response also includes blob_uri,
the URI of the recording in the customer's own storage (no SAS token), which the customer downloads using their
own storage credentials. For Foundry-managed storage blob_uri is absent and the bytes are streamed via the
/audio/content route instead.
public static Azure.AI.Projects.Agents.VoiceRecording VoiceRecording(string conversationId = default, Azure.AI.Projects.Agents.VoiceAudioContainerFormat format = default, int sampleRate = 0, int channels = 0, Azure.AI.Projects.Agents.VoiceRecordingChannelLayout channelLayout = default, TimeSpan durationMs = default, Uri blobUri = default);
static member VoiceRecording : string * Azure.AI.Projects.Agents.VoiceAudioContainerFormat * int * int * Azure.AI.Projects.Agents.VoiceRecordingChannelLayout * TimeSpan * Uri -> Azure.AI.Projects.Agents.VoiceRecording
Public Shared Function VoiceRecording (Optional conversationId As String = Nothing, Optional format As VoiceAudioContainerFormat = Nothing, Optional sampleRate As Integer = 0, Optional channels As Integer = 0, Optional channelLayout As VoiceRecordingChannelLayout = Nothing, Optional durationMs As TimeSpan = Nothing, Optional blobUri As Uri = Nothing) As VoiceRecording
Parameters
- conversationId
- String
The id of the conversation this recording belongs to.
- format
- VoiceAudioContainerFormat
The container format of the recording.
- sampleRate
- Int32
The sample rate of the recording in Hz, e.g. 24000.
- channels
- Int32
The number of audio channels. The merged recording is stereo (2).
- channelLayout
- VoiceRecordingChannelLayout
The role assigned to each stereo channel.
- durationMs
- TimeSpan
The total duration of the recording.
- blobUri
- Uri
For bring-your-own-storage (BYOS) recordings only: the URI of the recording 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 /audio/content route instead.
Returns
A new VoiceRecording instance for mocking.