sdk

package module
v1.2.3-0...-1190354 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2024 License: MIT Imports: 6 Imported by: 0

README

Deepgram Go SDK

Discord

Official Go SDK for Deepgram. Start building with our powerful transcription & speech understanding API.

SDK Documentation

This SDK implements the Deepgram API found at https://developers.deepgram.com.

Documentation for specifics about the structs, interfaces, and functions of this SDK can be found here: Go SDK Documentation

For documentation relating to Live Audio Transcription:

For documentation relating to PreRecorded Audio Transcription and Intelligence:

For documentation relating to Text-to-Speech:

For documentation relating to Text Intelligence:

For documentation relating to Manage API:

Getting an API Key

🔑 To access the Deepgram API you will need a free Deepgram API Key.

Installation

To incorporate this SDK into your project's go.mod file, run the following command from your repo:

go get github.com/deepgram/deepgram-go-sdk

Requirements

Go (version ^1.19)

Quickstarts

This SDK aims to reduce complexity and abtract/hide some internal Deepgram details that clients shouldn't need to know about. However you can still tweak options and settings if you need.

PreRecorded Audio Transcription Quickstart

You can find a walkthrough on our documentation site. Transcribing Pre-Recorded Audio can be done using the following sample code:

// context
ctx := context.Background()

//client
c := client.NewWithDefaults()
dg := prerecorded.New(c)

// transcription options
options := PreRecordedTranscriptionOptions{
    Punctuate:  true,
    Diarize:    true,
    Language:   "en-US",
}

// send URL
URL := "https://my-domain.com/files/my-conversation.mp3"
res, err := dg.FromURL(ctx, URL, options)
if err != nil {
    log.Fatalf("FromURL failed. Err: %v\n", err)
}
Live Audio Transcription Quickstart

You can find a walkthrough on our documentation site. Transcribing Live Audio can be done using the following sample code:

// options
transcriptOptions := interfaces.LiveTranscriptionOptions{
    Language:    "en-US",
    Punctuate:   true,
    Encoding:    "linear16",
    Channels:    1,
    Sample_rate: 16000,
}

// create a callback for transcription messages
// for example, you can take a look at this example project:
// https://github.com/deepgram/deepgram-go-sdk/blob/main/examples/streaming/microphone/main.go

// create the client
dgClient, err := client.NewWithDefaults(ctx, transcriptOptions, callback)
if err != nil {
    log.Println("ERROR creating LiveTranscription connection:", err)
    return
}

// call connect!
wsconn := dgClient.Connect()
if wsconn == nil {
    log.Println("Client.Connect failed")
    os.Exit(1)
}

Examples

There are examples for *every- API call in this SDK. You can find all of these examples in the examples folder at the root of this repo.

These examples provide:

Speech-to-Text: PreRecorded Audio:

Speech-to-Text: Live Audio:

Text-to-Speech

Management API exercise the full CRUD operations for:

To run each example set the DEEPGRAM_API_KEY as an environment variable, then cd into each example folder and execute the example: go run main.go.

Logging

This SDK provides logging as a means to troubleshoot and debug issues encountered. By default, this SDK will enable Information level messages and higher (ie Warning, Error, etc) when you initialize the library as follows:

client.InitWithDefault();

To increase the logging output/verbosity for debug or troubleshooting purposes, you can set the TRACE level but using this code:

// init library
client.Init(client.InitLib{
    LogLevel: client.LogLevelTrace,
})

Testing

TBD

Backwards Compatibility

Older SDK versions will receive Priority 1 (P1) bug support only. Security issues, both in our code and dependencies, are promptly addressed. Significant bugs without clear workarounds are also given priority attention.

Development and Contributing

Interested in contributing? We ❤️ pull requests!

To make sure our community is safe for all, be sure to review and agree to our Code of Conduct. Then see the Contribution guidelines for more information.

Getting Help

We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
examples
pkg
api/analyze/v1
This package defines the Analyze API for Deepgram
This package defines the Analyze API for Deepgram
api/live/v1/interfaces
This package defines interfaces for the live API
This package defines interfaces for the live API
api/manage/v1
Balances API: https://developers.deepgram.com/reference/get-all-balances https://developers.deepgram.com/reference/get-balance
Balances API: https://developers.deepgram.com/reference/get-all-balances https://developers.deepgram.com/reference/get-balance
api/manage/v1/interfaces
This package provides the types for the Deepgram Manage API.
This package provides the types for the Deepgram Manage API.
api/prerecorded/v1
This package defines the Pre-recorded API for Deepgram
This package defines the Pre-recorded API for Deepgram
api/prerecorded/v1/interfaces
This package provides the types for the Deepgram PreRecorded API.
This package provides the types for the Deepgram PreRecorded API.
api/speak/v1
This package defines the Pre-recorded API for Deepgram
This package defines the Pre-recorded API for Deepgram
api/version
This package handles the versioning in the API for the various clients (prerecorded, live, etc.)
This package handles the versioning in the API for the various clients (prerecorded, live, etc.)
audio/microphone
Implementation of a microphone using portaudio
Implementation of a microphone using portaudio
audio/microphone/interfaces
Microphone defines a interface for a Microphone implementation
Microphone defines a interface for a Microphone implementation
audio/replay
Implementation for a replay device.
Implementation for a replay device.
client/analyze
This package provides the analyze/read client implementation for the Deepgram API
This package provides the analyze/read client implementation for the Deepgram API
client/interfaces
This package contains the interface to manage the prerecorded and live/stream interfaces for the Deepgram API
This package contains the interface to manage the prerecorded and live/stream interfaces for the Deepgram API
client/live
This package provides the live/streaming client implementation for the Deepgram API
This package provides the live/streaming client implementation for the Deepgram API
client/prerecorded
This package provides the prerecorded client implementation for the Deepgram API
This package provides the prerecorded client implementation for the Deepgram API
client/rest
This package implements a reusable REST client
This package implements a reusable REST client
client/rest/debug
This package provides API debugging at the REST/HTTP level
This package provides API debugging at the REST/HTTP level
client/speak
This package provides the speak client implementation for the Deepgram API
This package provides the speak client implementation for the Deepgram API
common
This package contains the initialization code for the Deepgram Go SDK
This package contains the initialization code for the Deepgram Go SDK
tests

Jump to

Keyboard shortcuts

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