config

Documentation

Index

• Variables
• type App
  • func New(configPath string) (App, error)
  • func NewDefault() (App, error)
  • func (a App) GetPath() string
• type OpenAISourceConfig
• type ProfessorConfig
• type ProfessorSourceType

Variables

var ErrNoConfigFound = errors.New("config file or not found")

ErrNoConfigFound config file not found

Types

type App

type App struct {
	PathOverride string `toml:"pathOverride"`
	Debug        bool   `toml:"debug"`
	Professor    ProfessorConfig
}

App holds the application configuration

func New

func New(configPath string) (App, error)

New returns a new app's config.

func NewDefault

func NewDefault() (App, error)

NewDefault returns a default App.

func (App) GetPath

func (a App) GetPath() string

type OpenAISourceConfig

type OpenAISourceConfig struct {
	ApiKey       string `toml:"key"`
	CustomPrompt string `toml:"customPrompt"`
	Url          string `toml:"url"`
	Model        string `toml:"model"`
}

OpenAISourceConfig holds the configuration for setting the OpenAI professor source.

type ProfessorConfig

type ProfessorConfig struct {
	Enabled bool                `toml:"enabled"`
	Type    ProfessorSourceType `toml:"type"`
	OpenAI  OpenAISourceConfig  `toml:"openai"`
}

ProfessorConfig is the config for the Professor feature.

type ProfessorSourceType

type ProfessorSourceType string

ProfessorSourceType type for the professor source implementation.

const (
	// OpenAISourceType used for setting OpenAI as the professor source.
	OpenAISourceType ProfessorSourceType = "openai"
)