openaiapi

Documentation

Index

• func QueryOpenAIAPIModel(ctx context.Context, client *openai.Client, modelIdentifier string, ...) (result *provider.QueryResult, err error)
• type Provider
  • func NewProvider(id string, baseURL string) (provider *Provider)
  • func (p *Provider) AddModel(m model.Model)
  • func (p *Provider) Available(logger *log.Logger) (err error)
  • func (p *Provider) ID() (id string)
  • func (p *Provider) Models() (models []model.Model, err error)
  • func (p *Provider) Query(ctx context.Context, logger *log.Logger, model model.Model, promptText string) (result *provider.QueryResult, err error)
  • func (p *Provider) SetToken(token string)

Functions

func QueryOpenAIAPIModel

func QueryOpenAIAPIModel(ctx context.Context, client *openai.Client, modelIdentifier string, attributes map[string]string, promptText string) (result *provider.QueryResult, err error)

QueryOpenAIAPIModel queries an OpenAI API model.

Types

type Provider

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

Provider holds a generic "OpenAI API" provider.

func NewProvider

func NewProvider(id string, baseURL string) (provider *Provider)

NewProvider returns a generic "OpenAI API" provider.

func (*Provider) AddModel

func (p *Provider) AddModel(m model.Model)

AddModel manually adds a model to the provider.

func (*Provider) Available

func (p *Provider) Available(logger *log.Logger) (err error)

Available checks if the provider is ready to be used. This might include checking for an installation or making sure an API access token is valid.

func (*Provider) ID

func (p *Provider) ID() (id string)

ID returns the unique ID of this provider.

func (*Provider) Models

func (p *Provider) Models() (models []model.Model, err error)

Models returns which models are available to be queried via this provider.

func (*Provider) Query

func (p *Provider) Query(ctx context.Context, logger *log.Logger, model model.Model, promptText string) (result *provider.QueryResult, err error)

Query queries the provider with the given model name.

func (*Provider) SetToken

func (p *Provider) SetToken(token string)

SetToken sets a potential token to be used in case the provider needs to authenticate a remote API.