commonMain.aws.sdk.kotlin.services.transcribe.model.Rule.kt Maven / Gradle / Ivy

Go to download
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.transcribe.model



/**
 * A rule is a set of criteria that you can specify to flag an attribute in your Call Analytics output. Rules define a Call Analytics category.
 *
 * Rules can include these parameters: , , , and .
 *
 * To learn more about Call Analytics rules and categories, see [Creating categories for post-call transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html) and [Creating categories for real-time transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html).
 *
 * To learn more about Call Analytics, see [Analyzing call center audio with Call Analytics](https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html).
 */
public sealed class Rule {
    /**
     * Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to for more detail.
     */
    public data class InterruptionFilter(val value: aws.sdk.kotlin.services.transcribe.model.InterruptionFilter) : aws.sdk.kotlin.services.transcribe.model.Rule() {
    }

    /**
     * Flag the presence or absence of periods of silence in your Call Analytics transcription output. Refer to for more detail.
     */
    public data class NonTalkTimeFilter(val value: aws.sdk.kotlin.services.transcribe.model.NonTalkTimeFilter) : aws.sdk.kotlin.services.transcribe.model.Rule() {
    }

    /**
     * Flag the presence or absence of specific sentiments in your Call Analytics transcription output. Refer to for more detail.
     */
    public data class SentimentFilter(val value: aws.sdk.kotlin.services.transcribe.model.SentimentFilter) : aws.sdk.kotlin.services.transcribe.model.Rule() {
    }

    /**
     * Flag the presence or absence of specific words or phrases in your Call Analytics transcription output. Refer to for more detail.
     */
    public data class TranscriptFilter(val value: aws.sdk.kotlin.services.transcribe.model.TranscriptFilter) : aws.sdk.kotlin.services.transcribe.model.Rule() {
    }

    public object SdkUnknown : aws.sdk.kotlin.services.transcribe.model.Rule() {
    }

    /**
     * Casts this [Rule] as a [InterruptionFilter] and retrieves its [aws.sdk.kotlin.services.transcribe.model.InterruptionFilter] value. Throws an exception if the [Rule] is not a
     * [InterruptionFilter].
     */
    public fun asInterruptionFilter(): aws.sdk.kotlin.services.transcribe.model.InterruptionFilter = (this as Rule.InterruptionFilter).value

    /**
     * Casts this [Rule] as a [InterruptionFilter] and retrieves its [aws.sdk.kotlin.services.transcribe.model.InterruptionFilter] value. Returns null if the [Rule] is not a [InterruptionFilter].
     */
    public fun asInterruptionFilterOrNull(): aws.sdk.kotlin.services.transcribe.model.InterruptionFilter? = (this as? Rule.InterruptionFilter)?.value

    /**
     * Casts this [Rule] as a [NonTalkTimeFilter] and retrieves its [aws.sdk.kotlin.services.transcribe.model.NonTalkTimeFilter] value. Throws an exception if the [Rule] is not a
     * [NonTalkTimeFilter].
     */
    public fun asNonTalkTimeFilter(): aws.sdk.kotlin.services.transcribe.model.NonTalkTimeFilter = (this as Rule.NonTalkTimeFilter).value

    /**
     * Casts this [Rule] as a [NonTalkTimeFilter] and retrieves its [aws.sdk.kotlin.services.transcribe.model.NonTalkTimeFilter] value. Returns null if the [Rule] is not a [NonTalkTimeFilter].
     */
    public fun asNonTalkTimeFilterOrNull(): aws.sdk.kotlin.services.transcribe.model.NonTalkTimeFilter? = (this as? Rule.NonTalkTimeFilter)?.value

    /**
     * Casts this [Rule] as a [SentimentFilter] and retrieves its [aws.sdk.kotlin.services.transcribe.model.SentimentFilter] value. Throws an exception if the [Rule] is not a
     * [SentimentFilter].
     */
    public fun asSentimentFilter(): aws.sdk.kotlin.services.transcribe.model.SentimentFilter = (this as Rule.SentimentFilter).value

    /**
     * Casts this [Rule] as a [SentimentFilter] and retrieves its [aws.sdk.kotlin.services.transcribe.model.SentimentFilter] value. Returns null if the [Rule] is not a [SentimentFilter].
     */
    public fun asSentimentFilterOrNull(): aws.sdk.kotlin.services.transcribe.model.SentimentFilter? = (this as? Rule.SentimentFilter)?.value

    /**
     * Casts this [Rule] as a [TranscriptFilter] and retrieves its [aws.sdk.kotlin.services.transcribe.model.TranscriptFilter] value. Throws an exception if the [Rule] is not a
     * [TranscriptFilter].
     */
    public fun asTranscriptFilter(): aws.sdk.kotlin.services.transcribe.model.TranscriptFilter = (this as Rule.TranscriptFilter).value

    /**
     * Casts this [Rule] as a [TranscriptFilter] and retrieves its [aws.sdk.kotlin.services.transcribe.model.TranscriptFilter] value. Returns null if the [Rule] is not a [TranscriptFilter].
     */
    public fun asTranscriptFilterOrNull(): aws.sdk.kotlin.services.transcribe.model.TranscriptFilter? = (this as? Rule.TranscriptFilter)?.value
}