AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Contains set of transcription results from one or more audio segments, along with additional information about the parameters included in your request. For example, channel definitions, partial result stabilization, sentiment, and issue detection.

Inheritance Hierarchy

System.Object
  Amazon.TranscribeStreaming.Model.UtteranceEvent

Namespace: Amazon.TranscribeStreaming.Model
Assembly: AWSSDK.TranscribeStreaming.dll
Version: 3.x.y.z

Syntax

C#
public class UtteranceEvent
         IEventStreamEvent

The UtteranceEvent type exposes the following members

Constructors

NameDescription
Public Method UtteranceEvent()

Properties

NameTypeDescription
Public Property BeginOffsetMillis System.Nullable<System.Int64>

Gets and sets the property BeginOffsetMillis.

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

Public Property EndOffsetMillis System.Nullable<System.Int64>

Gets and sets the property EndOffsetMillis.

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

Public Property Entities System.Collections.Generic.List<Amazon.TranscribeStreaming.Model.CallAnalyticsEntity>

Gets and sets the property Entities.

Contains entities identified as personally identifiable information (PII) in your transcription output.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property IsPartial System.Nullable<System.Boolean>

Gets and sets the property IsPartial.

Indicates whether the segment in the UtteranceEvent is complete (FALSE) or partial (TRUE).

Public Property IssuesDetected System.Collections.Generic.List<Amazon.TranscribeStreaming.Model.IssueDetected>

Gets and sets the property IssuesDetected.

Provides the issue that was detected in the specified segment.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property Items System.Collections.Generic.List<Amazon.TranscribeStreaming.Model.CallAnalyticsItem>

Gets and sets the property Items.

Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property ParticipantRole Amazon.TranscribeStreaming.ParticipantRole

Gets and sets the property ParticipantRole.

Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.

Public Property Sentiment Amazon.TranscribeStreaming.Sentiment

Gets and sets the property Sentiment.

Provides the sentiment that was detected in the specified segment.

Public Property Transcript System.String

Gets and sets the property Transcript.

Contains transcribed text.

Public Property UtteranceId System.String

Gets and sets the property UtteranceId.

The unique identifier that is associated with the specified UtteranceEvent.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer