Skip to content

Commit 2d0393e

Browse files
modify enhanceed mode customization and update readme
1 parent 3de96a9 commit 2d0393e

File tree

5 files changed

+17
-28
lines changed

5 files changed

+17
-28
lines changed

sdk/cognitiveservices/azure-ai-speech-transcription/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,13 +196,14 @@ result.getPhrases().forEach(phrase -> {
196196

197197
### Transcribe with enhanced mode
198198

199-
Enhanced mode provides advanced features to improve transcription accuracy with custom prompts.
199+
Enhanced mode provides advanced features to improve transcription accuracy with custom prompts. Enhanced mode is automatically enabled when you create an `EnhancedModeOptions` instance.
200200

201201
```java com.azure.ai.speech.transcription.transcriptionoptions.enhancedmode
202202
byte[] audioData = Files.readAllBytes(Paths.get("path/to/audio.wav"));
203203

204204
AudioFileDetails audioFileDetails = new AudioFileDetails(BinaryData.fromBytes(audioData));
205205

206+
// Enhanced mode is automatically enabled
206207
EnhancedModeOptions enhancedMode = new EnhancedModeOptions()
207208
.setTask("transcribe")
208209
.setPrompts(java.util.Arrays.asList("Output must be in lexical format."));

sdk/cognitiveservices/azure-ai-speech-transcription/customization/src/main/java/SpeechTranscriptionCustomization.java

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,9 @@ private void customizeDiarizationOptionsToJson(PackageCustomization packageCusto
120120
}
121121

122122
/**
123-
* Customize EnhancedModeOptions constructor to automatically set enabled property to true.
124-
* This ensures enhanced mode is enabled when EnhancedModeOptions is instantiated.
123+
* Customize EnhancedModeOptions to hide the enabled property from the public API.
124+
* The enabled property is automatically set to true in the constructor.
125+
* Both isEnabled() getter and setEnabled() setter are removed from the public API.
125126
*
126127
* @param packageCustomization the package customization
127128
*/
@@ -141,8 +142,14 @@ private void customizeEnhancedModeOptions(PackageCustomization packageCustomizat
141142
// Add JavaDoc
142143
constructor.setJavadocComment(
143144
new Javadoc(parseText(
144-
"Creates an instance of EnhancedModeOptions class with enabled set to true.")));
145+
"Creates an instance of EnhancedModeOptions class with enhanced mode automatically enabled.")));
145146
});
147+
148+
// Remove isEnabled() getter to hide enabled from public API
149+
clazz.getMethodsByName("isEnabled").forEach(method -> method.remove());
150+
151+
// Remove ALL setEnabled() methods to hide enabled from public API
152+
clazz.getMethodsByName("setEnabled").forEach(method -> method.remove());
146153
});
147154
});
148155
}

sdk/cognitiveservices/azure-ai-speech-transcription/src/main/java/com/azure/ai/speech/transcription/models/EnhancedModeOptions.java

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -50,17 +50,6 @@ public EnhancedModeOptions() {
5050
this.enabled = true;
5151
}
5252

53-
/**
54-
* Get the enabled property: Enable enhanced mode for transcription. This is automatically set to true when task,
55-
* targetLanguage, or prompt are specified.
56-
*
57-
* @return the enabled value.
58-
*/
59-
@Generated
60-
public Boolean isEnabled() {
61-
return this.enabled;
62-
}
63-
6453
/**
6554
* Get the task property: Task type for enhanced mode.
6655
*
@@ -171,16 +160,4 @@ public static EnhancedModeOptions fromJson(JsonReader jsonReader) throws IOExcep
171160
return deserializedEnhancedModeOptions;
172161
});
173162
}
174-
175-
/**
176-
* Set the enabled property: Enable enhanced mode for transcription. Must be set to true to use enhanced mode
177-
* features.
178-
*
179-
* @param enabled the enabled value to set.
180-
* @return the EnhancedModeOptions object itself.
181-
*/
182-
public EnhancedModeOptions setEnabled(Boolean enabled) {
183-
this.enabled = enabled;
184-
return this;
185-
}
186163
}

sdk/cognitiveservices/azure-ai-speech-transcription/src/samples/java/com/azure/ai/speech/transcription/EnhancedModeSample.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ private static TranscriptionResult transcribeWithFullEnhancedMode(
120120
AudioFileDetails audioFileDetails = new AudioFileDetails(BinaryData.fromBytes(audioData));
121121

122122
// Configure comprehensive LLM-enhanced mode settings
123+
// Enhanced mode is automatically enabled when you create EnhancedModeOptions
123124
// Always include lexical format prompt for best results
124125
EnhancedModeOptions enhancedMode = new EnhancedModeOptions()
125126
.setTask("transcribe")

sdk/cognitiveservices/azure-ai-speech-transcription/src/samples/java/com/azure/ai/speech/transcription/ReadmeSamples.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ public void enhancedModeBasic() throws Exception {
239239

240240
AudioFileDetails audioFileDetails = new AudioFileDetails(BinaryData.fromBytes(audioData));
241241

242-
// Enable enhanced mode for improved transcription quality with lexical format
242+
// Enhanced mode is automatically enabled when you create EnhancedModeOptions
243243
EnhancedModeOptions enhancedMode = new EnhancedModeOptions()
244244
.setPrompts(java.util.Arrays.asList(
245245
"Output must be in lexical format."
@@ -267,6 +267,7 @@ public void enhancedModeWithPrompts() throws Exception {
267267

268268
AudioFileDetails audioFileDetails = new AudioFileDetails(BinaryData.fromBytes(audioData));
269269

270+
// Enhanced mode is automatically enabled
270271
// Use prompts to guide transcription with domain-specific terminology
271272
// Always include lexical format prompt for best results
272273
EnhancedModeOptions enhancedMode = new EnhancedModeOptions()
@@ -299,6 +300,7 @@ public void enhancedModeWithTranslation() throws Exception {
299300

300301
AudioFileDetails audioFileDetails = new AudioFileDetails(BinaryData.fromBytes(audioData));
301302

303+
// Enhanced mode is automatically enabled
302304
// Configure enhanced mode to transcribe Spanish audio and translate to English
303305
EnhancedModeOptions enhancedMode = new EnhancedModeOptions()
304306
.setTargetLanguage("en-US"); // Translate to English
@@ -375,6 +377,7 @@ public void transcribeEnhancedMode() throws Exception {
375377

376378
AudioFileDetails audioFileDetails = new AudioFileDetails(BinaryData.fromBytes(audioData));
377379

380+
// Enhanced mode is automatically enabled
378381
EnhancedModeOptions enhancedMode = new EnhancedModeOptions()
379382
.setTask("transcribe")
380383
.setPrompts(java.util.Arrays.asList("Output must be in lexical format."));

0 commit comments

Comments
 (0)