ai

Documentation

Index

• Variables
• func NeedPassword(backend string) bool
• type AIConfiguration
• type AIProvider
  • func (p *AIProvider) GetBaseURL() string
  • func (p *AIProvider) GetEngine() string
  • func (p *AIProvider) GetModel() string
  • func (p *AIProvider) GetPassword() string
• type AzureAIClient
  • func (c *AzureAIClient) Configure(config IAIConfig, lang string) error
  • func (c *AzureAIClient) GetCompletion(ctx context.Context, prompt string, promptTmpl string) (string, error)
  • func (a *AzureAIClient) GetName() string
  • func (a *AzureAIClient) Parse(ctx context.Context, prompt []string, cache cache.ICache, promptTmpl string) (string, error)
• type CohereClient
  • func (c *CohereClient) Configure(config IAIConfig, language string) error
  • func (c *CohereClient) GetCompletion(ctx context.Context, prompt, promptTmpl string) (string, error)
  • func (a *CohereClient) GetName() string
  • func (a *CohereClient) Parse(ctx context.Context, prompt []string, cache cache.ICache, promptTmpl string) (string, error)
• type IAI
  • func NewClient(provider string) IAI
• type IAIConfig
• type LocalAIClient
  • func (a *LocalAIClient) GetName() string
• type NoOpAIClient
  • func (c *NoOpAIClient) Configure(config IAIConfig, language string) error
  • func (c *NoOpAIClient) GetCompletion(ctx context.Context, prompt string, promptTmpl string) (string, error)
  • func (a *NoOpAIClient) GetName() string
  • func (a *NoOpAIClient) Parse(ctx context.Context, prompt []string, cache cache.ICache, promptTmpl string) (string, error)
• type OpenAIClient
  • func (c *OpenAIClient) Configure(config IAIConfig, language string) error
  • func (c *OpenAIClient) GetCompletion(ctx context.Context, prompt string, promptTmpl string) (string, error)
  • func (a *OpenAIClient) GetName() string
  • func (a *OpenAIClient) Parse(ctx context.Context, prompt []string, cache cache.ICache, promptTmpl string) (string, error)

Variables

var (
	Backends = []string{
		"openai",
		"localai",
		"azureopenai",
		"noopai",
		"cohere",
	}
)

var PromptMap = map[string]string{
	"default":             default_prompt,
	"VulnerabilityReport": trivy_prompt,
}

Functions

func NeedPassword

func NeedPassword(backend string) bool

Types

type AIConfiguration

type AIConfiguration struct {
	Providers       []AIProvider `mapstructure:"providers"`
	DefaultProvider string       `mapstructure:"defaultprovider"`
}

type AIProvider

type AIProvider struct {
	Name     string `mapstructure:"name"`
	Model    string `mapstructure:"model"`
	Password string `mapstructure:"password" yaml:"password,omitempty"`
	BaseURL  string `mapstructure:"baseurl" yaml:"baseurl,omitempty"`
	Engine   string `mapstructure:"engine" yaml:"engine,omitempty"`
}

func (*AIProvider) GetBaseURL

func (p *AIProvider) GetBaseURL() string

func (*AIProvider) GetEngine

func (p *AIProvider) GetEngine() string

func (*AIProvider) GetModel

func (p *AIProvider) GetModel() string

func (*AIProvider) GetPassword

func (p *AIProvider) GetPassword() string

type AzureAIClient

type AzureAIClient struct {
	// contains filtered or unexported fields
}

func (*AzureAIClient) Configure

func (c *AzureAIClient) Configure(config IAIConfig, lang string) error

func (*AzureAIClient) GetCompletion

func (c *AzureAIClient) GetCompletion(ctx context.Context, prompt string, promptTmpl string) (string, error)

func (*AzureAIClient) GetName

func (a *AzureAIClient) GetName() string

func (*AzureAIClient) Parse

func (a *AzureAIClient) Parse(ctx context.Context, prompt []string, cache cache.ICache, promptTmpl string) (string, error)

type CohereClient

type CohereClient struct {
	// contains filtered or unexported fields
}

func (*CohereClient) Configure

func (c *CohereClient) Configure(config IAIConfig, language string) error

func (*CohereClient) GetCompletion

func (c *CohereClient) GetCompletion(ctx context.Context, prompt, promptTmpl string) (string, error)

func (*CohereClient) GetName

func (a *CohereClient) GetName() string

func (*CohereClient) Parse

func (a *CohereClient) Parse(ctx context.Context, prompt []string, cache cache.ICache, promptTmpl string) (string, error)

type IAI

type IAI interface {
	Configure(config IAIConfig, language string) error
	GetCompletion(ctx context.Context, prompt string, promptTmpl string) (string, error)
	Parse(ctx context.Context, prompt []string, cache cache.ICache, promptTmpl string) (string, error)
	GetName() string
}

func NewClient

func NewClient(provider string) IAI

type IAIConfig

type IAIConfig interface {
	GetPassword() string
	GetModel() string
	GetBaseURL() string
	GetEngine() string
}

type LocalAIClient

type LocalAIClient struct {
	OpenAIClient
}

func (*LocalAIClient) GetName

func (a *LocalAIClient) GetName() string

type NoOpAIClient

type NoOpAIClient struct {
	// contains filtered or unexported fields
}

func (*NoOpAIClient) Configure

func (c *NoOpAIClient) Configure(config IAIConfig, language string) error

func (*NoOpAIClient) GetCompletion

func (c *NoOpAIClient) GetCompletion(ctx context.Context, prompt string, promptTmpl string) (string, error)

func (*NoOpAIClient) GetName

func (a *NoOpAIClient) GetName() string

func (*NoOpAIClient) Parse

func (a *NoOpAIClient) Parse(ctx context.Context, prompt []string, cache cache.ICache, promptTmpl string) (string, error)

type OpenAIClient

type OpenAIClient struct {
	// contains filtered or unexported fields
}

func (*OpenAIClient) Configure

func (c *OpenAIClient) Configure(config IAIConfig, language string) error

func (*OpenAIClient) GetCompletion

func (c *OpenAIClient) GetCompletion(ctx context.Context, prompt string, promptTmpl string) (string, error)

func (*OpenAIClient) GetName

func (a *OpenAIClient) GetName() string

func (*OpenAIClient) Parse

func (a *OpenAIClient) Parse(ctx context.Context, prompt []string, cache cache.ICache, promptTmpl string) (string, error)