openai

Documentation

Index

• Constants
• type AzureOpenAIConfig
• type EmbeddingModelProviderOpenAI
  • func New(c EmbeddingModelProviderOpenAI) (*EmbeddingModelProviderOpenAI, error)
  • func (p *EmbeddingModelProviderOpenAI) Config() any
  • func (p *EmbeddingModelProviderOpenAI) EmbeddingFunc() (cg.EmbeddingFunc, error)
  • func (p *EmbeddingModelProviderOpenAI) Name() string
• type OpenAIConfig

Constants

const EmbeddingModelProviderOpenAIName string = "openai"

Types

type AzureOpenAIConfig

type AzureOpenAIConfig struct {
	Deployment string `` /* 139-byte string literal not displayed */
}

type EmbeddingModelProviderOpenAI

type EmbeddingModelProviderOpenAI struct {
	OpenAIConfig
}

func New

func New(c EmbeddingModelProviderOpenAI) (*EmbeddingModelProviderOpenAI, error)

func (*EmbeddingModelProviderOpenAI) Config

func (p *EmbeddingModelProviderOpenAI) Config() any

func (*EmbeddingModelProviderOpenAI) EmbeddingFunc

func (p *EmbeddingModelProviderOpenAI) EmbeddingFunc() (cg.EmbeddingFunc, error)

func (*EmbeddingModelProviderOpenAI) Name

func (p *EmbeddingModelProviderOpenAI) Name() string

type OpenAIConfig

type OpenAIConfig struct {
	BaseURL           string            `usage:"OpenAI API base" default:"https://api.openai.com/v1" env:"OPENAI_BASE_URL" koanf:"baseURL"`
	APIKey            string            `usage:"OpenAI API key (not required if used with clicky-chats)" default:"sk-foo" env:"OPENAI_API_KEY" koanf:"apiKey"`
	Model             string            `usage:"OpenAI model" default:"gpt-4" env:"OPENAI_MODEL" koanf:"openai-model"`
	EmbeddingModel    string            `usage:"OpenAI Embedding model" default:"text-embedding-ada-002" env:"OPENAI_EMBEDDING_MODEL" koanf:"embeddingModel"`
	EmbeddingEndpoint string            `usage:"OpenAI Embedding endpoint" default:"/embeddings" env:"OPENAI_EMBEDDING_ENDPOINT" koanf:"embeddingEndpoint"`
	APIVersion        string            `usage:"OpenAI API version (for Azure)" default:"2024-02-01" env:"OPENAI_API_VERSION" koanf:"apiVersion"`
	APIType           string            `usage:"OpenAI API type (OPEN_AI, AZURE, AZURE_AD, ...)" default:"OPEN_AI" env:"OPENAI_API_TYPE" koanf:"apiType"`
	AzureOpenAIConfig AzureOpenAIConfig `koanf:"azure"`
}