Safe Haskell	None
Language	Haskell2010

VoicebaseClient

Description

Main module for doing the requests to the voicebase api: http://voicebase.readthedocs.io/en/v2-beta/

Synopsis

transcribe :: BearerToken -> Options -> [Part] -> IO (Either Error Value)
transcribeFile :: Configuration -> BearerToken -> FilePath -> IO (Either Error Value)
transcribeBytes :: Configuration -> BearerToken -> LazyByteFile -> IO (Either Error Value)
transcribeParse :: Configuration -> BearerToken -> FilePath -> IO (Either Error Transcript)
type BearerToken = String
data Error
- = UnkownResponse
- | ParseError String
data LazyByteFile = LazyByteFile {
- content :: ByteString
- mimetype :: MimeType
}
data Configuration = Configuration {
- channels :: Maybe Channels
- language :: Language
}
data Channels = Channels {
- left :: Speaker
- right :: Speaker
}
data Speaker = Speaker {
- speaker :: Text
}
data Language
- = Dutch
- | EnglishUS
- | EnglishUK
- | EnglishAus
- | French
- | German
- | Italian
- | Portuguese
- | SpanishLatinAmerican
- | SpanishSpain

Documentation

transcribe :: BearerToken -> Options -> [Part] -> IO (Either Error Value) Source #

Generic transcribe, agnostic of options, will add ssl, | the bearer token and a timeout to the options. | Throws HttpExceptionRequest

transcribeFile :: Configuration -> BearerToken -> FilePath -> IO (Either Error Value) Source #

Given a bearer token, and a filepath to an audio file, this function will | eventually return a transcript or times out after 10 seconds | Throws HttpExceptionRequest, IOException (file not found)

transcribeBytes :: Configuration -> BearerToken -> LazyByteFile -> IO (Either Error Value) Source #

Transcribe a bytestring | Throws HttpExceptionRequest

transcribeParse :: Configuration -> BearerToken -> FilePath -> IO (Either Error Transcript) Source #

transcribes the audio file and puts it into a Transcript

type BearerToken = String Source #

get your bearer token at http://voicebase.readthedocs.io/en/v2-beta/how-to-guides/hello-world.html#token

data Error Source #

Constructors

UnkownResponse
ParseError String

Instances

Show Error Source #
Instance details Defined in VoicebaseClient Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #

data LazyByteFile Source #

In case of a bytestring, we also need to mimetype to decode the send string

Constructors

LazyByteFile
Fields content :: ByteString mimetype :: MimeType

data Configuration Source #

Constructors

Configuration
Fields channels :: Maybe Channels language :: Language

Instances

Generic Configuration Source #
Instance details Defined in VoicebaseClient Associated Types type Rep Configuration :: * -> * # Methods from :: Configuration -> Rep Configuration x # to :: Rep Configuration x -> Configuration #
ToJSON Configuration Source #
Instance details Defined in VoicebaseClient Methods toJSON :: Configuration -> Value # toEncoding :: Configuration -> Encoding # toJSONList :: [Configuration] -> Value # toEncodingList :: [Configuration] -> Encoding #
type Rep Configuration Source #
Instance details Defined in VoicebaseClient type Rep Configuration = D1 (MetaData "Configuration" "VoicebaseClient" "voicebase-0.1.1.4-Lddxg5ZBF8j6xdnz2cdbBg" False) (C1 (MetaCons "Configuration" PrefixI True) (S1 (MetaSel (Just "channels") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Channels)) :*: S1 (MetaSel (Just "language") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Language)))

data Channels Source #

Constructors

Channels
Fields left :: Speaker right :: Speaker

Instances

Generic Channels Source #
Instance details Defined in VoicebaseClient Associated Types type Rep Channels :: * -> * # Methods from :: Channels -> Rep Channels x # to :: Rep Channels x -> Channels #
ToJSON Channels Source #
Instance details Defined in VoicebaseClient Methods toJSON :: Channels -> Value # toEncoding :: Channels -> Encoding # toJSONList :: [Channels] -> Value # toEncodingList :: [Channels] -> Encoding #
type Rep Channels Source #
Instance details Defined in VoicebaseClient type Rep Channels = D1 (MetaData "Channels" "VoicebaseClient" "voicebase-0.1.1.4-Lddxg5ZBF8j6xdnz2cdbBg" False) (C1 (MetaCons "Channels" PrefixI True) (S1 (MetaSel (Just "left") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Speaker) :*: S1 (MetaSel (Just "right") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Speaker)))

data Speaker Source #

Constructors

Speaker
Fields speaker :: Text

Instances

Generic Speaker Source #
Instance details Defined in VoicebaseClient Associated Types type Rep Speaker :: * -> * # Methods from :: Speaker -> Rep Speaker x # to :: Rep Speaker x -> Speaker #
ToJSON Speaker Source #
Instance details Defined in VoicebaseClient Methods toJSON :: Speaker -> Value # toEncoding :: Speaker -> Encoding # toJSONList :: [Speaker] -> Value # toEncodingList :: [Speaker] -> Encoding #
type Rep Speaker Source #
Instance details Defined in VoicebaseClient type Rep Speaker = D1 (MetaData "Speaker" "VoicebaseClient" "voicebase-0.1.1.4-Lddxg5ZBF8j6xdnz2cdbBg" False) (C1 (MetaCons "Speaker" PrefixI True) (S1 (MetaSel (Just "speaker") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data Language Source #

Constructors

Dutch
EnglishUS
EnglishUK
EnglishAus
French
German
Italian
Portuguese
SpanishLatinAmerican
SpanishSpain

Instances

ToJSON Language Source #
Instance details Defined in VoicebaseClient Methods toJSON :: Language -> Value # toEncoding :: Language -> Encoding # toJSONList :: [Language] -> Value # toEncodingList :: [Language] -> Encoding #