transcribestreamingservice

package
v1.44.136 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2022 License: Apache-2.0 Imports: 17 Imported by: 17

Documentation

Overview

Package transcribestreamingservice provides the client and types for making API requests to Amazon Transcribe Streaming Service.

Amazon Transcribe streaming offers two types of real-time transcription: Standard and Medical.

  • Standard transcriptions are the most common option. Refer to for details.

  • Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to for details.

See https://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26 for more information on this service.

See transcribestreamingservice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/transcribestreamingservice/

Using the Client

To contact Amazon Transcribe Streaming Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Transcribe Streaming Service client TranscribeStreamingService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/transcribestreamingservice/#New

Index

Examples

Constants

View Source
const (
	// ItemTypePronunciation is a ItemType enum value
	ItemTypePronunciation = "pronunciation"

	// ItemTypePunctuation is a ItemType enum value
	ItemTypePunctuation = "punctuation"
)
View Source
const (
	// LanguageCodeEnUs is a LanguageCode enum value
	LanguageCodeEnUs = "en-US"

	// LanguageCodeEnGb is a LanguageCode enum value
	LanguageCodeEnGb = "en-GB"

	// LanguageCodeEsUs is a LanguageCode enum value
	LanguageCodeEsUs = "es-US"

	// LanguageCodeFrCa is a LanguageCode enum value
	LanguageCodeFrCa = "fr-CA"

	// LanguageCodeFrFr is a LanguageCode enum value
	LanguageCodeFrFr = "fr-FR"

	// LanguageCodeEnAu is a LanguageCode enum value
	LanguageCodeEnAu = "en-AU"

	// LanguageCodeItIt is a LanguageCode enum value
	LanguageCodeItIt = "it-IT"

	// LanguageCodeDeDe is a LanguageCode enum value
	LanguageCodeDeDe = "de-DE"

	// LanguageCodePtBr is a LanguageCode enum value
	LanguageCodePtBr = "pt-BR"

	// LanguageCodeJaJp is a LanguageCode enum value
	LanguageCodeJaJp = "ja-JP"

	// LanguageCodeKoKr is a LanguageCode enum value
	LanguageCodeKoKr = "ko-KR"

	// LanguageCodeZhCn is a LanguageCode enum value
	LanguageCodeZhCn = "zh-CN"

	// LanguageCodeHiIn is a LanguageCode enum value
	LanguageCodeHiIn = "hi-IN"

	// LanguageCodeThTh is a LanguageCode enum value
	LanguageCodeThTh = "th-TH"
)
View Source
const (
	// MediaEncodingPcm is a MediaEncoding enum value
	MediaEncodingPcm = "pcm"

	// MediaEncodingOggOpus is a MediaEncoding enum value
	MediaEncodingOggOpus = "ogg-opus"

	// MediaEncodingFlac is a MediaEncoding enum value
	MediaEncodingFlac = "flac"
)
View Source
const (
	// PartialResultsStabilityHigh is a PartialResultsStability enum value
	PartialResultsStabilityHigh = "high"

	// PartialResultsStabilityMedium is a PartialResultsStability enum value
	PartialResultsStabilityMedium = "medium"

	// PartialResultsStabilityLow is a PartialResultsStability enum value
	PartialResultsStabilityLow = "low"
)
View Source
const (
	// SpecialtyPrimarycare is a Specialty enum value
	SpecialtyPrimarycare = "PRIMARYCARE"

	// SpecialtyCardiology is a Specialty enum value
	SpecialtyCardiology = "CARDIOLOGY"

	// SpecialtyNeurology is a Specialty enum value
	SpecialtyNeurology = "NEUROLOGY"

	// SpecialtyOncology is a Specialty enum value
	SpecialtyOncology = "ONCOLOGY"

	// SpecialtyRadiology is a Specialty enum value
	SpecialtyRadiology = "RADIOLOGY"

	// SpecialtyUrology is a Specialty enum value
	SpecialtyUrology = "UROLOGY"
)
View Source
const (
	// TypeConversation is a Type enum value
	TypeConversation = "CONVERSATION"

	// TypeDictation is a Type enum value
	TypeDictation = "DICTATION"
)
View Source
const (
	// VocabularyFilterMethodRemove is a VocabularyFilterMethod enum value
	VocabularyFilterMethodRemove = "remove"

	// VocabularyFilterMethodMask is a VocabularyFilterMethod enum value
	VocabularyFilterMethodMask = "mask"

	// VocabularyFilterMethodTag is a VocabularyFilterMethod enum value
	VocabularyFilterMethodTag = "tag"
)
View Source
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// One or more arguments to the StartStreamTranscription or StartMedicalStreamTranscription
	// operation was not valid. For example, MediaEncoding or LanguageCode used
	// not valid values. Check the specified parameters and try your request again.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// A new stream started with the same session ID. The current stream has been
	// terminated.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// A problem occurred while processing the audio. Amazon Transcribe terminated
	// processing.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeLimitExceededException for service response error code
	// "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.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is currently unavailable. Try your request later.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"
)
View Source
const (
	ServiceName = "Transcribe Streaming" // Name of service.
	EndpointsID = "transcribestreaming"  // ID to lookup a service endpoint with.
	ServiceID   = "Transcribe Streaming" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// ContentIdentificationTypePii is a ContentIdentificationType enum value
	ContentIdentificationTypePii = "PII"
)
View Source
const (
	// ContentRedactionTypePii is a ContentRedactionType enum value
	ContentRedactionTypePii = "PII"
)
View Source
const (
	// MedicalContentIdentificationTypePhi is a MedicalContentIdentificationType enum value
	MedicalContentIdentificationTypePhi = "PHI"
)

