openai

Documentation

Index

• Constants
• func GetAzureMapperFunction(defaultModel, azureModel string) func(string) string
• type Client
  • func NewClient(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) Supports(ctx context.Context, modelName string) (bool, error)
  • func (c *Client) ValidAuth() error
• type Options

Constants

const (
	DefaultModel = openai.GPT4TurboPreview
)

Functions

func GetAzureMapperFunction

func GetAzureMapperFunction(defaultModel, azureModel string) func(string) string

Types

type Client

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

func NewClient

func NewClient(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) Supports

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

func (*Client) ValidAuth

func (c *Client) ValidAuth() error

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"`
	APIVersion   string         `usage:"OpenAI API Version (for Azure)" name:"openai-api-version" env:"OPENAI_API_VERSION"`
	APIType      openai.APIType `usage:"OpenAI API Type (valid: OPEN_AI, AZURE, AZURE_AD)" name:"openai-api-type" env:"OPENAI_API_TYPE"`
	OrgID        string         `usage:"OpenAI organization ID" name:"openai-org-id" env:"OPENAI_ORG_ID"`
	DefaultModel string         `usage:"Default LLM model to use" default:"gpt-4-turbo-preview"`
	SetSeed      bool           `usage:"-"`
	CacheKey     string         `usage:"-"`
	Cache        *cache.Client
}