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.

Container for the parameters to the StartCallAnalyticsStreamTranscription operation. Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application. Use this operation for Call Analytics transcriptions.

The following parameters are required:

For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.TranscribeStreaming.AmazonTranscribeStreamingRequest
      Amazon.TranscribeStreaming.Model.StartCallAnalyticsStreamTranscriptionRequest

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

Syntax

C#
public class StartCallAnalyticsStreamTranscriptionRequest : AmazonTranscribeStreamingRequest
         IAmazonWebServiceRequest

The StartCallAnalyticsStreamTranscriptionRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AudioStreamPublisher System.Func<System.Threading.Tasks.Task<Amazon.TranscribeStreaming.Model.IAudioStreamEvent>>

Gets and sets the property AudioStreamPublisher.

An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.

For more information, see Transcribing streaming audio.

The Func set for this property by the consumer of the SDK is used to stream events into the service. Consumers provide a Func that the SDK will continue to call to get events to send. When the consumer is done streaming events to the service the Func can return null to stop the SDK calling the Func for new events. The Func must return an event known by the service which can be identified by implementing the IAudioStreamEvent interface. The known implementatons in the SDK for this interface are: Amazon.TranscribeStreaming.Model.AudioEvent Amazon.TranscribeStreaming.Model.ConfigurationEvent

Public Property ContentIdentificationType Amazon.TranscribeStreaming.ContentIdentificationType

Gets and sets the property ContentIdentificationType.

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment. If you don't include PiiEntityTypes in your request, all PII is identified.

You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information.

Public Property ContentRedactionType Amazon.TranscribeStreaming.ContentRedactionType

Gets and sets the property ContentRedactionType.

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment. If you don't include PiiEntityTypes in your request, all PII is redacted.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information.

Public Property EnablePartialResultsStabilization System.Nullable<System.Boolean>

Gets and sets the property EnablePartialResultsStabilization.

Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization.

Public Property LanguageCode Amazon.TranscribeStreaming.CallAnalyticsLanguageCode

Gets and sets the property LanguageCode.

Specify the language code that represents the language spoken in your audio.

For a list of languages supported with real-time Call Analytics, refer to the Supported languages table.

Public Property LanguageModelName System.String

Gets and sets the property LanguageModelName.

Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.

The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

For more information, see Custom language models.

Public Property MediaEncoding Amazon.TranscribeStreaming.MediaEncoding

Gets and sets the property MediaEncoding.

Specify the encoding of your input audio. Supported formats are:

  • FLAC

  • OPUS-encoded audio in an Ogg container

  • PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see Media formats.

Public Property MediaSampleRateHertz System.Nullable<System.Int32>

Gets and sets the property MediaSampleRateHertz.

The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.

Public Property PartialResultsStability Amazon.TranscribeStreaming.PartialResultsStability

Gets and sets the property PartialResultsStability.

Specify the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).

Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

For more information, see Partial-result stabilization.

Public Property PiiEntityTypes System.String

Gets and sets the property PiiEntityTypes.

Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

Note that if you include PiiEntityTypes in your request, you must also include ContentIdentificationType or ContentRedactionType.

If you include ContentRedactionType or ContentIdentificationType in your request, but do not include PiiEntityTypes, all PII is redacted or identified.

Public Property SessionId System.String

Gets and sets the property SessionId.

Specify a name for your Call Analytics transcription session. If you don't include this parameter in your request, Amazon Transcribe generates an ID and returns it in the response.

Public Property VocabularyFilterMethod Amazon.TranscribeStreaming.VocabularyFilterMethod

Gets and sets the property VocabularyFilterMethod.

Specify how you want your vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

Public Property VocabularyFilterName System.String

Gets and sets the property VocabularyFilterName.

Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.

If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription.

For more information, see Using vocabulary filtering with unwanted words.

Public Property VocabularyName System.String

Gets and sets the property VocabularyName.

Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription.

For more information, see Custom vocabularies.

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