Variables

This section is empty.

Functions

func ContentIdentificationType_Values added in v1.40.43

func ContentIdentificationType_Values() []string

ContentIdentificationType_Values returns all elements of the ContentIdentificationType enum

func ContentRedactionType_Values added in v1.40.43

func ContentRedactionType_Values() []string

ContentRedactionType_Values returns all elements of the ContentRedactionType enum

func ItemType_Values added in v1.34.3

func ItemType_Values() []string

ItemType_Values returns all elements of the ItemType enum

func LanguageCode_Values added in v1.34.3

func LanguageCode_Values() []string

LanguageCode_Values returns all elements of the LanguageCode enum

func MediaEncoding_Values added in v1.34.3

func MediaEncoding_Values() []string

MediaEncoding_Values returns all elements of the MediaEncoding enum

func MedicalContentIdentificationType_Values added in v1.37.1

func MedicalContentIdentificationType_Values() []string

MedicalContentIdentificationType_Values returns all elements of the MedicalContentIdentificationType enum

func PartialResultsStability_Values added in v1.38.38

func PartialResultsStability_Values() []string

PartialResultsStability_Values returns all elements of the PartialResultsStability enum

func Specialty_Values added in v1.35.35

func Specialty_Values() []string

Specialty_Values returns all elements of the Specialty enum

func StreamAudioFromReader

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 added in v1.35.35

func Type_Values() []string

Type_Values returns all elements of the Type enum

func VocabularyFilterMethod_Values added in v1.34.3

func VocabularyFilterMethod_Values() []string

VocabularyFilterMethod_Values returns all elements of the VocabularyFilterMethod enum

Types

type Alternative

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 (Alternative) GoString

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 (*Alternative) SetEntities added in v1.40.43

func (s *Alternative) SetEntities(v []*Entity) *Alternative

SetEntities sets the Entities field's value.

func (*Alternative) SetItems

func (s *Alternative) SetItems(v []*Item) *Alternative

SetItems sets the Items field's value.

func (*Alternative) SetTranscript

func (s *Alternative) SetTranscript(v string) *Alternative

SetTranscript sets the Transcript field's value.

func (Alternative) String

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

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 (AudioEvent) GoString

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 (*AudioEvent) MarshalEvent

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 (*AudioEvent) SetAudioChunk

func (s *AudioEvent) SetAudioChunk(v []byte) *AudioEvent

SetAudioChunk sets the AudioChunk field's value.

func (AudioEvent) String

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 (*AudioEvent) UnmarshalEvent

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

type AudioStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

AudioStreamEvent groups together all EventStream events writes for AudioStream.

These events are:

  • AudioEvent

type AudioStreamWriter

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:

  • AudioEvent

type BadRequestException

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 or StartMedicalStreamTranscription operation was not valid. For example, MediaEncoding or LanguageCode used not valid values. Check the specified parameters and try your request again.

func (*BadRequestException) Code

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error

func (s *BadRequestException) Error() string

func (BadRequestException) GoString

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 (*BadRequestException) MarshalEvent

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 (*BadRequestException) Message

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID added in v1.28.0

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode added in v1.28.0

