transcribe/aws.sdk.kotlin.services.transcribe.model

Package-level declarations

Types

A time range, in milliseconds, between two points in your media file.

class BadRequestException : TranscribeException

Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

BaseModelName

sealed class BaseModelName

CallAnalyticsFeature

sealed class CallAnalyticsFeature

CallAnalyticsJob

class CallAnalyticsJob

Provides detailed information about a Call Analytics job.

CallAnalyticsJobDetails

class CallAnalyticsJobDetails

Contains details about a call analytics job, including information about skipped analytics features.

CallAnalyticsJobSettings

class CallAnalyticsJobSettings

Provides additional optional settings for your request, including content redaction, automatic language identification; allows you to apply custom language models, custom vocabulary filters, and custom vocabularies.

CallAnalyticsJobStatus

sealed class CallAnalyticsJobStatus

CallAnalyticsJobSummary

class CallAnalyticsJobSummary

Provides detailed information about a specific Call Analytics job.

CallAnalyticsSkippedFeature

class CallAnalyticsSkippedFeature

Represents a skipped analytics feature during the analysis of a call analytics job.

CallAnalyticsSkippedReasonCode

sealed class CallAnalyticsSkippedReasonCode

CategoryProperties

class CategoryProperties

Provides you with the properties of the Call Analytics category you specified in your request. This includes the list of rules that define the specified category.

ChannelDefinition

class ChannelDefinition

Makes it possible to specify which speaker is on which 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).

ClinicalNoteGenerationSettings

class ClinicalNoteGenerationSettings

The output configuration for clinical note generation.

ClmLanguageCode

sealed class ClmLanguageCode

ConflictException

class ConflictException : TranscribeException

A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.

ContentRedaction

class ContentRedaction

Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact.

CreateCallAnalyticsCategoryRequest

class CreateCallAnalyticsCategoryRequest

CreateCallAnalyticsCategoryResponse

class CreateCallAnalyticsCategoryResponse

CreateLanguageModelRequest

class CreateLanguageModelRequest

CreateLanguageModelResponse

class CreateLanguageModelResponse

CreateMedicalVocabularyRequest

class CreateMedicalVocabularyRequest

CreateMedicalVocabularyResponse

class CreateMedicalVocabularyResponse

CreateVocabularyFilterRequest

class CreateVocabularyFilterRequest

CreateVocabularyFilterResponse

class CreateVocabularyFilterResponse

CreateVocabularyRequest

class CreateVocabularyRequest

CreateVocabularyResponse

class CreateVocabularyResponse

DeleteCallAnalyticsCategoryRequest

class DeleteCallAnalyticsCategoryRequest

DeleteCallAnalyticsCategoryResponse

class DeleteCallAnalyticsCategoryResponse

DeleteCallAnalyticsJobRequest

class DeleteCallAnalyticsJobRequest

DeleteCallAnalyticsJobResponse

class DeleteCallAnalyticsJobResponse

DeleteLanguageModelRequest

class DeleteLanguageModelRequest

DeleteLanguageModelResponse

class DeleteLanguageModelResponse

DeleteMedicalScribeJobRequest

class DeleteMedicalScribeJobRequest

DeleteMedicalScribeJobResponse

class DeleteMedicalScribeJobResponse

DeleteMedicalTranscriptionJobRequest

class DeleteMedicalTranscriptionJobRequest

DeleteMedicalTranscriptionJobResponse

class DeleteMedicalTranscriptionJobResponse

DeleteMedicalVocabularyRequest

class DeleteMedicalVocabularyRequest

DeleteMedicalVocabularyResponse

class DeleteMedicalVocabularyResponse

DeleteTranscriptionJobRequest

class DeleteTranscriptionJobRequest

DeleteTranscriptionJobResponse

class DeleteTranscriptionJobResponse

DeleteVocabularyFilterRequest

class DeleteVocabularyFilterRequest

DeleteVocabularyFilterResponse

class DeleteVocabularyFilterResponse

DeleteVocabularyRequest

class DeleteVocabularyRequest

DeleteVocabularyResponse

class DeleteVocabularyResponse

DescribeLanguageModelRequest

class DescribeLanguageModelRequest

DescribeLanguageModelResponse

class DescribeLanguageModelResponse

GetCallAnalyticsCategoryRequest

class GetCallAnalyticsCategoryRequest

GetCallAnalyticsCategoryResponse

class GetCallAnalyticsCategoryResponse

GetCallAnalyticsJobRequest

class GetCallAnalyticsJobRequest

GetCallAnalyticsJobResponse

class GetCallAnalyticsJobResponse

GetMedicalScribeJobRequest

class GetMedicalScribeJobRequest

