analyze

Documentation

Overview

This package defines the Analyze API for Deepgram

Index

• Constants
• Variables
• type Client
  • func New(client *analyze.Client) *Client
  • func (c *Client) FromFile(ctx context.Context, file string, options *interfaces.AnalyzeOptions) (*api.AnalyzeResponse, error)
  • func (c *Client) FromStream(ctx context.Context, src io.Reader, options *interfaces.AnalyzeOptions) (*api.AnalyzeResponse, error)
  • func (c *Client) FromURL(ctx context.Context, url string, options *interfaces.AnalyzeOptions) (*api.AnalyzeResponse, error)

Constants

const (
	PackageVersion string = "v1.0"
)

Variables

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

errors

Types

type Client

type Client struct {
	*analyze.Client
}

func New

func New(client *analyze.Client) *Client

New creates a new Client

func (*Client) FromFile

func (c *Client) FromFile(ctx context.Context, file string, options *interfaces.AnalyzeOptions) (*api.AnalyzeResponse, error)

FromFile transcribes a prerecorded audio file from a file

func (*Client) FromStream

func (c *Client) FromStream(ctx context.Context, src io.Reader, options *interfaces.AnalyzeOptions) (*api.AnalyzeResponse, error)

FromStream transcribes a prerecorded audio file from a stream

func (*Client) FromURL

func (c *Client) FromURL(ctx context.Context, url string, options *interfaces.AnalyzeOptions) (*api.AnalyzeResponse, error)

FromURL transcribes a prerecorded audio file from a URL