func (s *BadRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (BadRequestException) String

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 (*BadRequestException) UnmarshalEvent

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 ConflictException

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 (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

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 (*ConflictException) MarshalEvent

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 (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.28.0

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.28.0

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

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 (*ConflictException) UnmarshalEvent

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 added in v1.40.43

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 (Entity) GoString added in v1.40.43

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 (*Entity) SetCategory added in v1.40.43

func (s *Entity) SetCategory(v string) *Entity

SetCategory sets the Category field's value.

func (*Entity) SetConfidence added in v1.40.43

func (s *Entity) SetConfidence(v float64) *Entity

SetConfidence sets the Confidence field's value.

func (*Entity) SetContent added in v1.40.43

func (s *Entity) SetContent(v string) *Entity

SetContent sets the Content field's value.

func (*Entity) SetEndTime added in v1.40.43

func (s *Entity) SetEndTime(v float64) *Entity

SetEndTime sets the EndTime field's value.

func (*Entity) SetStartTime added in v1.40.43

func (s *Entity) SetStartTime(v float64) *Entity

SetStartTime sets the StartTime field's value.

func (*Entity) SetType added in v1.40.43

func (s *Entity) SetType(v string) *Entity

SetType sets the Type field's value.

func (Entity) String added in v1.40.43

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

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 (*InternalFailureException) Code

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString

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 (*InternalFailureException) MarshalEvent

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*InternalFailureException) Message

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID added in v1.28.0

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode added in v1.28.0

func (s *InternalFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalFailureException) String

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 (*InternalFailureException) UnmarshalEvent

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 Item

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 (Item) GoString

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 (*Item) SetConfidence added in v1.37.31

func (s *Item) SetConfidence(v float64) *Item

SetConfidence sets the Confidence field's value.

func (*Item) SetContent

func (s *Item) SetContent(v string) *Item

SetContent sets the Content field's value.

func (*Item) SetEndTime

func (s *Item) SetEndTime(v float64) *Item

SetEndTime sets the EndTime field's value.

func (*Item) SetSpeaker added in v1.34.8

func (s *Item) SetSpeaker(v string) *Item

SetSpeaker sets the Speaker field's value.

func (*Item) SetStable added in v1.38.38

func (s *Item) SetStable(v bool) *Item

SetStable sets the Stable field's value.

func (*Item) SetStartTime

func (s *Item) SetStartTime(v float64) *Item

SetStartTime sets the StartTime field's value.

func (*Item) SetType

func (s *Item) SetType(v string) *Item

SetType sets the Type field's value.

func (*Item) SetVocabularyFilterMatch added in v1.31.2

func (s *Item) SetVocabularyFilterMatch(v bool) *Item

SetVocabularyFilterMatch sets the VocabularyFilterMatch field's value.

func (Item) String

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 added in v1.42.10

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 (LanguageWithScore) GoString added in v1.42.10

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 (*LanguageWithScore) SetLanguageCode added in v1.42.10

func (s *LanguageWithScore) SetLanguageCode(v string) *LanguageWithScore

SetLanguageCode sets the LanguageCode field's value.

func (*LanguageWithScore) SetScore added in v1.42.10

SetScore sets the Score field's value.

func (LanguageWithScore) String added in v1.42.10

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

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 (*LimitExceededException) Code

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString

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 (*LimitExceededException) MarshalEvent

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*LimitExceededException) Message

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String

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 (*LimitExceededException) UnmarshalEvent

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 added in v1.35.35

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 (MedicalAlternative) GoString added in v1.35.35

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 (*MedicalAlternative) SetEntities added in v1.37.1

func (s *MedicalAlternative) SetEntities(v []*MedicalEntity) *MedicalAlternative

SetEntities sets the Entities field's value.

func (*MedicalAlternative) SetItems added in v1.35.35

SetItems sets the Items field's value.

func (*MedicalAlternative) SetTranscript added in v1.35.35

func (s *MedicalAlternative) SetTranscript(v string) *MedicalAlternative

SetTranscript sets the Transcript field's value.

func (MedicalAlternative) String added in v1.35.35

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 added in v1.37.1

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 (MedicalEntity) GoString added in v1.37.1

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 (*MedicalEntity) SetCategory added in v1.37.1

func (s *MedicalEntity) SetCategory(v string) *MedicalEntity

SetCategory sets the Category field's value.

func (*MedicalEntity) SetConfidence added in v1.37.1

func (s *MedicalEntity) SetConfidence(v float64) *MedicalEntity

SetConfidence sets the Confidence field's value.

func (*MedicalEntity) SetContent added in v1.37.1

func (s *MedicalEntity) SetContent(v string) *MedicalEntity

SetContent sets the Content field's value.

func (*MedicalEntity) SetEndTime added in v1.37.1

func (s *MedicalEntity) SetEndTime(v float64) *MedicalEntity

SetEndTime sets the EndTime field's value.

func (*MedicalEntity) SetStartTime added in v1.37.1

func (s *MedicalEntity) SetStartTime(v float64) *MedicalEntity

SetStartTime sets the StartTime field's value.

func (MedicalEntity) String added in v1.37.1

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 added in v1.35.35

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 (MedicalItem) GoString added in v1.35.35

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 (*MedicalItem) SetConfidence added in v1.35.35

func (s *MedicalItem) SetConfidence(v float64) *MedicalItem

SetConfidence sets the Confidence field's value.

func (*MedicalItem) SetContent added in v1.35.35

func (s *MedicalItem) SetContent(v string) *MedicalItem

SetContent sets the Content field's value.

func (*MedicalItem) SetEndTime added in v1.35.35

func (s *MedicalItem) SetEndTime(v float64) *MedicalItem

SetEndTime sets the EndTime field's value.

func (*MedicalItem) SetSpeaker added in v1.35.35

func (s *MedicalItem) SetSpeaker(v string) *MedicalItem

SetSpeaker sets the Speaker field's value.

func (*MedicalItem) SetStartTime added in v1.35.35

func (s *MedicalItem) SetStartTime(v float64) *MedicalItem

SetStartTime sets the StartTime field's value.

func (*MedicalItem) SetType added in v1.35.35

func (s *MedicalItem) SetType(v string) *MedicalItem

SetType sets the Type field's value.

func (MedicalItem) String added in v1.35.35

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 added in v1.35.35

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 (MedicalResult) GoString added in v1.35.35

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 (*MedicalResult) SetAlternatives added in v1.35.35

func (s *MedicalResult) SetAlternatives(v []*MedicalAlternative) *MedicalResult

SetAlternatives sets the Alternatives field's value.

func (*MedicalResult) SetChannelId added in v1.35.35

func (s *MedicalResult) SetChannelId(v string) *MedicalResult

SetChannelId sets the ChannelId field's value.

func (*MedicalResult) SetEndTime added in v1.35.35

func (s *MedicalResult) SetEndTime(v float64) *MedicalResult

SetEndTime sets the EndTime field's value.

func (*MedicalResult) SetIsPartial added in v1.35.35

func (s *MedicalResult) SetIsPartial(v bool) *MedicalResult

SetIsPartial sets the IsPartial field's value.

func (*MedicalResult) SetResultId added in v1.35.35

func (s *MedicalResult) SetResultId(v string) *MedicalResult

SetResultId sets the ResultId field's value.

func (*MedicalResult) SetStartTime added in v1.35.35

func (s *MedicalResult) SetStartTime(v float64) *MedicalResult

SetStartTime sets the StartTime field's value.

func (MedicalResult) String added in v1.35.35

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 added in v1.35.35

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 (MedicalTranscript) GoString added in v1.35.35

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 (*MedicalTranscript) SetResults added in v1.35.35

func (s *MedicalTranscript) SetResults(v []*MedicalResult) *MedicalTranscript

SetResults sets the Results field's value.

func (MedicalTranscript) String added in v1.35.35

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 added in v1.35.35

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 (MedicalTranscriptEvent) GoString added in v1.35.35

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 (*MedicalTranscriptEvent) MarshalEvent added in v1.35.35

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*MedicalTranscriptEvent) SetTranscript added in v1.35.35