GetMedicalScribeJobResponse

class GetMedicalScribeJobResponse

GetMedicalTranscriptionJobRequest

class GetMedicalTranscriptionJobRequest

GetMedicalTranscriptionJobResponse

class GetMedicalTranscriptionJobResponse

GetMedicalVocabularyRequest

class GetMedicalVocabularyRequest

GetMedicalVocabularyResponse

class GetMedicalVocabularyResponse

GetTranscriptionJobRequest

class GetTranscriptionJobRequest

GetTranscriptionJobResponse

class GetTranscriptionJobResponse

GetVocabularyFilterRequest

class GetVocabularyFilterRequest

GetVocabularyFilterResponse

class GetVocabularyFilterResponse

GetVocabularyRequest

class GetVocabularyRequest

GetVocabularyResponse

class GetVocabularyResponse

InputDataConfig

class InputDataConfig

Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.

InputType

sealed class InputType

InternalFailureException

class InternalFailureException : TranscribeException

There was an internal error. Check the error message, correct the issue, and try your request again.

InterruptionFilter

class InterruptionFilter

Flag the presence or absence of interruptions in your Call Analytics transcription output.

JobExecutionSettings

class JobExecutionSettings

Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter.

LanguageCode

sealed class LanguageCode

LanguageCodeItem

class LanguageCodeItem

Provides information on the speech contained in a discreet utterance when multi-language identification is enabled in your request. This utterance represents a block of speech consisting of one language, preceded or followed by a block of speech in a different language.

LanguageIdSettings

class LanguageIdSettings

If using automatic language identification in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). Note that multi-language identification (IdentifyMultipleLanguages) doesn't support custom language models.

LanguageModel

class LanguageModel

Provides information about a custom language model, including:

LimitExceededException

class LimitExceededException : TranscribeException

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

ListCallAnalyticsCategoriesRequest

class ListCallAnalyticsCategoriesRequest

ListCallAnalyticsCategoriesResponse

class ListCallAnalyticsCategoriesResponse

ListCallAnalyticsJobsRequest

class ListCallAnalyticsJobsRequest

ListCallAnalyticsJobsResponse

class ListCallAnalyticsJobsResponse

ListLanguageModelsRequest

class ListLanguageModelsRequest

ListLanguageModelsResponse

class ListLanguageModelsResponse

ListMedicalScribeJobsRequest

class ListMedicalScribeJobsRequest

ListMedicalScribeJobsResponse

class ListMedicalScribeJobsResponse

ListMedicalTranscriptionJobsRequest

class ListMedicalTranscriptionJobsRequest

ListMedicalTranscriptionJobsResponse

class ListMedicalTranscriptionJobsResponse

ListMedicalVocabulariesRequest

class ListMedicalVocabulariesRequest

ListMedicalVocabulariesResponse

class ListMedicalVocabulariesResponse

ListTagsForResourceRequest

class ListTagsForResourceRequest

ListTagsForResourceResponse

class ListTagsForResourceResponse

ListTranscriptionJobsRequest

class ListTranscriptionJobsRequest

ListTranscriptionJobsResponse

class ListTranscriptionJobsResponse

ListVocabulariesRequest

class ListVocabulariesRequest

ListVocabulariesResponse

class ListVocabulariesResponse

ListVocabularyFiltersRequest

class ListVocabularyFiltersRequest

ListVocabularyFiltersResponse

class ListVocabularyFiltersResponse

Media

class Media

Describes the Amazon S3 location of the media file you want to use in your request.

MediaFormat

sealed class MediaFormat

MedicalContentIdentificationType

sealed class MedicalContentIdentificationType

MedicalScribeChannelDefinition

class MedicalScribeChannelDefinition

Indicates which speaker is on which channel. The options are CLINICIAN and PATIENT

MedicalScribeJob

class MedicalScribeJob

Provides detailed information about a Medical Scribe job.

MedicalScribeJobStatus

sealed class MedicalScribeJobStatus

MedicalScribeJobSummary

class MedicalScribeJobSummary

Provides detailed information about a specific Medical Scribe job.

MedicalScribeLanguageCode

sealed class MedicalScribeLanguageCode

MedicalScribeNoteTemplate

sealed class MedicalScribeNoteTemplate

MedicalScribeOutput

class MedicalScribeOutput

The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

MedicalScribeParticipantRole

sealed class MedicalScribeParticipantRole

MedicalScribeSettings

class MedicalScribeSettings

Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.

MedicalTranscript

class MedicalTranscript

Provides you with the Amazon S3 URI you can use to access your transcript.

MedicalTranscriptionJob

class MedicalTranscriptionJob

Provides detailed information about a medical transcription job.

