Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon Transcribe Streaming Service can respond with.

Structs

Alternative

A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.

AudioEvent

A wrapper for your audio chunks. Your audio stream consists of one or more audio events, which consist of one or more audio chunks.

For more information, see Event stream encoding.

CallAnalyticsEntity

Contains entities identified as personally identifiable information (PII) in your transcription output, along with various associated attributes. Examples include category, confidence score, content, type, and start and end times.

CallAnalyticsItem

A word, phrase, or punctuation mark in your Call Analytics transcription output, along with various associated attributes, such as confidence score, type, and start and end times.

CategoryEvent

Provides information on any TranscriptFilterType categories that matched your transcription output. Matches are identified for each segment upon completion of that segment.

ChannelDefinition

Makes it possible to specify which speaker is on which audio channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

CharacterOffsets

Provides the location, using character count, in your transcript where a match is identified. For example, the location of an issue or a category match within a segment.

ConfigurationEvent

Allows you to set audio channel definitions and post-call analytics settings.

Entity

Contains entities identified as personally identifiable information (PII) in your transcription output, along with various associated attributes. Examples include category, confidence score, type, stability score, and start and end times.

IssueDetected

Lists the issues that were identified in your audio segment.

Item

A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as confidence score, type, and start and end times.

LanguageWithScore

The language code that represents the language identified in your audio, including the associated confidence score. If you enabled channel identification in your request and each channel contained a different language, you will have more than one LanguageWithScore result.

MedicalAlternative

A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.

MedicalEntity

Contains entities identified as personal health information (PHI) in your transcription output, along with various associated attributes. Examples include category, confidence score, type, stability score, and start and end times.

MedicalItem

A word, phrase, or punctuation mark in your transcription output, along with various associated attributes, such as confidence score, type, and start and end times.

MedicalResult

The Result associated with a .

Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.

MedicalTranscript

The MedicalTranscript associated with a .

MedicalTranscript contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.

MedicalTranscriptEvent

The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream.

Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.

PointsOfInterest

Contains the timestamps of matched categories.

PostCallAnalyticsSettings

Allows you to specify additional settings for your streaming Call Analytics post-call request, including output locations for your redacted and unredacted transcript, which IAM role to use, and, optionally, which encryption key to use.

ContentRedactionOutput, DataAccessRoleArn, and OutputLocation are required fields.

Result

The Result associated with a .

Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. This can include information relating to alternative transcriptions, channel identification, partial result stabilization, language identification, and other transcription-related data.

TimestampRange

Contains the timestamp range (start time through end time) of a matched category.

Transcript

The Transcript associated with a .

Transcript contains Results, which contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.

TranscriptEvent

The TranscriptEvent associated with a TranscriptResultStream.

Contains a set of transcription results from one or more audio segments, along with additional information per your request parameters.

UtteranceEvent

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.

Enums

AudioStream

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.

CallAnalyticsLanguageCode

When writing a match expression against CallAnalyticsLanguageCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CallAnalyticsTranscriptResultStream

Contains detailed information about your Call Analytics streaming session. These details are provided in the UtteranceEvent and CategoryEvent objects.

ContentIdentificationType

When writing a match expression against ContentIdentificationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContentRedactionOutput

When writing a match expression against ContentRedactionOutput, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContentRedactionType

When writing a match expression against ContentRedactionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ItemType

When writing a match expression against ItemType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

LanguageCode

When writing a match expression against LanguageCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MediaEncoding

When writing a match expression against MediaEncoding, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MedicalContentIdentificationType

When writing a match expression against MedicalContentIdentificationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MedicalTranscriptResultStream

Contains detailed information about your streaming session.

PartialResultsStability

When writing a match expression against PartialResultsStability, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ParticipantRole

When writing a match expression against ParticipantRole, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Sentiment

When writing a match expression against Sentiment, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Specialty

When writing a match expression against Specialty, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TranscriptResultStream

Contains detailed information about your streaming session.

Type

When writing a match expression against Type, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VocabularyFilterMethod

When writing a match expression against VocabularyFilterMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.