SetTranscript sets the Transcript field's value.

func (MedicalTranscriptEvent) String added in v1.35.35

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 (*MedicalTranscriptEvent) UnmarshalEvent added in v1.35.35

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 added in v1.35.35

type MedicalTranscriptResultStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

MedicalTranscriptResultStreamEvent groups together all EventStream events writes for MedicalTranscriptResultStream.

These events are:

  • MedicalTranscriptEvent

type MedicalTranscriptResultStreamReader added in v1.35.35

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:

  • MedicalTranscriptEvent
  • MedicalTranscriptResultStreamUnknownEvent

type MedicalTranscriptResultStreamUnknownEvent added in v1.35.35

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 (*MedicalTranscriptResultStreamUnknownEvent) MarshalEvent added in v1.35.35

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*MedicalTranscriptResultStreamUnknownEvent) UnmarshalEvent added in v1.35.35

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 Result

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 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"`

	// 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 (Result) GoString

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 (*Result) SetAlternatives

func (s *Result) SetAlternatives(v []*Alternative) *Result

SetAlternatives sets the Alternatives field's value.

func (*Result) SetChannelId added in v1.34.26

func (s *Result) SetChannelId(v string) *Result

SetChannelId sets the ChannelId field's value.

func (*Result) SetEndTime

func (s *Result) SetEndTime(v float64) *Result

SetEndTime sets the EndTime field's value.

func (*Result) SetIsPartial

func (s *Result) SetIsPartial(v bool) *Result

