View Source HipcallDeepgram (HipcallDeepgram v0.3.0)
Provides API wrappers for Deepgram API
See https://developers.deepgram.com/reference/deepgram-api-overview for further info on REST endpoints
Summary
Functions
Listen endpoint
Functions
@spec listen( audio_url :: binary(), options :: keyword(), config :: map() ) :: {:ok, map()} | {:error, map()} | {:error, any()}
Listen endpoint
For more information https://developers.deepgram.com/reference/listen-file
Examples
iex> audio_url = "https://static.deepgram.com/examples/Bueller-Life-moves-pretty-fast.wav"
iex> option = [model: "base", language: "tr"]
iex> HipcallDeepgram.listen(audio_url, option)Arguments
audio_urloptionsconfig
Options
:model- AI model used to process submitted audio. Default: nova-2-general. Learn more https://developers.deepgram.com/docs/model The default value is"nova-2-general".:language- The BCP-47 language tag that hints at the primary spoken language. Default: en. Learn more https://developers.deepgram.com/docs/language The default value is"en".:punctuate(boolean/0) - Add punctuation and capitalization to the transcript. Default: false. Learn more https://developers.deepgram.com/docs/punctuation The default value isfalse.:diarize(boolean/0) - Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0. Default: false. Learn more https://developers.deepgram.com/docs/diarization The default value isfalse.:paragraphs(boolean/0) - Split audio into paragraphs. Default: false. Learn more https://developers.deepgram.com/docs/paragraphs The default value isfalse.:smart_format(boolean/0) - Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability. Default: false. Learn more https://developers.deepgram.com/docs/smart-format The default value isfalse.:multichannel(boolean/0) - Transcribe each audio channel independently. Default: false. Learn more https://developers.deepgram.com/docs/multichannel The default value isfalse.
Raises
NimbleOptions.ValidationError- Validates the given options with the given schema and raises if they're not valid.
Returns
{:ok, Finch.Response.t()}
{:error, Exception.t()}