View Source ExAzureSpeech.Auth.Config (ex_azure_speech v0.1.0)

Configuration required to authenticate with the Azure Cognitive Services Speech Pronunciation Assessment API.

Summary

Types

t()
  • :auth_key (String.t/0) - Required. The API Key for the Azure Cognitive Services

Functions

Returns the URI for the Azure Cognitive Services Auth API.

Returns a validated basic configuration for the Azure Cognitive Services Speech Pronunciation Accessment.

Types

@type t() :: [auth_key: binary(), region: binary()]
  • :auth_key (String.t/0) - Required. The API Key for the Azure Cognitive Services

  • :region (String.t/0) - Required. The region where the Azure Cognitive Services is hosted, eg: 'westus'

Example Configuration

[
  region: "westus",
  auth_key: "your_subscription_key",
]

Default global values can be set in the application configuration.

config :ex_azure_speech,
  region: "westus",
  auth_key: "your_subscription_key"

Functions

@spec get_uri(t()) :: String.t()

Returns the URI for the Azure Cognitive Services Auth API.

@spec new(Keyword.t()) :: {:ok, t()} | {:error, NimbleOptions.ValidationError.t()}

Returns a validated basic configuration for the Azure Cognitive Services Speech Pronunciation Accessment.