The highest tagged major version is v3.

speak

package

v1.5.1-dev.1 Latest Latest Go to latest Published: Sep 9, 2024 License: MIT Imports: 3 Imported by: 12

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/deepgram/deepgram-go-sdk

Links

Documentation ¶

Overview ¶

This package provides the speak client implementation for the Deepgram API

Index ¶

Constants
func Init(init InitLib)
func InitWithDefault()
func New(apiKey string, options *interfaces.ClientOptions) *speakv1rest.Clientdeprecated
func NewREST(apiKey string, options *interfaces.ClientOptions) *speakv1rest.Client
func NewRESTWithDefaults() *speakv1rest.Client
func NewWithDefaults() *speakv1rest.Clientdeprecated
type Clientdeprecated
type InitLib
type RestClient

Constants ¶

View Source

const (
	LogLevelDefault   = common.LogLevelDefault
	LogLevelErrorOnly = common.LogLevelErrorOnly
	LogLevelStandard  = common.LogLevelStandard
	LogLevelElevated  = common.LogLevelElevated
	LogLevelFull      = common.LogLevelFull
	LogLevelDebug     = common.LogLevelDebug
	LogLevelTrace     = common.LogLevelTrace
	LogLevelVerbose   = common.LogLevelVerbose
)

please see pkg/common/init.go for more information

View Source

const (
	RESTPackageVersion = speakv1rest.PackageVersion
)

********************************* REST Client *********************************

Variables ¶

This section is empty.

Functions ¶

func Init ¶

func Init(init InitLib)

The SDK Init function for this library. Allows you to set the logging level and use of a log file. Default is output to the stdout.

func InitWithDefault ¶

func InitWithDefault()

InitWithDefault is the SDK Init function for this library using default values.

func New deprecated

func New(apiKey string, options *interfaces.ClientOptions) *speakv1rest.Client

New creates a new speak client with the specified options

Input parameters: - ctx: context.Context object - apiKey: string containing the Deepgram API key - options: ClientOptions which allows overriding things like hostname, version of the API, etc.

Deprecated: This function is deprecated. Please use NewREST(). This will be removed in a future release.

func NewREST ¶ added in v1.4.0

func NewREST(apiKey string, options *interfaces.ClientOptions) *speakv1rest.Client

New creates a new speak client with the specified options

Input parameters: - ctx: context.Context object - apiKey: string containing the Deepgram API key - options: ClientOptions which allows overriding things like hostname, version of the API, etc.

func NewRESTWithDefaults ¶ added in v1.4.0

func NewRESTWithDefaults() *speakv1rest.Client

NewRESTWithDefaults creates a new speak client with all default options

Notes:

The Deepgram API KEY is read from the environment variable DEEPGRAM_API_KEY

func NewWithDefaults deprecated

func NewWithDefaults() *speakv1rest.Client

NewWithDefaults creates a new speak client with all default options

Notes:

The Deepgram API KEY is read from the environment variable DEEPGRAM_API_KEY

Deprecated: This function is deprecated. Please use NewREST(). This will be removed in a future release.

Types ¶

type Client deprecated

type Client = speakv1rest.Client

Legacy Client Name

Deprecated: This struct is deprecated. Please use RestClient struct. This will be removed in a future release.

type InitLib ¶

type InitLib struct {
	LogLevel      common.LogLevel
	DebugFilePath string
}

Initialization options for this SDK.

type RestClient ¶ added in v1.4.0

type RestClient = speakv1rest.Client

New Client Name

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
v1
rest This package provides the speak client implementation for the Deepgram API	This package provides the speak client implementation for the Deepgram API

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL