AWSTranscribeLanguageModel

Objective-C

@interface AWSTranscribeLanguageModel

Swift

class AWSTranscribeLanguageModel

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

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

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeBaseModelName baseModelName;

    Swift

    var baseModelName: AWSTranscribeBaseModelName { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable createTime;

    Swift

    var createTime: Date? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable failureReason;

    Swift

    var failureReason: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTranscribeInputDataConfig *_Nullable inputDataConfig;

    Swift

    var inputDataConfig: AWSTranscribeInputDataConfig? { get set }

  • 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 US English (en-US) is the only language supported with Amazon Transcribe Medical.

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeCLMLanguageCode languageCode;

    Swift

    var languageCode: AWSTranscribeCLMLanguageCode { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable lastModifiedTime;

    Swift

    var lastModifiedTime: Date? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable modelName;

    Swift

    var modelName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSTranscribeModelStatus modelStatus;

    Swift

    var modelStatus: AWSTranscribeModelStatus { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable upgradeAvailability;

    Swift

    var upgradeAvailability: NSNumber? { get set }