huggingface

Documentation

Index

• Variables
• 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, model string, task string) ([][]float32, error)
  • func (o *LLM) GenerateContent(ctx context.Context, messages []llms.MessageContent, ...) (*llms.ContentResponse, error)
• type Option
  • func WithModel(model string) Option
  • func WithToken(token string) Option
  • func WithURL(url string) Option

Variables

var (
	ErrEmptyResponse            = errors.New("empty response")
	ErrMissingToken             = errors.New("missing the Hugging Face API token. Set it in the HUGGINGFACEHUB_API_TOKEN environment variable") //nolint:lll
	ErrUnexpectedResponseLength = errors.New("unexpected length of response")
)

Types

type LLM

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

func New

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

func (*LLM) Call

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

Call implements the LLM interface.

func (*LLM) CreateEmbedding

func (o *LLM) CreateEmbedding(
	ctx context.Context,
	inputTexts []string,
	model string,
	task 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)

func WithModel

func WithModel(model string) Option

WithModel passes the HuggingFace model to the client. If not set, then will be used default model.

func WithToken

func WithToken(token string) Option

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

func WithURL

func WithURL(url string) Option

WithURL passes the HuggingFace url to the client. If not set, then will be used default url.