config

Documentation

Index

• Variables
• func JSONSchema() ([]byte, error)
• func SetLogLevel(cfg *Config)
• type AuthConfig
• type AvailableIndexes
• type AzureOpenAIConfig
• type Config
  • func LoadConfig(configFile string) (*Config, error)
• type CustomPromptsConfig
• type DataConfig
• type DocumentExtractorsConfig
• type EmbeddingsConfig
• type EntityExtractorConfig
• type ExtractorPromptsConfig
• type ExtractorsConfig
• type IntentExtractorConfig
• type LLM
• type LogConfig
• type MemoryConfig
• type MessageExtractorsConfig
• type NLP
• type OpenTelemetryConfig
• type PostgresConfig
• type ServerConfig
• type StoreConfig
• type SummarizerConfig

Variables

var (
	Version       = "dev"
	CommitHash    = "n/a"
	BuildTime     = "n/a"
	VersionString = fmt.Sprintf("%s-%s (%s)", Version, CommitHash, BuildTime)
)

var EnvVars = map[string]string{
	"llm.anthropic_api_key": "ZEP_ANTHROPIC_API_KEY",
	"llm.openai_api_key":    "ZEP_OPENAI_API_KEY",
	"auth.secret":           "ZEP_AUTH_SECRET",
	"development":           "ZEP_DEVELOPMENT",
}

EnvVars is a set of secrets that should be stored in the environment, not config file

var (
	ErrGeneratedSchemaIsNil = errors.New("generated JSON Schema is nil")
)

Functions

func JSONSchema

func JSONSchema() ([]byte, error)

func SetLogLevel

func SetLogLevel(cfg *Config)

SetLogLevel sets the log level based on the config file. Defaults to INFO if not set or invalid

Types

type AuthConfig

type AuthConfig struct {
	Secret   string `mapstructure:"secret"`
	Required bool   `mapstructure:"required"`
}

type AvailableIndexes

type AvailableIndexes struct {
	IVFFLAT bool `mapstructure:"ivfflat"`
	HSNW    bool `mapstructure:"hsnw"`
}

type AzureOpenAIConfig

type AzureOpenAIConfig struct {
	LLMDeployment       string `mapstructure:"llm_deployment"`
	EmbeddingDeployment string `mapstructure:"embedding_deployment"`
}

type Config

type Config struct {
	LLM           LLM                 `mapstructure:"llm"`
	NLP           NLP                 `mapstructure:"nlp"`
	Memory        MemoryConfig        `mapstructure:"memory"`
	Extractors    ExtractorsConfig    `mapstructure:"extractors"`
	Store         StoreConfig         `mapstructure:"store"`
	Server        ServerConfig        `mapstructure:"server"`
	Log           LogConfig           `mapstructure:"log"`
	Auth          AuthConfig          `mapstructure:"auth"`
	OpenTelemetry OpenTelemetryConfig `mapstructure:"opentelemetry"`
	DataConfig    DataConfig          `mapstructure:"data"`
	Development   bool                `mapstructure:"development"`
	CustomPrompts CustomPromptsConfig `mapstructure:"custom_prompts"`
}

Config holds the configuration of the application Use cmd.NewConfig to create a new instance

func LoadConfig

func LoadConfig(configFile string) (*Config, error)

LoadConfig loads the config file and ENV variables into a Config struct

type CustomPromptsConfig

type CustomPromptsConfig struct {
	SummarizerPrompts ExtractorPromptsConfig `mapstructure:"summarizer_prompts"`
}

type DataConfig

type DataConfig struct {
	// PurgeEvery is the period between hard deletes, in minutes.
	// If set to 0, hard deletes will not be performed.
	PurgeEvery int `mapstructure:"purge_every"`
}

type DocumentExtractorsConfig

type DocumentExtractorsConfig struct {
	Embeddings EmbeddingsConfig `mapstructure:"embeddings"`
}

type EmbeddingsConfig

type EmbeddingsConfig struct {
	Enabled    bool   `mapstructure:"enabled"`
	Dimensions int    `mapstructure:"dimensions"`
	Service    string `mapstructure:"service"`
	// ChunkSize is the number of documents to embed in a single task.
	ChunkSize int `mapstructure:"chunk_size"`
}

type EntityExtractorConfig

type EntityExtractorConfig struct {
	Enabled bool `mapstructure:"enabled"`
}

type ExtractorPromptsConfig

type ExtractorPromptsConfig struct {
	OpenAI    string `mapstructure:"openai"`
	Anthropic string `mapstructure:"anthropic"`
}

type ExtractorsConfig

type ExtractorsConfig struct {
	Messages  MessageExtractorsConfig  `mapstructure:"messages"`
	Documents DocumentExtractorsConfig `mapstructure:"documents"`
}

type IntentExtractorConfig

type IntentExtractorConfig struct {
	Enabled bool `mapstructure:"enabled"`
}

type LLM

type LLM struct {
	Service             string            `mapstructure:"service"`
	Model               string            `mapstructure:"model"`
	AnthropicAPIKey     string            `mapstructure:"anthropic_api_key"`
	OpenAIAPIKey        string            `mapstructure:"openai_api_key"`
	AzureOpenAIEndpoint string            `mapstructure:"azure_openai_endpoint"`
	AzureOpenAIModel    AzureOpenAIConfig `mapstructure:"azure_openai"`
	OpenAIEndpoint      string            `mapstructure:"openai_endpoint"`
	OpenAIOrgID         string            `mapstructure:"openai_org_id"`
}

type LogConfig

type LogConfig struct {
	Level string `mapstructure:"level"`
}

type MemoryConfig

type MemoryConfig struct {
	MessageWindow int `mapstructure:"message_window"`
}

type MessageExtractorsConfig

type MessageExtractorsConfig struct {
	Summarizer SummarizerConfig      `mapstructure:"summarizer"`
	Embeddings EmbeddingsConfig      `mapstructure:"embeddings"`
	Entities   EntityExtractorConfig `mapstructure:"entities"`
	Intent     IntentExtractorConfig `mapstructure:"intent"`
}

MessageExtractorsConfig holds the configuration for all extractors

type NLP

type NLP struct {
	ServerURL string `mapstructure:"server_url"`
}

type OpenTelemetryConfig

type OpenTelemetryConfig struct {
	Enabled bool `mapstructure:"enabled"`
}

type PostgresConfig

type PostgresConfig struct {
	DSN              string           `mapstructure:"dsn"`
	AvailableIndexes AvailableIndexes `mapstructure:"available_indexes"`
}

type ServerConfig

type ServerConfig struct {
	Host           string `mapstructure:"host"`
	Port           int    `mapstructure:"port"`
	WebEnabled     bool   `mapstructure:"web_enabled"`
	MaxRequestSize int64  `mapstructure:"max_request_size"`
}

type StoreConfig

type StoreConfig struct {
	Type     string         `mapstructure:"type"`
	Postgres PostgresConfig `mapstructure:"postgres"`
}

type SummarizerConfig

type SummarizerConfig struct {
	Enabled    bool                  `mapstructure:"enabled"`
	Embeddings EmbeddingsConfig      `mapstructure:"embeddings"`
	Entities   EntityExtractorConfig `mapstructure:"entities"`
}