func CallAnalyticsLanguageCode_Values() []string
CallAnalyticsLanguageCode_Values returns all elements of the CallAnalyticsLanguageCode enum
func ContentIdentificationType_Values() []string
ContentIdentificationType_Values returns all elements of the ContentIdentificationType enum
func ContentRedactionOutput__Values() []string
ContentRedactionOutput__Values returns all elements of the ContentRedactionOutput_ enum
func ContentRedactionType_Values() []string
ContentRedactionType_Values returns all elements of the ContentRedactionType enum
func ItemType_Values() []string
ItemType_Values returns all elements of the ItemType enum
func LanguageCode_Values() []string
LanguageCode_Values returns all elements of the LanguageCode enum
func MediaEncoding_Values() []string
MediaEncoding_Values returns all elements of the MediaEncoding enum
func MedicalContentIdentificationType_Values() []string
MedicalContentIdentificationType_Values returns all elements of the MedicalContentIdentificationType enum
func PartialResultsStability_Values() []string
PartialResultsStability_Values returns all elements of the PartialResultsStability enum
func ParticipantRole_Values() []string
ParticipantRole_Values returns all elements of the ParticipantRole enum
func Sentiment_Values() []string
Sentiment_Values returns all elements of the Sentiment enum
func Specialty_Values() []string
Specialty_Values returns all elements of the Specialty enum
func StreamAudioFromReader(ctx aws.Context, stream AudioStreamWriter, frameSize int, input io.Reader) (err error)
StreamAudioFromReader will stream bytes from the provided input io.Reader to the AudioStreamWriter in chunks of frameSize in length. Returns an error if streaming to AudioStreamWriter fails.
func Type_Values() []string
Type_Values returns all elements of the Type enum
func VocabularyFilterMethod_Values() []string
VocabularyFilterMethod_Values returns all elements of the VocabularyFilterMethod enum
type Alternative struct {
// Contains entities identified as personally identifiable information (PII)
// in your transcription output.
Entities []*Entity `type:"list"`
// Contains words, phrases, or punctuation marks in your transcription output.
Items []*Item `type:"list"`
// Contains transcribed text.
Transcript *string `type:"string"`
// contains filtered or unexported fields
}
A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.
func (s Alternative) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Alternative) SetEntities(v []*Entity) *Alternative
SetEntities sets the Entities field's value.
func (s *Alternative) SetItems(v []*Item) *Alternative
SetItems sets the Items field's value.
func (s *Alternative) SetTranscript(v string) *Alternative
SetTranscript sets the Transcript field's value.
func (s Alternative) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AudioEvent struct {
// An audio blob that contains the next part of the audio that you want to transcribe.
// The maximum audio chunk size is 32 KB.
// AudioChunk is automatically base64 encoded/decoded by the SDK.
AudioChunk []byte `type:"blob"`
// contains filtered or unexported fields
}
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 (https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html).
func (s AudioEvent) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AudioEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *AudioEvent) SetAudioChunk(v []byte) *AudioEvent
SetAudioChunk sets the AudioChunk field's value.
func (s AudioEvent) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AudioEvent) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the AudioEvent value. This method is only used internally within the SDK's EventStream handling.
type AudioStreamEvent interface {
eventstreamapi.Marshaler
eventstreamapi.Unmarshaler
// contains filtered or unexported methods
}
AudioStreamEvent groups together all EventStream events writes for AudioStream.
These events are:
type AudioStreamWriter interface {
// Sends writes events to the stream blocking until the event has been
// written. An error is returned if the write fails.
Send(aws.Context, AudioStreamEvent) error
// Close will stop the writer writing to the event stream.
Close() error
// Returns any error that has occurred while writing to the event stream.
Err() error
}
AudioStreamWriter provides the interface for writing events to the stream. The default implementation for this interface will be AudioStream.
The writer's Close method must allow multiple concurrent calls.
These events are:
type BadRequestException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.
func (s *BadRequestException) Code() string
Code returns the exception type name.
func (s *BadRequestException) Error() string
func (s BadRequestException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BadRequestException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *BadRequestException) Message() string
Message returns the exception's message.
func (s *BadRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *BadRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *BadRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s BadRequestException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BadRequestException) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the BadRequestException value. This method is only used internally within the SDK's EventStream handling.
type CallAnalyticsEntity struct {
// The time, in milliseconds, from the beginning of the audio stream to the
// start of the identified entity.
BeginOffsetMillis *int64 `type:"long"`
// The category of information identified. For example, PII.
Category *string `type:"string"`
// The confidence score associated with the identification of an entity in your
// transcript.
//
// Confidence scores are values between 0 and 1. A larger value indicates a
// higher probability that the identified entity correctly matches the entity
// spoken in your media.
Confidence *float64 `type:"double"`
// The word or words that represent the identified entity.
Content *string `type:"string"`
// The time, in milliseconds, from the beginning of the audio stream to the
// end of the identified entity.
EndOffsetMillis *int64 `type:"long"`
// The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER.
Type *string `type:"string"`
// contains filtered or unexported fields
}
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.
func (s CallAnalyticsEntity) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CallAnalyticsEntity) SetBeginOffsetMillis(v int64) *CallAnalyticsEntity
SetBeginOffsetMillis sets the BeginOffsetMillis field's value.
func (s *CallAnalyticsEntity) SetCategory(v string) *CallAnalyticsEntity
SetCategory sets the Category field's value.
func (s *CallAnalyticsEntity) SetConfidence(v float64) *CallAnalyticsEntity
SetConfidence sets the Confidence field's value.
func (s *CallAnalyticsEntity) SetContent(v string) *CallAnalyticsEntity
SetContent sets the Content field's value.
func (s *CallAnalyticsEntity) SetEndOffsetMillis(v int64) *CallAnalyticsEntity
SetEndOffsetMillis sets the EndOffsetMillis field's value.
func (s *CallAnalyticsEntity) SetType(v string) *CallAnalyticsEntity
SetType sets the Type field's value.
func (s CallAnalyticsEntity) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CallAnalyticsItem struct {
// The time, in milliseconds, from the beginning of the audio stream to the
// start of the identified item.
BeginOffsetMillis *int64 `type:"long"`
// The confidence score associated with a word or phrase in your transcript.
//
// Confidence scores are values between 0 and 1. A larger value indicates a
// higher probability that the identified item correctly matches the item spoken
// in your media.
Confidence *float64 `type:"double"`
// The word or punctuation that was transcribed.
Content *string `type:"string"`
// The time, in milliseconds, from the beginning of the audio stream to the
// end of the identified item.
EndOffsetMillis *int64 `type:"long"`
// If partial result stabilization is enabled, Stable indicates whether the
// specified item is stable (true) or if it may change when the segment is complete
// (false).
Stable *bool `type:"boolean"`
// The type of item identified. Options are: PRONUNCIATION (spoken words) and
// PUNCTUATION.
Type *string `type:"string" enum:"ItemType"`
// Indicates whether the specified item matches a word in the vocabulary filter
// included in your Call Analytics request. If true, there is a vocabulary filter
// match.
VocabularyFilterMatch *bool `type:"boolean"`
// contains filtered or unexported fields
}
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.
func (s CallAnalyticsItem) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CallAnalyticsItem) SetBeginOffsetMillis(v int64) *CallAnalyticsItem
SetBeginOffsetMillis sets the BeginOffsetMillis field's value.
func (s *CallAnalyticsItem) SetConfidence(v float64) *CallAnalyticsItem
SetConfidence sets the Confidence field's value.
func (s *CallAnalyticsItem) SetContent(v string) *CallAnalyticsItem
SetContent sets the Content field's value.
func (s *CallAnalyticsItem) SetEndOffsetMillis(v int64) *CallAnalyticsItem
SetEndOffsetMillis sets the EndOffsetMillis field's value.
func (s *CallAnalyticsItem) SetStable(v bool) *CallAnalyticsItem
SetStable sets the Stable field's value.
func (s *CallAnalyticsItem) SetType(v string) *CallAnalyticsItem
SetType sets the Type field's value.
func (s *CallAnalyticsItem) SetVocabularyFilterMatch(v bool) *CallAnalyticsItem
SetVocabularyFilterMatch sets the VocabularyFilterMatch field's value.
func (s CallAnalyticsItem) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CallAnalyticsTranscriptResultStreamEvent interface {
eventstreamapi.Marshaler
eventstreamapi.Unmarshaler
// contains filtered or unexported methods
}
CallAnalyticsTranscriptResultStreamEvent groups together all EventStream events writes for CallAnalyticsTranscriptResultStream.
These events are:
type CallAnalyticsTranscriptResultStreamReader interface {
// Returns a channel of events as they are read from the event stream.
Events() <-chan CallAnalyticsTranscriptResultStreamEvent
// Close will stop the reader reading events from the stream.
Close() error
// Returns any error that has occurred while reading from the event stream.
Err() error
}
CallAnalyticsTranscriptResultStreamReader provides the interface for reading to the stream. The default implementation for this interface will be CallAnalyticsTranscriptResultStream.
The reader's Close method must allow multiple concurrent calls.
These events are:
type CallAnalyticsTranscriptResultStreamUnknownEvent struct {
Type string
Message eventstream.Message
}
CallAnalyticsTranscriptResultStreamUnknownEvent provides a failsafe event for the CallAnalyticsTranscriptResultStream group of events when an unknown event is received.
func (e *CallAnalyticsTranscriptResultStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) ( msg eventstream.Message, err error, )
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (e *CallAnalyticsTranscriptResultStreamUnknownEvent) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the CallAnalyticsTranscriptResultStream value. This method is only used internally within the SDK's EventStream handling.
type CategoryEvent struct {
// Lists the categories that were matched in your audio segment.
MatchedCategories []*string `type:"list"`
// Contains information about the matched categories, including category names
// and timestamps.
MatchedDetails map[string]*PointsOfInterest `type:"map"`
// contains filtered or unexported fields
}
Provides information on any TranscriptFilterType categories that matched your transcription output. Matches are identified for each segment upon completion of that segment.
func (s CategoryEvent) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CategoryEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *CategoryEvent) SetMatchedCategories(v []*string) *CategoryEvent
SetMatchedCategories sets the MatchedCategories field's value.
func (s *CategoryEvent) SetMatchedDetails(v map[string]*PointsOfInterest) *CategoryEvent
SetMatchedDetails sets the MatchedDetails field's value.
func (s CategoryEvent) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CategoryEvent) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the CategoryEvent value. This method is only used internally within the SDK's EventStream handling.
type ChannelDefinition struct {
// Specify the audio channel you want to define.
//
// ChannelId is a required field
ChannelId *int64 `type:"integer" required:"true"`
// Specify the speaker you want to define. Omitting this parameter is equivalent
// to specifying both participants.
//
// ParticipantRole is a required field
ParticipantRole *string `type:"string" required:"true" enum:"ParticipantRole"`
// contains filtered or unexported fields
}
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).
func (s ChannelDefinition) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ChannelDefinition) SetChannelId(v int64) *ChannelDefinition
SetChannelId sets the ChannelId field's value.
func (s *ChannelDefinition) SetParticipantRole(v string) *ChannelDefinition
SetParticipantRole sets the ParticipantRole field's value.
func (s ChannelDefinition) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CharacterOffsets struct {
// Provides the character count of the first character where a match is identified.
// For example, the first character associated with an issue or a category match
// in a segment transcript.
Begin *int64 `type:"integer"`
// Provides the character count of the last character where a match is identified.
// For example, the last character associated with an issue or a category match
// in a segment transcript.
End *int64 `type:"integer"`
// contains filtered or unexported fields
}
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.
func (s CharacterOffsets) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CharacterOffsets) SetBegin(v int64) *CharacterOffsets
SetBegin sets the Begin field's value.
func (s *CharacterOffsets) SetEnd(v int64) *CharacterOffsets
SetEnd sets the End field's value.
func (s CharacterOffsets) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConfigurationEvent struct {
// Indicates which speaker is on which audio channel.
ChannelDefinitions []*ChannelDefinition `min:"2" type:"list"`
// Provides additional optional settings for your Call Analytics post-call request,
// including encryption and output locations for your redacted and unredacted
// transcript.
PostCallAnalyticsSettings *PostCallAnalyticsSettings `type:"structure"`
// contains filtered or unexported fields
}
Allows you to set audio channel definitions and post-call analytics settings.
func (s ConfigurationEvent) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConfigurationEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *ConfigurationEvent) SetChannelDefinitions(v []*ChannelDefinition) *ConfigurationEvent
SetChannelDefinitions sets the ChannelDefinitions field's value.
func (s *ConfigurationEvent) SetPostCallAnalyticsSettings(v *PostCallAnalyticsSettings) *ConfigurationEvent
SetPostCallAnalyticsSettings sets the PostCallAnalyticsSettings field's value.
func (s ConfigurationEvent) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConfigurationEvent) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the ConfigurationEvent value. This method is only used internally within the SDK's EventStream handling.
type ConflictException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
A new stream started with the same session ID. The current stream has been terminated.
func (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConflictException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConflictException) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the ConflictException value. This method is only used internally within the SDK's EventStream handling.
type Entity struct {
// The category of information identified. The only category is PII.
Category *string `type:"string"`
// The confidence score associated with the identified PII entity in your audio.
//
// Confidence scores are values between 0 and 1. A larger value indicates a
// higher probability that the identified entity correctly matches the entity
// spoken in your media.
Confidence *float64 `type:"double"`
// The word or words identified as PII.
Content *string `type:"string"`
// The end time, in milliseconds, of the utterance that was identified as PII.
EndTime *float64 `type:"double"`
// The start time, in milliseconds, of the utterance that was identified as
// PII.
StartTime *float64 `type:"double"`
// The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER.
Type *string `type:"string"`
// contains filtered or unexported fields
}
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.
func (s Entity) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Entity) SetCategory(v string) *Entity
SetCategory sets the Category field's value.
func (s *Entity) SetConfidence(v float64) *Entity
SetConfidence sets the Confidence field's value.
func (s *Entity) SetContent(v string) *Entity
SetContent sets the Content field's value.
func (s *Entity) SetEndTime(v float64) *Entity
SetEndTime sets the EndTime field's value.
func (s *Entity) SetStartTime(v float64) *Entity
SetStartTime sets the StartTime field's value.
func (s *Entity) SetType(v string) *Entity
SetType sets the Type field's value.
func (s Entity) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InternalFailureException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
A problem occurred while processing the audio. Amazon Transcribe terminated processing.
func (s *InternalFailureException) Code() string
Code returns the exception type name.
func (s *InternalFailureException) Error() string
func (s InternalFailureException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InternalFailureException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *InternalFailureException) Message() string
Message returns the exception's message.
func (s *InternalFailureException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalFailureException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalFailureException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InternalFailureException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InternalFailureException) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the InternalFailureException value. This method is only used internally within the SDK's EventStream handling.
type IssueDetected struct {
// Provides the timestamps that identify when in an audio segment the specified
// issue occurs.
CharacterOffsets *CharacterOffsets `type:"structure"`
// contains filtered or unexported fields
}
Lists the issues that were identified in your audio segment.
func (s IssueDetected) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IssueDetected) SetCharacterOffsets(v *CharacterOffsets) *IssueDetected
SetCharacterOffsets sets the CharacterOffsets field's value.
func (s IssueDetected) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Item struct {
// The confidence score associated with a word or phrase in your transcript.
//
// Confidence scores are values between 0 and 1. A larger value indicates a
// higher probability that the identified item correctly matches the item spoken
// in your media.
Confidence *float64 `type:"double"`
// The word or punctuation that was transcribed.
Content *string `type:"string"`
// The end time, in milliseconds, of the transcribed item.
EndTime *float64 `type:"double"`
// If speaker partitioning is enabled, Speaker labels the speaker of the specified
// item.
Speaker *string `type:"string"`
// If partial result stabilization is enabled, Stable indicates whether the
// specified item is stable (true) or if it may change when the segment is complete
// (false).
Stable *bool `type:"boolean"`
// The start time, in milliseconds, of the transcribed item.
StartTime *float64 `type:"double"`
// The type of item identified. Options are: PRONUNCIATION (spoken words) and
// PUNCTUATION.
Type *string `type:"string" enum:"ItemType"`
// Indicates whether the specified item matches a word in the vocabulary filter
// included in your request. If true, there is a vocabulary filter match.
VocabularyFilterMatch *bool `type:"boolean"`
// contains filtered or unexported fields
}
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.
func (s Item) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Item) SetConfidence(v float64) *Item
SetConfidence sets the Confidence field's value.
func (s *Item) SetContent(v string) *Item
SetContent sets the Content field's value.
func (s *Item) SetEndTime(v float64) *Item
SetEndTime sets the EndTime field's value.
func (s *Item) SetSpeaker(v string) *Item
SetSpeaker sets the Speaker field's value.
func (s *Item) SetStable(v bool) *Item
SetStable sets the Stable field's value.
func (s *Item) SetStartTime(v float64) *Item
SetStartTime sets the StartTime field's value.
func (s *Item) SetType(v string) *Item
SetType sets the Type field's value.
func (s *Item) SetVocabularyFilterMatch(v bool) *Item
SetVocabularyFilterMatch sets the VocabularyFilterMatch field's value.
func (s Item) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type LanguageWithScore struct {
// The language code of the identified language.
LanguageCode *string `type:"string" enum:"LanguageCode"`
// The confidence score associated with the identified language code. Confidence
// scores are values between zero and one; larger values indicate a higher confidence
// in the identified language.
Score *float64 `type:"double"`
// contains filtered or unexported fields
}
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.
func (s LanguageWithScore) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LanguageWithScore) SetLanguageCode(v string) *LanguageWithScore
SetLanguageCode sets the LanguageCode field's value.
func (s *LanguageWithScore) SetScore(v float64) *LanguageWithScore
SetScore sets the Score field's value.
func (s LanguageWithScore) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type LimitExceededException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
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.
func (s *LimitExceededException) Code() string
Code returns the exception type name.
func (s *LimitExceededException) Error() string
func (s LimitExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LimitExceededException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *LimitExceededException) Message() string
Message returns the exception's message.
func (s *LimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *LimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *LimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s LimitExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *LimitExceededException) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the LimitExceededException value. This method is only used internally within the SDK's EventStream handling.
type MedicalAlternative struct {
// Contains entities identified as personal health information (PHI) in your
// transcription output.
Entities []*MedicalEntity `type:"list"`
// Contains words, phrases, or punctuation marks in your transcription output.
Items []*MedicalItem `type:"list"`
// Contains transcribed text.
Transcript *string `type:"string"`
// contains filtered or unexported fields
}
A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of Items, Entities, or Transcript.
func (s MedicalAlternative) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MedicalAlternative) SetEntities(v []*MedicalEntity) *MedicalAlternative
SetEntities sets the Entities field's value.
func (s *MedicalAlternative) SetItems(v []*MedicalItem) *MedicalAlternative
SetItems sets the Items field's value.
func (s *MedicalAlternative) SetTranscript(v string) *MedicalAlternative
SetTranscript sets the Transcript field's value.
func (s MedicalAlternative) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type MedicalEntity struct {
// The category of information identified. The only category is PHI.
Category *string `type:"string"`
// The confidence score associated with the identified PHI entity in your audio.
//
// Confidence scores are values between 0 and 1. A larger value indicates a
// higher probability that the identified entity correctly matches the entity
// spoken in your media.
Confidence *float64 `type:"double"`
// The word or words identified as PHI.
Content *string `type:"string"`
// The end time, in milliseconds, of the utterance that was identified as PHI.
EndTime *float64 `type:"double"`
// The start time, in milliseconds, of the utterance that was identified as
// PHI.
StartTime *float64 `type:"double"`
// contains filtered or unexported fields
}
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.
func (s MedicalEntity) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MedicalEntity) SetCategory(v string) *MedicalEntity
SetCategory sets the Category field's value.
func (s *MedicalEntity) SetConfidence(v float64) *MedicalEntity
SetConfidence sets the Confidence field's value.
func (s *MedicalEntity) SetContent(v string) *MedicalEntity
SetContent sets the Content field's value.
func (s *MedicalEntity) SetEndTime(v float64) *MedicalEntity
SetEndTime sets the EndTime field's value.
func (s *MedicalEntity) SetStartTime(v float64) *MedicalEntity
SetStartTime sets the StartTime field's value.
func (s MedicalEntity) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type MedicalItem struct {
// The confidence score associated with a word or phrase in your transcript.
//
// Confidence scores are values between 0 and 1. A larger value indicates a
// higher probability that the identified item correctly matches the item spoken
// in your media.
Confidence *float64 `type:"double"`
// The word or punctuation that was transcribed.
Content *string `type:"string"`
// The end time, in milliseconds, of the transcribed item.
EndTime *float64 `type:"double"`
// If speaker partitioning is enabled, Speaker labels the speaker of the specified
// item.
Speaker *string `type:"string"`
// The start time, in milliseconds, of the transcribed item.
StartTime *float64 `type:"double"`
// The type of item identified. Options are: PRONUNCIATION (spoken words) and
// PUNCTUATION.
Type *string `type:"string" enum:"ItemType"`
// contains filtered or unexported fields
}
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.
func (s MedicalItem) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MedicalItem) SetConfidence(v float64) *MedicalItem
SetConfidence sets the Confidence field's value.
func (s *MedicalItem) SetContent(v string) *MedicalItem
SetContent sets the Content field's value.
func (s *MedicalItem) SetEndTime(v float64) *MedicalItem
SetEndTime sets the EndTime field's value.
func (s *MedicalItem) SetSpeaker(v string) *MedicalItem
SetSpeaker sets the Speaker field's value.
func (s *MedicalItem) SetStartTime(v float64) *MedicalItem
SetStartTime sets the StartTime field's value.
func (s *MedicalItem) SetType(v string) *MedicalItem
SetType sets the Type field's value.
func (s MedicalItem) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type MedicalResult struct {
// A list of possible alternative transcriptions for the input audio. Each alternative
// may contain one or more of Items, Entities, or Transcript.
Alternatives []*MedicalAlternative `type:"list"`
// Indicates the channel identified for the Result.
ChannelId *string `type:"string"`
// The end time, in milliseconds, of the Result.
EndTime *float64 `type:"double"`
// Indicates if the segment is complete.
//
// If IsPartial is true, the segment is not complete. If IsPartial is false,
// the segment is complete.
IsPartial *bool `type:"boolean"`
// Provides a unique identifier for the Result.
ResultId *string `type:"string"`
// The start time, in milliseconds, of the Result.
StartTime *float64 `type:"double"`
// contains filtered or unexported fields
}
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.
func (s MedicalResult) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MedicalResult) SetAlternatives(v []*MedicalAlternative) *MedicalResult
SetAlternatives sets the Alternatives field's value.
func (s *MedicalResult) SetChannelId(v string) *MedicalResult
SetChannelId sets the ChannelId field's value.
func (s *MedicalResult) SetEndTime(v float64) *MedicalResult
SetEndTime sets the EndTime field's value.
func (s *MedicalResult) SetIsPartial(v bool) *MedicalResult
SetIsPartial sets the IsPartial field's value.
func (s *MedicalResult) SetResultId(v string) *MedicalResult
SetResultId sets the ResultId field's value.
func (s *MedicalResult) SetStartTime(v float64) *MedicalResult
SetStartTime sets the StartTime field's value.
func (s MedicalResult) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type MedicalTranscript struct {
// 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.
Results []*MedicalResult `type:"list"`
// contains filtered or unexported fields
}
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.
func (s MedicalTranscript) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MedicalTranscript) SetResults(v []*MedicalResult) *MedicalTranscript
SetResults sets the Results field's value.
func (s MedicalTranscript) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type MedicalTranscriptEvent struct {
// Contains Results, which 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.
Transcript *MedicalTranscript `type:"structure"`
// contains filtered or unexported fields
}
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.
func (s MedicalTranscriptEvent) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MedicalTranscriptEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *MedicalTranscriptEvent) SetTranscript(v *MedicalTranscript) *MedicalTranscriptEvent
SetTranscript sets the Transcript field's value.
func (s MedicalTranscriptEvent) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *MedicalTranscriptEvent) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the MedicalTranscriptEvent value. This method is only used internally within the SDK's EventStream handling.
type MedicalTranscriptResultStreamEvent interface {
eventstreamapi.Marshaler
eventstreamapi.Unmarshaler
// contains filtered or unexported methods
}
MedicalTranscriptResultStreamEvent groups together all EventStream events writes for MedicalTranscriptResultStream.
These events are:
type MedicalTranscriptResultStreamReader interface {
// Returns a channel of events as they are read from the event stream.
Events() <-chan MedicalTranscriptResultStreamEvent
// Close will stop the reader reading events from the stream.
Close() error
// Returns any error that has occurred while reading from the event stream.
Err() error
}
MedicalTranscriptResultStreamReader provides the interface for reading to the stream. The default implementation for this interface will be MedicalTranscriptResultStream.
The reader's Close method must allow multiple concurrent calls.
These events are:
type MedicalTranscriptResultStreamUnknownEvent struct {
Type string
Message eventstream.Message
}
MedicalTranscriptResultStreamUnknownEvent provides a failsafe event for the MedicalTranscriptResultStream group of events when an unknown event is received.
func (e *MedicalTranscriptResultStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) ( msg eventstream.Message, err error, )
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (e *MedicalTranscriptResultStreamUnknownEvent) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the MedicalTranscriptResultStream value. This method is only used internally within the SDK's EventStream handling.
type PointsOfInterest struct {
// Contains the timestamp ranges (start time through end time) of matched categories
// and rules.
TimestampRanges []*TimestampRange `type:"list"`
// contains filtered or unexported fields
}
Contains the timestamps of matched categories.
func (s PointsOfInterest) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PointsOfInterest) SetTimestampRanges(v []*TimestampRange) *PointsOfInterest
SetTimestampRanges sets the TimestampRanges field's value.
func (s PointsOfInterest) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type PostCallAnalyticsSettings struct {
// Specify whether you want only a redacted transcript or both a redacted and
// an unredacted transcript. If you choose redacted and unredacted, two JSON
// files are generated and stored in the Amazon S3 output location you specify.
//
// Note that to include ContentRedactionOutput in your request, you must enable
// content redaction (ContentRedactionType).
ContentRedactionOutput *string `type:"string" enum:"ContentRedactionOutput_"`
// The Amazon Resource Name (ARN) of an IAM role that has permissions to access
// the Amazon S3 bucket that contains your input files. If the role that you
// specify doesn’t have the appropriate permissions to access the specified
// Amazon S3 location, your request fails.
//
// IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path.
// For example: arn:aws:iam::111122223333:role/Admin. For more information,
// see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
//
// DataAccessRoleArn is a required field
DataAccessRoleArn *string `type:"string" required:"true"`
// The KMS key you want to use to encrypt your Call Analytics post-call output.
//
// If using a key located in the current Amazon Web Services account, you can
// specify your KMS key in one of four ways:
//
// Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
//
// Use an alias for the KMS key ID. For example, alias/ExampleAlias.
//
// Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
//
// Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
//
// If using a key located in a different Amazon Web Services account than the
// current Amazon Web Services account, you can specify your KMS key in one
// of two ways:
//
// Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
//
// Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
//
// Note that the user making the request must have permission to use the specified
// KMS key.
OutputEncryptionKMSKeyId *string `type:"string"`
// The Amazon S3 location where you want your Call Analytics post-call transcription
// output stored. You can use any of the following formats to specify the output
// location:
//
// s3://DOC-EXAMPLE-BUCKET
//
// s3://DOC-EXAMPLE-BUCKET/my-output-folder/
//
// s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
//
// OutputLocation is a required field
OutputLocation *string `type:"string" required:"true"`
// contains filtered or unexported fields
}
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.
func (s PostCallAnalyticsSettings) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PostCallAnalyticsSettings) SetContentRedactionOutput(v string) *PostCallAnalyticsSettings
SetContentRedactionOutput sets the ContentRedactionOutput field's value.
func (s *PostCallAnalyticsSettings) SetDataAccessRoleArn(v string) *PostCallAnalyticsSettings
SetDataAccessRoleArn sets the DataAccessRoleArn field's value.
func (s *PostCallAnalyticsSettings) SetOutputEncryptionKMSKeyId(v string) *PostCallAnalyticsSettings
SetOutputEncryptionKMSKeyId sets the OutputEncryptionKMSKeyId field's value.
func (s *PostCallAnalyticsSettings) SetOutputLocation(v string) *PostCallAnalyticsSettings
SetOutputLocation sets the OutputLocation field's value.
func (s PostCallAnalyticsSettings) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Result struct {
// A list of possible alternative transcriptions for the input audio. Each alternative
// may contain one or more of Items, Entities, or Transcript.
Alternatives []*Alternative `type:"list"`
// Indicates which audio channel is associated with the Result.
ChannelId *string `type:"string"`
// The end time, in milliseconds, of the Result.
EndTime *float64 `type:"double"`
// Indicates if the segment is complete.
//
// If IsPartial is true, the segment is not complete. If IsPartial is false,
// the segment is complete.
IsPartial *bool `type:"boolean"`
// The language code that represents the language spoken in your audio stream.
LanguageCode *string `type:"string" enum:"LanguageCode"`
// The language code of the dominant language identified in your stream.
//
// If you enabled channel identification and each channel of your audio contains
// a different language, you may have more than one result.
LanguageIdentification []*LanguageWithScore `type:"list"`
// Provides a unique identifier for the Result.
ResultId *string `type:"string"`
// The start time, in milliseconds, of the Result.
StartTime *float64 `type:"double"`
// contains filtered or unexported fields
}
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.
func (s Result) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Result) SetAlternatives(v []*Alternative) *Result
SetAlternatives sets the Alternatives field's value.
func (s *Result) SetChannelId(v string) *Result
SetChannelId sets the ChannelId field's value.
func (s *Result) SetEndTime(v float64) *Result
SetEndTime sets the EndTime field's value.
func (s *Result) SetIsPartial(v bool) *Result
SetIsPartial sets the IsPartial field's value.
func (s *Result) SetLanguageCode(v string) *Result
SetLanguageCode sets the LanguageCode field's value.
func (s *Result) SetLanguageIdentification(v []*LanguageWithScore) *Result
SetLanguageIdentification sets the LanguageIdentification field's value.
func (s *Result) SetResultId(v string) *Result
SetResultId sets the ResultId field's value.
func (s *Result) SetStartTime(v float64) *Result
SetStartTime sets the StartTime field's value.
func (s Result) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ServiceUnavailableException struct {
RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
Message_ *string `locationName:"Message" type:"string"`
// contains filtered or unexported fields
}
The service is currently unavailable. Try your request later.
func (s *ServiceUnavailableException) Code() string
Code returns the exception type name.
func (s *ServiceUnavailableException) Error() string
func (s ServiceUnavailableException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ServiceUnavailableException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *ServiceUnavailableException) Message() string
Message returns the exception's message.
func (s *ServiceUnavailableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceUnavailableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceUnavailableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ServiceUnavailableException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ServiceUnavailableException) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the ServiceUnavailableException value. This method is only used internally within the SDK's EventStream handling.
type StartCallAnalyticsStreamTranscriptionEventStream struct {
// Writer is the EventStream writer for the AudioStream
// events. This value is automatically set by the SDK when the API call is made
// Use this member when unit testing your code with the SDK to mock out the
// EventStream Writer.
//
// Must not be nil.
Writer AudioStreamWriter
// Reader is the EventStream reader for the CallAnalyticsTranscriptResultStream
// events. This value is automatically set by the SDK when the API call is made
// Use this member when unit testing your code with the SDK to mock out the
// EventStream Reader.
//
// Must not be nil.
Reader CallAnalyticsTranscriptResultStreamReader
// contains filtered or unexported fields
}
StartCallAnalyticsStreamTranscriptionEventStream provides the event stream handling for the StartCallAnalyticsStreamTranscription.
For testing and mocking the event stream this type should be initialized via the NewStartCallAnalyticsStreamTranscriptionEventStream constructor function. Using the functional options to pass in nested mock behavior.
func NewStartCallAnalyticsStreamTranscriptionEventStream(opts ...func(*StartCallAnalyticsStreamTranscriptionEventStream)) *StartCallAnalyticsStreamTranscriptionEventStream
NewStartCallAnalyticsStreamTranscriptionEventStream initializes an StartCallAnalyticsStreamTranscriptionEventStream. This function should only be used for testing and mocking the StartCallAnalyticsStreamTranscriptionEventStream stream within your application.
The Writer member must be set before writing events to the stream.
The Reader member must be set before reading events from the stream.
es := NewStartCallAnalyticsStreamTranscriptionEventStream(func(o *StartCallAnalyticsStreamTranscriptionEventStream){
es.Writer = myMockStreamWriter
es.Reader = myMockStreamReader
})
func (es *StartCallAnalyticsStreamTranscriptionEventStream) Close() (err error)
Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.
Will close the underlying EventStream writer, and no more events can be sent.
You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.
func (es *StartCallAnalyticsStreamTranscriptionEventStream) Err() error
Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.
func (es *StartCallAnalyticsStreamTranscriptionEventStream) Events() <-chan CallAnalyticsTranscriptResultStreamEvent
Events returns a channel to read events from.
These events are:
func (es *StartCallAnalyticsStreamTranscriptionEventStream) Send(ctx aws.Context, event AudioStreamEvent) error
Send writes the event to the stream blocking until the event is written. Returns an error if the event was not written.
These events are:
type StartCallAnalyticsStreamTranscriptionInput struct {
// 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.
//
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html).
ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"ContentIdentificationType"`
// 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.
//
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html).
ContentRedactionType *string `location:"header" locationName:"x-amzn-transcribe-content-redaction-type" type:"string" enum:"ContentRedactionType"`
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization).
EnablePartialResultsStabilization *bool `location:"header" locationName:"x-amzn-transcribe-enable-partial-results-stabilization" type:"boolean"`
// Specify the language code that represents the language spoken in your audio.
//
// If you're unsure of the language spoken in your audio, consider using IdentifyLanguage
// to enable automatic language identification.
//
// For a list of languages supported with streaming Call Analytics, refer to
// the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
// table.
//
// LanguageCode is a required field
LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" required:"true" enum:"CallAnalyticsLanguageCode"`
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html).
LanguageModelName *string `location:"header" locationName:"x-amzn-transcribe-language-model-name" min:"1" type:"string"`
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio).
//
// MediaEncoding is a required field
MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" required:"true" enum:"MediaEncoding"`
// 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.
//
// MediaSampleRateHertz is a required field
MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer" required:"true"`
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization).
PartialResultsStability *string `location:"header" locationName:"x-amzn-transcribe-partial-results-stability" type:"string" enum:"PartialResultsStability"`
// 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.
//
// To include PiiEntityTypes in your Call Analytics request, you must also include
// either ContentIdentificationType or ContentRedactionType.
//
// Values must be comma-separated and can include: BANK_ACCOUNT_NUMBER, BANK_ROUTING,
// CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS,
// NAME, PHONE, SSN, or ALL.
PiiEntityTypes *string `location:"header" locationName:"x-amzn-transcribe-pii-entity-types" min:"1" type:"string"`
// 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.
//
// You can use a session ID to retry a streaming session.
SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"`
// 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.
VocabularyFilterMethod *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-method" type:"string" enum:"VocabularyFilterMethod"`
// 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
// (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html).
VocabularyFilterName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-name" min:"1" type:"string"`
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html).
VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s StartCallAnalyticsStreamTranscriptionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartCallAnalyticsStreamTranscriptionInput) SetContentIdentificationType(v string) *StartCallAnalyticsStreamTranscriptionInput
SetContentIdentificationType sets the ContentIdentificationType field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetContentRedactionType(v string) *StartCallAnalyticsStreamTranscriptionInput
SetContentRedactionType sets the ContentRedactionType field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetEnablePartialResultsStabilization(v bool) *StartCallAnalyticsStreamTranscriptionInput
SetEnablePartialResultsStabilization sets the EnablePartialResultsStabilization field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetLanguageCode(v string) *StartCallAnalyticsStreamTranscriptionInput
SetLanguageCode sets the LanguageCode field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetLanguageModelName(v string) *StartCallAnalyticsStreamTranscriptionInput
SetLanguageModelName sets the LanguageModelName field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetMediaEncoding(v string) *StartCallAnalyticsStreamTranscriptionInput
SetMediaEncoding sets the MediaEncoding field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetMediaSampleRateHertz(v int64) *StartCallAnalyticsStreamTranscriptionInput
SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetPartialResultsStability(v string) *StartCallAnalyticsStreamTranscriptionInput
SetPartialResultsStability sets the PartialResultsStability field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetPiiEntityTypes(v string) *StartCallAnalyticsStreamTranscriptionInput
SetPiiEntityTypes sets the PiiEntityTypes field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetSessionId(v string) *StartCallAnalyticsStreamTranscriptionInput
SetSessionId sets the SessionId field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetVocabularyFilterMethod(v string) *StartCallAnalyticsStreamTranscriptionInput
SetVocabularyFilterMethod sets the VocabularyFilterMethod field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetVocabularyFilterName(v string) *StartCallAnalyticsStreamTranscriptionInput
SetVocabularyFilterName sets the VocabularyFilterName field's value.
func (s *StartCallAnalyticsStreamTranscriptionInput) SetVocabularyName(v string) *StartCallAnalyticsStreamTranscriptionInput
SetVocabularyName sets the VocabularyName field's value.
func (s StartCallAnalyticsStreamTranscriptionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartCallAnalyticsStreamTranscriptionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartCallAnalyticsStreamTranscriptionOutput struct {
// Shows whether content identification was enabled for your Call Analytics
// transcription.
ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"ContentIdentificationType"`
// Shows whether content redaction was enabled for your Call Analytics transcription.
ContentRedactionType *string `location:"header" locationName:"x-amzn-transcribe-content-redaction-type" type:"string" enum:"ContentRedactionType"`
// Shows whether partial results stabilization was enabled for your Call Analytics
// transcription.
EnablePartialResultsStabilization *bool `location:"header" locationName:"x-amzn-transcribe-enable-partial-results-stabilization" type:"boolean"`
// Provides the language code that you specified in your Call Analytics request.
LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"CallAnalyticsLanguageCode"`
// Provides the name of the custom language model that you specified in your
// Call Analytics request.
LanguageModelName *string `location:"header" locationName:"x-amzn-transcribe-language-model-name" min:"1" type:"string"`
// Provides the media encoding you specified in your Call Analytics request.
MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" enum:"MediaEncoding"`
// Provides the sample rate that you specified in your Call Analytics request.
MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer"`
// Provides the stabilization level used for your transcription.
PartialResultsStability *string `location:"header" locationName:"x-amzn-transcribe-partial-results-stability" type:"string" enum:"PartialResultsStability"`
// Lists the PII entity types you specified in your Call Analytics request.
PiiEntityTypes *string `location:"header" locationName:"x-amzn-transcribe-pii-entity-types" min:"1" type:"string"`
// Provides the identifier for your Call Analytics streaming request.
RequestId *string `location:"header" locationName:"x-amzn-request-id" type:"string"`
// Provides the identifier for your Call Analytics transcription session.
SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"`
// Provides the vocabulary filtering method used in your Call Analytics transcription.
VocabularyFilterMethod *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-method" type:"string" enum:"VocabularyFilterMethod"`
// Provides the name of the custom vocabulary filter that you specified in your
// Call Analytics request.
VocabularyFilterName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-name" min:"1" type:"string"`
// Provides the name of the custom vocabulary that you specified in your Call
// Analytics request.
VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s *StartCallAnalyticsStreamTranscriptionOutput) GetStream() *StartCallAnalyticsStreamTranscriptionEventStream
GetStream returns the type to interact with the event stream.
func (s StartCallAnalyticsStreamTranscriptionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetContentIdentificationType(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetContentIdentificationType sets the ContentIdentificationType field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetContentRedactionType(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetContentRedactionType sets the ContentRedactionType field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetEnablePartialResultsStabilization(v bool) *StartCallAnalyticsStreamTranscriptionOutput
SetEnablePartialResultsStabilization sets the EnablePartialResultsStabilization field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetLanguageCode(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetLanguageCode sets the LanguageCode field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetLanguageModelName(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetLanguageModelName sets the LanguageModelName field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetMediaEncoding(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetMediaEncoding sets the MediaEncoding field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetMediaSampleRateHertz(v int64) *StartCallAnalyticsStreamTranscriptionOutput
SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetPartialResultsStability(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetPartialResultsStability sets the PartialResultsStability field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetPiiEntityTypes(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetPiiEntityTypes sets the PiiEntityTypes field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetRequestId(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetRequestId sets the RequestId field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetSessionId(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetSessionId sets the SessionId field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetVocabularyFilterMethod(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetVocabularyFilterMethod sets the VocabularyFilterMethod field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetVocabularyFilterName(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetVocabularyFilterName sets the VocabularyFilterName field's value.
func (s *StartCallAnalyticsStreamTranscriptionOutput) SetVocabularyName(v string) *StartCallAnalyticsStreamTranscriptionOutput
SetVocabularyName sets the VocabularyName field's value.
func (s StartCallAnalyticsStreamTranscriptionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type StartMedicalStreamTranscriptionEventStream struct {
// Writer is the EventStream writer for the AudioStream
// events. This value is automatically set by the SDK when the API call is made
// Use this member when unit testing your code with the SDK to mock out the
// EventStream Writer.
//
// Must not be nil.
Writer AudioStreamWriter
// Reader is the EventStream reader for the MedicalTranscriptResultStream
// events. This value is automatically set by the SDK when the API call is made
// Use this member when unit testing your code with the SDK to mock out the
// EventStream Reader.
//
// Must not be nil.
Reader MedicalTranscriptResultStreamReader
// contains filtered or unexported fields
}
StartMedicalStreamTranscriptionEventStream provides the event stream handling for the StartMedicalStreamTranscription.
For testing and mocking the event stream this type should be initialized via the NewStartMedicalStreamTranscriptionEventStream constructor function. Using the functional options to pass in nested mock behavior.
func NewStartMedicalStreamTranscriptionEventStream(opts ...func(*StartMedicalStreamTranscriptionEventStream)) *StartMedicalStreamTranscriptionEventStream
NewStartMedicalStreamTranscriptionEventStream initializes an StartMedicalStreamTranscriptionEventStream. This function should only be used for testing and mocking the StartMedicalStreamTranscriptionEventStream stream within your application.
The Writer member must be set before writing events to the stream.
The Reader member must be set before reading events from the stream.
es := NewStartMedicalStreamTranscriptionEventStream(func(o *StartMedicalStreamTranscriptionEventStream){
es.Writer = myMockStreamWriter
es.Reader = myMockStreamReader
})
func (es *StartMedicalStreamTranscriptionEventStream) Close() (err error)
Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.
Will close the underlying EventStream writer, and no more events can be sent.
You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.
func (es *StartMedicalStreamTranscriptionEventStream) Err() error
Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.
func (es *StartMedicalStreamTranscriptionEventStream) Events() <-chan MedicalTranscriptResultStreamEvent
Events returns a channel to read events from.
These events are:
func (es *StartMedicalStreamTranscriptionEventStream) Send(ctx aws.Context, event AudioStreamEvent) error
Send writes the event to the stream blocking until the event is written. Returns an error if the event was not written.
These events are:
type StartMedicalStreamTranscriptionInput struct {
// Labels all personal health information (PHI) identified in your transcript.
//
// Content identification is performed at the segment level; PHI is flagged
// upon complete transcription of an audio segment.
//
// For more information, see Identifying personal health information (PHI) in
// a transcription (https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html).
ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"MedicalContentIdentificationType"`
// Enables channel identification in multi-channel audio.
//
// Channel identification transcribes the audio on each channel independently,
// then appends the output for each channel into one transcript.
//
// If you have multi-channel audio and do not enable channel identification,
// your audio is transcribed in a continuous manner and your transcript is not
// separated by channel.
//
// For more information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html).
EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"`
// Specify the language code that represents the language spoken in your audio.
//
// Amazon Transcribe Medical only supports US English (en-US).
//
// LanguageCode is a required field
LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" required:"true" enum:"LanguageCode"`
// Specify the encoding used for the 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 (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio).
//
// MediaEncoding is a required field
MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" required:"true" enum:"MediaEncoding"`
// The sample rate of the input audio (in hertz). Amazon Transcribe Medical
// supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you
// specify must match that of your audio.
//
// MediaSampleRateHertz is a required field
MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer" required:"true"`
// Specify the number of channels in your audio stream. Up to two channels are
// supported.
NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"`
// Specify a name for your transcription session. If you don't include this
// parameter in your request, Amazon Transcribe Medical generates an ID and
// returns it in the response.
//
// You can use a session ID to retry a streaming session.
SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"`
// Enables speaker partitioning (diarization) in your transcription output.
// Speaker partitioning labels the speech from individual speakers in your media
// file.
//
// For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html).
ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"`
// Specify the medical specialty contained in your audio.
//
// Specialty is a required field
Specialty *string `location:"header" locationName:"x-amzn-transcribe-specialty" type:"string" required:"true" enum:"Specialty"`
// Specify the type of input audio. For example, choose DICTATION for a provider
// dictating patient notes and CONVERSATION for a dialogue between a patient
// and a medical professional.
//
// Type is a required field
Type *string `location:"header" locationName:"x-amzn-transcribe-type" type:"string" required:"true" enum:"Type"`
// Specify the name of the custom vocabulary that you want to use when processing
// your transcription. Note that vocabulary names are case sensitive.
VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s StartMedicalStreamTranscriptionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartMedicalStreamTranscriptionInput) SetContentIdentificationType(v string) *StartMedicalStreamTranscriptionInput
SetContentIdentificationType sets the ContentIdentificationType field's value.
func (s *StartMedicalStreamTranscriptionInput) SetEnableChannelIdentification(v bool) *StartMedicalStreamTranscriptionInput
SetEnableChannelIdentification sets the EnableChannelIdentification field's value.
func (s *StartMedicalStreamTranscriptionInput) SetLanguageCode(v string) *StartMedicalStreamTranscriptionInput
SetLanguageCode sets the LanguageCode field's value.
func (s *StartMedicalStreamTranscriptionInput) SetMediaEncoding(v string) *StartMedicalStreamTranscriptionInput
SetMediaEncoding sets the MediaEncoding field's value.
func (s *StartMedicalStreamTranscriptionInput) SetMediaSampleRateHertz(v int64) *StartMedicalStreamTranscriptionInput
SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.
func (s *StartMedicalStreamTranscriptionInput) SetNumberOfChannels(v int64) *StartMedicalStreamTranscriptionInput
SetNumberOfChannels sets the NumberOfChannels field's value.
func (s *StartMedicalStreamTranscriptionInput) SetSessionId(v string) *StartMedicalStreamTranscriptionInput
SetSessionId sets the SessionId field's value.
func (s *StartMedicalStreamTranscriptionInput) SetShowSpeakerLabel(v bool) *StartMedicalStreamTranscriptionInput
SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.
func (s *StartMedicalStreamTranscriptionInput) SetSpecialty(v string) *StartMedicalStreamTranscriptionInput
SetSpecialty sets the Specialty field's value.
func (s *StartMedicalStreamTranscriptionInput) SetType(v string) *StartMedicalStreamTranscriptionInput
SetType sets the Type field's value.
func (s *StartMedicalStreamTranscriptionInput) SetVocabularyName(v string) *StartMedicalStreamTranscriptionInput
SetVocabularyName sets the VocabularyName field's value.
func (s StartMedicalStreamTranscriptionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartMedicalStreamTranscriptionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartMedicalStreamTranscriptionOutput struct {
// Shows whether content identification was enabled for your transcription.
ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"MedicalContentIdentificationType"`
// Shows whether channel identification was enabled for your transcription.
EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"`
// Provides the language code that you specified in your request. This must
// be en-US.
LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"LanguageCode"`
// Provides the media encoding you specified in your request.
MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" enum:"MediaEncoding"`
// Provides the sample rate that you specified in your request.
MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer"`
// Provides the number of channels that you specified in your request.
NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"`
// Provides the identifier for your streaming request.
RequestId *string `location:"header" locationName:"x-amzn-request-id" type:"string"`
// Provides the identifier for your transcription session.
SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"`
// Shows whether speaker partitioning was enabled for your transcription.
ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"`
// Provides the medical specialty that you specified in your request.
Specialty *string `location:"header" locationName:"x-amzn-transcribe-specialty" type:"string" enum:"Specialty"`
// Provides the type of audio you specified in your request.
Type *string `location:"header" locationName:"x-amzn-transcribe-type" type:"string" enum:"Type"`
// Provides the name of the custom vocabulary that you specified in your request.
VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s *StartMedicalStreamTranscriptionOutput) GetStream() *StartMedicalStreamTranscriptionEventStream
GetStream returns the type to interact with the event stream.
func (s StartMedicalStreamTranscriptionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartMedicalStreamTranscriptionOutput) SetContentIdentificationType(v string) *StartMedicalStreamTranscriptionOutput
SetContentIdentificationType sets the ContentIdentificationType field's value.
func (s *StartMedicalStreamTranscriptionOutput) SetEnableChannelIdentification(v bool) *StartMedicalStreamTranscriptionOutput
SetEnableChannelIdentification sets the EnableChannelIdentification field's value.
func (s *StartMedicalStreamTranscriptionOutput) SetLanguageCode(v string) *StartMedicalStreamTranscriptionOutput
SetLanguageCode sets the LanguageCode field's value.
func (s *StartMedicalStreamTranscriptionOutput) SetMediaEncoding(v string) *StartMedicalStreamTranscriptionOutput
SetMediaEncoding sets the MediaEncoding field's value.
func (s *StartMedicalStreamTranscriptionOutput) SetMediaSampleRateHertz(v int64) *StartMedicalStreamTranscriptionOutput
SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.
func (s *StartMedicalStreamTranscriptionOutput) SetNumberOfChannels(v int64) *StartMedicalStreamTranscriptionOutput
SetNumberOfChannels sets the NumberOfChannels field's value.
func (s *StartMedicalStreamTranscriptionOutput) SetRequestId(v string) *StartMedicalStreamTranscriptionOutput
SetRequestId sets the RequestId field's value.
func (s *StartMedicalStreamTranscriptionOutput) SetSessionId(v string) *StartMedicalStreamTranscriptionOutput
SetSessionId sets the SessionId field's value.
func (s *StartMedicalStreamTranscriptionOutput) SetShowSpeakerLabel(v bool) *StartMedicalStreamTranscriptionOutput
SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.
func (s *StartMedicalStreamTranscriptionOutput) SetSpecialty(v string) *StartMedicalStreamTranscriptionOutput
SetSpecialty sets the Specialty field's value.
func (s *StartMedicalStreamTranscriptionOutput) SetType(v string) *StartMedicalStreamTranscriptionOutput
SetType sets the Type field's value.
func (s *StartMedicalStreamTranscriptionOutput) SetVocabularyName(v string) *StartMedicalStreamTranscriptionOutput
SetVocabularyName sets the VocabularyName field's value.
func (s StartMedicalStreamTranscriptionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type StartStreamTranscriptionEventStream struct {
// Writer is the EventStream writer for the AudioStream
// events. This value is automatically set by the SDK when the API call is made
// Use this member when unit testing your code with the SDK to mock out the
// EventStream Writer.
//
// Must not be nil.
Writer AudioStreamWriter
// Reader is the EventStream reader for the TranscriptResultStream
// events. This value is automatically set by the SDK when the API call is made
// Use this member when unit testing your code with the SDK to mock out the
// EventStream Reader.
//
// Must not be nil.
Reader TranscriptResultStreamReader
// contains filtered or unexported fields
}
StartStreamTranscriptionEventStream provides the event stream handling for the StartStreamTranscription.
For testing and mocking the event stream this type should be initialized via the NewStartStreamTranscriptionEventStream constructor function. Using the functional options to pass in nested mock behavior.
func NewStartStreamTranscriptionEventStream(opts ...func(*StartStreamTranscriptionEventStream)) *StartStreamTranscriptionEventStream
NewStartStreamTranscriptionEventStream initializes an StartStreamTranscriptionEventStream. This function should only be used for testing and mocking the StartStreamTranscriptionEventStream stream within your application.
The Writer member must be set before writing events to the stream.
The Reader member must be set before reading events from the stream.
es := NewStartStreamTranscriptionEventStream(func(o *StartStreamTranscriptionEventStream){
es.Writer = myMockStreamWriter
es.Reader = myMockStreamReader
})
func (es *StartStreamTranscriptionEventStream) Close() (err error)
Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.
Will close the underlying EventStream writer, and no more events can be sent.
You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.
func (es *StartStreamTranscriptionEventStream) Err() error
Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.
func (es *StartStreamTranscriptionEventStream) Events() <-chan TranscriptResultStreamEvent
Events returns a channel to read events from.
These events are:
func (es *StartStreamTranscriptionEventStream) Send(ctx aws.Context, event AudioStreamEvent) error
Send writes the event to the stream blocking until the event is written. Returns an error if the event was not written.
These events are:
type StartStreamTranscriptionInput struct {
// 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.
//
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html).
ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"ContentIdentificationType"`
// 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.
//
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html).
ContentRedactionType *string `location:"header" locationName:"x-amzn-transcribe-content-redaction-type" type:"string" enum:"ContentRedactionType"`
// Enables channel identification in multi-channel audio.
//
// Channel identification transcribes the audio on each channel independently,
// then appends the output for each channel into one transcript.
//
// If you have multi-channel audio and do not enable channel identification,
// your audio is transcribed in a continuous manner and your transcript is not
// separated by channel.
//
// For more information, see Transcribing multi-channel audio (https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html).
EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"`
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization).
EnablePartialResultsStabilization *bool `location:"header" locationName:"x-amzn-transcribe-enable-partial-results-stabilization" type:"boolean"`
// Enables automatic language identification for your transcription.
//
// If you include IdentifyLanguage, you can optionally include a list of language
// codes, using LanguageOptions, that you think may be present in your audio
// stream. Including language options can improve transcription accuracy.
//
// You can also include a preferred language using PreferredLanguage. Adding
// a preferred language can help Amazon Transcribe identify the language faster
// than if you omit this parameter.
//
// If you have multi-channel audio that contains different languages on each
// channel, and you've enabled channel identification, automatic language identification
// identifies the dominant language on each audio channel.
//
// Note that you must include either LanguageCode or IdentifyLanguage or IdentifyMultipleLanguages
// in your request. If you include more than one of these parameters, your transcription
// job fails.
//
// Streaming language identification can't be combined with custom language
// models or redaction.
IdentifyLanguage *bool `location:"header" locationName:"x-amzn-transcribe-identify-language" type:"boolean"`
// Enables automatic multi-language identification in your transcription job
// request. Use this parameter if your stream contains more than one language.
// If your stream contains only one language, use IdentifyLanguage instead.
//
// If you include IdentifyMultipleLanguages, you can optionally include a list
// of language codes, using LanguageOptions, that you think may be present in
// your stream. Including LanguageOptions restricts IdentifyMultipleLanguages
// to only the language options that you specify, which can improve transcription
// accuracy.
//
// If you want to apply a custom vocabulary or a custom vocabulary filter to
// your automatic multiple language identification request, include VocabularyNames
// or VocabularyFilterNames.
//
// Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages
// in your request. If you include more than one of these parameters, your transcription
// job fails.
IdentifyMultipleLanguages *bool `location:"header" locationName:"x-amzn-transcribe-identify-multiple-languages" type:"boolean"`
// Specify the language code that represents the language spoken in your audio.
//
// If you're unsure of the language spoken in your audio, consider using IdentifyLanguage
// to enable automatic language identification.
//
// For a list of languages supported with Amazon Transcribe streaming, refer
// to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
// table.
LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"LanguageCode"`
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html).
LanguageModelName *string `location:"header" locationName:"x-amzn-transcribe-language-model-name" min:"1" type:"string"`
// Specify two or more language codes that represent the languages you think
// may be present in your media; including more than five is not recommended.
// If you're unsure what languages are present, do not include this parameter.
//
// Including language options can improve the accuracy of language identification.
//
// If you include LanguageOptions in your request, you must also include IdentifyLanguage.
//
// For a list of languages supported with Amazon Transcribe streaming, refer
// to the Supported languages (https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html)
// table.
//
// You can only include one language dialect per language per stream. For example,
// you cannot include en-US and en-AU in the same request.
LanguageOptions *string `location:"header" locationName:"x-amzn-transcribe-language-options" min:"1" type:"string"`
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio).
//
// MediaEncoding is a required field
MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" required:"true" enum:"MediaEncoding"`
// 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.
//
// MediaSampleRateHertz is a required field
MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer" required:"true"`
// Specify the number of channels in your audio stream. Up to two channels are
// supported.
NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"`
// 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 (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization).
PartialResultsStability *string `location:"header" locationName:"x-amzn-transcribe-partial-results-stability" type:"string" enum:"PartialResultsStability"`
// 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.
//
// To include PiiEntityTypes in your request, you must also include either ContentIdentificationType
// or ContentRedactionType.
//
// Values must be comma-separated and can include: BANK_ACCOUNT_NUMBER, BANK_ROUTING,
// CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS,
// NAME, PHONE, SSN, or ALL.
PiiEntityTypes *string `location:"header" locationName:"x-amzn-transcribe-pii-entity-types" min:"1" type:"string"`
// Specify a preferred language from the subset of languages codes you specified
// in LanguageOptions.
//
// You can only use this parameter if you've included IdentifyLanguage and LanguageOptions
// in your request.
PreferredLanguage *string `location:"header" locationName:"x-amzn-transcribe-preferred-language" type:"string" enum:"LanguageCode"`
// Specify a name for your transcription session. If you don't include this
// parameter in your request, Amazon Transcribe generates an ID and returns
// it in the response.
//
// You can use a session ID to retry a streaming session.
SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"`
// Enables speaker partitioning (diarization) in your transcription output.
// Speaker partitioning labels the speech from individual speakers in your media
// file.
//
// For more information, see Partitioning speakers (diarization) (https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html).
ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"`
// 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.
VocabularyFilterMethod *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-method" type:"string" enum:"VocabularyFilterMethod"`
// 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.
//
// This parameter is not intended for use with the IdentifyLanguage parameter.
// If you're including IdentifyLanguage in your request and want to use one
// or more vocabulary filters with your transcription, use the VocabularyFilterNames
// parameter instead.
//
// For more information, see Using vocabulary filtering with unwanted words
// (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html).
VocabularyFilterName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-name" min:"1" type:"string"`
// Specify the names of the custom vocabulary filters that you want to use when
// processing your transcription. Note that vocabulary filter names are case
// sensitive.
//
// If none of the languages of the specified custom vocabulary filters match
// the language identified in your media, your job fails.
//
// This parameter is only intended for use with the IdentifyLanguage parameter.
// If you're not including IdentifyLanguage in your request and want to use
// a custom vocabulary filter with your transcription, use the VocabularyFilterName
// parameter instead.
//
// For more information, see Using vocabulary filtering with unwanted words
// (https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html).
VocabularyFilterNames *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-names" min:"1" type:"string"`
// 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.
//
// This parameter is not intended for use with the IdentifyLanguage parameter.
// If you're including IdentifyLanguage in your request and want to use one
// or more custom vocabularies with your transcription, use the VocabularyNames
// parameter instead.
//
// For more information, see Custom vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html).
VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"`
// Specify the names of the custom vocabularies that you want to use when processing
// your transcription. Note that vocabulary names are case sensitive.
//
// If none of the languages of the specified custom vocabularies match the language
// identified in your media, your job fails.
//
// This parameter is only intended for use with the IdentifyLanguage parameter.
// If you're not including IdentifyLanguage in your request and want to use
// a custom vocabulary with your transcription, use the VocabularyName parameter
// instead.
//
// For more information, see Custom vocabularies (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html).
VocabularyNames *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-names" min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s StartStreamTranscriptionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartStreamTranscriptionInput) SetContentIdentificationType(v string) *StartStreamTranscriptionInput
SetContentIdentificationType sets the ContentIdentificationType field's value.
func (s *StartStreamTranscriptionInput) SetContentRedactionType(v string) *StartStreamTranscriptionInput
SetContentRedactionType sets the ContentRedactionType field's value.
func (s *StartStreamTranscriptionInput) SetEnableChannelIdentification(v bool) *StartStreamTranscriptionInput
SetEnableChannelIdentification sets the EnableChannelIdentification field's value.
func (s *StartStreamTranscriptionInput) SetEnablePartialResultsStabilization(v bool) *StartStreamTranscriptionInput
SetEnablePartialResultsStabilization sets the EnablePartialResultsStabilization field's value.
func (s *StartStreamTranscriptionInput) SetIdentifyLanguage(v bool) *StartStreamTranscriptionInput
SetIdentifyLanguage sets the IdentifyLanguage field's value.
func (s *StartStreamTranscriptionInput) SetIdentifyMultipleLanguages(v bool) *StartStreamTranscriptionInput
SetIdentifyMultipleLanguages sets the IdentifyMultipleLanguages field's value.
func (s *StartStreamTranscriptionInput) SetLanguageCode(v string) *StartStreamTranscriptionInput
SetLanguageCode sets the LanguageCode field's value.
func (s *StartStreamTranscriptionInput) SetLanguageModelName(v string) *StartStreamTranscriptionInput
SetLanguageModelName sets the LanguageModelName field's value.
func (s *StartStreamTranscriptionInput) SetLanguageOptions(v string) *StartStreamTranscriptionInput
SetLanguageOptions sets the LanguageOptions field's value.
func (s *StartStreamTranscriptionInput) SetMediaEncoding(v string) *StartStreamTranscriptionInput
SetMediaEncoding sets the MediaEncoding field's value.
func (s *StartStreamTranscriptionInput) SetMediaSampleRateHertz(v int64) *StartStreamTranscriptionInput
SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.
func (s *StartStreamTranscriptionInput) SetNumberOfChannels(v int64) *StartStreamTranscriptionInput
SetNumberOfChannels sets the NumberOfChannels field's value.
func (s *StartStreamTranscriptionInput) SetPartialResultsStability(v string) *StartStreamTranscriptionInput
SetPartialResultsStability sets the PartialResultsStability field's value.
func (s *StartStreamTranscriptionInput) SetPiiEntityTypes(v string) *StartStreamTranscriptionInput
SetPiiEntityTypes sets the PiiEntityTypes field's value.
func (s *StartStreamTranscriptionInput) SetPreferredLanguage(v string) *StartStreamTranscriptionInput
SetPreferredLanguage sets the PreferredLanguage field's value.
func (s *StartStreamTranscriptionInput) SetSessionId(v string) *StartStreamTranscriptionInput
SetSessionId sets the SessionId field's value.
func (s *StartStreamTranscriptionInput) SetShowSpeakerLabel(v bool) *StartStreamTranscriptionInput
SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.
func (s *StartStreamTranscriptionInput) SetVocabularyFilterMethod(v string) *StartStreamTranscriptionInput
SetVocabularyFilterMethod sets the VocabularyFilterMethod field's value.
func (s *StartStreamTranscriptionInput) SetVocabularyFilterName(v string) *StartStreamTranscriptionInput
SetVocabularyFilterName sets the VocabularyFilterName field's value.
func (s *StartStreamTranscriptionInput) SetVocabularyFilterNames(v string) *StartStreamTranscriptionInput
SetVocabularyFilterNames sets the VocabularyFilterNames field's value.
func (s *StartStreamTranscriptionInput) SetVocabularyName(v string) *StartStreamTranscriptionInput
SetVocabularyName sets the VocabularyName field's value.
func (s *StartStreamTranscriptionInput) SetVocabularyNames(v string) *StartStreamTranscriptionInput
SetVocabularyNames sets the VocabularyNames field's value.
func (s StartStreamTranscriptionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartStreamTranscriptionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartStreamTranscriptionOutput struct {
// Shows whether content identification was enabled for your transcription.
ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"ContentIdentificationType"`
// Shows whether content redaction was enabled for your transcription.
ContentRedactionType *string `location:"header" locationName:"x-amzn-transcribe-content-redaction-type" type:"string" enum:"ContentRedactionType"`
// Shows whether channel identification was enabled for your transcription.
EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"`
// Shows whether partial results stabilization was enabled for your transcription.
EnablePartialResultsStabilization *bool `location:"header" locationName:"x-amzn-transcribe-enable-partial-results-stabilization" type:"boolean"`
// Shows whether automatic language identification was enabled for your transcription.
IdentifyLanguage *bool `location:"header" locationName:"x-amzn-transcribe-identify-language" type:"boolean"`
// Shows whether automatic multi-language identification was enabled for your
// transcription.
IdentifyMultipleLanguages *bool `location:"header" locationName:"x-amzn-transcribe-identify-multiple-languages" type:"boolean"`
// Provides the language code that you specified in your request.
LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"LanguageCode"`
// Provides the name of the custom language model that you specified in your
// request.
LanguageModelName *string `location:"header" locationName:"x-amzn-transcribe-language-model-name" min:"1" type:"string"`
// Provides the language codes that you specified in your request.
LanguageOptions *string `location:"header" locationName:"x-amzn-transcribe-language-options" min:"1" type:"string"`
// Provides the media encoding you specified in your request.
MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" enum:"MediaEncoding"`
// Provides the sample rate that you specified in your request.
MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer"`
// Provides the number of channels that you specified in your request.
NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"`
// Provides the stabilization level used for your transcription.
PartialResultsStability *string `location:"header" locationName:"x-amzn-transcribe-partial-results-stability" type:"string" enum:"PartialResultsStability"`
// Lists the PII entity types you specified in your request.
PiiEntityTypes *string `location:"header" locationName:"x-amzn-transcribe-pii-entity-types" min:"1" type:"string"`
// Provides the preferred language that you specified in your request.
PreferredLanguage *string `location:"header" locationName:"x-amzn-transcribe-preferred-language" type:"string" enum:"LanguageCode"`
// Provides the identifier for your streaming request.
RequestId *string `location:"header" locationName:"x-amzn-request-id" type:"string"`
// Provides the identifier for your transcription session.
SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"`
// Shows whether speaker partitioning was enabled for your transcription.
ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"`
// Provides the vocabulary filtering method used in your transcription.
VocabularyFilterMethod *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-method" type:"string" enum:"VocabularyFilterMethod"`
// Provides the name of the custom vocabulary filter that you specified in your
// request.
VocabularyFilterName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-name" min:"1" type:"string"`
// Provides the names of the custom vocabulary filters that you specified in
// your request.
VocabularyFilterNames *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-names" min:"1" type:"string"`
// Provides the name of the custom vocabulary that you specified in your request.
VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"`
// Provides the names of the custom vocabularies that you specified in your
// request.
VocabularyNames *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-names" min:"1" type:"string"`
// contains filtered or unexported fields
}
func (s *StartStreamTranscriptionOutput) GetStream() *StartStreamTranscriptionEventStream
GetStream returns the type to interact with the event stream.
func (s StartStreamTranscriptionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *StartStreamTranscriptionOutput) SetContentIdentificationType(v string) *StartStreamTranscriptionOutput
SetContentIdentificationType sets the ContentIdentificationType field's value.
func (s *StartStreamTranscriptionOutput) SetContentRedactionType(v string) *StartStreamTranscriptionOutput
SetContentRedactionType sets the ContentRedactionType field's value.
func (s *StartStreamTranscriptionOutput) SetEnableChannelIdentification(v bool) *StartStreamTranscriptionOutput
SetEnableChannelIdentification sets the EnableChannelIdentification field's value.
func (s *StartStreamTranscriptionOutput) SetEnablePartialResultsStabilization(v bool) *StartStreamTranscriptionOutput
SetEnablePartialResultsStabilization sets the EnablePartialResultsStabilization field's value.
func (s *StartStreamTranscriptionOutput) SetIdentifyLanguage(v bool) *StartStreamTranscriptionOutput
SetIdentifyLanguage sets the IdentifyLanguage field's value.
func (s *StartStreamTranscriptionOutput) SetIdentifyMultipleLanguages(v bool) *StartStreamTranscriptionOutput
SetIdentifyMultipleLanguages sets the IdentifyMultipleLanguages field's value.
func (s *StartStreamTranscriptionOutput) SetLanguageCode(v string) *StartStreamTranscriptionOutput
SetLanguageCode sets the LanguageCode field's value.
func (s *StartStreamTranscriptionOutput) SetLanguageModelName(v string) *StartStreamTranscriptionOutput
SetLanguageModelName sets the LanguageModelName field's value.
func (s *StartStreamTranscriptionOutput) SetLanguageOptions(v string) *StartStreamTranscriptionOutput
SetLanguageOptions sets the LanguageOptions field's value.
func (s *StartStreamTranscriptionOutput) SetMediaEncoding(v string) *StartStreamTranscriptionOutput
SetMediaEncoding sets the MediaEncoding field's value.
func (s *StartStreamTranscriptionOutput) SetMediaSampleRateHertz(v int64) *StartStreamTranscriptionOutput
SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.
func (s *StartStreamTranscriptionOutput) SetNumberOfChannels(v int64) *StartStreamTranscriptionOutput
SetNumberOfChannels sets the NumberOfChannels field's value.
func (s *StartStreamTranscriptionOutput) SetPartialResultsStability(v string) *StartStreamTranscriptionOutput
SetPartialResultsStability sets the PartialResultsStability field's value.
func (s *StartStreamTranscriptionOutput) SetPiiEntityTypes(v string) *StartStreamTranscriptionOutput
SetPiiEntityTypes sets the PiiEntityTypes field's value.
func (s *StartStreamTranscriptionOutput) SetPreferredLanguage(v string) *StartStreamTranscriptionOutput
SetPreferredLanguage sets the PreferredLanguage field's value.
func (s *StartStreamTranscriptionOutput) SetRequestId(v string) *StartStreamTranscriptionOutput
SetRequestId sets the RequestId field's value.
func (s *StartStreamTranscriptionOutput) SetSessionId(v string) *StartStreamTranscriptionOutput
SetSessionId sets the SessionId field's value.
func (s *StartStreamTranscriptionOutput) SetShowSpeakerLabel(v bool) *StartStreamTranscriptionOutput
SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.
func (s *StartStreamTranscriptionOutput) SetVocabularyFilterMethod(v string) *StartStreamTranscriptionOutput
SetVocabularyFilterMethod sets the VocabularyFilterMethod field's value.
func (s *StartStreamTranscriptionOutput) SetVocabularyFilterName(v string) *StartStreamTranscriptionOutput
SetVocabularyFilterName sets the VocabularyFilterName field's value.
func (s *StartStreamTranscriptionOutput) SetVocabularyFilterNames(v string) *StartStreamTranscriptionOutput
SetVocabularyFilterNames sets the VocabularyFilterNames field's value.
func (s *StartStreamTranscriptionOutput) SetVocabularyName(v string) *StartStreamTranscriptionOutput
SetVocabularyName sets the VocabularyName field's value.
func (s *StartStreamTranscriptionOutput) SetVocabularyNames(v string) *StartStreamTranscriptionOutput
SetVocabularyNames sets the VocabularyNames field's value.
func (s StartStreamTranscriptionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TimestampRange struct {
// The time, in milliseconds, from the beginning of the audio stream to the
// start of the category match.
BeginOffsetMillis *int64 `type:"long"`
// The time, in milliseconds, from the beginning of the audio stream to the
// end of the category match.
EndOffsetMillis *int64 `type:"long"`
// contains filtered or unexported fields
}
Contains the timestamp range (start time through end time) of a matched category.
func (s TimestampRange) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TimestampRange) SetBeginOffsetMillis(v int64) *TimestampRange
SetBeginOffsetMillis sets the BeginOffsetMillis field's value.
func (s *TimestampRange) SetEndOffsetMillis(v int64) *TimestampRange
SetEndOffsetMillis sets the EndOffsetMillis field's value.
func (s TimestampRange) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TranscribeStreamingService struct {
*client.Client
}
TranscribeStreamingService provides the API operation methods for making requests to Amazon Transcribe Streaming Service. See this package's package overview docs for details on the service.
TranscribeStreamingService methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *TranscribeStreamingService
New creates a new instance of the TranscribeStreamingService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession())
// Create a TranscribeStreamingService client from just a session.
svc := transcribestreamingservice.New(mySession)
// Create a TranscribeStreamingService client with additional configuration
svc := transcribestreamingservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *TranscribeStreamingService) StartCallAnalyticsStreamTranscription(input *StartCallAnalyticsStreamTranscriptionInput) (*StartCallAnalyticsStreamTranscriptionOutput, error)
StartCallAnalyticsStreamTranscription API operation for Amazon Transcribe Streaming Service.
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 (https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html) transcriptions.
The following parameters are required:
language-code
media-encoding
sample-rate
For more information on streaming with Amazon Transcribe, see Transcribing streaming audio (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Transcribe Streaming Service's API operation StartCallAnalyticsStreamTranscription for usage and error information.
Returned Error Types:
BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.
LimitExceededException 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.
InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing.
ConflictException A new stream started with the same session ID. The current stream has been terminated.
ServiceUnavailableException The service is currently unavailable. Try your request later.
func (c *TranscribeStreamingService) StartCallAnalyticsStreamTranscriptionRequest(input *StartCallAnalyticsStreamTranscriptionInput) (req *request.Request, output *StartCallAnalyticsStreamTranscriptionOutput)
StartCallAnalyticsStreamTranscriptionRequest generates a "aws/request.Request" representing the client's request for the StartCallAnalyticsStreamTranscription operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartCallAnalyticsStreamTranscription for more information on using the StartCallAnalyticsStreamTranscription API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartCallAnalyticsStreamTranscriptionRequest method.
req, resp := client.StartCallAnalyticsStreamTranscriptionRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *TranscribeStreamingService) StartCallAnalyticsStreamTranscriptionWithContext(ctx aws.Context, input *StartCallAnalyticsStreamTranscriptionInput, opts ...request.Option) (*StartCallAnalyticsStreamTranscriptionOutput, error)
StartCallAnalyticsStreamTranscriptionWithContext is the same as StartCallAnalyticsStreamTranscription with the addition of the ability to pass a context and additional request options.
See StartCallAnalyticsStreamTranscription for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *TranscribeStreamingService) StartMedicalStreamTranscription(input *StartMedicalStreamTranscriptionInput) (*StartMedicalStreamTranscriptionOutput, error)
StartMedicalStreamTranscription API operation for Amazon Transcribe Streaming Service.
Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.
The following parameters are required:
language-code
media-encoding
sample-rate
For more information on streaming with Amazon Transcribe Medical, see Transcribing streaming audio (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Transcribe Streaming Service's API operation StartMedicalStreamTranscription for usage and error information.
Returned Error Types:
BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.
LimitExceededException 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.
InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing.
ConflictException A new stream started with the same session ID. The current stream has been terminated.
ServiceUnavailableException The service is currently unavailable. Try your request later.
func (c *TranscribeStreamingService) StartMedicalStreamTranscriptionRequest(input *StartMedicalStreamTranscriptionInput) (req *request.Request, output *StartMedicalStreamTranscriptionOutput)
StartMedicalStreamTranscriptionRequest generates a "aws/request.Request" representing the client's request for the StartMedicalStreamTranscription operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartMedicalStreamTranscription for more information on using the StartMedicalStreamTranscription API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartMedicalStreamTranscriptionRequest method.
req, resp := client.StartMedicalStreamTranscriptionRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *TranscribeStreamingService) StartMedicalStreamTranscriptionWithContext(ctx aws.Context, input *StartMedicalStreamTranscriptionInput, opts ...request.Option) (*StartMedicalStreamTranscriptionOutput, error)
StartMedicalStreamTranscriptionWithContext is the same as StartMedicalStreamTranscription with the addition of the ability to pass a context and additional request options.
See StartMedicalStreamTranscription for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *TranscribeStreamingService) StartStreamTranscription(input *StartStreamTranscriptionInput) (*StartStreamTranscriptionOutput, error)
StartStreamTranscription API operation for Amazon Transcribe Streaming Service.
Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.
The following parameters are required:
language-code or identify-language or identify-multiple-language
media-encoding
sample-rate
For more information on streaming with Amazon Transcribe, see Transcribing streaming audio (https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon Transcribe Streaming Service's API operation StartStreamTranscription for usage and error information.
Returned Error Types:
BadRequestException One or more arguments to the StartStreamTranscription, StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.
LimitExceededException 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.
InternalFailureException A problem occurred while processing the audio. Amazon Transcribe terminated processing.
ConflictException A new stream started with the same session ID. The current stream has been terminated.
ServiceUnavailableException The service is currently unavailable. Try your request later.
▹ Example (StreamAudio)
func (c *TranscribeStreamingService) StartStreamTranscriptionRequest(input *StartStreamTranscriptionInput) (req *request.Request, output *StartStreamTranscriptionOutput)
StartStreamTranscriptionRequest generates a "aws/request.Request" representing the client's request for the StartStreamTranscription operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartStreamTranscription for more information on using the StartStreamTranscription API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartStreamTranscriptionRequest method.
req, resp := client.StartStreamTranscriptionRequest(params)
err := req.Send()
if err == nil { // resp is now filled
fmt.Println(resp)
}
func (c *TranscribeStreamingService) StartStreamTranscriptionWithContext(ctx aws.Context, input *StartStreamTranscriptionInput, opts ...request.Option) (*StartStreamTranscriptionOutput, error)
StartStreamTranscriptionWithContext is the same as StartStreamTranscription with the addition of the ability to pass a context and additional request options.
See StartStreamTranscription for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type Transcript struct {
// 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.
Results []*Result `type:"list"`
// contains filtered or unexported fields
}
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.
func (s Transcript) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Transcript) SetResults(v []*Result) *Transcript
SetResults sets the Results field's value.
func (s Transcript) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TranscriptEvent struct {
// Contains Results, which 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.
Transcript *Transcript `type:"structure"`
// contains filtered or unexported fields
}
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.
func (s TranscriptEvent) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TranscriptEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *TranscriptEvent) SetTranscript(v *Transcript) *TranscriptEvent
SetTranscript sets the Transcript field's value.
func (s TranscriptEvent) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TranscriptEvent) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the TranscriptEvent value. This method is only used internally within the SDK's EventStream handling.
type TranscriptResultStreamEvent interface {
eventstreamapi.Marshaler
eventstreamapi.Unmarshaler
// contains filtered or unexported methods
}
TranscriptResultStreamEvent groups together all EventStream events writes for TranscriptResultStream.
These events are:
type TranscriptResultStreamReader interface {
// Returns a channel of events as they are read from the event stream.
Events() <-chan TranscriptResultStreamEvent
// Close will stop the reader reading events from the stream.
Close() error
// Returns any error that has occurred while reading from the event stream.
Err() error
}
TranscriptResultStreamReader provides the interface for reading to the stream. The default implementation for this interface will be TranscriptResultStream.
The reader's Close method must allow multiple concurrent calls.
These events are:
type TranscriptResultStreamUnknownEvent struct {
Type string
Message eventstream.Message
}
TranscriptResultStreamUnknownEvent provides a failsafe event for the TranscriptResultStream group of events when an unknown event is received.
func (e *TranscriptResultStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) ( msg eventstream.Message, err error, )
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (e *TranscriptResultStreamUnknownEvent) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the TranscriptResultStream value. This method is only used internally within the SDK's EventStream handling.
type UtteranceEvent struct {
// The time, in milliseconds, from the beginning of the audio stream to the
// start of the UtteranceEvent.
BeginOffsetMillis *int64 `type:"long"`
// The time, in milliseconds, from the beginning of the audio stream to the
// start of the UtteranceEvent.
EndOffsetMillis *int64 `type:"long"`
// Contains entities identified as personally identifiable information (PII)
// in your transcription output.
Entities []*CallAnalyticsEntity `type:"list"`
// Indicates whether the segment in the UtteranceEvent is complete (FALSE) or
// partial (TRUE).
IsPartial *bool `type:"boolean"`
// Provides the issue that was detected in the specified segment.
IssuesDetected []*IssueDetected `type:"list"`
// Contains words, phrases, or punctuation marks that are associated with the
// specified UtteranceEvent.
Items []*CallAnalyticsItem `type:"list"`
// Provides the role of the speaker for each audio channel, either CUSTOMER
// or AGENT.
ParticipantRole *string `type:"string" enum:"ParticipantRole"`
// Provides the sentiment that was detected in the specified segment.
Sentiment *string `type:"string" enum:"Sentiment"`
// Contains transcribed text.
Transcript *string `type:"string"`
// The unique identifier that is associated with the specified UtteranceEvent.
UtteranceId *string `type:"string"`
// contains filtered or unexported fields
}
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.
func (s UtteranceEvent) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UtteranceEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)
MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.
func (s *UtteranceEvent) SetBeginOffsetMillis(v int64) *UtteranceEvent
SetBeginOffsetMillis sets the BeginOffsetMillis field's value.
func (s *UtteranceEvent) SetEndOffsetMillis(v int64) *UtteranceEvent
SetEndOffsetMillis sets the EndOffsetMillis field's value.
func (s *UtteranceEvent) SetEntities(v []*CallAnalyticsEntity) *UtteranceEvent
SetEntities sets the Entities field's value.
func (s *UtteranceEvent) SetIsPartial(v bool) *UtteranceEvent
SetIsPartial sets the IsPartial field's value.
func (s *UtteranceEvent) SetIssuesDetected(v []*IssueDetected) *UtteranceEvent
SetIssuesDetected sets the IssuesDetected field's value.
func (s *UtteranceEvent) SetItems(v []*CallAnalyticsItem) *UtteranceEvent
SetItems sets the Items field's value.
func (s *UtteranceEvent) SetParticipantRole(v string) *UtteranceEvent
SetParticipantRole sets the ParticipantRole field's value.
func (s *UtteranceEvent) SetSentiment(v string) *UtteranceEvent
SetSentiment sets the Sentiment field's value.
func (s *UtteranceEvent) SetTranscript(v string) *UtteranceEvent
SetTranscript sets the Transcript field's value.
func (s *UtteranceEvent) SetUtteranceId(v string) *UtteranceEvent
SetUtteranceId sets the UtteranceId field's value.
func (s UtteranceEvent) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UtteranceEvent) UnmarshalEvent( payloadUnmarshaler protocol.PayloadUnmarshaler, msg eventstream.Message, ) error
UnmarshalEvent unmarshals the EventStream Message into the UtteranceEvent value. This method is only used internally within the SDK's EventStream handling.