analyzev1

Documentation

Overview

This package provides the analyze/read client implementation for the Deepgram API

Index

• Constants
• Variables
• func IsURL(str string) bool
• type Client
  • func New(apiKey string, options *interfaces.ClientOptions) *Client
  • func NewWithDefaults() *Client
  • func (c *Client) DoFile(ctx context.Context, filePath string, req *interfaces.AnalyzeOptions, ...) error
  • func (c *Client) DoStream(ctx context.Context, src io.Reader, options *interfaces.AnalyzeOptions, ...) error
  • func (c *Client) DoText(ctx context.Context, text string, options *interfaces.AnalyzeOptions, ...) error
  • func (c *Client) DoURL(ctx context.Context, uri string, options *interfaces.AnalyzeOptions, ...) error

Constants

const (
	PackageVersion string = "v1.0"
)

Variables

var (
	// ErrInvalidInput required input was not found
	ErrInvalidInput = errors.New("required input was not found")
)

errors

Functions

func IsURL

func IsURL(str string) bool

IsURL returns true if a string is of a URL format

Types

type Client

type Client struct {
	*common.RESTClient
}

Client implements helper functionality for Prerecorded API

func New

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

New creates a new analyze/read 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 NewWithDefaults

func NewWithDefaults() *Client

NewWithDefaults creates a new analyze/read client with all default options

Notes:

• The Deepgram API KEY is read from the environment variable DEEPGRAM_API_KEY

func (*Client) DoFile

func (c *Client) DoFile(ctx context.Context, filePath string, req *interfaces.AnalyzeOptions, resBody interface{}) error

DoFile posts a file capturing a conversation to a given REST endpoint

Input parameters: - ctx: context.Context object - filePath: string containing the path to the file to be posted - req: PreRecordedTranscriptionOptions which allows overriding things like language, etc.

Output parameters: - resBody: interface{} which will be populated with the response from the server

func (*Client) DoStream

func (c *Client) DoStream(ctx context.Context, src io.Reader, options *interfaces.AnalyzeOptions, resBody interface{}) error

DoStream posts a stream capturing a conversation to a given REST endpoint

Input parameters: - ctx: context.Context object - src: io.Reader containing the stream to be posted - req: PreRecordedTranscriptionOptions which allows overriding things like language, etc.

Output parameters: - resBody: interface{} which will be populated with the response from the server

func (*Client) DoText

func (c *Client) DoText(ctx context.Context, text string, options *interfaces.AnalyzeOptions, resBody interface{}) error

func (*Client) DoURL

func (c *Client) DoURL(ctx context.Context, uri string, options *interfaces.AnalyzeOptions, resBody interface{}) error

DoURL posts a URL capturing a conversation to a given REST endpoint

Input parameters: - ctx: context.Context object - url: string containing the URL to be posted - req: PreRecordedTranscriptionOptions which allows overriding things like language, etc.

Output parameters: - resBody: interface{} which will be populated with the response from the server