config

Documentation

Index

• Constants
• type CallTranscriberConfig
  • func FromEnv() (CallTranscriberConfig, error)
  • func (cfg *CallTranscriberConfig) FromMap(m map[string]any) *CallTranscriberConfig
  • func (cfg CallTranscriberConfig) IsValid() error
  • func (cfg CallTranscriberConfig) IsValidURL() error
  • func (cfg *CallTranscriberConfig) SetDefaults()
  • func (cfg CallTranscriberConfig) ToEnv() []string
  • func (cfg CallTranscriberConfig) ToMap() map[string]any
• type ModelSize
  • func (p ModelSize) IsValid() bool
• type OutputFormat
• type OutputOptions
• type TranscribeAPI
  • func (a TranscribeAPI) IsValid() bool

Constants

const (
	// defaults
	ModelSizeDefault                            = ModelSizeBase
	NumThreadsDefault                           = 2
	TranscribeAPIDefault                        = TranscribeAPIWhisperCPP
	OutputFormatDefault                         = OutputFormatVTT
	LiveCaptionsModelSizeDefault                = ModelSizeTiny
	LiveCaptionsNumTranscribersDefault          = 1
	LiveCaptionsNumThreadsPerTranscriberDefault = 2
	LiveCaptionsLanguageDefault                 = "en"
)

const (
	ModelSizeTiny   ModelSize = "tiny"
	ModelSizeBase             = "base"
	ModelSizeSmall            = "small"
	ModelSizeMedium           = "medium"
	ModelSizeLarge            = "large"
)

const (
	TranscribeAPIWhisperCPP    = "whisper.cpp"
	TranscribeAPIOpenAIWhisper = "openai/whisper"
	TranscribeAPIAzure         = "azure"
)

Types

type CallTranscriberConfig

type CallTranscriberConfig struct {
	// input config
	SiteURL         string
	CallID          string
	PostID          string
	AuthToken       string
	TranscriptionID string
	NumThreads      int

	// output config
	TranscribeAPI        TranscribeAPI
	TranscribeAPIOptions map[string]any
	ModelSize            ModelSize
	OutputFormat         OutputFormat
	OutputOptions        OutputOptions

	// live captions config
	LiveCaptionsOn                       bool
	LiveCaptionsModelSize                ModelSize
	LiveCaptionsNumTranscribers          int
	LiveCaptionsNumThreadsPerTranscriber int
	LiveCaptionsLanguage                 string
}

func FromEnv

func FromEnv() (CallTranscriberConfig, error)

func (*CallTranscriberConfig) FromMap

func (cfg *CallTranscriberConfig) FromMap(m map[string]any) *CallTranscriberConfig

func (CallTranscriberConfig) IsValid

func (cfg CallTranscriberConfig) IsValid() error

func (CallTranscriberConfig) IsValidURL

func (cfg CallTranscriberConfig) IsValidURL() error

func (*CallTranscriberConfig) SetDefaults

func (cfg *CallTranscriberConfig) SetDefaults()

func (CallTranscriberConfig) ToEnv

func (cfg CallTranscriberConfig) ToEnv() []string

func (CallTranscriberConfig) ToMap

func (cfg CallTranscriberConfig) ToMap() map[string]any

type ModelSize

type ModelSize string

func (ModelSize) IsValid

func (p ModelSize) IsValid() bool

type OutputFormat

type OutputFormat string

const (
	OutputFormatVTT OutputFormat = "vtt"
)

type OutputOptions

type OutputOptions struct {
	WebVTT transcribe.WebVTTOptions
	Text   transcribe.TextOptions
}

type TranscribeAPI

type TranscribeAPI string

func (TranscribeAPI) IsValid

func (a TranscribeAPI) IsValid() bool