Deepgram.Client (Deepgram v0.1.0)

Main client for interacting with the Deepgram API.

This module provides the main client interface and delegates to specific service modules for different API endpoints.

Summary

Types

t()

Functions

agent(client)

Returns the Agent service module for AI agent operations.

config(client)

Returns the configuration for the client.

listen(client)

Returns the Listen service module for speech-to-text operations.

manage(client)

Returns the Manage service module for project and key management.

new(config)

Creates a new Deepgram client.

read(client)

Returns the Read service module for text intelligence operations.

speak(client)

Returns the Speak service module for text-to-speech operations.

Types

t()

@type t() :: %Deepgram.Client{
  agent: module(),
  config: Deepgram.Config.t(),
  listen: module(),
  manage: module(),
  read: module(),
  speak: module()
}

Functions

agent(client)

@spec agent(t()) :: module()

Returns the Agent service module for AI agent operations.

config(client)

@spec config(t()) :: Deepgram.Config.t()

Returns the configuration for the client.

listen(client)

@spec listen(t()) :: module()

Returns the Listen service module for speech-to-text operations.

manage(client)

@spec manage(t()) :: module()

Returns the Manage service module for project and key management.

new(config)

@spec new(Deepgram.Config.t()) :: t()

Creates a new Deepgram client.

Parameters

config - A Deepgram.Config struct containing configuration options.

Examples

iex> config = Deepgram.Config.new(api_key: "your-api-key")
iex> client = Deepgram.Client.new(config)
%Deepgram.Client{...}

read(client)

@spec read(t()) :: module()

Returns the Read service module for text intelligence operations.

speak(client)

@spec speak(t()) :: module()

Returns the Speak service module for text-to-speech operations.