config

package

v0.6.0 Latest Latest Go to latest Published: Mar 12, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/emilkje/cwc

Links

Open Source Insights

Documentation ¶

Index ¶

func ClearConfig() error
func NewFromConfigFile() (openai.ClientConfig, error)
func SanitizeInput(input string) string
func SaveConfig(config *Config) error
func ValidateConfig(c *Config) error
type Config
- func LoadConfig() (*Config, error)
- func NewConfig(endpoint, apiVersion, modelDeployment string) *Config
- func (c *Config) APIKey() string
- func (c *Config) SetAPIKey(apiKey string)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ClearConfig ¶ added in v0.3.0

func ClearConfig() error

func NewFromConfigFile ¶ added in v0.3.0

func NewFromConfigFile() (openai.ClientConfig, error)

func SanitizeInput ¶ added in v0.3.0

func SanitizeInput(input string) string

SanitizeInput trims whitespaces and newlines from a string.

func SaveConfig ¶ added in v0.3.0

func SaveConfig(config *Config) error

SaveConfig writes the configuration to disk, and the API key to the keyring.

func ValidateConfig ¶ added in v0.3.0

func ValidateConfig(c *Config) error

ValidateConfig checks if a Config object has valid data.

Types ¶

type Config ¶ added in v0.3.0

type Config struct {
	Endpoint        string `json:"endpoint"`
	ApiVersion      string `json:"apiVersion"`
	ModelDeployment string `json:"modelDeployment"`
	// contains filtered or unexported fields
}

func LoadConfig ¶ added in v0.3.0

func LoadConfig() (*Config, error)

LoadConfig reads the configuration from disk and loads the API key from the keyring.

func NewConfig ¶ added in v0.3.0

func NewConfig(endpoint, apiVersion, modelDeployment string) *Config

NewConfig creates a new Config object

func (*Config) APIKey ¶ added in v0.3.0

func (c *Config) APIKey() string

APIKey returns the confidential field apiKey

func (*Config) SetAPIKey ¶ added in v0.3.0

func (c *Config) SetAPIKey(apiKey string)

SetAPIKey sets the confidential field apiKey

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL