Safe Haskell	None
Language	Haskell2010

AWS.Transcribe

Contents

Credentials
Channel
Settings
StreamingResponse

Description

Use the WebSocket protocol to stream audio to the AWS Transcribe service

For general information regarding the service see the relevant AWS documentation (https://docs.aws.amazon.com/transcribe/latest/dg/websocket.html)

Synopsis

data Credentials
newCredentials :: Text -> Text -> Credentials
lookupCredentials :: String -> String -> IO (Maybe Credentials)
runClient :: Credentials -> Settings -> Channel -> IO ()
data Channel
newChannel :: IO Channel
readChannel :: Channel -> IO StreamingResponse
writeChannel :: Channel -> ByteString -> IO ()
tryReadChannel :: Channel -> IO (Maybe StreamingResponse)
isEmpty :: Channel -> IO Bool
data Settings = MkSettings {
- languageCode :: LanguageCode
- mediaEncoding :: MediaEncoding
- sampleRate :: Word
- region :: Region
}
data LanguageCode
- = EnAU
- | EnGB
- | EnUS
- | EsUS
- | FrCA
- | FrFR
- | DeDE
- | JaJP
- | KoKR
- | PtBR
- | ZhCN
- | ItIT
data MediaEncoding
- = PCM
- | OggOpus
- | Flac
data Region
- = USEast1
- | USEast2
- | USWest2
- | APNorthEast1
- | APNorthEast2
- | APSouthEast2
- | CACentral1
- | EUCentral1
- | EUWest1
- | EUWest2
- | SAEast1
data StreamingResponse
- = Event TranscriptEvent
- | Error StreamingError
- | EndOfStream
data StreamingError
- = BadRequestException
- | InternalFailureException
- | LimitExceededException
- | UnrecognizedClientException
- | TranscriptEventError String
- | OtherStreamingError Message String
data TranscriptEvent
transcript :: Iso' TranscriptEvent Transcript
data Transcript
results :: Iso' Transcript [Result]
data Result
alternatives :: Lens' Result [Alternative]
channelId :: Lens' Result (Maybe Text)
endTime :: Lens' Result Double
isPartial :: Lens' Result Bool
resultId :: Lens' Result Text
startTime :: Lens' Result Double
data Alternative
items :: Lens' Alternative [Item]
altTranscript :: Lens' Alternative (Maybe Text)
data Item
confidence :: Lens' Item (Maybe Double)
content :: Lens' Item (Maybe Text)
iEndTime :: Lens' Item (Maybe Double)
speaker :: Lens' Item (Maybe Text)
stable :: Lens' Item (Maybe Bool)
iStartTime :: Lens' Item (Maybe Double)
itemType :: Lens' Item (Maybe ItemType)
vocabularyFilterMatch :: Lens' Item (Maybe Bool)
data ItemType
- = Pronunciation
- | Punctuation

Credentials

data Credentials Source #

AWS Security credentials comprising of an access key ID and a secret key. Temporary security tokens are not supported

Instances

Instances details

FromJSON Credentials Source #
Instance details Defined in AWS.Credentials Methods parseJSON :: Value -> Parser Credentials # parseJSONList :: Value -> Parser [Credentials] #

newCredentials Source #

Arguments

:: Text	Access Key
-> Text	Secret Key
-> Credentials

lookupCredentials Source #

Arguments

:: String	Access Key environment variable
-> String	Secret Key environment variable
-> IO (Maybe Credentials)

Use the provided environment variables to create Credentials

runClient Source #

Arguments

:: Credentials	AWS Credentials
-> Settings	Session settings
-> Channel	Transcribe channel
-> IO ()

Start a WebSocket client. The client will probe the channel for incoming ByteString, encode it in the expected Event Stream and transmit them to the AWS Transcribe endpoint. When a response is received it will be written in the channel.

Sending an empty ByteString will close the WebSocket connection. Receiving any kind of exception from AWS Transcribe will also close the connection.

Channel

data Channel Source #

An AWS Transcribe channel abstraction. Audio Bytestrings are written to the channel to be transcribed. Transcribed StreamingResponses are read from the channel.

newChannel :: IO Channel Source #

Create a new Channel.

readChannel :: Channel -> IO StreamingResponse Source #

Read a StreamingResponse from the Channel

writeChannel :: Channel -> ByteString -> IO () Source #

Write an audio ByteString to the channel

tryReadChannel :: Channel -> IO (Maybe StreamingResponse) Source #

Read a StreamingResponse from the Channel if one is available

isEmpty :: Channel -> IO Bool Source #

Is the reading side of the channel empty?

Settings

data Settings Source #

Transcribe session specific settings

Constructors

MkSettings
Fields languageCode :: LanguageCode mediaEncoding :: MediaEncoding sampleRate :: Word region :: Region

data LanguageCode Source #

The language code for the input audio.

Constructors

EnAU
EnGB
EnUS
EsUS
FrCA
FrFR
DeDE
JaJP
KoKR
PtBR
ZhCN
ItIT

data MediaEncoding Source #

The encoding used for the input audio

Constructors

PCM
OggOpus
Flac

data Region Source #

Amazon Transcribe Streaming regions

Constructors

USEast1
USEast2
USWest2
APNorthEast1
APNorthEast2
APSouthEast2
CACentral1
EUCentral1
EUWest1
EUWest2
SAEast1

StreamingResponse

data StreamingResponse Source #

Constructors

Event TranscriptEvent
Error StreamingError
EndOfStream

Instances

Instances details

Eq StreamingResponse Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods (==) :: StreamingResponse -> StreamingResponse -> Bool # (/=) :: StreamingResponse -> StreamingResponse -> Bool #
Show StreamingResponse Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods showsPrec :: Int -> StreamingResponse -> ShowS # show :: StreamingResponse -> String # showList :: [StreamingResponse] -> ShowS #

data StreamingError Source #

Constructors

BadRequestException
InternalFailureException
LimitExceededException
UnrecognizedClientException
TranscriptEventError String	An error in decoding a `TranscriptEvent`
OtherStreamingError Message String	An unrecognised exception type or a binary decoding error. The original message is returned along with a possible description of the error

Instances

Instances details

Eq StreamingError Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods (==) :: StreamingError -> StreamingError -> Bool # (/=) :: StreamingError -> StreamingError -> Bool #
Show StreamingError Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods showsPrec :: Int -> StreamingError -> ShowS # show :: StreamingError -> String # showList :: [StreamingError] -> ShowS #

data TranscriptEvent Source #

Instances

Instances details

Eq TranscriptEvent Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods (==) :: TranscriptEvent -> TranscriptEvent -> Bool # (/=) :: TranscriptEvent -> TranscriptEvent -> Bool #
Show TranscriptEvent Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods showsPrec :: Int -> TranscriptEvent -> ShowS # show :: TranscriptEvent -> String # showList :: [TranscriptEvent] -> ShowS #
FromJSON TranscriptEvent Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods parseJSON :: Value -> Parser TranscriptEvent # parseJSONList :: Value -> Parser [TranscriptEvent] #

transcript :: Iso' TranscriptEvent Transcript Source #

data Transcript Source #

Instances

Instances details

Eq Transcript Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods (==) :: Transcript -> Transcript -> Bool # (/=) :: Transcript -> Transcript -> Bool #
Show Transcript Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods showsPrec :: Int -> Transcript -> ShowS # show :: Transcript -> String # showList :: [Transcript] -> ShowS #
FromJSON Transcript Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods parseJSON :: Value -> Parser Transcript # parseJSONList :: Value -> Parser [Transcript] #

results :: Iso' Transcript [Result] Source #

data Result Source #

Instances

Instances details

Eq Result Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods (==) :: Result -> Result -> Bool # (/=) :: Result -> Result -> Bool #
Show Result Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods showsPrec :: Int -> Result -> ShowS # show :: Result -> String # showList :: [Result] -> ShowS #
ToJSON Result Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods toJSON :: Result -> Value # toEncoding :: Result -> Encoding # toJSONList :: [Result] -> Value # toEncodingList :: [Result] -> Encoding #
FromJSON Result Source #
Instance details Defined in AWS.Transcribe.StreamingResponse Methods parseJSON :: Value -> Parser Result # parseJSONList :: Value -> Parser [Result] #

alternatives :: Lens' Result [Alternative] Source #

channelId :: Lens' Result (Maybe Text) Source #

endTime :: Lens' Result Double Source #

isPartial :: Lens' Result Bool Source #

resultId :: Lens' Result Text Source #

startTime :: Lens' Result Double Source #

data Alternative Source #

Instances

Instances details

Eq Alternative Source #
Instance details Defined in AWS.Transcribe.Alternative Methods (==) :: Alternative -> Alternative -> Bool # (/=) :: Alternative -> Alternative -> Bool #
Show Alternative Source #
Instance details Defined in AWS.Transcribe.Alternative Methods showsPrec :: Int -> Alternative -> ShowS # show :: Alternative -> String # showList :: [Alternative] -> ShowS #
ToJSON Alternative Source #
Instance details Defined in AWS.Transcribe.Alternative Methods toJSON :: Alternative -> Value # toEncoding :: Alternative -> Encoding # toJSONList :: [Alternative] -> Value # toEncodingList :: [Alternative] -> Encoding #
FromJSON Alternative Source #
Instance details Defined in AWS.Transcribe.Alternative Methods parseJSON :: Value -> Parser Alternative # parseJSONList :: Value -> Parser [Alternative] #

items :: Lens' Alternative [Item] Source #

altTranscript :: Lens' Alternative (Maybe Text) Source #

data Item Source #

A word, phrase, or punctuation mark that is transcribed from the input audio. https://docs.aws.amazon.com/transcribe/latest/dg/API_streaming_Item.html

Instances

Instances details

Eq Item Source #
Instance details Defined in AWS.Transcribe.Item Methods (==) :: Item -> Item -> Bool # (/=) :: Item -> Item -> Bool #
Show Item Source #
Instance details Defined in AWS.Transcribe.Item Methods showsPrec :: Int -> Item -> ShowS # show :: Item -> String # showList :: [Item] -> ShowS #
FromJSON Item Source #
Instance details Defined in AWS.Transcribe.Item Methods parseJSON :: Value -> Parser Item # parseJSONList :: Value -> Parser [Item] #

confidence :: Lens' Item (Maybe Double) Source #

content :: Lens' Item (Maybe Text) Source #

iEndTime :: Lens' Item (Maybe Double) Source #

speaker :: Lens' Item (Maybe Text) Source #

stable :: Lens' Item (Maybe Bool) Source #

iStartTime :: Lens' Item (Maybe Double) Source #

itemType :: Lens' Item (Maybe ItemType) Source #

vocabularyFilterMatch :: Lens' Item (Maybe Bool) Source #

data ItemType Source #

The type of the Item

Constructors

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

Instances

Instances details

Eq ItemType Source #
Instance details Defined in AWS.Transcribe.Item Methods (==) :: ItemType -> ItemType -> Bool # (/=) :: ItemType -> ItemType -> Bool #
Show ItemType Source #
Instance details Defined in AWS.Transcribe.Item Methods showsPrec :: Int -> ItemType -> ShowS # show :: ItemType -> String # showList :: [ItemType] -> ShowS #
FromJSON ItemType Source #
Instance details Defined in AWS.Transcribe.Item Methods parseJSON :: Value -> Parser ItemType # parseJSONList :: Value -> Parser [ItemType] #