Package com.microsoft.semantickernel.services.audio

Class AudioToTextExecutionSettings.Builder

  • Enclosing class:
    AudioToTextExecutionSettings
    public static class AudioToTextExecutionSettings.Builder
extends Object
    Represents a builder for audio to text execution settings.

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • withDeploymentName

        public AudioToTextExecutionSettings.Builder withDeploymentName​(String deploymentName)
        Sets the deployment name to use for audio transcription.
        Parameters:
        deploymentName - The deployment name.
        Returns:
        The builder.

      • withFilename

        public AudioToTextExecutionSettings.Builder withFilename​(String filename)
        Sets the filename or descriptive identifier to associate with the audio data.
        Parameters:
        filename - The filename or descriptive identifier.
        Returns:
        The builder.

      • withResponseFormat

        public AudioToTextExecutionSettings.Builder withResponseFormat​(String responseFormat)
        The requested format of the transcription response data, which will influence the content and detail of the result.
        Parameters:
        responseFormat - The response format. Supported formats are json, text, srt, verbose_json, or vtt. Default is 'json'.
        Returns:
        The builder.

      • withLanguage

        public AudioToTextExecutionSettings.Builder withLanguage​(String language)
        The language of the audio data as two-letter ISO-639-1 language code (e.g. 'en' or 'es').
        Parameters:
        language - The language of the audio data.
        Returns:
        The builder.

      • withPrompt

        public AudioToTextExecutionSettings.Builder withPrompt​(String prompt)
        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.
        Returns:
        The builder.

      • withTemperature

        public AudioToTextExecutionSettings.Builder withTemperature​(Double temperature)
        The randomness of the generated text. Select a value from 0.0 to 1.0. 0 is the default.
        Parameters:
        temperature - The temperature.
        Returns:
        The builder.

      • build

        public AudioToTextExecutionSettings build()
        Builds the audio to text execution settings.
        Returns:
        The audio to text execution settings.