SetIsPartial sets the IsPartial field's value.

func (*Result) SetLanguageCode added in v1.42.10

func (s *Result) SetLanguageCode(v string) *Result

SetLanguageCode sets the LanguageCode field's value.

func (*Result) SetLanguageIdentification added in v1.42.10

func (s *Result) SetLanguageIdentification(v []*LanguageWithScore) *Result

SetLanguageIdentification sets the LanguageIdentification field's value.

func (*Result) SetResultId

func (s *Result) SetResultId(v string) *Result

SetResultId sets the ResultId field's value.

func (*Result) SetStartTime

func (s *Result) SetStartTime(v float64) *Result

SetStartTime sets the StartTime field's value.

func (Result) String

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 added in v1.30.12

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 (*ServiceUnavailableException) Code added in v1.30.12

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.30.12

func (ServiceUnavailableException) GoString added in v1.30.12

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 (*ServiceUnavailableException) MarshalEvent added in v1.30.12

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ServiceUnavailableException) Message added in v1.30.12

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.30.12

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.30.12

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.30.12

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String added in v1.30.12

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 (*ServiceUnavailableException) UnmarshalEvent added in v1.30.12

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 StartMedicalStreamTranscriptionEventStream added in v1.35.35

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 added in v1.35.35

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 (*StartMedicalStreamTranscriptionEventStream) Close added in v1.35.35

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 (*StartMedicalStreamTranscriptionEventStream) Err added in v1.35.35

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 (*StartMedicalStreamTranscriptionEventStream) Events added in v1.35.35

Events returns a channel to read events from.

These events are:

  • MedicalTranscriptEvent
  • MedicalTranscriptResultStreamUnknownEvent

func (*StartMedicalStreamTranscriptionEventStream) Send added in v1.35.35

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:

  • AudioEvent

type StartMedicalStreamTranscriptionInput added in v1.35.35

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 `` /* 132-byte string literal not displayed */

	// 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 (StartMedicalStreamTranscriptionInput) GoString added in v1.35.35

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 (*StartMedicalStreamTranscriptionInput) SetContentIdentificationType added in v1.37.1

SetContentIdentificationType sets the ContentIdentificationType field's value.

func (*StartMedicalStreamTranscriptionInput) SetEnableChannelIdentification added in v1.35.35

SetEnableChannelIdentification sets the EnableChannelIdentification field's value.

func (*StartMedicalStreamTranscriptionInput) SetLanguageCode added in v1.35.35

SetLanguageCode sets the LanguageCode field's value.

func (*StartMedicalStreamTranscriptionInput) SetMediaEncoding added in v1.35.35

SetMediaEncoding sets the MediaEncoding field's value.

func (*StartMedicalStreamTranscriptionInput) SetMediaSampleRateHertz added in v1.35.35

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*StartMedicalStreamTranscriptionInput) SetNumberOfChannels added in v1.35.35

SetNumberOfChannels sets the NumberOfChannels field's value.

func (*StartMedicalStreamTranscriptionInput) SetSessionId added in v1.35.35

SetSessionId sets the SessionId field's value.

func (*StartMedicalStreamTranscriptionInput) SetShowSpeakerLabel added in v1.35.35

SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.

func (*StartMedicalStreamTranscriptionInput) SetSpecialty added in v1.35.35

SetSpecialty sets the Specialty field's value.

func (*StartMedicalStreamTranscriptionInput) SetType added in v1.35.35

SetType sets the Type field's value.

func (*StartMedicalStreamTranscriptionInput) SetVocabularyName added in v1.35.35

SetVocabularyName sets the VocabularyName field's value.

func (StartMedicalStreamTranscriptionInput) String added in v1.35.35

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 (*StartMedicalStreamTranscriptionInput) Validate added in v1.35.35

Validate inspects the fields of the type to determine if they are valid.

type StartMedicalStreamTranscriptionOutput added in v1.35.35

type StartMedicalStreamTranscriptionOutput struct {

	// Shows whether content identification was enabled for your transcription.
	ContentIdentificationType *string `` /* 132-byte string literal not displayed */

	// 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 (*StartMedicalStreamTranscriptionOutput) GetStream added in v1.35.35

GetStream returns the type to interact with the event stream.

func (StartMedicalStreamTranscriptionOutput) GoString added in v1.35.35

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 (*StartMedicalStreamTranscriptionOutput) SetContentIdentificationType added in v1.37.1

SetContentIdentificationType sets the ContentIdentificationType field's value.

func (*StartMedicalStreamTranscriptionOutput) SetEnableChannelIdentification added in v1.35.35

SetEnableChannelIdentification sets the EnableChannelIdentification field's value.

func (*StartMedicalStreamTranscriptionOutput) SetLanguageCode added in v1.35.35

SetLanguageCode sets the LanguageCode field's value.

func (*StartMedicalStreamTranscriptionOutput) SetMediaEncoding added in v1.35.35

SetMediaEncoding sets the MediaEncoding field's value.

func (*StartMedicalStreamTranscriptionOutput) SetMediaSampleRateHertz added in v1.35.35

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*StartMedicalStreamTranscriptionOutput) SetNumberOfChannels added in v1.35.35

