Skip to content

symbldoc/symbl-go-sdk

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Symbl Go SDK

The Symbl Go SDK provides a convenient method in which to consume the Symbl APIs from applications written in Go. A prescribed or opinionated set of interfaces, classes, and functions allow users to quickly bootstrap themselves to using the Symbl platform and unlock the context behind conversations.

We are working diligently to support every aspect of the Symbl API. Currently, we support the following:

  • Streaming API:
    • WebSocket Enabled
    • Easy to implement Real-Time language understanding
    • For local voice capture, provides an easy-to-understand library to enable Microphone audio as an input source
  • Asynchronous APIs:
    • Transcription/Messages
    • Dynamic Topics
    • Questions
    • Follow-Ups
    • Entities
    • Action Items
    • Summary
    • Analytics
    • Trackers
  • Management APIs:
    • Entities: Get, Create, Delete
    • Bookmarks: Get, Create, Delete
    • Trackers: Get, Create, Delete

IMPORTANT: I would consider this project in a beta-ish status. Since this is the first release, we currently reserve the right to make breaking API changes at this time.

Documentation

See the API docs.

Requirements

The minimal Go version supported is 1.18. Realistically, much older versions will work, but let’s start with that first as we launch this project.

Installation

First, make sure that Go is installed on your system with the following command in Mac/Linux console or Windows command prompt:

$ go version
go version go1.18.4 darwin/arm64

To install Go, visit the installation guide which covers Linux, Mac and Windows.

Configuration

The SDK needs to be initialized with your account's credentials APP_ID and APP_SECRET, which are available in your Symbl Platform. If you don't have a Symbl Platform account, you can sign up here for free.

You must add your APP_ID and APP_SECRET to your list of environment variables. We use environment variables because they are easy to configure, support PaaS-style deployments, and work well in containerized environments like Docker and Kubernetes.

export APP_ID=YOUR-APP-ID-HERE
export APP_SECRET=YOUR-APP-SECRET-HERE

Examples

You can find a list of very simple main-style examples to consume this SDK in the examples folder.

Community

If you have any questions, feel free to contact us at devrelations@symbl.ai or through our Community Slack.

This SDK is actively developed, and we love to hear from you! Please feel free to create an issue or open a pull request with your questions, comments, suggestions, and feedback. If you liked our integration guide, please star our repo!

This library is released under the MIT License

About

A Go SDK for the Symbl.ai Platform

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages

  • Go 100.0%