...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/transcribestreamingservice"
Overview
Examples
Constants

Overview ▾

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

Operations and objects for transcribing streaming speech to text.

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

The stub package, transcribestreamingserviceiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type TranscribeStreamingService
func New(p client.ConfigProvider, cfgs ...*aws.Config) *TranscribeStreamingService
func (c *TranscribeStreamingService) StartMedicalStreamTranscription(input *StartMedicalStreamTranscriptionInput) (*StartMedicalStreamTranscriptionOutput, error)
func (c *TranscribeStreamingService) StartMedicalStreamTranscriptionRequest(input *StartMedicalStreamTranscriptionInput) (req *request.Request, output *StartMedicalStreamTranscriptionOutput)
func (c *TranscribeStreamingService) StartMedicalStreamTranscriptionWithContext(ctx aws.Context, input *StartMedicalStreamTranscriptionInput, opts ...request.Option) (*StartMedicalStreamTranscriptionOutput, error)
func (c *TranscribeStreamingService) StartStreamTranscription(input *StartStreamTranscriptionInput) (*StartStreamTranscriptionOutput, error)
func (c *TranscribeStreamingService) StartStreamTranscriptionRequest(input *StartStreamTranscriptionInput) (req *request.Request, output *StartStreamTranscriptionOutput)
func (c *TranscribeStreamingService) StartStreamTranscriptionWithContext(ctx aws.Context, input *StartStreamTranscriptionInput, opts ...request.Option) (*StartStreamTranscriptionOutput, error)
func ContentIdentificationType_Values() []string
func ContentRedactionType_Values() []string
func ItemType_Values() []string
func LanguageCode_Values() []string
func MediaEncoding_Values() []string
func MedicalContentIdentificationType_Values() []string
func PartialResultsStability_Values() []string
func Specialty_Values() []string
func StreamAudioFromReader(ctx aws.Context, stream AudioStreamWriter, frameSize int, input io.Reader) (err error)
func Type_Values() []string
func VocabularyFilterMethod_Values() []string
type Alternative
type AudioEvent
type AudioStreamEvent
type AudioStreamWriter
type BadRequestException
type ConflictException
type Entity
type InternalFailureException
type Item
type LanguageWithScore
type LimitExceededException
type MedicalAlternative
type MedicalEntity
type MedicalItem
type MedicalResult
type MedicalTranscript
type MedicalTranscriptEvent
type MedicalTranscriptResultStreamEvent
type MedicalTranscriptResultStreamReader
type MedicalTranscriptResultStreamUnknownEvent
type Result
type ServiceUnavailableException
type StartMedicalStreamTranscriptionEventStream
func (es *StartMedicalStreamTranscriptionEventStream) Close() (err error)
func (es *StartMedicalStreamTranscriptionEventStream) Err() error
func (es *StartMedicalStreamTranscriptionEventStream) Events() <-chan MedicalTranscriptResultStreamEvent
func (es *StartMedicalStreamTranscriptionEventStream) Send(ctx aws.Context, event AudioStreamEvent) error
type StartMedicalStreamTranscriptionInput
type StartMedicalStreamTranscriptionOutput
func (s *StartMedicalStreamTranscriptionOutput) GetStream() *StartMedicalStreamTranscriptionEventStream
type StartStreamTranscriptionEventStream
func (es *StartStreamTranscriptionEventStream) Close() (err error)
func (es *StartStreamTranscriptionEventStream) Err() error
func (es *StartStreamTranscriptionEventStream) Events() <-chan TranscriptResultStreamEvent
func (es *StartStreamTranscriptionEventStream) Send(ctx aws.Context, event AudioStreamEvent) error
type StartStreamTranscriptionInput
type StartStreamTranscriptionOutput
func (s *StartStreamTranscriptionOutput) GetStream() *StartStreamTranscriptionEventStream
type Transcript
type TranscriptEvent
type TranscriptResultStreamEvent
type TranscriptResultStreamReader
type TranscriptResultStreamUnknownEvent

Constants ▾

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

    // ItemTypePunctuation is a ItemType enum value
    ItemTypePunctuation = "punctuation"
)
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"
)
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"
)
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"
)
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"
)
const (
    // TypeConversation is a Type enum value
    TypeConversation = "CONVERSATION"

    // TypeDictation is a Type enum value
    TypeDictation = "DICTATION"
)
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"
)
const (

    // ErrCodeBadRequestException for service response error code
    // "BadRequestException".
    //
    // One or more arguments to the StartStreamTranscription or StartMedicalStreamTranscription
    // operation was invalid. For example, MediaEncoding was not set to a valid
    // encoding, or LanguageCode was not set to a valid code. Check the 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 or Amazon
    // Transcribe Medical terminated processing. Try your request again.
    ErrCodeInternalFailureException = "InternalFailureException"

    // ErrCodeLimitExceededException for service response error code
    // "LimitExceededException".
    //
    // You have exceeded the maximum number of concurrent transcription streams,
    // are starting transcription streams too quickly, or the maximum audio length
    // of 4 hours. Wait until a stream has finished processing, or break your audio
    // stream into smaller chunks and try your request again.
    ErrCodeLimitExceededException = "LimitExceededException"

    // ErrCodeServiceUnavailableException for service response error code
    // "ServiceUnavailableException".
    //
    // Service is currently unavailable. Try your request later.
    ErrCodeServiceUnavailableException = "ServiceUnavailableException"
)
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

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

func ContentIdentificationType_Values

func ContentIdentificationType_Values() []string

ContentIdentificationType_Values returns all elements of the ContentIdentificationType enum

func ContentRedactionType_Values

func ContentRedactionType_Values() []string

ContentRedactionType_Values returns all elements of the ContentRedactionType enum

func ItemType_Values

func ItemType_Values() []string

ItemType_Values returns all elements of the ItemType enum

func LanguageCode_Values

