/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace TranscribeService { namespace Model { /** *

Provides information about a custom language model, including:

  • *

    The base model name

  • When the model was created

  • *
  • The location of the files used to train the model

  • When * the model was last modified

  • The name you chose for the * model

  • The model's language

  • The model's * processing state

  • Any available upgrades for the base model

    *

See Also:

AWS * API Reference

*/ class LanguageModel { public: AWS_TRANSCRIBESERVICE_API LanguageModel(); AWS_TRANSCRIBESERVICE_API LanguageModel(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSCRIBESERVICE_API LanguageModel& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSCRIBESERVICE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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.

*/ inline const Aws::String& GetModelName() const{ return m_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.

*/ inline bool ModelNameHasBeenSet() const { return m_modelNameHasBeenSet; } /** *

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.

*/ inline void SetModelName(const Aws::String& value) { m_modelNameHasBeenSet = true; m_modelName = value; } /** *

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.

*/ inline void SetModelName(Aws::String&& value) { m_modelNameHasBeenSet = true; m_modelName = std::move(value); } /** *

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.

*/ inline void SetModelName(const char* value) { m_modelNameHasBeenSet = true; m_modelName.assign(value); } /** *

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.

*/ inline LanguageModel& WithModelName(const Aws::String& value) { SetModelName(value); return *this;} /** *

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.

*/ inline LanguageModel& WithModelName(Aws::String&& value) { SetModelName(std::move(value)); return *this;} /** *

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.

*/ inline LanguageModel& WithModelName(const char* value) { SetModelName(value); return *this;} /** *

The date and time the specified custom language model was created.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline const Aws::Utils::DateTime& GetCreateTime() const{ return m_createTime; } /** *

The date and time the specified custom language model was created.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline bool CreateTimeHasBeenSet() const { return m_createTimeHasBeenSet; } /** *

The date and time the specified custom language model was created.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline void SetCreateTime(const Aws::Utils::DateTime& value) { m_createTimeHasBeenSet = true; m_createTime = value; } /** *

The date and time the specified custom language model was created.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline void SetCreateTime(Aws::Utils::DateTime&& value) { m_createTimeHasBeenSet = true; m_createTime = std::move(value); } /** *

The date and time the specified custom language model was created.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline LanguageModel& WithCreateTime(const Aws::Utils::DateTime& value) { SetCreateTime(value); return *this;} /** *

The date and time the specified custom language model was created.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline LanguageModel& WithCreateTime(Aws::Utils::DateTime&& value) { SetCreateTime(std::move(value)); return *this;} /** *

The date and time the specified custom language model was last modified.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline const Aws::Utils::DateTime& GetLastModifiedTime() const{ return m_lastModifiedTime; } /** *

The date and time the specified custom language model was last modified.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline bool LastModifiedTimeHasBeenSet() const { return m_lastModifiedTimeHasBeenSet; } /** *

The date and time the specified custom language model was last modified.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline void SetLastModifiedTime(const Aws::Utils::DateTime& value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = value; } /** *

The date and time the specified custom language model was last modified.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline void SetLastModifiedTime(Aws::Utils::DateTime&& value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = std::move(value); } /** *

The date and time the specified custom language model was last modified.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline LanguageModel& WithLastModifiedTime(const Aws::Utils::DateTime& value) { SetLastModifiedTime(value); return *this;} /** *

The date and time the specified custom language model was last modified.

*

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. * For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM * UTC-7 on May 4, 2022.

*/ inline LanguageModel& WithLastModifiedTime(Aws::Utils::DateTime&& value) { SetLastModifiedTime(std::move(value)); return *this;} /** *

The language code used to create your custom language 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 U.S. English (en-US) is the only * language supported with Amazon Transcribe Medical.

*/ inline const CLMLanguageCode& GetLanguageCode() const{ return m_languageCode; } /** *

The language code used to create your custom language 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 U.S. English (en-US) is the only * language supported with Amazon Transcribe Medical.

*/ inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; } /** *

The language code used to create your custom language 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 U.S. English (en-US) is the only * language supported with Amazon Transcribe Medical.

*/ inline void SetLanguageCode(const CLMLanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; } /** *

The language code used to create your custom language 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 U.S. English (en-US) is the only * language supported with Amazon Transcribe Medical.

*/ inline void SetLanguageCode(CLMLanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); } /** *

The language code used to create your custom language 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 U.S. English (en-US) is the only * language supported with Amazon Transcribe Medical.

*/ inline LanguageModel& WithLanguageCode(const CLMLanguageCode& value) { SetLanguageCode(value); return *this;} /** *

The language code used to create your custom language 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 U.S. English (en-US) is the only * language supported with Amazon Transcribe Medical.

*/ inline LanguageModel& WithLanguageCode(CLMLanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;} /** *

The Amazon Transcribe standard language model, or base model, used to create * your custom language model.

*/ inline const BaseModelName& GetBaseModelName() const{ return m_baseModelName; } /** *

The Amazon Transcribe standard language model, or base model, used to create * your custom language model.

*/ inline bool BaseModelNameHasBeenSet() const { return m_baseModelNameHasBeenSet; } /** *

The Amazon Transcribe standard language model, or base model, used to create * your custom language model.

*/ inline void SetBaseModelName(const BaseModelName& value) { m_baseModelNameHasBeenSet = true; m_baseModelName = value; } /** *

The Amazon Transcribe standard language model, or base model, used to create * your custom language model.

*/ inline void SetBaseModelName(BaseModelName&& value) { m_baseModelNameHasBeenSet = true; m_baseModelName = std::move(value); } /** *

The Amazon Transcribe standard language model, or base model, used to create * your custom language model.

*/ inline LanguageModel& WithBaseModelName(const BaseModelName& value) { SetBaseModelName(value); return *this;} /** *

The Amazon Transcribe standard language model, or base model, used to create * your custom language model.

*/ inline LanguageModel& WithBaseModelName(BaseModelName&& value) { SetBaseModelName(std::move(value)); return *this;} /** *

The status of the specified custom language model. When the status displays * as COMPLETED the model is ready for use.

*/ inline const ModelStatus& GetModelStatus() const{ return m_modelStatus; } /** *

The status of the specified custom language model. When the status displays * as COMPLETED the model is ready for use.

*/ inline bool ModelStatusHasBeenSet() const { return m_modelStatusHasBeenSet; } /** *

The status of the specified custom language model. When the status displays * as COMPLETED the model is ready for use.

*/ inline void SetModelStatus(const ModelStatus& value) { m_modelStatusHasBeenSet = true; m_modelStatus = value; } /** *

The status of the specified custom language model. When the status displays * as COMPLETED the model is ready for use.

*/ inline void SetModelStatus(ModelStatus&& value) { m_modelStatusHasBeenSet = true; m_modelStatus = std::move(value); } /** *

The status of the specified custom language model. When the status displays * as COMPLETED the model is ready for use.

*/ inline LanguageModel& WithModelStatus(const ModelStatus& value) { SetModelStatus(value); return *this;} /** *

The status of the specified custom language model. When the status displays * as COMPLETED the model is ready for use.

*/ inline LanguageModel& WithModelStatus(ModelStatus&& value) { SetModelStatus(std::move(value)); return *this;} /** *

Shows if a more current base model is available for use with the specified * custom language model.

If false, your custom language model * is using the most up-to-date base model.

If true, there is a * newer base model available than the one your language model is using.

*

Note that to update a base model, you must recreate the custom language model * using the new base model. Base model upgrades for existing custom language * models are not supported.

*/ inline bool GetUpgradeAvailability() const{ return m_upgradeAvailability; } /** *

Shows if a more current base model is available for use with the specified * custom language model.

If false, your custom language model * is using the most up-to-date base model.

If true, there is a * newer base model available than the one your language model is using.

*

Note that to update a base model, you must recreate the custom language model * using the new base model. Base model upgrades for existing custom language * models are not supported.

*/ inline bool UpgradeAvailabilityHasBeenSet() const { return m_upgradeAvailabilityHasBeenSet; } /** *

Shows if a more current base model is available for use with the specified * custom language model.

If false, your custom language model * is using the most up-to-date base model.

If true, there is a * newer base model available than the one your language model is using.

*

Note that to update a base model, you must recreate the custom language model * using the new base model. Base model upgrades for existing custom language * models are not supported.

*/ inline void SetUpgradeAvailability(bool value) { m_upgradeAvailabilityHasBeenSet = true; m_upgradeAvailability = value; } /** *

Shows if a more current base model is available for use with the specified * custom language model.

If false, your custom language model * is using the most up-to-date base model.

If true, there is a * newer base model available than the one your language model is using.

*

Note that to update a base model, you must recreate the custom language model * using the new base model. Base model upgrades for existing custom language * models are not supported.

*/ inline LanguageModel& WithUpgradeAvailability(bool value) { SetUpgradeAvailability(value); return *this;} /** *

If ModelStatus is FAILED, * FailureReason contains information about why the custom language * model request failed. See also: Common * Errors.

*/ inline const Aws::String& GetFailureReason() const{ return m_failureReason; } /** *

If ModelStatus is FAILED, * FailureReason contains information about why the custom language * model request failed. See also: Common * Errors.

*/ inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; } /** *

If ModelStatus is FAILED, * FailureReason contains information about why the custom language * model request failed. See also: Common * Errors.

*/ inline void SetFailureReason(const Aws::String& value) { m_failureReasonHasBeenSet = true; m_failureReason = value; } /** *

If ModelStatus is FAILED, * FailureReason contains information about why the custom language * model request failed. See also: Common * Errors.

*/ inline void SetFailureReason(Aws::String&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::move(value); } /** *

If ModelStatus is FAILED, * FailureReason contains information about why the custom language * model request failed. See also: Common * Errors.

*/ inline void SetFailureReason(const char* value) { m_failureReasonHasBeenSet = true; m_failureReason.assign(value); } /** *

If ModelStatus is FAILED, * FailureReason contains information about why the custom language * model request failed. See also: Common * Errors.

*/ inline LanguageModel& WithFailureReason(const Aws::String& value) { SetFailureReason(value); return *this;} /** *

If ModelStatus is FAILED, * FailureReason contains information about why the custom language * model request failed. See also: Common * Errors.

*/ inline LanguageModel& WithFailureReason(Aws::String&& value) { SetFailureReason(std::move(value)); return *this;} /** *

If ModelStatus is FAILED, * FailureReason contains information about why the custom language * model request failed. See also: Common * Errors.

*/ inline LanguageModel& WithFailureReason(const char* value) { SetFailureReason(value); return *this;} /** *

The Amazon S3 location of the input files used to train and tune your custom * language model, in addition to the data access role ARN (Amazon Resource Name) * that has permissions to access these data.

*/ inline const InputDataConfig& GetInputDataConfig() const{ return m_inputDataConfig; } /** *

The Amazon S3 location of the input files used to train and tune your custom * language model, in addition to the data access role ARN (Amazon Resource Name) * that has permissions to access these data.

*/ inline bool InputDataConfigHasBeenSet() const { return m_inputDataConfigHasBeenSet; } /** *

The Amazon S3 location of the input files used to train and tune your custom * language model, in addition to the data access role ARN (Amazon Resource Name) * that has permissions to access these data.

*/ inline void SetInputDataConfig(const InputDataConfig& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = value; } /** *

The Amazon S3 location of the input files used to train and tune your custom * language model, in addition to the data access role ARN (Amazon Resource Name) * that has permissions to access these data.

*/ inline void SetInputDataConfig(InputDataConfig&& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = std::move(value); } /** *

The Amazon S3 location of the input files used to train and tune your custom * language model, in addition to the data access role ARN (Amazon Resource Name) * that has permissions to access these data.

*/ inline LanguageModel& WithInputDataConfig(const InputDataConfig& value) { SetInputDataConfig(value); return *this;} /** *

The Amazon S3 location of the input files used to train and tune your custom * language model, in addition to the data access role ARN (Amazon Resource Name) * that has permissions to access these data.

*/ inline LanguageModel& WithInputDataConfig(InputDataConfig&& value) { SetInputDataConfig(std::move(value)); return *this;} private: Aws::String m_modelName; bool m_modelNameHasBeenSet = false; Aws::Utils::DateTime m_createTime; bool m_createTimeHasBeenSet = false; Aws::Utils::DateTime m_lastModifiedTime; bool m_lastModifiedTimeHasBeenSet = false; CLMLanguageCode m_languageCode; bool m_languageCodeHasBeenSet = false; BaseModelName m_baseModelName; bool m_baseModelNameHasBeenSet = false; ModelStatus m_modelStatus; bool m_modelStatusHasBeenSet = false; bool m_upgradeAvailability; bool m_upgradeAvailabilityHasBeenSet = false; Aws::String m_failureReason; bool m_failureReasonHasBeenSet = false; InputDataConfig m_inputDataConfig; bool m_inputDataConfigHasBeenSet = false; }; } // namespace Model } // namespace TranscribeService } // namespace Aws