openai

Documentation

Overview

Package openai provides a wrapper around the OpenAI API.

Index

• Constants
• Variables
• type Function
• type FunctionParameterOption
• type Model
• type OpenAI
  • func New(model Model, temperature float32, maxTokens int, verbose bool) *OpenAI
  • func NewChat() *OpenAI
  • func NewCompletion() *OpenAI
  • func (o *OpenAI) BatchCompletion(ctx context.Context, prompts []string) ([]string, error)
  • func (o *OpenAI) BatchCompletionStream(ctx context.Context, callbackFn []OpenAIStreamCallback, prompts []string) error
  • func (o *OpenAI) BindFunction(fn interface{}, name string, description string, ...) error
  • func (o *OpenAI) CalledFunctionName() *string
  • func (o *OpenAI) Chat(ctx context.Context, prompt *chat.Chat) (string, error)
  • func (o *OpenAI) ChatStream(ctx context.Context, callbackFn OpenAIStreamCallback, prompt *chat.Chat) error
  • func (o *OpenAI) Completion(ctx context.Context, prompt string) (string, error)
  • func (o *OpenAI) CompletionStream(ctx context.Context, callbackFn OpenAIStreamCallback, prompt string) error
  • func (o *OpenAI) FinishReason() string
  • func (o *OpenAI) SetStop(stop []string)
  • func (o *OpenAI) WithCallback(callback OpenAIUsageCallback) *OpenAI
  • func (o *OpenAI) WithClient(client *openai.Client) *OpenAI
  • func (o *OpenAI) WithMaxTokens(maxTokens int) *OpenAI
  • func (o *OpenAI) WithModel(model Model) *OpenAI
  • func (o *OpenAI) WithStop(stop []string) *OpenAI
  • func (o *OpenAI) WithTemperature(temperature float32) *OpenAI
  • func (o *OpenAI) WithVerbose(verbose bool) *OpenAI
• type OpenAIStreamCallback
• type OpenAIUsageCallback

Constants

const (
	DefaultOpenAIMaxTokens   = 256
	DefaultOpenAITemperature = 0.7
	DefaultOpenAINumResults  = 1
	DefaultOpenAITopP        = 1.0
	DefaultMaxIterations     = 3
)

Variables

var (
	ErrOpenAICompletion = fmt.Errorf("openai completion error")
	ErrOpenAIChat       = fmt.Errorf("openai chat error")
)

Types

type Function

type Function struct {
	Name        string
	Description string
	Parameters  map[string]interface{}
	Fn          interface{}
}

type FunctionParameterOption

type FunctionParameterOption func(map[string]interface{}) error

type Model

type Model string

const (
	GPT432K0613             Model = openai.GPT432K0613
	GPT432K0314             Model = openai.GPT432K0314
	GPT432K                 Model = openai.GPT432K
	GPT40613                Model = openai.GPT40613
	GPT40314                Model = openai.GPT40314
	GPT4                    Model = openai.GPT4
	GPT3Dot5Turbo0613       Model = openai.GPT3Dot5Turbo0613
	GPT3Dot5Turbo0301       Model = openai.GPT3Dot5Turbo0301
	GPT3Dot5Turbo16K        Model = openai.GPT3Dot5Turbo16K
	GPT3Dot5Turbo16K0613    Model = openai.GPT3Dot5Turbo16K0613
	GPT3Dot5Turbo           Model = openai.GPT3Dot5Turbo
	GPT3TextDavinci003      Model = openai.GPT3TextDavinci003
	GPT3TextDavinci002      Model = openai.GPT3TextDavinci002
	GPT3TextCurie001        Model = openai.GPT3TextCurie001
	GPT3TextBabbage001      Model = openai.GPT3TextBabbage001
	GPT3TextAda001          Model = openai.GPT3TextAda001
	GPT3TextDavinci001      Model = openai.GPT3TextDavinci001
	GPT3DavinciInstructBeta Model = openai.GPT3DavinciInstructBeta
	GPT3Davinci             Model = openai.GPT3Davinci
	GPT3CurieInstructBeta   Model = openai.GPT3CurieInstructBeta
	GPT3Curie               Model = openai.GPT3Curie
	GPT3Ada                 Model = openai.GPT3Ada
	GPT3Babbage             Model = openai.GPT3Babbage
)

