commonMain.aws.sdk.kotlin.services.transcribestreaming.model.CallAnalyticsTranscriptResultStream.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of transcribestreaming-jvm Show documentation
The AWS SDK for Kotlin client for Transcribe Streaming
The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.transcribestreaming.model



/**
 * Contains detailed information about your real-time Call Analytics session. These details are provided in the `UtteranceEvent` and `CategoryEvent` objects.
 */
public sealed class CallAnalyticsTranscriptResultStream {
    /**
     * Provides information on matched categories that were used to generate real-time supervisor alerts.
     */
    public data class CategoryEvent(val value: aws.sdk.kotlin.services.transcribestreaming.model.CategoryEvent) : aws.sdk.kotlin.services.transcribestreaming.model.CallAnalyticsTranscriptResultStream() {
    }

    /**
     * Contains set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to channel definitions, partial result stabilization, sentiment, issue detection, and other transcription-related data.
     */
    public data class UtteranceEvent(val value: aws.sdk.kotlin.services.transcribestreaming.model.UtteranceEvent) : aws.sdk.kotlin.services.transcribestreaming.model.CallAnalyticsTranscriptResultStream() {
    }

    public object SdkUnknown : aws.sdk.kotlin.services.transcribestreaming.model.CallAnalyticsTranscriptResultStream() {
    }

    /**
     * Casts this [CallAnalyticsTranscriptResultStream] as a [CategoryEvent] and retrieves its [aws.sdk.kotlin.services.transcribestreaming.model.CategoryEvent] value. Throws an exception if the [CallAnalyticsTranscriptResultStream] is not a
     * [CategoryEvent].
     */
    public fun asCategoryEvent(): aws.sdk.kotlin.services.transcribestreaming.model.CategoryEvent = (this as CallAnalyticsTranscriptResultStream.CategoryEvent).value

    /**
     * Casts this [CallAnalyticsTranscriptResultStream] as a [CategoryEvent] and retrieves its [aws.sdk.kotlin.services.transcribestreaming.model.CategoryEvent] value. Returns null if the [CallAnalyticsTranscriptResultStream] is not a [CategoryEvent].
     */
    public fun asCategoryEventOrNull(): aws.sdk.kotlin.services.transcribestreaming.model.CategoryEvent? = (this as? CallAnalyticsTranscriptResultStream.CategoryEvent)?.value

    /**
     * Casts this [CallAnalyticsTranscriptResultStream] as a [UtteranceEvent] and retrieves its [aws.sdk.kotlin.services.transcribestreaming.model.UtteranceEvent] value. Throws an exception if the [CallAnalyticsTranscriptResultStream] is not a
     * [UtteranceEvent].
     */
    public fun asUtteranceEvent(): aws.sdk.kotlin.services.transcribestreaming.model.UtteranceEvent = (this as CallAnalyticsTranscriptResultStream.UtteranceEvent).value

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