Skip to content

Commit 20d59ef

Browse files
authored
Beta3 update (Azure#52884)
1 parent 3dbf3ac commit 20d59ef

File tree

1 file changed

+42
-44
lines changed

1 file changed

+42
-44
lines changed

sdk/ai/Azure.AI.VoiceLive/CHANGELOG.md

Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release History
22

3-
## 1.0.0-beta.3 (Unreleased)
3+
## 1.0.0-beta.3 (2025-09-26)
44

55
### Features Added
66

@@ -20,175 +20,175 @@
2020

2121
### Breaking Changes
2222

23-
### Type Changes from Enums to Extensible Enums
23+
#### Type Changes from Enums to Extensible Enums
2424

2525
Several enum types have been converted to extensible enums (struct-based) for better extensibility:
2626

27-
### AnimationOutputType
27+
#### AnimationOutputType
2828
- **Before**: `enum AnimationOutputType`
2929
- **After**: `readonly partial struct AnimationOutputType`
3030
- **Impact**: The type is now an extensible enum. Existing code using the enum values will continue to work due to implicit conversions.
3131

32-
### AudioNoiseReductionType
32+
#### AudioNoiseReductionType
3333
- **Before**: `enum AudioNoiseReductionType`
3434
- **After**: `readonly partial struct AudioNoiseReductionType`
3535
- **Impact**: The type is now an extensible enum. Existing code using the enum values will continue to work due to implicit conversions.
3636

37-
### ItemParamStatus
37+
#### ItemParamStatus
3838
- **Before**: `enum ItemParamStatus`
3939
- **After**: `readonly partial struct ItemParamStatus`
4040
- **Impact**: The type is now an extensible enum. Existing code using the enum values will continue to work due to implicit conversions.
4141

42-
### ResponseCancelledDetailsReason
42+
#### ResponseCancelledDetailsReason
4343
- **Before**: `enum ResponseCancelledDetailsReason`
4444
- **After**: `readonly partial struct ResponseCancelledDetailsReason`
4545
- **Impact**: The type is now an extensible enum. Existing code using the enum values will continue to work due to implicit conversions.
4646

47-
### ResponseIncompleteDetailsReason
47+
#### ResponseIncompleteDetailsReason
4848
- **Before**: `enum ResponseIncompleteDetailsReason`
4949
- **After**: `readonly partial struct ResponseIncompleteDetailsReason`
5050
- **Impact**: The type is now an extensible enum. Existing code using the enum values will continue to work due to implicit conversions.
5151

52-
## Class and Property Renames
52+
#### Class and Property Renames
5353

54-
### AudioInputTranscriptionSettings → AudioInputTranscriptionOptions
54+
#### AudioInputTranscriptionSettings → AudioInputTranscriptionOptions
5555
- **Type renamed**: `AudioInputTranscriptionSettings` is now `AudioInputTranscriptionOptions`
5656
- **Model property renamed**: `AudioInputTranscriptionSettingsModel` is now `AudioInputTranscriptionOptionsModel`
5757
- **Impact**: Update all references to use the new type name.
5858

59-
### InputModality → InteractionModality
59+
#### InputModality → InteractionModality
6060
- **Type renamed**: `InputModality` is now `InteractionModality`
6161
- **Impact**: Update all references from `InputModality` to `InteractionModality` throughout your code.
6262

63-
### ResponseMaxOutputTokensOption → MaxResponseOutputTokensOption
63+
#### ResponseMaxOutputTokensOption → MaxResponseOutputTokensOption
6464
- **Type renamed**: `ResponseMaxOutputTokensOption` is now `MaxResponseOutputTokensOption`
6565
- **Impact**: Update all type references to use the new name.
6666

67-
### Removed Types
67+
#### Removed Types
6868

69-
### UserContentPart (abstract base class)
69+
#### UserContentPart (abstract base class)
7070
- **Removed**: The abstract `UserContentPart` class has been removed.
7171
- **Replacement**: Use the new `MessageContentPart` abstract base class instead.
7272
- **Impact**: Update inheritance hierarchies to use `MessageContentPart`.
7373

74-
### AzureSemanticEnEouDetection
74+
#### AzureSemanticEnEouDetection
7575
- **Removed**: This class has been removed.
7676
- **Replacement**: Use `AzureSemanticEouDetectionEn` instead.
7777

78-
### AzureSemanticMultilingualEouDetection
78+
#### AzureSemanticMultilingualEouDetection
7979
- **Removed**: This class has been removed.
8080
- **Replacement**: Use `AzureSemanticEouDetectionMultilingual` instead.
8181

82-
### AzureSemanticVadEnTurnDetection
82+
#### AzureSemanticVadEnTurnDetection
8383
- **Removed**: This class has been removed.
8484
- **Replacement**: Use `AzureSemanticVadTurnDetectionEn` instead.
8585

86-
### AzureSemanticVadMultilingualTurnDetection
86+
#### AzureSemanticVadMultilingualTurnDetection
8787
- **Removed**: This class has been removed.
8888
- **Replacement**: Use `AzureSemanticVadTurnDetectionMultilingual` instead.
8989

90-
### Property Removals
90+
#### Property Removals
9191

92-
### AnimationOptions
92+
#### AnimationOptions
9393
- **Removed properties**:
9494
- `EmotionDetectionInterval`
9595
- `EmotionDetectionIntervalMs`
9696
- **Impact**: Remove any code that sets or reads these properties.
9797

98-
### AzureSemanticEouDetection family
98+
#### AzureSemanticEouDetection family
9999
- **Changed property**: `Threshold` (float) has been replaced with `ThresholdLevel` using new threshold level types:
100100
- `AzureSemanticDetectionThresholdLevel` for `AzureSemanticEouDetection`
101101
- `AzureSemanticDetectionEnThresholdLevel` for `AzureSemanticEouDetectionEn`
102102
- `AzureSemanticDetectionMultilingualThresholdLevel` for `AzureSemanticEouDetectionMultilingual`
103103
- **Impact**: Update code to use the new `ThresholdLevel` property with appropriate enum values (Default, Low, Medium, High).
104104

105-
### Constructor and Method Signature Changes
105+
#### Constructor and Method Signature Changes
106106

107-
### MessageItem
107+
#### MessageItem
108108
- **Constructor changed**:
109109
- **Before**: `MessageItem(string role)`
110110
- **After**: `MessageItem(ResponseMessageRole role, IEnumerable<MessageContentPart> content)`
111111
- **Impact**: Update all MessageItem instantiations to provide both role and content parameters.
112112

113-
### AssistantMessageItem
113+
#### AssistantMessageItem
114114
- **Constructor changed**:
115115
- **Before**: Accepted `OutputTextContentPart` or `IEnumerable<OutputTextContentPart>`
116116
- **After**: Accepts `MessageContentPart`, `IEnumerable<MessageContentPart>`, or a string
117117
- **Property changed**: `Content` is now `IList<MessageContentPart>` instead of `IList<OutputTextContentPart>`
118118

119-
### SystemMessageItem
119+
#### SystemMessageItem
120120
- **Constructor changed**:
121121
- **Before**: Accepted `InputTextContentPart` or `IEnumerable<InputTextContentPart>`
122122
- **After**: Accepts `InputTextContentPart`, `IEnumerable<MessageContentPart>`, or a string
123123
- **Property changed**: `Content` is now part of base `MessageItem` as `IList<MessageContentPart>`
124124

125-
### UserMessageItem
125+
#### UserMessageItem
126126
- **Constructor changed**:
127127
- **Before**: Accepted `UserContentPart` or `IEnumerable<UserContentPart>`
128128
- **After**: Accepts `InputTextContentPart`, `IEnumerable<MessageContentPart>`, or a string
129129
- **Property changed**: `Content` is now part of base `MessageItem` as `IList<MessageContentPart>`
130130

131-
### ToolChoiceOption
131+
#### ToolChoiceOption
132132
- **Constructor parameter renamed**:
133133
- **Before**: `ToolChoiceOption(string stringValue)`
134134
- **After**: `ToolChoiceOption(string functionName)`
135135
- **Impact**: The parameter name has changed, but functionality remains the same.
136136

137-
### Service Version Changes
137+
#### Service Version Changes
138138

139-
### VoiceLiveClientOptions
139+
#### VoiceLiveClientOptions
140140
- **Default service version changed**:
141141
- **Before**: `ServiceVersion.V2025_05_01_Preview`
142142
- **After**: `ServiceVersion.V2025_10_01`
143143
- **Impact**: The client now defaults to a newer, non-preview API version.
144144

145-
### Class Inheritance Changes
145+
#### Class Inheritance Changes
146146

147-
### VoiceLiveClientOptions
147+
#### VoiceLiveClientOptions
148148
- **Before**: Inherited from `Azure.Core.ClientOptions`
149149
- **After**: No longer inherits from `ClientOptions`, but provides a `DiagnosticsOptions` property
150150
- **Impact**: Some properties previously available through inheritance may need to be accessed differently.
151151

152-
### Content Part Classes
152+
#### Content Part Classes
153153
- `InputAudioContentPart`: Now inherits from `MessageContentPart` instead of `UserContentPart`
154154
- `InputTextContentPart`: Now inherits from `MessageContentPart` instead of `UserContentPart`
155155
- `OutputTextContentPart`: Now inherits from `MessageContentPart` instead of being standalone
156156

157-
### New Required Properties
157+
#### New Required Properties
158158

159-
### Turn Detection Classes
159+
#### Turn Detection Classes
160160
Several turn detection classes have new properties that should be considered:
161161
- `CreateResponse` (bool?): Added to `ServerVadTurnDetection`, `AzureSemanticVadTurnDetection`, and related classes
162162
- `InterruptResponse` (bool?): Added to the same turn detection classes
163163

164-
### VideoParams
164+
#### VideoParams
165165
- New optional properties:
166166
- `Background` (VideoBackground): Configure video background settings
167167
- `GopSize` (int?): Configure Group of Pictures size
168168

169-
### Property Access Changes
169+
#### Property Access Changes
170170

171-
### VoiceLiveClient
171+
#### VoiceLiveClient
172172
- **Removed**: `Pipeline` property is no longer publicly accessible
173173
- **Impact**: If you were accessing the HTTP pipeline directly, you'll need to find alternative approaches.
174174

175-
### VoiceLiveResponse
175+
#### VoiceLiveResponse
176176
- **Property changed**: `Modalities` is now `ModalitiesInternal` and returns `IList<InteractionModality>` instead of `SessionUpdateModality`
177177

178-
### Authentication Changes
178+
#### Authentication Changes
179179

180-
### VoiceLiveClient Authentication Scope
180+
#### VoiceLiveClient Authentication Scope
181181
- **Authentication scope changed**: The default authentication scope has been updated from `https://cognitiveservices.azure.com/.default` to `https://ai.azure.com/.default`
182182
- **Impact**: This change should be transparent for most users, but custom authentication implementations may need adjustment.
183183

184-
### Class Inheritance and Interface Implementation Changes
184+
#### Class Inheritance and Interface Implementation Changes
185185

186-
### AzureSemanticEouDetectionEn and AzureSemanticEouDetectionMultilingual
186+
#### AzureSemanticEouDetectionEn and AzureSemanticEouDetectionMultilingual
187187
- **Before**: These classes were incomplete and did not properly inherit from base classes
188188
- **After**: Both classes now properly inherit from `EouDetection` and implement full serialization interfaces
189189
- **Impact**: These classes are now fully functional and consistent with the API pattern
190190

191-
### Migration Guide
191+
#### Migration Guide
192192

193193
1. **Update enum usage**: While the conversion to extensible enums maintains backward compatibility through implicit conversions, consider updating to use the new struct-based pattern for future-proofing.
194194

@@ -205,8 +205,6 @@ Several turn detection classes have new properties that should be considered:
205205

206206
6. **Consider new properties**: Review the new `CreateResponse` and `InterruptResponse` properties in turn detection configurations to see if they benefit your use case.
207207

208-
### Bugs Fixed
209-
210208
### Other Changes
211209

212210
- Updated README examples to use new `InteractionModality` instead of `InputModality`

0 commit comments

Comments
 (0)