Package-level declarations

Types

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
sealed class AudioStream

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

Link copied to clipboard

One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used unsupported values. Check the specified parameters and try your request again.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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).

Link copied to clipboard

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.

Link copied to clipboard

The details for clinical note generation, including status, and output locations for clinical note and aggregated transcript if the analytics completed, or failure reason if the analytics failed.

Link copied to clipboard

The output configuration for aggregated transcript and clinical note generation.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

A new stream started with the same session ID. The current stream has been terminated.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class 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.

Link copied to clipboard

A problem occurred while processing the audio. Amazon Transcribe terminated processing.

Link copied to clipboard

Lists the issues that were identified in your audio segment.

Link copied to clipboard
class 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.

Link copied to clipboard
sealed class ItemType
Link copied to clipboard
sealed class LanguageCode
Link copied to clipboard

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.

Link copied to clipboard

Your client has exceeded one of the Amazon Transcribe limits. This is typically the audio length limit. Break your audio stream into smaller chunks and try your request again.

Link copied to clipboard
sealed class MediaEncoding
Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The Result associated with a ``.

Link copied to clipboard

A wrapper for your audio chunks

Link copied to clipboard

Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set the ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).

Link copied to clipboard

Specify details to configure the streaming session, including channel definitions, encryption settings, post-stream analytics settings, resource access role ARN and vocabulary settings.

Link copied to clipboard

Contains encryption related settings to be used for data encryption with Key Management Service, including KmsEncryptionContext and KmsKeyId. The KmsKeyId is required, while KmsEncryptionContext is optional for additional layer of security.

Link copied to clipboard

An encoded stream of events. The stream is encoded as HTTP/2 data frames.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Contains details for the result of post-stream analytics.

Link copied to clipboard

The settings for post-stream analytics.

Link copied to clipboard

Result stream where you will receive the output events. The details are provided in the MedicalScribeTranscriptEvent object.

Link copied to clipboard

Specify the lifecycle of your streaming session.

Link copied to clipboard

Contains details about a Amazon Web Services HealthScribe streaming session.

Link copied to clipboard
Link copied to clipboard

The event associated with MedicalScribeResultStream.

Link copied to clipboard

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.

Link copied to clipboard

Contains a set of transcription results, along with additional information of the segment.

Link copied to clipboard

The MedicalTranscript associated with a ``.

Link copied to clipboard

The MedicalTranscriptEvent associated with a MedicalTranscriptResultStream.

Link copied to clipboard

Contains detailed information about your streaming session.

Link copied to clipboard
Link copied to clipboard
sealed class ParticipantRole
Link copied to clipboard

Contains the timestamps of matched categories.

Link copied to clipboard

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

Link copied to clipboard

The request references a resource which doesn't exist.

Link copied to clipboard
class Result

The Result associated with a ``.

Link copied to clipboard
sealed class Sentiment
Link copied to clipboard

The service is currently unavailable. Try your request later.

Link copied to clipboard
sealed class Specialty
Link copied to clipboard

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

Link copied to clipboard

Base class for all service related exceptions thrown by the TranscribeStreaming client

Link copied to clipboard

The Transcript associated with a ``.

Link copied to clipboard

The TranscriptEvent associated with a TranscriptResultStream.

Link copied to clipboard

Contains detailed information about your streaming session.

Link copied to clipboard
sealed class Type
Link copied to clipboard

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.

Link copied to clipboard