openai

Documentation

Index

• Constants
• Variables
• type APIType
• type ChatMessage
• type LLM
  • func New(opts ...Option) (*LLM, error)
  • func (o *LLM) Call(ctx context.Context, prompt string, options ...llms.CallOption) (string, error)
  • func (o *LLM) CreateEmbedding(ctx context.Context, inputTexts []string) ([][]float32, error)
  • func (o *LLM) GenerateContent(ctx context.Context, messages []llms.MessageContent, ...) (*llms.ContentResponse, error)
• type Option
  • func WithAPIType(apiType APIType) Option
  • func WithAPIVersion(apiVersion string) Option
  • func WithBaseURL(baseURL string) Option
  • func WithCallback(callbackHandler callbacks.Handler) Option
  • func WithEmbeddingModel(embeddingModel string) Option
  • func WithHTTPClient(client openaiclient.Doer) Option
  • func WithModel(model string) Option
  • func WithOrganization(organization string) Option
  • func WithResponseFormat(responseFormat ResponseFormat) Option
  • func WithToken(token string) Option
• type ResponseFormat

Constants

const (
	RoleSystem    = "system"
	RoleAssistant = "assistant"
	RoleUser      = "user"
	RoleFunction  = "function"
)

const (
	APITypeOpenAI  APIType = APIType(openaiclient.APITypeOpenAI)
	APITypeAzure           = APIType(openaiclient.APITypeAzure)
	APITypeAzureAD         = APIType(openaiclient.APITypeAzureAD)
)

const (
	DefaultAPIVersion = "2023-05-15"
)

Variables

var (
	ErrEmptyResponse              = errors.New("no response")
	ErrMissingToken               = errors.New("missing the OpenAI API key, set it in the OPENAI_API_KEY environment variable") //nolint:lll
	ErrMissingAzureEmbeddingModel = errors.New("embeddings model needs to be provided when using Azure API")

	ErrUnexpectedResponseLength = errors.New("unexpected length of response")
)

var ResponseFormatJSON = ResponseFormat{Type: "json_object"} //nolint:gochecknoglobals

ResponseFormatJSON is the JSON response format.

Types

type APIType

type APIType openaiclient.APIType

type ChatMessage

type ChatMessage = openaiclient.ChatMessage

type LLM

type LLM struct {
	CallbacksHandler callbacks.Handler
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) (*LLM, error)

New returns a new OpenAI LLM.

func (*LLM) Call

func (o *LLM) Call(ctx context.Context, prompt string, options ...llms.CallOption) (string, error)

Call requests a completion for the given prompt.

func (*LLM) CreateEmbedding

func (o *LLM) CreateEmbedding(ctx context.Context, inputTexts []string) ([][]float32, error)

CreateEmbedding creates embeddings for the given input texts.

func (*LLM) GenerateContent

func (o *LLM) GenerateContent(ctx context.Context, messages []llms.MessageContent, options ...llms.CallOption) (*llms.ContentResponse, error)

GenerateContent implements the Model interface.

type Option

type Option func(*options)

Option is a functional option for the OpenAI client.

func WithAPIType

func WithAPIType(apiType APIType) Option

WithAPIType passes the api type to the client. If not set, the default value is APITypeOpenAI.

func WithAPIVersion

func WithAPIVersion(apiVersion string) Option

WithAPIVersion passes the api version to the client. If not set, the default value is DefaultAPIVersion.

func WithBaseURL

func WithBaseURL(baseURL string) Option

WithBaseURL passes the OpenAI base url to the client. If not set, the base url is read from the OPENAI_BASE_URL environment variable. If still not set in ENV VAR OPENAI_BASE_URL, then the default value is https://api.openai.com/v1 is used.

func WithCallback

func WithCallback(callbackHandler callbacks.Handler) Option

WithCallback allows setting a custom Callback Handler.

func WithEmbeddingModel

func WithEmbeddingModel(embeddingModel string) Option

WithEmbeddingModel passes the OpenAI model to the client. Required when ApiType is Azure.

func WithHTTPClient

func WithHTTPClient(client openaiclient.Doer) Option

WithHTTPClient allows setting a custom HTTP client. If not set, the default value is http.DefaultClient.

func WithModel

func WithModel(model string) Option

WithModel passes the OpenAI model to the client. If not set, the model is read from the OPENAI_MODEL environment variable.

func WithOrganization

func WithOrganization(organization string) Option

WithOrganization passes the OpenAI organization to the client. If not set, the organization is read from the OPENAI_ORGANIZATION.

func WithResponseFormat

func WithResponseFormat(responseFormat ResponseFormat) Option

WithResponseFormat allows setting a custom response format.

func WithToken

func WithToken(token string) Option

WithToken passes the OpenAI API token to the client. If not set, the token is read from the OPENAI_API_KEY environment variable.

type ResponseFormat

type ResponseFormat = openaiclient.ResponseFormat

ResponseFormat is the response format for the OpenAI client.