README.md

HipcallDeepgram

Unofficial Deepgram API Wrapper written in Elixir.

Installation

If available in Hex, the package can be installed by adding hipcall_deepgram to your list of dependencies in mix.exs:

def deps do
  [
    {:hipcall_deepgram, "~> 0.5.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/hipcall_deepgram.

Configuration

You can configure HipcallDeepgram in your mix config.exs (default $project_root/config/config.exs). If you're using Phoenix add the configuration in your config/dev.exs|test.exs|prod.exs files. An example config is:

import Config

config :hipcall_deepgram,
  api_key: "your-api-key",
  # optional, useful if you want to do local integration tests using Bypass or similar
  # (https://github.com/PSPDFKit-labs/bypass), do not use it for production code,
  # but only in your test config!
  api_url: "https://api.deepgram.com/v1/"

Configuration override

Client library configuration can be overwritten in runtime by passing a %HipcallDeepgram.Config{} struct as last argument of the function you need to use. For instance if you need to use a different api_key you can simply do:

config_override = %HipcallDeepgram.Config{api_key: "f3034ef489524e48207d7f4b61ab1f0899e852fd"}
# pass the overriden configuration as last argument of the function
HipcallDeepgram.listen(audio_url, option, config_override)

Usage overview

listen endpoint

iex> audio_url = "https://static.deepgram.com/examples/Bueller-Life-moves-pretty-fast.wav"
iex> option = [model: "base", language: "tr", punctuate: true, diarize: true, paragraphs: true, smart_format: true]
iex> HipcallDeepgram.listen(audio_url, option)

Hipcall

All Hipcall libraries:

• HipcallDisposableEmail - Simple library checking the email's domain is disposable or not.
• HipcallDeepgram - Unofficial Deepgram API Wrapper written in Elixir.
• HipcallOpenai - Unofficial OpenAI API Wrapper written in Elixir.
• HipcallWhichtech - Find out what the website is built with.
• HipcallSDK - Official Hipcall API Wrapper written in Elixir.