func LanguageCode_Values() []string

LanguageCode_Values returns all elements of the LanguageCode enum

func MediaEncoding_Values

func MediaEncoding_Values() []string

MediaEncoding_Values returns all elements of the MediaEncoding enum

func MedicalContentIdentificationType_Values

func MedicalContentIdentificationType_Values() []string

MedicalContentIdentificationType_Values returns all elements of the MedicalContentIdentificationType enum

func PartialResultsStability_Values

func PartialResultsStability_Values() []string

PartialResultsStability_Values returns all elements of the PartialResultsStability enum

func Specialty_Values

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

func Type_Values() []string

Type_Values returns all elements of the Type enum

func VocabularyFilterMethod_Values

func VocabularyFilterMethod_Values() []string

VocabularyFilterMethod_Values returns all elements of the VocabularyFilterMethod enum

type Alternative

type Alternative struct {

    // Contains the entities identified as personally identifiable information (PII)
    // in the transcription output.
    Entities []*Entity `type:"list"`

    // One or more alternative interpretations of the input audio.
    Items []*Item `type:"list"`

    // The text that was transcribed from the audio.
    Transcript *string `type:"string"`
    // contains filtered or unexported fields
}

A list of possible transcriptions for the audio.

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

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
}

Provides a wrapper for the audio chunks that you are sending.

