LanguageModel ¶

class LanguageModel(TypedDict, closed=True):
    model_name: NotRequired["capo_transcribe.types.model_name.ModelName"]
    """<p>A unique name, chosen by you, for your custom language model.</p> <p>This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.</p>"""
    create_time: NotRequired["capo_transcribe.types.date_time.DateTime"]
    """<p>The date and time the specified custom language model was created.</p> <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May 4, 2022.</p>"""
    last_modified_time: NotRequired["capo_transcribe.types.date_time.DateTime"]
    """<p>The date and time the specified custom language model was last modified.</p> <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May 4, 2022.</p>"""
    language_code: NotRequired[
        "capo_transcribe.types.clm_language_code.CLMLanguageCode"
    ]
    """<p>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.</p> <p>For a list of supported languages and their associated language codes, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that US English (<code>en-US</code>) is the only language supported with Amazon Transcribe Medical.</p>"""
    base_model_name: NotRequired["capo_transcribe.types.base_model_name.BaseModelName"]
    """<p>The Amazon Transcribe standard language model, or base model, used to create your custom language model.</p>"""
    model_status: NotRequired["capo_transcribe.types.model_status.ModelStatus"]
    """<p>The status of the specified custom language model. When the status displays as <code>COMPLETED</code> the model is ready for use.</p>"""
    upgrade_availability: NotRequired["capo_transcribe.types.boolean.Boolean"]
    """<p>Shows if a more current base model is available for use with the specified custom language model.</p> <p>If <code>false</code>, your custom language model is using the most up-to-date base model.</p> <p>If <code>true</code>, there is a newer base model available than the one your language model is using.</p> <p>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.</p>"""
    failure_reason: NotRequired["capo_transcribe.types.failure_reason.FailureReason"]
    """<p>If <code>ModelStatus</code> is <code>FAILED</code>, <code>FailureReason</code> contains information about why the custom language model request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>"""
    input_data_config: NotRequired[
        "capo_transcribe.types.input_data_config.InputDataConfig"
    ]
    """<p>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.</p>"""
    encryption_configuration: NotRequired[
        "capo_transcribe.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>The encryption configuration used for your custom language model.</p>"""