SetNumberOfChannels sets the NumberOfChannels field's value.

func (*StartMedicalStreamTranscriptionOutput) SetRequestId added in v1.35.35

SetRequestId sets the RequestId field's value.

func (*StartMedicalStreamTranscriptionOutput) SetSessionId added in v1.35.35

SetSessionId sets the SessionId field's value.

func (*StartMedicalStreamTranscriptionOutput) SetShowSpeakerLabel added in v1.35.35

SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.

func (*StartMedicalStreamTranscriptionOutput) SetSpecialty added in v1.35.35

SetSpecialty sets the Specialty field's value.

func (*StartMedicalStreamTranscriptionOutput) SetType added in v1.35.35

SetType sets the Type field's value.

func (*StartMedicalStreamTranscriptionOutput) SetVocabularyName added in v1.35.35

SetVocabularyName sets the VocabularyName field's value.

func (StartMedicalStreamTranscriptionOutput) String added in v1.35.35

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

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 added in v1.34.3

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 (*StartStreamTranscriptionEventStream) Close

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 (*StartStreamTranscriptionEventStream) Err

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 (*StartStreamTranscriptionEventStream) Events

Events returns a channel to read events from.

These events are:

  • TranscriptEvent
  • TranscriptResultStreamUnknownEvent

func (*StartStreamTranscriptionEventStream) Send

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:

  • AudioEvent

type StartStreamTranscriptionInput

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 in your
	// request. If you include both parameters, your request 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"`

	// 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 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 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). 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, your job fails.
	//
	// 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, your job fails.
	//
	// 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 (StartStreamTranscriptionInput) GoString

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 (*StartStreamTranscriptionInput) SetContentIdentificationType added in v1.40.43

func (s *StartStreamTranscriptionInput) SetContentIdentificationType(v string) *StartStreamTranscriptionInput

SetContentIdentificationType sets the ContentIdentificationType field's value.

func (*StartStreamTranscriptionInput) SetContentRedactionType added in v1.40.43

SetContentRedactionType sets the ContentRedactionType field's value.

func (*StartStreamTranscriptionInput) SetEnableChannelIdentification added in v1.34.26

func (s *StartStreamTranscriptionInput) SetEnableChannelIdentification(v bool) *StartStreamTranscriptionInput

SetEnableChannelIdentification sets the EnableChannelIdentification field's value.

func (*StartStreamTranscriptionInput) SetEnablePartialResultsStabilization added in v1.38.38

func (s *StartStreamTranscriptionInput) SetEnablePartialResultsStabilization(v bool) *StartStreamTranscriptionInput

SetEnablePartialResultsStabilization sets the EnablePartialResultsStabilization field's value.

func (*StartStreamTranscriptionInput) SetIdentifyLanguage added in v1.42.10

SetIdentifyLanguage sets the IdentifyLanguage field's value.

func (*StartStreamTranscriptionInput) SetLanguageCode

SetLanguageCode sets the LanguageCode field's value.

func (*StartStreamTranscriptionInput) SetLanguageModelName added in v1.41.7

SetLanguageModelName sets the LanguageModelName field's value.

func (*StartStreamTranscriptionInput) SetLanguageOptions added in v1.42.10

SetLanguageOptions sets the LanguageOptions field's value.

func (*StartStreamTranscriptionInput) SetMediaEncoding

SetMediaEncoding sets the MediaEncoding field's value.

func (*StartStreamTranscriptionInput) SetMediaSampleRateHertz

func (s *StartStreamTranscriptionInput) SetMediaSampleRateHertz(v int64) *StartStreamTranscriptionInput

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*StartStreamTranscriptionInput) SetNumberOfChannels added in v1.34.26

SetNumberOfChannels sets the NumberOfChannels field's value.

func (*StartStreamTranscriptionInput) SetPartialResultsStability added in v1.38.38

func (s *StartStreamTranscriptionInput) SetPartialResultsStability(v string) *StartStreamTranscriptionInput

SetPartialResultsStability sets the PartialResultsStability field's value.