MedicalTranscriptionJobSummary

class MedicalTranscriptionJobSummary

Provides detailed information about a specific medical transcription job.

MedicalTranscriptionSetting

class MedicalTranscriptionSetting

Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your medical transcription job.

ModelSettings

class ModelSettings

Provides the name of the custom language model that was included in the specified transcription job.

ModelStatus

sealed class ModelStatus

NonTalkTimeFilter

class NonTalkTimeFilter

Flag the presence or absence of periods of silence in your Call Analytics transcription output.

NotFoundException

class NotFoundException : TranscribeException

We can't find the requested resource. Check that the specified name is correct and try your request again.

OutputLocationType

sealed class OutputLocationType

ParticipantRole

sealed class ParticipantRole

PiiEntityType

sealed class PiiEntityType

RedactionOutput

sealed class RedactionOutput

RedactionType

sealed class RedactionType

RelativeTimeRange

class RelativeTimeRange

A time range, in percentage, between two points in your media file.

Rule

sealed class Rule

A rule is a set of criteria that you can specify to flag an attribute in your Call Analytics output. Rules define a Call Analytics category.

SentimentFilter

class SentimentFilter

Flag the presence or absence of specific sentiments detected in your Call Analytics transcription output.

SentimentValue

sealed class SentimentValue

Settings

class Settings

Specialty

sealed class Specialty

StartCallAnalyticsJobRequest

class StartCallAnalyticsJobRequest

StartCallAnalyticsJobResponse

class StartCallAnalyticsJobResponse

StartMedicalScribeJobRequest

class StartMedicalScribeJobRequest

StartMedicalScribeJobResponse

class StartMedicalScribeJobResponse

StartMedicalTranscriptionJobRequest

class StartMedicalTranscriptionJobRequest

StartMedicalTranscriptionJobResponse

class StartMedicalTranscriptionJobResponse

StartTranscriptionJobRequest

class StartTranscriptionJobRequest

StartTranscriptionJobResponse

class StartTranscriptionJobResponse

SubtitleFormat

sealed class SubtitleFormat

Subtitles

class Subtitles

Generate subtitles for your media file with your transcription request.

SubtitlesOutput

class SubtitlesOutput

Provides information about your subtitle file, including format, start index, and Amazon S3 location.

Summarization

class Summarization

Contains GenerateAbstractiveSummary, which is a required parameter if you want to enable Generative call summarization in your Call Analytics request.

Tag

class Tag

Adds metadata, in the form of a key:value pair, to the specified resource.

TagResourceRequest

class TagResourceRequest

TagResourceResponse

class TagResourceResponse

ToxicityCategory

sealed class ToxicityCategory

ToxicityDetectionSettings

class ToxicityDetectionSettings

Contains ToxicityCategories, which is a required parameter if you want to enable toxicity detection (ToxicityDetection) in your transcription request.

TranscribeException

open class TranscribeException : AwsServiceException

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

Transcript

class Transcript

Provides you with the Amazon S3 URI you can use to access your transcript.

TranscriptFilter

class TranscriptFilter

Flag the presence or absence of specific words or phrases detected in your Call Analytics transcription output.

TranscriptFilterType

sealed class TranscriptFilterType

TranscriptionJob

class TranscriptionJob

Provides detailed information about a transcription job.

TranscriptionJobStatus

sealed class TranscriptionJobStatus

TranscriptionJobSummary

class TranscriptionJobSummary

Provides detailed information about a specific transcription job.

Type

sealed class Type

UntagResourceRequest

class UntagResourceRequest

UntagResourceResponse

class UntagResourceResponse

UpdateCallAnalyticsCategoryRequest

class UpdateCallAnalyticsCategoryRequest

UpdateCallAnalyticsCategoryResponse

class UpdateCallAnalyticsCategoryResponse

UpdateMedicalVocabularyRequest

class UpdateMedicalVocabularyRequest

UpdateMedicalVocabularyResponse

class UpdateMedicalVocabularyResponse

UpdateVocabularyFilterRequest

class UpdateVocabularyFilterRequest

UpdateVocabularyFilterResponse

class UpdateVocabularyFilterResponse

UpdateVocabularyRequest

class UpdateVocabularyRequest

UpdateVocabularyResponse

class UpdateVocabularyResponse

VocabularyFilterInfo

class VocabularyFilterInfo

Provides information about a custom vocabulary filter, including the language of the filter, when it was last modified, and its name.

VocabularyFilterMethod

sealed class VocabularyFilterMethod

VocabularyInfo

class VocabularyInfo

Provides information about a custom vocabulary, including the language of the custom vocabulary, when it was last modified, its name, and the processing state.

VocabularyState

sealed class VocabularyState