package types
import "github.com/aws/aws-sdk-go-v2/service/transcribe/types"
Index ¶
- type BadRequestException
- func (e *BadRequestException) Error() string
- func (e *BadRequestException) ErrorCode() string
- func (e *BadRequestException) ErrorFault() smithy.ErrorFault
- func (e *BadRequestException) ErrorMessage() string
- type ConflictException
- func (e *ConflictException) Error() string
- func (e *ConflictException) ErrorCode() string
- func (e *ConflictException) ErrorFault() smithy.ErrorFault
- func (e *ConflictException) ErrorMessage() string
- type ContentRedaction
- type InternalFailureException
- func (e *InternalFailureException) Error() string
- func (e *InternalFailureException) ErrorCode() string
- func (e *InternalFailureException) ErrorFault() smithy.ErrorFault
- func (e *InternalFailureException) ErrorMessage() string
- type JobExecutionSettings
- type LanguageCode
- type LimitExceededException
- func (e *LimitExceededException) Error() string
- func (e *LimitExceededException) ErrorCode() string
- func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
- func (e *LimitExceededException) ErrorMessage() string
- type Media
- type MediaFormat
- type MedicalTranscript
- type MedicalTranscriptionJob
- type MedicalTranscriptionJobSummary
- type MedicalTranscriptionSetting
- type NotFoundException
- func (e *NotFoundException) Error() string
- func (e *NotFoundException) ErrorCode() string
- func (e *NotFoundException) ErrorFault() smithy.ErrorFault
- func (e *NotFoundException) ErrorMessage() string
- type OutputLocationType
- type RedactionOutput
- type RedactionType
- type Settings
- type Specialty
- type Transcript
- type TranscriptionJob
- type TranscriptionJobStatus
- type TranscriptionJobSummary
- type Type
- type VocabularyFilterInfo
- type VocabularyFilterMethod
- type VocabularyInfo
- type VocabularyState
Types ¶
type BadRequestException ¶
type BadRequestException struct {
Message *string
}
Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.
func (*BadRequestException) Error ¶
func (e *BadRequestException) Error() string
func (*BadRequestException) ErrorCode ¶
func (e *BadRequestException) ErrorCode() string
func (*BadRequestException) ErrorFault ¶
func (e *BadRequestException) ErrorFault() smithy.ErrorFault
func (*BadRequestException) ErrorMessage ¶
func (e *BadRequestException) ErrorMessage() string
type ConflictException ¶
type ConflictException struct {
Message *string
}
The resource name already exists.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type ContentRedaction ¶
type ContentRedaction struct {
// The output transcript file stored in either the default S3 bucket or in a bucket
// you specify. When you choose redacted Amazon Transcribe outputs only the
// redacted transcript. When you choose redacted_and_unredacted Amazon Transcribe
// outputs both the redacted and unredacted transcripts.
//
// This member is required.
RedactionOutput RedactionOutput
// Request parameter that defines the entities to be redacted. The only accepted
// value is PII.
//
// This member is required.
RedactionType RedactionType
}
Settings for content redaction within a transcription job.
type InternalFailureException ¶
type InternalFailureException struct {
Message *string
}
There was an internal error. Check the error message and try your request again.
func (*InternalFailureException) Error ¶
func (e *InternalFailureException) Error() string
func (*InternalFailureException) ErrorCode ¶
func (e *InternalFailureException) ErrorCode() string
func (*InternalFailureException) ErrorFault ¶
func (e *InternalFailureException) ErrorFault() smithy.ErrorFault
func (*InternalFailureException) ErrorMessage ¶
func (e *InternalFailureException) ErrorMessage() string
type JobExecutionSettings ¶
type JobExecutionSettings struct {
// Indicates whether a job should be queued by Amazon Transcribe when the
// concurrent execution limit is exceeded. When the AllowDeferredExecution field is
// true, jobs are queued and executed when the number of executing jobs falls below
// the concurrent execution limit. If the field is false, Amazon Transcribe returns
// a LimitExceededException exception. If you specify the AllowDeferredExecution
// field, you must specify the DataAccessRoleArn field.
AllowDeferredExecution *bool
// The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that
// contains the input files. Amazon Transcribe assumes this role to read queued
// media files. If you have specified an output S3 bucket for the transcription
// results, this role should have access to the output bucket as well. If you
// specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn
// field.
DataAccessRoleArn *string
}
Provides information about when a transcription job should be executed.
type LanguageCode ¶
type LanguageCode string
const ( LanguageCodeEn_us LanguageCode = "en-US" LanguageCodeEs_us LanguageCode = "es-US" LanguageCodeEn_au LanguageCode = "en-AU" LanguageCodeFr_ca LanguageCode = "fr-CA" LanguageCodeEn_gb LanguageCode = "en-GB" LanguageCodeDe_de LanguageCode = "de-DE" LanguageCodePt_br LanguageCode = "pt-BR" LanguageCodeFr_fr LanguageCode = "fr-FR" LanguageCodeIt_it LanguageCode = "it-IT" LanguageCodeKo_kr LanguageCode = "ko-KR" LanguageCodeEs_es LanguageCode = "es-ES" LanguageCodeEn_in LanguageCode = "en-IN" LanguageCodeHi_in LanguageCode = "hi-IN" LanguageCodeAr_sa LanguageCode = "ar-SA" LanguageCodeRu_ru LanguageCode = "ru-RU" LanguageCodeZh_cn LanguageCode = "zh-CN" LanguageCodeNl_nl LanguageCode = "nl-NL" LanguageCodeId_id LanguageCode = "id-ID" LanguageCodeTa_in LanguageCode = "ta-IN" LanguageCodeFa_ir LanguageCode = "fa-IR" LanguageCodeEn_ie LanguageCode = "en-IE" LanguageCodeEn_ab LanguageCode = "en-AB" LanguageCodeEn_wl LanguageCode = "en-WL" LanguageCodePt_pt LanguageCode = "pt-PT" LanguageCodeTe_in LanguageCode = "te-IN" LanguageCodeTr_tr LanguageCode = "tr-TR" LanguageCodeDe_ch LanguageCode = "de-CH" LanguageCodeHe_il LanguageCode = "he-IL" LanguageCodeMs_my LanguageCode = "ms-MY" LanguageCodeJa_jp LanguageCode = "ja-JP" LanguageCodeAr_ae LanguageCode = "ar-AE" )
Enum values for LanguageCode
type LimitExceededException ¶
type LimitExceededException struct {
Message *string
}
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
func (*LimitExceededException) Error ¶
func (e *LimitExceededException) Error() string
func (*LimitExceededException) ErrorCode ¶
func (e *LimitExceededException) ErrorCode() string
func (*LimitExceededException) ErrorFault ¶
func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
func (*LimitExceededException) ErrorMessage ¶
func (e *LimitExceededException) ErrorMessage() string
type Media ¶
type Media struct {
// The S3 object location of the input media file. The URI must be in the same
// region as the API endpoint that you are calling. The general form is: For
// example: For more information about S3 object names, see Object Keys
// (http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys)
// in the Amazon S3 Developer Guide.
MediaFileUri *string
}
Describes the input media file in a transcription request.
type MediaFormat ¶
type MediaFormat string
const ( MediaFormatMp3 MediaFormat = "mp3" MediaFormatMp4 MediaFormat = "mp4" MediaFormatWav MediaFormat = "wav" MediaFormatFlac MediaFormat = "flac" )
Enum values for MediaFormat
type MedicalTranscript ¶
type MedicalTranscript struct {
// The S3 object location of the medical transcript. Use this URI to access the
// medical transcript. This URI points to the S3 bucket you created to store the
// medical transcript.
TranscriptFileUri *string
}
Identifies the location of a medical transcript.
type MedicalTranscriptionJob ¶
type MedicalTranscriptionJob struct {
// A timestamp that shows when the job was completed.
CompletionTime *time.Time
// A timestamp that shows when the job was created.
CreationTime *time.Time
// If the TranscriptionJobStatus field is FAILED, this field contains information
// about why the job failed. The FailureReason field contains one of the following
// values:
//
// * Unsupported media format- The media format specified in the
// MediaFormat field of the request isn't valid. See the description of the
// MediaFormat field for a list of valid values.
//
// * The media format provided
// does not match the detected media format- The media format of the audio file
// doesn't match the format specified in the MediaFormat field in the request.
// Check the media format of your media file and make sure the two values match.
//
//
// * Invalid sample rate for audio file- The sample rate specified in the
// MediaSampleRateHertz of the request isn't valid. The sample rate must be between
// 8000 and 48000 Hertz.
//
// * The sample rate provided does not match the
// detected sample rate- The sample rate in the audio file doesn't match the sample
// rate specified in the MediaSampleRateHertz field in the request. Check the
// sample rate of your media file and make sure that the two values match.
//
// *
// Invalid file size: file size too large- The size of your audio file is larger
// than what Amazon Transcribe Medical can process. For more information, see
// Guidlines and Quotas
// (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits)
// in the Amazon Transcribe Medical Guide
//
// * Invalid number of channels: number
// of channels too large- Your audio contains more channels than Amazon Transcribe
// Medical is configured to process. To request additional channels, see Amazon
// Transcribe Medical Endpoints and Quotas
// (https://docs.aws.amazon.com/general/latest/gr/transcribe-medical.html) in the
// Amazon Web Services General Reference
FailureReason *string
// The language code for the language spoken in the source audio file. US English
// (en-US) is the only supported language for medical transcriptions. Any other
// value you enter for language code results in a BadRequestException error.
LanguageCode LanguageCode
// Describes the input media file in a transcription request.
Media *Media
// The format of the input media file.
MediaFormat MediaFormat
// The sample rate, in Hertz, of the source audio containing medical information.
// If you don't specify the sample rate, Amazon Transcribe Medical determines it
// for you. If you choose to specify the sample rate, it must match the rate
// detected by Amazon Transcribe Medical. In most cases, you should leave the
// MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample
// rate.
MediaSampleRateHertz *int32
// The name for a given medical transcription job.
MedicalTranscriptionJobName *string
// Object that contains object.
Settings *MedicalTranscriptionSetting
// The medical specialty of any clinicians providing a dictation or having a
// conversation. PRIMARYCARE is the only available setting for this object. This
// specialty enables you to generate transcriptions for the following medical
// fields:
//
// * Family Medicine
Specialty Specialty
// A timestamp that shows when the job started processing.
StartTime *time.Time
// An object that contains the MedicalTranscript. The MedicalTranscript contains
// the TranscriptFileUri.
Transcript *MedicalTranscript
// The completion status of a medical transcription job.
TranscriptionJobStatus TranscriptionJobStatus
// The type of speech in the transcription job. CONVERSATION is generally used for
// patient-physician dialogues. DICTATION is the setting for physicians speaking
// their notes after seeing a patient. For more information, see how-it-works-med
Type Type
}
The data structure that containts the information for a medical transcription job.
type MedicalTranscriptionJobSummary ¶
type MedicalTranscriptionJobSummary struct {
// A timestamp that shows when the job was completed.
CompletionTime *time.Time
// A timestamp that shows when the medical transcription job was created.
CreationTime *time.Time
// If the TranscriptionJobStatus field is FAILED, a description of the error.
FailureReason *string
// The language of the transcript in the source audio file.
LanguageCode LanguageCode
// The name of a medical transcription job.
MedicalTranscriptionJobName *string
// Indicates the location of the transcription job's output. The CUSTOMER_BUCKET is
// the S3 location provided in the OutputBucketName field when the
OutputLocationType OutputLocationType
// The medical specialty of the transcription job. Primary care is the only valid
// value.
Specialty Specialty
// A timestamp that shows when the job began processing.
StartTime *time.Time
// The status of the medical transcription job.
TranscriptionJobStatus TranscriptionJobStatus
// The speech of the clinician in the input audio.
Type Type
}
Provides summary information about a transcription job.
type MedicalTranscriptionSetting ¶
type MedicalTranscriptionSetting struct {
// Instructs Amazon Transcribe Medical to process each audio channel separately and
// then merge the transcription output of each channel into a single transcription.
// Amazon Transcribe Medical also produces a transcription of each item detected on
// an audio channel, including the start time and end time of the item and
// alternative transcriptions of item. The alternative transcriptions also come
// with confidence scores provided by Amazon Transcribe Medical. You can't set both
// ShowSpeakerLabels and ChannelIdentification in the same request. If you set
// both, your request returns a BadRequestException
ChannelIdentification *bool
// The maximum number of alternatives that you tell the service to return. If you
// specify the MaxAlternatives field, you must set the ShowAlternatives field to
// true.
MaxAlternatives *int32
// The maximum number of speakers to identify in the input audio. If there are more
// speakers in the audio than this number, multiple speakers are identified as a
// single speaker. If you specify the MaxSpeakerLabels field, you must set the
// ShowSpeakerLabels field to true.
MaxSpeakerLabels *int32
// Determines whether alternative transcripts are generated along with the
// transcript that has the highest confidence. If you set ShowAlternatives field to
// true, you must also set the maximum number of alternatives to return in the
// MaxAlternatives field.
ShowAlternatives *bool
// Determines whether the transcription job uses speaker recognition to identify
// different speakers in the input audio. Speaker recongition labels individual
// speakers in the audio file. If you set the ShowSpeakerLabels field to true, you
// must also set the maximum number of speaker labels in the MaxSpeakerLabels
// field. You can't set both ShowSpeakerLabels and ChannelIdentification in the
// same request. If you set both, your request returns a BadRequestException.
ShowSpeakerLabels *bool
// The name of the vocabulary to use when processing a medical transcription job.
VocabularyName *string
}
Optional settings for the StartMedicalTranscriptionJob operation.
type NotFoundException ¶
type NotFoundException struct {
Message *string
}
We can't find the requested resource. Check the name and try your request again.
func (*NotFoundException) Error ¶
func (e *NotFoundException) Error() string
func (*NotFoundException) ErrorCode ¶
func (e *NotFoundException) ErrorCode() string
func (*NotFoundException) ErrorFault ¶
func (e *NotFoundException) ErrorFault() smithy.ErrorFault
func (*NotFoundException) ErrorMessage ¶
func (e *NotFoundException) ErrorMessage() string
type OutputLocationType ¶
type OutputLocationType string
const ( OutputLocationTypeCustomer_bucket OutputLocationType = "CUSTOMER_BUCKET" OutputLocationTypeService_bucket OutputLocationType = "SERVICE_BUCKET" )
Enum values for OutputLocationType
type RedactionOutput ¶
type RedactionOutput string
const ( RedactionOutputRedacted RedactionOutput = "redacted" RedactionOutputRedacted_and_unredacted RedactionOutput = "redacted_and_unredacted" )
Enum values for RedactionOutput
type RedactionType ¶
type RedactionType string
const ( RedactionTypePii RedactionType = "PII" )
Enum values for RedactionType
type Settings ¶
type Settings struct {
// Instructs Amazon Transcribe to process each audio channel separately and then
// merge the transcription output of each channel into a single transcription.
// Amazon Transcribe also produces a transcription of each item detected on an
// audio channel, including the start time and end time of the item and alternative
// transcriptions of the item including the confidence that Amazon Transcribe has
// in the transcription. You can't set both ShowSpeakerLabels and
// ChannelIdentification in the same request. If you set both, your request returns
// a BadRequestException.
ChannelIdentification *bool
// The number of alternative transcriptions that the service should return. If you
// specify the MaxAlternatives field, you must set the ShowAlternatives field to
// true.
MaxAlternatives *int32
// The maximum number of speakers to identify in the input audio. If there are more
// speakers in the audio than this number, multiple speakers are identified as a
// single speaker. If you specify the MaxSpeakerLabels field, you must set the
// ShowSpeakerLabels field to true.
MaxSpeakerLabels *int32
// Determines whether the transcription contains alternative transcriptions. If you
// set the ShowAlternatives field to true, you must also set the maximum number of
// alternatives to return in the MaxAlternatives field.
ShowAlternatives *bool
// Determines whether the transcription job uses speaker recognition to identify
// different speakers in the input audio. Speaker recognition labels individual
// speakers in the audio file. If you set the ShowSpeakerLabels field to true, you
// must also set the maximum number of speaker labels MaxSpeakerLabels field. You
// can't set both ShowSpeakerLabels and ChannelIdentification in the same request.
// If you set both, your request returns a BadRequestException.
ShowSpeakerLabels *bool
// Set to mask to remove filtered text from the transcript and replace it with
// three asterisks ("***") as placeholder text. Set to remove to remove filtered
// text from the transcript without using placeholder text.
VocabularyFilterMethod VocabularyFilterMethod
// The name of the vocabulary filter to use when transcribing the audio. The filter
// that you specify must have the same language code as the transcription job.
VocabularyFilterName *string
// The name of a vocabulary to use when processing the transcription job.
VocabularyName *string
}
Provides optional settings for the StartTranscriptionJob operation.
type Specialty ¶
type Specialty string
const ( SpecialtyPrimarycare Specialty = "PRIMARYCARE" )
Enum values for Specialty
type Transcript ¶
type Transcript struct {
// The S3 object location of the redacted transcript. Use this URI to access the
// redacated transcript. If you specified an S3 bucket in the OutputBucketName
// field when you created the job, this is the URI of that bucket. If you chose to
// store the transcript in Amazon Transcribe, this is a shareable URL that provides
// secure access to that location.
RedactedTranscriptFileUri *string
// The S3 object location of the the transcript. Use this URI to access the
// transcript. If you specified an S3 bucket in the OutputBucketName field when you
// created the job, this is the URI of that bucket. If you chose to store the
// transcript in Amazon Transcribe, this is a shareable URL that provides secure
// access to that location.
TranscriptFileUri *string
}
Identifies the location of a transcription.
type TranscriptionJob ¶
type TranscriptionJob struct {
// A timestamp that shows when the job was completed.
CompletionTime *time.Time
// An object that describes content redaction settings for the transcription job.
ContentRedaction *ContentRedaction
// A timestamp that shows when the job was created.
CreationTime *time.Time
// If the TranscriptionJobStatus field is FAILED, this field contains information
// about why the job failed. The FailureReason field can contain one of the
// following values:
//
// * Unsupported media format - The media format specified
// in the MediaFormat field of the request isn't valid. See the description of the
// MediaFormat field for a list of valid values.
//
// * The media format provided
// does not match the detected media format - The media format of the audio file
// doesn't match the format specified in the MediaFormat field in the request.
// Check the media format of your media file and make sure that the two values
// match.
//
// * Invalid sample rate for audio file - The sample rate specified in
// the MediaSampleRateHertz of the request isn't valid. The sample rate must be
// between 8000 and 48000 Hertz.
//
// * The sample rate provided does not match the
// detected sample rate - The sample rate in the audio file doesn't match the
// sample rate specified in the MediaSampleRateHertz field in the request. Check
// the sample rate of your media file and make sure that the two values match.
//
//
// * Invalid file size: file size too large - The size of your audio file is larger
// than Amazon Transcribe can process. For more information, see Limits
// (https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits)
// in the Amazon Transcribe Developer Guide.
//
// * Invalid number of channels:
// number of channels too large - Your audio contains more channels than Amazon
// Transcribe is configured to process. To request additional channels, see Amazon
// Transcribe Limits
// (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits-amazon-transcribe)
// in the Amazon Web Services General Reference.
FailureReason *string
// Provides information about how a transcription job is executed.
JobExecutionSettings *JobExecutionSettings
// The language code for the input speech.
LanguageCode LanguageCode
// An object that describes the input media for the transcription job.
Media *Media
// The format of the input media file.
MediaFormat MediaFormat
// The sample rate, in Hertz, of the audio track in the input media file.
MediaSampleRateHertz *int32
// Optional settings for the transcription job. Use these settings to turn on
// speaker recognition, to set the maximum number of speakers that should be
// identified and to specify a custom vocabulary to use when processing the
// transcription job.
Settings *Settings
// A timestamp that shows with the job was started processing.
StartTime *time.Time
// An object that describes the output of the transcription job.
Transcript *Transcript
// The name of the transcription job.
TranscriptionJobName *string
// The status of the transcription job.
TranscriptionJobStatus TranscriptionJobStatus
}
Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.
type TranscriptionJobStatus ¶
type TranscriptionJobStatus string
const ( TranscriptionJobStatusQueued TranscriptionJobStatus = "QUEUED" TranscriptionJobStatusIn_progress TranscriptionJobStatus = "IN_PROGRESS" TranscriptionJobStatusFailed TranscriptionJobStatus = "FAILED" TranscriptionJobStatusCompleted TranscriptionJobStatus = "COMPLETED" )
Enum values for TranscriptionJobStatus
type TranscriptionJobSummary ¶
type TranscriptionJobSummary struct {
// A timestamp that shows when the job was completed.
CompletionTime *time.Time
// The content redaction settings of the transcription job.
ContentRedaction *ContentRedaction
// A timestamp that shows when the job was created.
CreationTime *time.Time
// If the TranscriptionJobStatus field is FAILED, a description of the error.
FailureReason *string
// The language code for the input speech.
LanguageCode LanguageCode
// Indicates the location of the output of the transcription job. If the value is
// CUSTOMER_BUCKET then the location is the S3 bucket specified in the
// outputBucketName field when the transcription job was started with the
// StartTranscriptionJob operation. If the value is SERVICE_BUCKET then the output
// is stored by Amazon Transcribe and can be retrieved using the URI in the
// GetTranscriptionJob response's TranscriptFileUri field.
OutputLocationType OutputLocationType
// A timestamp that shows when the job started processing.
StartTime *time.Time
// The name of the transcription job.
TranscriptionJobName *string
// The status of the transcription job. When the status is COMPLETED, use the
// GetTranscriptionJob operation to get the results of the transcription.
TranscriptionJobStatus TranscriptionJobStatus
}
Provides a summary of information about a transcription job.
type Type ¶
type Type string
Enum values for Type
type VocabularyFilterInfo ¶
type VocabularyFilterInfo struct {
// The language code of the words in the vocabulary filter.
LanguageCode LanguageCode
// The date and time that the vocabulary was last updated.
LastModifiedTime *time.Time
// The name of the vocabulary filter. The name must be unique in the account that
// holds the filter.
VocabularyFilterName *string
}
Provides information about a vocabulary filter.
type VocabularyFilterMethod ¶
type VocabularyFilterMethod string
const ( VocabularyFilterMethodRemove VocabularyFilterMethod = "remove" VocabularyFilterMethodMask VocabularyFilterMethod = "mask" )
Enum values for VocabularyFilterMethod
type VocabularyInfo ¶
type VocabularyInfo struct {
// The language code of the vocabulary entries.
LanguageCode LanguageCode
// The date and time that the vocabulary was last modified.
LastModifiedTime *time.Time
// The name of the vocabulary.
VocabularyName *string
// The processing state of the vocabulary. If the state is READY you can use the
// vocabulary in a StartTranscriptionJob request.
VocabularyState VocabularyState
}
Provides information about a custom vocabulary.
type VocabularyState ¶
type VocabularyState string
const ( VocabularyStatePending VocabularyState = "PENDING" VocabularyStateReady VocabularyState = "READY" VocabularyStateFailed VocabularyState = "FAILED" )
Enum values for VocabularyState
Source Files ¶
- Version
- v0.27.0
- Published
- Oct 17, 2020
- Platform
- js/wasm
- Imports
- 3 packages
- Last checked
- 11 months ago –
Tools for package owners.