For information on audio encoding in Amazon Transcribe, see Speech input (https://docs.aws.amazon.com/transcribe/latest/dg/input.html). For information on audio encoding formats in Amazon Transcribe Medical, see Speech input (https://docs.aws.amazon.com/transcribe/latest/dg/input-med.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 invalid. For example, MediaEncoding was not set to a valid encoding, or LanguageCode was not set to a valid code. Check the 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

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode

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

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

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

type Entity struct {

    // The category of information identified in this entity; for example, PII.
    Category *string `type:"string"`

    // A value between zero and one that Amazon Transcribe assigns to PII identified
    // in the source audio. Larger values indicate a higher confidence in PII identification.
    Confidence *float64 `type:"double"`

    // The words in the transcription output that have been identified as a PII
    // entity.
    Content *string `type:"string"`

    // The end time of speech that was identified as PII.
    EndTime *float64 `type:"double"`

    // The start time of speech that was identified as PII.
    StartTime *float64 `type:"double"`

    // The type of PII identified in this entity; for example, name or credit card
    // number.
    Type *string `type:"string"`
    // contains filtered or unexported fields
}

The entity identified as personally identifiable information (PII).

func (Entity) GoString

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

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

SetCategory sets the Category field's value.

func (*Entity) SetConfidence

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

SetConfidence sets the Confidence field's value.

func (*Entity) SetContent

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

SetContent sets the Content field's value.

func (*Entity) SetEndTime

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

SetEndTime sets the EndTime field's value.

func (*Entity) SetStartTime

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

SetStartTime sets the StartTime field's value.

func (*Entity) SetType

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

SetType sets the Type field's value.

func (Entity) String

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 or Amazon Transcribe Medical terminated processing. Try your request again.

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

func (s *InternalFailureException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

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

func (*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

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode

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 {

    // A value between zero and one for an item that is a confidence score that
    // Amazon Transcribe assigns to each word or phrase that it transcribes.
    Confidence *float64 `type:"double"`

    // The word or punctuation that was recognized in the input audio.
    Content *string `type:"string"`

    // The offset from the beginning of the audio stream to the end of the audio
    // that resulted in the item.
    EndTime *float64 `type:"double"`

    // If speaker identification is enabled, shows the speakers identified in the
    // media stream.
    Speaker *string `type:"string"`

    // If partial result stabilization has been enabled, indicates whether the word
    // or phrase in the item is stable. If Stable is true, the result is stable.
    Stable *bool `type:"boolean"`

    // The offset from the beginning of the audio stream to the beginning of the
    // audio that resulted in the item.
    StartTime *float64 `type:"double"`

    // The type of the item. PRONUNCIATION indicates that the item is a word that
    // was recognized in the input audio. PUNCTUATION indicates that the item was
    // interpreted as a pause in the input audio.
    Type *string `type:"string" enum:"ItemType"`

    // Indicates whether a word in the item matches a word in the vocabulary filter
    // you've chosen for your media stream. If true then a word in the item matches
    // your vocabulary filter.
    VocabularyFilterMatch *bool `type:"boolean"`
    // contains filtered or unexported fields
}

A word, phrase, or punctuation mark that is transcribed from the input audio.

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

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

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

SetSpeaker sets the Speaker field's value.

func (*Item) SetStable

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

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

type LanguageWithScore struct {

    // The language code of the language identified by Amazon Transcribe.
    LanguageCode *string `type:"string" enum:"LanguageCode"`

    // The confidence score for the associated 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 codes of the identified languages and their associated confidence scores. The confidence score is a value between zero and one; a larger value indicates a higher confidence in the identified language.

func (LanguageWithScore) GoString

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

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

SetLanguageCode sets the LanguageCode field's value.

func (*LanguageWithScore) SetScore

func (s *LanguageWithScore) SetScore(v float64) *LanguageWithScore

SetScore sets the Score field's value.

func (LanguageWithScore) String

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
}

You have exceeded the maximum number of concurrent transcription streams, are starting transcription streams too quickly, or the maximum audio length of 4 hours. Wait until a stream has finished processing, or 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

func (s *LimitExceededException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

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

func (*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

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode

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

type MedicalAlternative struct {

    // Contains the medical entities identified as personal health information in
    // the transcription output.
    Entities []*MedicalEntity `type:"list"`

    // A list of objects that contains words and punctuation marks that represents
    // one or more interpretations of the input audio.
    Items []*MedicalItem `type:"list"`

    // The text that was transcribed from the audio.
    Transcript *string `type:"string"`
    // contains filtered or unexported fields
}

A list of possible transcriptions for the audio.

func (MedicalAlternative) GoString

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

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

SetEntities sets the Entities field's value.

func (*MedicalAlternative) SetItems

func (s *MedicalAlternative) SetItems(v []*MedicalItem) *MedicalAlternative

SetItems sets the Items field's value.

func (*MedicalAlternative) SetTranscript

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

SetTranscript sets the Transcript field's value.

func (MedicalAlternative) String

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

type MedicalEntity struct {

    // The type of personal health information of the medical entity.
    Category *string `type:"string"`

    // A value between zero and one that Amazon Transcribe Medical assigned to the
    // personal health information that it identified in the source audio. Larger
    // values indicate that Amazon Transcribe Medical has higher confidence in the
    // personal health information that it identified.
    Confidence *float64 `type:"double"`

    // The word or words in the transcription output that have been identified as
    // a medical entity.
    Content *string `type:"string"`

    // The end time of the speech that was identified as a medical entity.
    EndTime *float64 `type:"double"`

    // The start time of the speech that was identified as a medical entity.
    StartTime *float64 `type:"double"`
    // contains filtered or unexported fields
}

The medical entity identified as personal health information.

func (MedicalEntity) GoString

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

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

SetCategory sets the Category field's value.

func (*MedicalEntity) SetConfidence

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

SetConfidence sets the Confidence field's value.

func (*MedicalEntity) SetContent

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

SetContent sets the Content field's value.

func (*MedicalEntity) SetEndTime

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

SetEndTime sets the EndTime field's value.

func (*MedicalEntity) SetStartTime

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

SetStartTime sets the StartTime field's value.

func (MedicalEntity) String

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

type MedicalItem struct {

    // A value between 0 and 1 for an item that is a confidence score that Amazon
    // Transcribe Medical assigns to each word that it transcribes.
    Confidence *float64 `type:"double"`

    // The word or punctuation mark that was recognized in the input audio.
    Content *string `type:"string"`

    // The number of seconds into an audio stream that indicates the creation time
    // of an item.
    EndTime *float64 `type:"double"`

    // If speaker identification is enabled, shows the integer values that correspond
    // to the different speakers identified in the stream. For example, if the value
    // of Speaker in the stream is either a 0 or a 1, that indicates that Amazon
    // Transcribe Medical has identified two speakers in the stream. The value of
    // 0 corresponds to one speaker and the value of 1 corresponds to the other
    // speaker.
    Speaker *string `type:"string"`

    // The number of seconds into an audio stream that indicates the creation time
    // of an item.
    StartTime *float64 `type:"double"`

    // The type of the item. PRONUNCIATION indicates that the item is a word that
    // was recognized in the input audio. PUNCTUATION indicates that the item was
    // interpreted as a pause in the input audio, such as a period to indicate the
    // end of a sentence.
    Type *string `type:"string" enum:"ItemType"`
    // contains filtered or unexported fields
}

A word, phrase, or punctuation mark that is transcribed from the input audio.

func (MedicalItem) GoString

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

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

SetConfidence sets the Confidence field's value.

func (*MedicalItem) SetContent

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

SetContent sets the Content field's value.

func (*MedicalItem) SetEndTime

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

SetEndTime sets the EndTime field's value.

func (*MedicalItem) SetSpeaker

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

SetSpeaker sets the Speaker field's value.

func (*MedicalItem) SetStartTime

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

SetStartTime sets the StartTime field's value.

func (*MedicalItem) SetType

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

SetType sets the Type field's value.

func (MedicalItem) String

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

type MedicalResult struct {

    // A list of possible transcriptions of the audio. Each alternative typically
    // contains one Item that contains the result of the transcription.
    Alternatives []*MedicalAlternative `type:"list"`

    // When channel identification is enabled, Amazon Transcribe Medical transcribes
    // the speech from each audio channel separately.
    //
    // You can use ChannelId to retrieve the transcription results for a single
    // channel in your audio stream.
    ChannelId *string `type:"string"`

    // The time, in seconds, from the beginning of the audio stream to the end of
    // the result.
    EndTime *float64 `type:"double"`

    // Amazon Transcribe Medical divides the incoming audio stream into segments
    // at natural points in the audio. Transcription results are returned based
    // on these segments.
    //
    // The IsPartial field is true to indicate that Amazon Transcribe Medical has
    // additional transcription data to send. The IsPartial field is false to indicate
    // that this is the last transcription result for the segment.
    IsPartial *bool `type:"boolean"`

    // A unique identifier for the result.
    ResultId *string `type:"string"`

    // The time, in seconds, from the beginning of the audio stream to the beginning
    // of the result.
    StartTime *float64 `type:"double"`
    // contains filtered or unexported fields
}

The results of transcribing a portion of the input audio stream.

func (MedicalResult) GoString

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

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

SetAlternatives sets the Alternatives field's value.

func (*MedicalResult) SetChannelId

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

SetChannelId sets the ChannelId field's value.

func (*MedicalResult) SetEndTime

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

SetEndTime sets the EndTime field's value.

func (*MedicalResult) SetIsPartial

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

SetIsPartial sets the IsPartial field's value.

func (*MedicalResult) SetResultId

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

SetResultId sets the ResultId field's value.

func (*MedicalResult) SetStartTime

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

SetStartTime sets the StartTime field's value.

func (MedicalResult) String

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

type MedicalTranscript struct {

    // MedicalResult objects that contain the results of transcribing a portion
    // of the input audio stream. The array can be empty.
    Results []*MedicalResult `type:"list"`
    // contains filtered or unexported fields
}

The medical transcript in a MedicalTranscriptEvent.

func (MedicalTranscript) GoString

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

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

SetResults sets the Results field's value.

func (MedicalTranscript) String

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

type MedicalTranscriptEvent struct {

    // The transcription of the audio stream. The transcription is composed of all
    // of the items in the results list.
    Transcript *MedicalTranscript `type:"structure"`
    // contains filtered or unexported fields
}

Represents a set of transcription results from the server to the client. It contains one or more segments of the transcription.

func (MedicalTranscriptEvent) GoString

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

func (s *MedicalTranscriptEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

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

func (*MedicalTranscriptEvent) SetTranscript

func (s *MedicalTranscriptEvent) SetTranscript(v *MedicalTranscript) *MedicalTranscriptEvent

SetTranscript sets the Transcript field's value.

func (MedicalTranscriptEvent) String

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

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

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

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

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

func (e *MedicalTranscriptResultStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) (
    msg eventstream.Message, err error,
)

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

func (*MedicalTranscriptResultStreamUnknownEvent) UnmarshalEvent

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 transcriptions for the audio. Each alternative typically
    // contains one item that contains the result of the transcription.
    Alternatives []*Alternative `type:"list"`

    // When channel identification is enabled, Amazon Transcribe transcribes the
    // speech from each audio channel separately.
    //
    // You can use ChannelId to retrieve the transcription results for a single
    // channel in your audio stream.
    ChannelId *string `type:"string"`

    // The offset in seconds from the beginning of the audio stream to the end of
    // the result.
    EndTime *float64 `type:"double"`

    // Amazon Transcribe divides the incoming audio stream into segments at natural
    // points in the audio. Transcription results are returned based on these segments.
    //
    // The IsPartial field is true to indicate that Amazon Transcribe has additional
    // transcription data to send, false to indicate that this is the last transcription
    // result for the segment.
    IsPartial *bool `type:"boolean"`

    // The language code of the identified language in your media stream.
    LanguageCode *string `type:"string" enum:"LanguageCode"`

    // The language code of the dominant language identified in your media.
    LanguageIdentification []*LanguageWithScore `type:"list"`

    // A unique identifier for the result.
    ResultId *string `type:"string"`

    // The offset in seconds from the beginning of the audio stream to the beginning
    // of the result.
    StartTime *float64 `type:"double"`
    // contains filtered or unexported fields
}

The result of transcribing a portion of the input audio stream.

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

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

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

SetLanguageCode sets the LanguageCode field's value.

func (*Result) SetLanguageIdentification

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

type ServiceUnavailableException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

Service is currently unavailable. Try your request later.

func (*ServiceUnavailableException) Code

func (s *ServiceUnavailableException) Code() string

Code returns the exception type name.

func (*ServiceUnavailableException) Error

func (s *ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString

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

func (s *ServiceUnavailableException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

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

func (*ServiceUnavailableException) Message

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode

func (s *ServiceUnavailableException) StatusCode() int

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

func (ServiceUnavailableException) String

func (s ServiceUnavailableException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableException) UnmarshalEvent

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

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

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

func (es *StartMedicalStreamTranscriptionEventStream) Close() (err error)

Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.

Will close the underlying EventStream writer, and no more events can be sent.

You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.

func (*StartMedicalStreamTranscriptionEventStream) Err

func (es *StartMedicalStreamTranscriptionEventStream) Err() error

Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.

func (*StartMedicalStreamTranscriptionEventStream) Events

func (es *StartMedicalStreamTranscriptionEventStream) Events() <-chan MedicalTranscriptResultStreamEvent

Events returns a channel to read events from.

These events are:

* MedicalTranscriptEvent
* MedicalTranscriptResultStreamUnknownEvent

func (*StartMedicalStreamTranscriptionEventStream) Send

func (es *StartMedicalStreamTranscriptionEventStream) Send(ctx aws.Context, event AudioStreamEvent) error

Send writes the event to the stream blocking until the event is written. Returns an error if the event was not written.

These events are:

* AudioEvent

type StartMedicalStreamTranscriptionInput

type StartMedicalStreamTranscriptionInput struct {

    // Set this field to PHI to identify personal health information in the transcription
    // output.
    ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"MedicalContentIdentificationType"`

    // When true, instructs Amazon Transcribe Medical to process each audio channel
    // separately and then merge the transcription output of each channel into a
    // single transcription.
    //
    // Amazon Transcribe Medical also produces a transcription of each item. An
    // item includes the start time, end time, and any alternative transcriptions.
    //
    // You can't set both ShowSpeakerLabel and EnableChannelIdentification in the
    // same request. If you set both, your request returns a BadRequestException.
    EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"`

    // Indicates the source language used in the input audio stream. For Amazon
    // Transcribe Medical, this is 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"`

    // The encoding used for the 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.
    //
    // MediaSampleRateHertz is a required field
    MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer" required:"true"`

    // The number of channels that are in your audio stream.
    NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"`

    // Optional. An identifier for the transcription session. If you don't provide
    // a session ID, Amazon Transcribe generates one for you and returns it in the
    // response.
    SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"`

    // When true, enables speaker identification in your real-time stream.
    ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"`

    // The medical specialty of the clinician or provider.
    //
    // Specialty is a required field
    Specialty *string `location:"header" locationName:"x-amzn-transcribe-specialty" type:"string" required:"true" enum:"Specialty"`

    // The type of input audio. Choose DICTATION for a provider dictating patient
    // notes. Choose CONVERSATION for a dialogue between a patient and one or more
    // medical professionanls.
    //
    // Type is a required field
    Type *string `location:"header" locationName:"x-amzn-transcribe-type" type:"string" required:"true" enum:"Type"`

    // The name of the medical custom vocabulary to use when processing the real-time
    // stream.
    VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (StartMedicalStreamTranscriptionInput) GoString

func (s StartMedicalStreamTranscriptionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMedicalStreamTranscriptionInput) SetContentIdentificationType

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

SetContentIdentificationType sets the ContentIdentificationType field's value.

func (*StartMedicalStreamTranscriptionInput) SetEnableChannelIdentification

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

SetEnableChannelIdentification sets the EnableChannelIdentification field's value.

func (*StartMedicalStreamTranscriptionInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*StartMedicalStreamTranscriptionInput) SetMediaEncoding

func (s *StartMedicalStreamTranscriptionInput) SetMediaEncoding(v string) *StartMedicalStreamTranscriptionInput

SetMediaEncoding sets the MediaEncoding field's value.

func (*StartMedicalStreamTranscriptionInput) SetMediaSampleRateHertz

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

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*StartMedicalStreamTranscriptionInput) SetNumberOfChannels

func (s *StartMedicalStreamTranscriptionInput) SetNumberOfChannels(v int64) *StartMedicalStreamTranscriptionInput

SetNumberOfChannels sets the NumberOfChannels field's value.

func (*StartMedicalStreamTranscriptionInput) SetSessionId

func (s *StartMedicalStreamTranscriptionInput) SetSessionId(v string) *StartMedicalStreamTranscriptionInput

SetSessionId sets the SessionId field's value.

func (*StartMedicalStreamTranscriptionInput) SetShowSpeakerLabel

func (s *StartMedicalStreamTranscriptionInput) SetShowSpeakerLabel(v bool) *StartMedicalStreamTranscriptionInput

SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.

func (*StartMedicalStreamTranscriptionInput) SetSpecialty

func (s *StartMedicalStreamTranscriptionInput) SetSpecialty(v string) *StartMedicalStreamTranscriptionInput

SetSpecialty sets the Specialty field's value.

func (*StartMedicalStreamTranscriptionInput) SetType

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

SetType sets the Type field's value.

func (*StartMedicalStreamTranscriptionInput) SetVocabularyName

func (s *StartMedicalStreamTranscriptionInput) SetVocabularyName(v string) *StartMedicalStreamTranscriptionInput

SetVocabularyName sets the VocabularyName field's value.

func (StartMedicalStreamTranscriptionInput) String

func (s StartMedicalStreamTranscriptionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMedicalStreamTranscriptionInput) Validate

func (s *StartMedicalStreamTranscriptionInput) Validate() error

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

type StartMedicalStreamTranscriptionOutput

type StartMedicalStreamTranscriptionOutput struct {

    // If the value is PHI, indicates that you've configured your stream to identify
    // personal health information.
    ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"MedicalContentIdentificationType"`

    // Shows whether channel identification has been enabled in the stream.
    EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"`

    // The language code for the response transcript. For Amazon Transcribe Medical,
    // this is US English (en-US).
    LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"LanguageCode"`

    // The encoding used for the input audio stream.
    MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" enum:"MediaEncoding"`

    // The sample rate of the input audio in Hertz.
    MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer"`

    // The number of channels identified in the stream.
    NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"`

    // An identifier for the streaming transcription.
    RequestId *string `location:"header" locationName:"x-amzn-request-id" type:"string"`

    // Optional. An identifier for the transcription session. If you don't provide
    // a session ID, Amazon Transcribe generates one for you and returns it in the
    // response.
    SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"`

    // Shows whether speaker identification was enabled in the stream.
    ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"`

    // The specialty in the medical domain.
    Specialty *string `location:"header" locationName:"x-amzn-transcribe-specialty" type:"string" enum:"Specialty"`

    // The type of audio that was transcribed.
    Type *string `location:"header" locationName:"x-amzn-transcribe-type" type:"string" enum:"Type"`

    // The name of the vocabulary used when processing the stream.
    VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (*StartMedicalStreamTranscriptionOutput) GetStream

func (s *StartMedicalStreamTranscriptionOutput) GetStream() *StartMedicalStreamTranscriptionEventStream

GetStream returns the type to interact with the event stream.

func (StartMedicalStreamTranscriptionOutput) GoString

func (s StartMedicalStreamTranscriptionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartMedicalStreamTranscriptionOutput) SetContentIdentificationType

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

SetContentIdentificationType sets the ContentIdentificationType field's value.

func (*StartMedicalStreamTranscriptionOutput) SetEnableChannelIdentification

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

SetEnableChannelIdentification sets the EnableChannelIdentification field's value.

func (*StartMedicalStreamTranscriptionOutput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*StartMedicalStreamTranscriptionOutput) SetMediaEncoding

func (s *StartMedicalStreamTranscriptionOutput) SetMediaEncoding(v string) *StartMedicalStreamTranscriptionOutput

SetMediaEncoding sets the MediaEncoding field's value.

func (*StartMedicalStreamTranscriptionOutput) SetMediaSampleRateHertz

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

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*StartMedicalStreamTranscriptionOutput) SetNumberOfChannels

func (s *StartMedicalStreamTranscriptionOutput) SetNumberOfChannels(v int64) *StartMedicalStreamTranscriptionOutput

SetNumberOfChannels sets the NumberOfChannels field's value.

func (*StartMedicalStreamTranscriptionOutput) SetRequestId

func (s *StartMedicalStreamTranscriptionOutput) SetRequestId(v string) *StartMedicalStreamTranscriptionOutput

SetRequestId sets the RequestId field's value.

func (*StartMedicalStreamTranscriptionOutput) SetSessionId

func (s *StartMedicalStreamTranscriptionOutput) SetSessionId(v string) *StartMedicalStreamTranscriptionOutput

SetSessionId sets the SessionId field's value.

func (*StartMedicalStreamTranscriptionOutput) SetShowSpeakerLabel

func (s *StartMedicalStreamTranscriptionOutput) SetShowSpeakerLabel(v bool) *StartMedicalStreamTranscriptionOutput

SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.

func (*StartMedicalStreamTranscriptionOutput) SetSpecialty

func (s *StartMedicalStreamTranscriptionOutput) SetSpecialty(v string) *StartMedicalStreamTranscriptionOutput

SetSpecialty sets the Specialty field's value.

func (*StartMedicalStreamTranscriptionOutput) SetType

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

SetType sets the Type field's value.

func (*StartMedicalStreamTranscriptionOutput) SetVocabularyName

func (s *StartMedicalStreamTranscriptionOutput) SetVocabularyName(v string) *StartMedicalStreamTranscriptionOutput

SetVocabularyName sets the VocabularyName field's value.

func (StartMedicalStreamTranscriptionOutput) String

func (s StartMedicalStreamTranscriptionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartStreamTranscriptionEventStream

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

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

func (es *StartStreamTranscriptionEventStream) Err() error

Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.

func (*StartStreamTranscriptionEventStream) Events

func (es *StartStreamTranscriptionEventStream) Events() <-chan TranscriptResultStreamEvent

Events returns a channel to read events from.

These events are:

* TranscriptEvent
* TranscriptResultStreamUnknownEvent

func (*StartStreamTranscriptionEventStream) Send

func (es *StartStreamTranscriptionEventStream) Send(ctx aws.Context, event AudioStreamEvent) error

Send writes the event to the stream blocking until the event is written. Returns an error if the event was not written.

These events are:

* AudioEvent

type StartStreamTranscriptionInput

type StartStreamTranscriptionInput struct {

    // Set this field to PII to identify personally identifiable information (PII)
    // in the transcription output. Content identification is performed only upon
    // complete transcription of the audio segments.
    //
    // You can’t set both ContentIdentificationType and ContentRedactionType in
    // the same request. If you set both, your request returns a BadRequestException.
    ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"ContentIdentificationType"`

    // Set this field to PII to redact personally identifiable information (PII)
    // in the transcription output. Content redaction is performed only upon complete
    // transcription of the audio segments.
    //
    // You can’t set both ContentRedactionType and ContentIdentificationType in
    // the same request. If you set both, your request returns a BadRequestException.
    ContentRedactionType *string `location:"header" locationName:"x-amzn-transcribe-content-redaction-type" type:"string" enum:"ContentRedactionType"`

    // When true, instructs Amazon Transcribe to process each audio channel separately,
    // then merges the transcription output of each channel into a single transcription.
    //
    // Amazon Transcribe also produces a transcription of each item. An item includes
    // the start time, end time, and any alternative transcriptions.
    //
    // You can't set both ShowSpeakerLabel and EnableChannelIdentification in the
    // same request. If you set both, your request returns a BadRequestException.
    EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"`

    // When true, instructs Amazon Transcribe to present transcription results that
    // have the partial results stabilized. Normally, any word or phrase from one
    // partial result can change in a subsequent partial result. With partial results
    // stabilization enabled, only the last few words of one partial result can
    // change in another partial result.
    EnablePartialResultsStabilization *bool `location:"header" locationName:"x-amzn-transcribe-enable-partial-results-stabilization" type:"boolean"`

    // Optional. Set this value to true to enable language identification for your
    // media stream.
    IdentifyLanguage *bool `location:"header" locationName:"x-amzn-transcribe-identify-language" type:"boolean"`

    // The language code of the input audio stream.
    LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"LanguageCode"`

    // The name of the language model you want to use.
    LanguageModelName *string `location:"header" locationName:"x-amzn-transcribe-language-model-name" min:"1" type:"string"`

    // An object containing a list of languages that might be present in your audio.
    //
    // You must provide two or more language codes to help Amazon Transcribe identify
    // the correct language of your media stream with the highest possible accuracy.
    // You can only select one variant per language; for example, you can't include
    // both en-US and en-UK in the same request.
    //
    // You can only use this parameter if you've set IdentifyLanguage to truein
    // your request.
    LanguageOptions *string `location:"header" locationName:"x-amzn-transcribe-language-options" min:"1" type:"string"`

    // The encoding used for the 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, in Hertz (Hz), of the input audio. We suggest that you use
    // 8,000 Hz for low quality audio and 16,000 Hz or higher for high quality audio.
    //
    // MediaSampleRateHertz is a required field
    MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer" required:"true"`

    // The number of channels that are in your audio stream.
    NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"`

    // You can use this field to set the stability level of the transcription results.
    // A higher stability level means that the transcription results are less likely
    // to change. Higher stability levels can come with lower overall transcription
    // accuracy.
    PartialResultsStability *string `location:"header" locationName:"x-amzn-transcribe-partial-results-stability" type:"string" enum:"PartialResultsStability"`

    // List the PII entity types you want to identify or redact. In order to specify
    // entity types, you must have either ContentIdentificationType or ContentRedactionType
    // enabled.
    //
    // PIIEntityTypes must be comma-separated; the available values are: BANK_ACCOUNT_NUMBER,
    // BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY,
    // PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.
    //
    // PiiEntityTypes is an optional parameter with a default value of ALL.
    PiiEntityTypes *string `location:"header" locationName:"x-amzn-transcribe-pii-entity-types" min:"1" type:"string"`

    // Optional. From the subset of languages codes you provided for LanguageOptions,
    // you can select one preferred language for your transcription.
    //
    // You can only use this parameter if you've set IdentifyLanguage to truein
    // your request.
    PreferredLanguage *string `location:"header" locationName:"x-amzn-transcribe-preferred-language" type:"string" enum:"LanguageCode"`

    // A identifier for the transcription session. Use this parameter when you want
    // to retry a session. If you don't provide a session ID, Amazon Transcribe
    // will generate one for you and return it in the response.
    SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"`

    // When true, enables speaker identification in your media stream.
    ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"`

    // The manner in which you use your vocabulary filter to filter words in your
    // transcript. Remove removes filtered words from your transcription results.
    // Mask masks filtered words with a *** in your transcription results. Tag keeps
    // the filtered words in your transcription results and tags them. The tag appears
    // as VocabularyFilterMatch equal to True.
    VocabularyFilterMethod *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-method" type:"string" enum:"VocabularyFilterMethod"`

    // The name of the vocabulary filter you've created that is unique to your account.
    // Provide the name in this field to successfully use it in a stream.
    VocabularyFilterName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-name" min:"1" type:"string"`

    // The name of the vocabulary to use when processing the transcription job.
    VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (StartStreamTranscriptionInput) GoString

func (s StartStreamTranscriptionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartStreamTranscriptionInput) SetContentIdentificationType

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

SetContentIdentificationType sets the ContentIdentificationType field's value.

func (*StartStreamTranscriptionInput) SetContentRedactionType

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

SetContentRedactionType sets the ContentRedactionType field's value.

func (*StartStreamTranscriptionInput) SetEnableChannelIdentification

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

SetEnableChannelIdentification sets the EnableChannelIdentification field's value.

func (*StartStreamTranscriptionInput) SetEnablePartialResultsStabilization

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

SetEnablePartialResultsStabilization sets the EnablePartialResultsStabilization field's value.

func (*StartStreamTranscriptionInput) SetIdentifyLanguage

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

SetIdentifyLanguage sets the IdentifyLanguage field's value.

func (*StartStreamTranscriptionInput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*StartStreamTranscriptionInput) SetLanguageModelName

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

SetLanguageModelName sets the LanguageModelName field's value.

func (*StartStreamTranscriptionInput) SetLanguageOptions

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

SetLanguageOptions sets the LanguageOptions field's value.

func (*StartStreamTranscriptionInput) SetMediaEncoding

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

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

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

SetNumberOfChannels sets the NumberOfChannels field's value.

func (*StartStreamTranscriptionInput) SetPartialResultsStability

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

SetPartialResultsStability sets the PartialResultsStability field's value.

func (*StartStreamTranscriptionInput) SetPiiEntityTypes

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

SetPiiEntityTypes sets the PiiEntityTypes field's value.

func (*StartStreamTranscriptionInput) SetPreferredLanguage

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

SetPreferredLanguage sets the PreferredLanguage field's value.

func (*StartStreamTranscriptionInput) SetSessionId

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

SetSessionId sets the SessionId field's value.

func (*StartStreamTranscriptionInput) SetShowSpeakerLabel

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

SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.

func (*StartStreamTranscriptionInput) SetVocabularyFilterMethod

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

SetVocabularyFilterMethod sets the VocabularyFilterMethod field's value.

func (*StartStreamTranscriptionInput) SetVocabularyFilterName

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

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (*StartStreamTranscriptionInput) SetVocabularyName

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

SetVocabularyName sets the VocabularyName field's value.

func (StartStreamTranscriptionInput) String

func (s StartStreamTranscriptionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*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 in this stream.
    ContentIdentificationType *string `location:"header" locationName:"x-amzn-transcribe-content-identification-type" type:"string" enum:"ContentIdentificationType"`

    // Shows whether content redaction was enabled in this stream.
    ContentRedactionType *string `location:"header" locationName:"x-amzn-transcribe-content-redaction-type" type:"string" enum:"ContentRedactionType"`

    // Shows whether channel identification has been enabled in the stream.
    EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"`

    // Shows whether partial results stabilization has been enabled in the stream.
    EnablePartialResultsStabilization *bool `location:"header" locationName:"x-amzn-transcribe-enable-partial-results-stabilization" type:"boolean"`

    // The language code of the language identified in your media stream.
    IdentifyLanguage *bool `location:"header" locationName:"x-amzn-transcribe-identify-language" type:"boolean"`

    // The language code of the input audio stream.
    LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"LanguageCode"`

    // The name of the language model used in your media stream.
    LanguageModelName *string `location:"header" locationName:"x-amzn-transcribe-language-model-name" min:"1" type:"string"`

    // The language codes used in the identification of your media stream's predominant
    // language.
    LanguageOptions *string `location:"header" locationName:"x-amzn-transcribe-language-options" min:"1" type:"string"`

    // The encoding used for the input audio stream.
    MediaEncoding *string `location:"header" locationName:"x-amzn-transcribe-media-encoding" type:"string" enum:"MediaEncoding"`

    // The sample rate, in Hertz (Hz), for the input audio stream. Use 8,000 Hz
    // for low quality audio and 16,000 Hz or higher for high quality audio.
    MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer"`

    // The number of channels identified in the stream.
    NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"`

    // If partial results stabilization has been enabled in the stream, shows the
    // stability level.
    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"`

    // The preferred language you specified in your request.
    PreferredLanguage *string `location:"header" locationName:"x-amzn-transcribe-preferred-language" type:"string" enum:"LanguageCode"`

    // An identifier for the streaming transcription.
    RequestId *string `location:"header" locationName:"x-amzn-request-id" type:"string"`

    // An identifier for a specific transcription session.
    SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"`

    // Shows whether speaker identification was enabled in the stream.
    ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"`

    // The vocabulary filtering method used in the media stream.
    VocabularyFilterMethod *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-method" type:"string" enum:"VocabularyFilterMethod"`

    // The name of the vocabulary filter used in your media stream.
    VocabularyFilterName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-filter-name" min:"1" type:"string"`

    // The name of the vocabulary used when processing the stream.
    VocabularyName *string `location:"header" locationName:"x-amzn-transcribe-vocabulary-name" min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (*StartStreamTranscriptionOutput) GetStream

func (s *StartStreamTranscriptionOutput) GetStream() *StartStreamTranscriptionEventStream

GetStream returns the type to interact with the event stream.

func (StartStreamTranscriptionOutput) GoString

func (s StartStreamTranscriptionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartStreamTranscriptionOutput) SetContentIdentificationType

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

SetContentIdentificationType sets the ContentIdentificationType field's value.

func (*StartStreamTranscriptionOutput) SetContentRedactionType

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

SetContentRedactionType sets the ContentRedactionType field's value.

func (*StartStreamTranscriptionOutput) SetEnableChannelIdentification

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

SetEnableChannelIdentification sets the EnableChannelIdentification field's value.

func (*StartStreamTranscriptionOutput) SetEnablePartialResultsStabilization

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

SetEnablePartialResultsStabilization sets the EnablePartialResultsStabilization field's value.

func (*StartStreamTranscriptionOutput) SetIdentifyLanguage

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

SetIdentifyLanguage sets the IdentifyLanguage field's value.

func (*StartStreamTranscriptionOutput) SetLanguageCode

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

SetLanguageCode sets the LanguageCode field's value.

func (*StartStreamTranscriptionOutput) SetLanguageModelName

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

SetLanguageModelName sets the LanguageModelName field's value.

func (*StartStreamTranscriptionOutput) SetLanguageOptions

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

SetLanguageOptions sets the LanguageOptions field's value.

func (*StartStreamTranscriptionOutput) SetMediaEncoding

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

SetMediaEncoding sets the MediaEncoding field's value.

func (*StartStreamTranscriptionOutput) SetMediaSampleRateHertz

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

SetMediaSampleRateHertz sets the MediaSampleRateHertz field's value.

func (*StartStreamTranscriptionOutput) SetNumberOfChannels

func (s *StartStreamTranscriptionOutput) SetNumberOfChannels(v int64) *StartStreamTranscriptionOutput

SetNumberOfChannels sets the NumberOfChannels field's value.

func (*StartStreamTranscriptionOutput) SetPartialResultsStability

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

SetPartialResultsStability sets the PartialResultsStability field's value.

func (*StartStreamTranscriptionOutput) SetPiiEntityTypes

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

SetPiiEntityTypes sets the PiiEntityTypes field's value.

func (*StartStreamTranscriptionOutput) SetPreferredLanguage

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

SetPreferredLanguage sets the PreferredLanguage field's value.

func (*StartStreamTranscriptionOutput) SetRequestId

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

SetRequestId sets the RequestId field's value.

func (*StartStreamTranscriptionOutput) SetSessionId

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

SetSessionId sets the SessionId field's value.

func (*StartStreamTranscriptionOutput) SetShowSpeakerLabel

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

SetShowSpeakerLabel sets the ShowSpeakerLabel field's value.

func (*StartStreamTranscriptionOutput) SetVocabularyFilterMethod

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

SetVocabularyFilterMethod sets the VocabularyFilterMethod field's value.

func (*StartStreamTranscriptionOutput) SetVocabularyFilterName

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

SetVocabularyFilterName sets the VocabularyFilterName field's value.

func (*StartStreamTranscriptionOutput) SetVocabularyName

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

SetVocabularyName sets the VocabularyName field's value.

func (StartStreamTranscriptionOutput) String

func (s StartStreamTranscriptionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type 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

func New(p client.ConfigProvider, cfgs ...*aws.Config) *TranscribeStreamingService

New creates a new instance of the TranscribeStreamingService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a TranscribeStreamingService client from just a session.
svc := transcribestreamingservice.New(mySession)

// Create a TranscribeStreamingService client with additional configuration
svc := transcribestreamingservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*TranscribeStreamingService) StartMedicalStreamTranscription

func (c *TranscribeStreamingService) StartMedicalStreamTranscription(input *StartMedicalStreamTranscriptionInput) (*StartMedicalStreamTranscriptionOutput, error)

StartMedicalStreamTranscription API operation for Amazon Transcribe Streaming Service.

Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.

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 invalid. For example, MediaEncoding was not set to a valid
encoding, or LanguageCode was not set to a valid code. Check the parameters
and try your request again.

* LimitExceededException
You have exceeded the maximum number of concurrent transcription streams,
are starting transcription streams too quickly, or the maximum audio length
of 4 hours. Wait until a stream has finished processing, or break your audio
stream into smaller chunks and try your request again.

* InternalFailureException
A problem occurred while processing the audio. Amazon Transcribe or Amazon
Transcribe Medical terminated processing. Try your request again.

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

* ServiceUnavailableException
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

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

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

func (c *TranscribeStreamingService) StartStreamTranscription(input *StartStreamTranscriptionInput) (*StartStreamTranscriptionOutput, error)

StartStreamTranscription API operation for Amazon Transcribe Streaming Service.

Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.

The following are encoded as HTTP/2 headers:

* x-amzn-transcribe-language-code

* x-amzn-transcribe-media-encoding

* x-amzn-transcribe-sample-rate

* x-amzn-transcribe-session-id

See the SDK for Go API Reference (https://docs.aws.amazon.com/sdk-for-go/api/service/transcribestreamingservice/#TranscribeStreamingService.StartStreamTranscription) for more detail.

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 invalid. For example, MediaEncoding was not set to a valid
encoding, or LanguageCode was not set to a valid code. Check the parameters
and try your request again.

* LimitExceededException
You have exceeded the maximum number of concurrent transcription streams,
are starting transcription streams too quickly, or the maximum audio length
of 4 hours. Wait until a stream has finished processing, or break your audio
stream into smaller chunks and try your request again.

* InternalFailureException
A problem occurred while processing the audio. Amazon Transcribe or Amazon
Transcribe Medical terminated processing. Try your request again.

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

* ServiceUnavailableException
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)

Code:

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

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 {

    // Result objects that contain the results of transcribing a portion of the
    // input audio stream. The array can be empty.
    Results []*Result `type:"list"`
    // contains filtered or unexported fields
}

The transcription in a TranscriptEvent.

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 {

    // The transcription of the audio stream. The transcription is composed of all
    // of the items in the results list.
    Transcript *Transcript `type:"structure"`
    // contains filtered or unexported fields
}

Represents a set of transcription results from the server to the client. It contains one or more segments of the transcription.

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

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

func (e *TranscriptResultStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) (
    msg eventstream.Message, err error,
)

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

func (*TranscriptResultStreamUnknownEvent) UnmarshalEvent

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.