func (*StartStreamTranscriptionInput) SetPiiEntityTypes added in v1.40.43

SetPiiEntityTypes sets the PiiEntityTypes field's value.

func (*StartStreamTranscriptionInput) SetPreferredLanguage added in v1.42.10

SetPreferredLanguage sets the PreferredLanguage field's value.

func (*StartStreamTranscriptionInput) SetSessionId

SetSessionId sets the SessionId field's value.

func (*StartStreamTranscriptionInput) SetShowSpeakerLabel added in v1.34.8

SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.

func (*StartStreamTranscriptionInput) SetVocabularyFilterMethod added in v1.31.2

func (s *StartStreamTranscriptionInput) SetVocabularyFilterMethod(v string) *StartStreamTranscriptionInput

SetVocabularyFilterMethod sets the VocabularyFilterMethod field's value.

func (*StartStreamTranscriptionInput) SetVocabularyFilterName added in v1.31.2

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (*StartStreamTranscriptionInput) SetVocabularyFilterNames added in v1.43.17

func (s *StartStreamTranscriptionInput) SetVocabularyFilterNames(v string) *StartStreamTranscriptionInput

SetVocabularyFilterNames sets the VocabularyFilterNames field's value.

func (*StartStreamTranscriptionInput) SetVocabularyName

SetVocabularyName sets the VocabularyName field's value.

func (*StartStreamTranscriptionInput) SetVocabularyNames added in v1.43.17

SetVocabularyNames sets the VocabularyNames field's value.

func (StartStreamTranscriptionInput) 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 (*StartStreamTranscriptionInput) Validate

func (s *StartStreamTranscriptionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartStreamTranscriptionOutput

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"`

	// 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 (*StartStreamTranscriptionOutput) GetStream

GetStream returns the type to interact with the event stream.

func (StartStreamTranscriptionOutput) GoString

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 (*StartStreamTranscriptionOutput) SetContentIdentificationType added in v1.40.43

func (s *StartStreamTranscriptionOutput) SetContentIdentificationType(v string) *StartStreamTranscriptionOutput

SetContentIdentificationType sets the ContentIdentificationType field's value.

func (*StartStreamTranscriptionOutput) SetContentRedactionType added in v1.40.43

SetContentRedactionType sets the ContentRedactionType field's value.

func (*StartStreamTranscriptionOutput) SetEnableChannelIdentification added in v1.34.26

func (s *StartStreamTranscriptionOutput) SetEnableChannelIdentification(v bool) *StartStreamTranscriptionOutput

SetEnableChannelIdentification sets the EnableChannelIdentification field's value.

func (*StartStreamTranscriptionOutput) SetEnablePartialResultsStabilization added in v1.38.38

func (s *StartStreamTranscriptionOutput) SetEnablePartialResultsStabilization(v bool) *StartStreamTranscriptionOutput

SetEnablePartialResultsStabilization sets the EnablePartialResultsStabilization field's value.

func (*StartStreamTranscriptionOutput) SetIdentifyLanguage added in v1.42.10

SetIdentifyLanguage sets the IdentifyLanguage field's value.

func (*StartStreamTranscriptionOutput) SetLanguageCode

SetLanguageCode sets the LanguageCode field's value.

func (*StartStreamTranscriptionOutput) SetLanguageModelName added in v1.41.7

SetLanguageModelName sets the LanguageModelName field's value.

func (*StartStreamTranscriptionOutput) SetLanguageOptions added in v1.42.10

SetLanguageOptions sets the LanguageOptions field's value.

func (*StartStreamTranscriptionOutput) SetMediaEncoding

SetMediaEncoding sets the MediaEncoding field's value.

func (*StartStreamTranscriptionOutput) SetMediaSampleRateHertz

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*StartStreamTranscriptionOutput) SetNumberOfChannels added in v1.34.26

SetNumberOfChannels sets the NumberOfChannels field's value.

func (*StartStreamTranscriptionOutput) SetPartialResultsStability added in v1.38.38

func (s *StartStreamTranscriptionOutput) SetPartialResultsStability(v string) *StartStreamTranscriptionOutput

SetPartialResultsStability sets the PartialResultsStability field's value.

func (*StartStreamTranscriptionOutput) SetPiiEntityTypes added in v1.40.43

SetPiiEntityTypes sets the PiiEntityTypes field's value.

func (*StartStreamTranscriptionOutput) SetPreferredLanguage added in v1.42.10

SetPreferredLanguage sets the PreferredLanguage field's value.

func (*StartStreamTranscriptionOutput) SetRequestId

SetRequestId sets the RequestId field's value.

func (*StartStreamTranscriptionOutput) SetSessionId

