Share via

AudioTranslationOptions Class

  • Reference
Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.12
  • java.lang.Object
    • com.azure.ai.openai.models.AudioTranslationOptions

public final class AudioTranslationOptions

The configuration information for an audio translation request.

Constructor Summary

Constructor Description
AudioTranslationOptions(byte[] file)

Creates an instance of AudioTranslationOptions class.

Method Summary

Modifier and Type Method and Description
byte[] getFile()

Get the file property: The audio data to translate.
String getFilename()

Get the filename property: The optional filename or descriptive identifier to associate with with the audio data.
String getModel()

Get the model property: The model to use for this translation request.
String getPrompt()

Get the prompt property: An optional hint to guide the model's style or continue from a prior audio segment.
AudioTranslationFormat getResponseFormat()

Get the responseFormat property: The requested format of the translation response data, which will influence the content and detail of the result.
Double getTemperature()

Get the temperature property: The sampling temperature, between 0 and 1.
AudioTranslationOptions setFilename(String filename)

Set the filename property: The optional filename or descriptive identifier to associate with with the audio data.
AudioTranslationOptions setModel(String model)

Set the model property: The model to use for this translation request.
AudioTranslationOptions setPrompt(String prompt)

Set the prompt property: An optional hint to guide the model's style or continue from a prior audio segment.
AudioTranslationOptions setResponseFormat(AudioTranslationFormat responseFormat)

Set the responseFormat property: The requested format of the translation response data, which will influence the content and detail of the result.
AudioTranslationOptions setTemperature(Double temperature)

Set the temperature property: The sampling temperature, between 0 and 1.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AudioTranslationOptions

public AudioTranslationOptions(byte[] file)

Creates an instance of AudioTranslationOptions class.

Parameters:

file - the file value to set.

Method Details

getFile

public byte[] getFile()

Get the file property: The audio data to translate. This must be the binary content of a file in one of the supported media formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm.

Returns:

the file value.

getFilename

public String getFilename()

Get the filename property: The optional filename or descriptive identifier to associate with with the audio data.

Returns:

the filename value.

getModel

public String getModel()

Get the model property: The model to use for this translation request.

Returns:

the model value.

getPrompt

public String getPrompt()

Get the prompt property: An optional hint to guide the model's style or continue from a prior audio segment. The written language of the prompt should match the primary spoken language of the audio data.

Returns:

the prompt value.

getResponseFormat

public AudioTranslationFormat getResponseFormat()

Get the responseFormat property: The requested format of the translation response data, which will influence the content and detail of the result.

Returns:

the responseFormat value.

getTemperature

public Double getTemperature()

Get the temperature property: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.

Returns:

the temperature value.

setFilename

public AudioTranslationOptions setFilename(String filename)

Set the filename property: The optional filename or descriptive identifier to associate with with the audio data.

Parameters:

filename - the filename value to set.

Returns:

the AudioTranslationOptions object itself.

setModel

public AudioTranslationOptions setModel(String model)

Set the model property: The model to use for this translation request.

Parameters:

model - the model value to set.

Returns:

the AudioTranslationOptions object itself.

setPrompt

public AudioTranslationOptions setPrompt(String prompt)

Set the prompt property: An optional hint to guide the model's style or continue from a prior audio segment. The written language of the prompt should match the primary spoken language of the audio data.

Parameters:

prompt - the prompt value to set.

Returns:

the AudioTranslationOptions object itself.

setResponseFormat

public AudioTranslationOptions setResponseFormat(AudioTranslationFormat responseFormat)

Set the responseFormat property: The requested format of the translation response data, which will influence the content and detail of the result.

Parameters:

responseFormat - the responseFormat value to set.

Returns:

the AudioTranslationOptions object itself.

setTemperature

public AudioTranslationOptions setTemperature(Double temperature)

Set the temperature property: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.

Parameters:

temperature - the temperature value to set.

Returns:

the AudioTranslationOptions object itself.

Applies to