VoiceContext (voice_context v0.1.0)

Copy Markdown

Voice-to-text and text-to-context helpers.

Summary

Types

audio()
context()
transcript()

Functions

extract_context(text, opts \\ [])

Extracts context from text.

from_audio(audio, opts \\ [])

Transcribes audio then extracts context.

transcribe(audio, opts \\ [])

Transcribes audio into text.

Types

audio()

@type audio() :: binary() | Path.t()

context()

@type context() :: %{
  summary: String.t(),
  topics: [String.t()],
  entities: [String.t()],
  intent: String.t() | nil,
  raw_text: String.t()
}

transcript()

@type transcript() :: String.t()

Functions

extract_context(text, opts \\ [])

@spec extract_context(
  transcript(),
  keyword()
) :: {:ok, context()} | {:error, term()}

Extracts context from text.

Examples

iex> {:ok, ctx} = VoiceContext.extract_context("Book a meeting with Alice tomorrow about Elixir")
iex> ctx.intent
"schedule"
iex> "Alice" in ctx.entities
true

from_audio(audio, opts \\ [])

@spec from_audio(
  audio(),
  keyword()
) :: {:ok, %{transcript: transcript(), context: context()}} | {:error, term()}

Transcribes audio then extracts context.

Examples

iex> {:ok, result} = VoiceContext.from_audio("remind me to ship the Hex package")
iex> is_binary(result.transcript)
true
iex> is_map(result.context)
true

transcribe(audio, opts \\ [])

@spec transcribe(
  audio(),
  keyword()
) :: {:ok, transcript()} | {:error, term()}

Transcribes audio into text.

Examples

iex> {:ok, text} = VoiceContext.transcribe("hello from audio")
iex> text
"hello from audio"