Package software.amazon.awssdk.services.transcribe.model

Interface CreateLanguageModelRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateLanguageModelRequest.Builder,CreateLanguageModelRequest>, SdkBuilder<CreateLanguageModelRequest.Builder,CreateLanguageModelRequest>, SdkPojo, SdkRequest.Builder, TranscribeRequest.Builder
Enclosing class:
CreateLanguageModelRequest
public static interface CreateLanguageModelRequest.Builder extends TranscribeRequest.Builder, SdkPojo, CopyableBuilder<CreateLanguageModelRequest.Builder,CreateLanguageModelRequest>

  • Method Details

    • languageCode

      CreateLanguageModelRequest.Builder languageCode(String languageCode)

      The language code that represents the language of your model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

      For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.

      A custom language model can only be used to transcribe files in the same language as the model. For example, if you create a custom language model using US English (en-US), you can only apply this model to files that contain English audio.

      Parameters:
      languageCode - The language code that represents the language of your model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

      For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.

      A custom language model can only be used to transcribe files in the same language as the model. For example, if you create a custom language model using US English (en-US), you can only apply this model to files that contain English audio.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      CreateLanguageModelRequest.Builder languageCode(CLMLanguageCode languageCode)

      The language code that represents the language of your model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

      For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.

      A custom language model can only be used to transcribe files in the same language as the model. For example, if you create a custom language model using US English (en-US), you can only apply this model to files that contain English audio.

      Parameters:
      languageCode - The language code that represents the language of your model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data.

      For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.

      A custom language model can only be used to transcribe files in the same language as the model. For example, if you create a custom language model using US English (en-US), you can only apply this model to files that contain English audio.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • baseModelName

      CreateLanguageModelRequest.Builder baseModelName(String baseModelName)

      The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.

      If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.

      Parameters:
      baseModelName - The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.

      If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • baseModelName

      CreateLanguageModelRequest.Builder baseModelName(BaseModelName baseModelName)

      The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.

      If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.

      Parameters:
      baseModelName - The Amazon Transcribe standard language model, or base model, used to create your custom language model. Amazon Transcribe offers two options for base models: Wideband and Narrowband.

      If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose NarrowBand.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • modelName

      CreateLanguageModelRequest.Builder modelName(String modelName)

      A unique name, chosen by you, for your custom language model.

      This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom language model with the same name as an existing custom language model, you get a ConflictException error.

      Parameters:
      modelName - A unique name, chosen by you, for your custom language model.

      This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom language model with the same name as an existing custom language model, you get a ConflictException error.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      CreateLanguageModelRequest.Builder inputDataConfig(InputDataConfig inputDataConfig)

      Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.

      When using InputDataConfig, you must include these sub-parameters: S3Uri, which is the Amazon S3 location of your training data, and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role that has permission to access your specified Amazon S3 location. You can optionally include TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If you specify different Amazon S3 locations for training and tuning data, the ARN you use must have permissions to access both locations.

      Parameters:
      inputDataConfig - Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.

      When using InputDataConfig, you must include these sub-parameters: S3Uri, which is the Amazon S3 location of your training data, and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role that has permission to access your specified Amazon S3 location. You can optionally include TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If you specify different Amazon S3 locations for training and tuning data, the ARN you use must have permissions to access both locations.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      default CreateLanguageModelRequest.Builder inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig)

      Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.

      When using InputDataConfig, you must include these sub-parameters: S3Uri, which is the Amazon S3 location of your training data, and DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role that has permission to access your specified Amazon S3 location. You can optionally include TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If you specify different Amazon S3 locations for training and tuning data, the ARN you use must have permissions to access both locations.

      This is a convenience method that creates an instance of the InputDataConfig.Builder avoiding the need to create one manually via InputDataConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputDataConfig(InputDataConfig).

      Parameters:
      inputDataConfig - a consumer that will call methods on InputDataConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateLanguageModelRequest.Builder tags(Collection<Tag> tags)

      Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.

      To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

      Parameters:
      tags - Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.

      To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLanguageModelRequest.Builder tags(Tag... tags)

      Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.

      To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

      Parameters:
      tags - Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.

      To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLanguageModelRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Adds one or more custom tags, each in the form of a key:value pair, to a new custom language model at the time you create this new model.

      To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateLanguageModelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateLanguageModelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.