SetSessionId sets the SessionId field's value.

func (*StartStreamTranscriptionOutput) SetShowSpeakerLabel added in v1.34.8

SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.

func (*StartStreamTranscriptionOutput) SetVocabularyFilterMethod added in v1.31.2

func (s *StartStreamTranscriptionOutput) SetVocabularyFilterMethod(v string) *StartStreamTranscriptionOutput

SetVocabularyFilterMethod sets the VocabularyFilterMethod field's value.

func (*StartStreamTranscriptionOutput) SetVocabularyFilterName added in v1.31.2

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (*StartStreamTranscriptionOutput) SetVocabularyFilterNames added in v1.43.17

SetVocabularyFilterNames sets the VocabularyFilterNames field's value.

func (*StartStreamTranscriptionOutput) SetVocabularyName

SetVocabularyName sets the VocabularyName field's value.

func (*StartStreamTranscriptionOutput) SetVocabularyNames added in v1.43.17

SetVocabularyNames sets the VocabularyNames field's value.

func (StartStreamTranscriptionOutput) 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

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

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 (*TranscribeStreamingService) StartMedicalStreamTranscription added in v1.35.35

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.

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 or StartMedicalStreamTranscription 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartMedicalStreamTranscription

func (*TranscribeStreamingService) StartMedicalStreamTranscriptionRequest added in v1.35.35

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartMedicalStreamTranscription

func (*TranscribeStreamingService) StartMedicalStreamTranscriptionWithContext added in v1.35.35

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 (*TranscribeStreamingService) StartStreamTranscription

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 are encoded as headers:

  • language-code

  • media-encoding

  • sample-rate

  • session-id

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 or StartMedicalStreamTranscription 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartStreamTranscription

Example (StreamAudio)
sess, err := session.NewSession()
if err != nil {
	log.Fatalf("failed to load SDK configuration, %v", err)
}

client := New(sess)
resp, err := client.StartStreamTranscription(&StartStreamTranscriptionInput{
	LanguageCode:         aws.String(LanguageCodeEnUs),
	MediaEncoding:        aws.String(MediaEncodingPcm),
	MediaSampleRateHertz: aws.Int64(16000),
})
if err != nil {
	log.Fatalf("failed to start streaming, %v", err)
}
stream := resp.GetStream()
defer stream.Close()

var audio io.Reader
// TODO Set audio to an io.Reader to stream audio bytes from.
go StreamAudioFromReader(context.Background(), stream.Writer, 10*1024, audio)

for event := range stream.Events() {
	switch e := event.(type) {
	case *TranscriptEvent:
		log.Printf("got event, %v results", len(e.Transcript.Results))
		for _, res := range e.Transcript.Results {
			for _, alt := range res.Alternatives {
				log.Printf("* %s", aws.StringValue(alt.Transcript))
			}
		}
	default:
		log.Fatalf("unexpected event, %T", event)
	}
}

if err := stream.Err(); err != nil {
	log.Fatalf("expect no error from stream, got %v", err)
}
Output:

func (*TranscribeStreamingService) StartStreamTranscriptionRequest

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

See also, https://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartStreamTranscription

func (*TranscribeStreamingService) StartStreamTranscriptionWithContext

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

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 (Transcript) GoString

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 (*Transcript) SetResults

func (s *Transcript) SetResults(v []*Result) *Transcript

SetResults sets the Results field's value.

func (Transcript) String

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

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 (TranscriptEvent) GoString

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 (*TranscriptEvent) MarshalEvent

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 (*TranscriptEvent) SetTranscript

func (s *TranscriptEvent) SetTranscript(v *Transcript) *TranscriptEvent

SetTranscript sets the Transcript field's value.

func (TranscriptEvent) String

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 (*TranscriptEvent) UnmarshalEvent

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

type TranscriptResultStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

TranscriptResultStreamEvent groups together all EventStream events writes for TranscriptResultStream.

These events are:

  • TranscriptEvent

type TranscriptResultStreamReader

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:

  • TranscriptEvent
  • TranscriptResultStreamUnknownEvent

type TranscriptResultStreamUnknownEvent added in v1.33.7

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 (*TranscriptResultStreamUnknownEvent) MarshalEvent added in v1.33.7

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*TranscriptResultStreamUnknownEvent) UnmarshalEvent added in v1.33.7

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.

Directories

Path Synopsis
Package transcribestreamingserviceiface provides an interface to enable mocking the Amazon Transcribe Streaming Service service client for testing your code.
Package transcribestreamingserviceiface provides an interface to enable mocking the Amazon Transcribe Streaming Service service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL