openai

Documentation

Index

• Constants
• type Client
  • func NewClient(ctx context.Context, credStore credentials.CredentialStore, opts ...Options) (*Client, error)
  • func (c *Client) Call(ctx context.Context, messageRequest types.CompletionRequest, ...) (*types.CompletionMessage, error)
  • func (c *Client) ListModels(ctx context.Context, providers ...string) (result []string, _ error)
  • func (c *Client) RetrieveAPIKey(ctx context.Context) error
  • func (c *Client) Supports(ctx context.Context, modelName string) (bool, error)
  • func (c *Client) ValidAuth() error
• type InvalidAuthError
  • func (InvalidAuthError) Error() string
• type Options
  • func Complete(opts ...Options) (result Options)

Constants

const (
	DefaultModel    = openai.GPT4o
	BuiltinCredName = "sys.openai"
)

Types

type Client

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

func NewClient

func NewClient(ctx context.Context, credStore credentials.CredentialStore, opts ...Options) (*Client, error)

func (*Client) Call

func (c *Client) Call(ctx context.Context, messageRequest types.CompletionRequest, status chan<- types.CompletionStatus) (*types.CompletionMessage, error)

func (*Client) ListModels

func (c *Client) ListModels(ctx context.Context, providers ...string) (result []string, _ error)

func (*Client) RetrieveAPIKey

func (c *Client) RetrieveAPIKey(ctx context.Context) error

func (*Client) Supports

func (c *Client) Supports(ctx context.Context, modelName string) (bool, error)

func (*Client) ValidAuth

func (c *Client) ValidAuth() error

type InvalidAuthError

type InvalidAuthError struct{}

func (InvalidAuthError) Error

func (InvalidAuthError) Error() string

type Options

type Options struct {
	BaseURL      string `usage:"OpenAI base URL" name:"openai-base-url" env:"OPENAI_BASE_URL"`
	APIKey       string `usage:"OpenAI API KEY" name:"openai-api-key" env:"OPENAI_API_KEY"`
	OrgID        string `usage:"OpenAI organization ID" name:"openai-org-id" env:"OPENAI_ORG_ID"`
	DefaultModel string `usage:"Default LLM model to use" default:"gpt-4o"`
	ConfigFile   string `usage:"Path to GPTScript config file" name:"config"`
	SetSeed      bool   `usage:"-"`
	CacheKey     string `usage:"-"`
	Cache        *cache.Client
}

func Complete

func Complete(opts ...Options) (result Options)