type OpenAI

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

func New

func New(model Model, temperature float32, maxTokens int, verbose bool) *OpenAI

func NewChat

func NewChat() *OpenAI

func NewCompletion

func NewCompletion() *OpenAI

func (*OpenAI) BatchCompletion

func (o *OpenAI) BatchCompletion(ctx context.Context, prompts []string) ([]string, error)

BatchCompletion returns multiple completions for the given prompts.

func (*OpenAI) BatchCompletionStream

func (o *OpenAI) BatchCompletionStream(ctx context.Context, callbackFn []OpenAIStreamCallback, prompts []string) error

BatchCompletionStream returns multiple completion streams for the given prompts.

func (*OpenAI) BindFunction

func (o *OpenAI) BindFunction(
	fn interface{},
	name string,
	description string,
	functionParamenterOptions ...FunctionParameterOption,
) error

func (*OpenAI) CalledFunctionName

func (o *OpenAI) CalledFunctionName() *string

CalledFunctionName returns the name of the function that was called.

func (*OpenAI) Chat

func (o *OpenAI) Chat(ctx context.Context, prompt *chat.Chat) (string, error)

Chat returns a single chat completion for the given prompt.

func (*OpenAI) ChatStream

func (o *OpenAI) ChatStream(ctx context.Context, callbackFn OpenAIStreamCallback, prompt *chat.Chat) error

ChatStream returns a single chat stream for the given prompt.

func (*OpenAI) Completion

func (o *OpenAI) Completion(ctx context.Context, prompt string) (string, error)

Completion returns a single completion for the given prompt.

func (*OpenAI) CompletionStream

func (o *OpenAI) CompletionStream(ctx context.Context, callbackFn OpenAIStreamCallback, prompt string) error

CompletionStream returns a single completion stream for the given prompt.

func (*OpenAI) FinishReason

func (o *OpenAI) FinishReason() string

FinishReason returns the LLM finish reason.

func (*OpenAI) SetStop

func (o *OpenAI) SetStop(stop []string)

SetStop sets the stop sequences for the completion.

func (*OpenAI) WithCallback

func (o *OpenAI) WithCallback(callback OpenAIUsageCallback) *OpenAI

WithUsageCallback sets the usage callback to use for the OpenAI instance.

func (*OpenAI) WithClient

func (o *OpenAI) WithClient(client *openai.Client) *OpenAI

WithClient sets the client to use for the OpenAI instance.

func (*OpenAI) WithMaxTokens

func (o *OpenAI) WithMaxTokens(maxTokens int) *OpenAI

WithMaxTokens sets the max tokens to use for the OpenAI instance.

func (*OpenAI) WithModel

func (o *OpenAI) WithModel(model Model) *OpenAI

WithModel sets the model to use for the OpenAI instance.

func (*OpenAI) WithStop

func (o *OpenAI) WithStop(stop []string) *OpenAI

WithStop sets the stop sequences to use for the OpenAI instance.

func (*OpenAI) WithTemperature

func (o *OpenAI) WithTemperature(temperature float32) *OpenAI

WithTemperature sets the temperature to use for the OpenAI instance.

func (*OpenAI) WithVerbose

func (o *OpenAI) WithVerbose(verbose bool) *OpenAI

WithVerbose sets the verbose flag to use for the OpenAI instance.

type OpenAIStreamCallback

type OpenAIStreamCallback func(string)

type OpenAIUsageCallback

type OpenAIUsageCallback func(types.Meta)