huggingface

Documentation

Index

• Constants
• Variables
• type HuggingFace
  • func New(model string, temperature float32, verbose bool) *HuggingFace
  • func (h *HuggingFace) BatchCompletion(ctx context.Context, prompts []string) ([]string, error)
  • func (h *HuggingFace) Completion(ctx context.Context, prompt string) (string, error)
  • func (h *HuggingFace) WithHTTPClient(httpClient *http.Client) *HuggingFace
  • func (h *HuggingFace) WithMaxLength(maxLength int) *HuggingFace
  • func (h *HuggingFace) WithMinLength(minLength int) *HuggingFace
  • func (h *HuggingFace) WithMode(mode Mode) *HuggingFace
  • func (h *HuggingFace) WithModel(model string) *HuggingFace
  • func (h *HuggingFace) WithTemperature(temperature float32) *HuggingFace
  • func (h *HuggingFace) WithToken(token string) *HuggingFace
  • func (h *HuggingFace) WithTopK(topK int) *HuggingFace
  • func (h *HuggingFace) WithTopP(topP float32) *HuggingFace
  • func (h *HuggingFace) WithVerbose(verbose bool) *HuggingFace
• type Mode

Constants

const APIBaseURL = "https://api-inference.huggingface.co/models/"

Variables

var (
	ErrHuggingFaceCompletion = errors.New("huggingface completion error")
)

Types

type HuggingFace

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

func New

func New(model string, temperature float32, verbose bool) *HuggingFace

func (*HuggingFace) BatchCompletion

func (h *HuggingFace) BatchCompletion(ctx context.Context, prompts []string) ([]string, error)

BatchCompletion returns the completion for the given prompts

func (*HuggingFace) Completion

func (h *HuggingFace) Completion(ctx context.Context, prompt string) (string, error)

Completion returns the completion for the given prompt

func (*HuggingFace) WithHTTPClient

func (h *HuggingFace) WithHTTPClient(httpClient *http.Client) *HuggingFace

WithHTTPClient sets the http client to use for the LLM

func (*HuggingFace) WithMaxLength

func (h *HuggingFace) WithMaxLength(maxLength int) *HuggingFace

WithMaxLength sets the maxLength to use for the LLM

func (*HuggingFace) WithMinLength

func (h *HuggingFace) WithMinLength(minLength int) *HuggingFace

WithMinLength sets the minLength to use for the LLM

func (*HuggingFace) WithMode

func (h *HuggingFace) WithMode(mode Mode) *HuggingFace

WithMode sets the mode to use for the LLM

func (*HuggingFace) WithModel

func (h *HuggingFace) WithModel(model string) *HuggingFace

WithModel sets the model to use for the LLM

func (*HuggingFace) WithTemperature

func (h *HuggingFace) WithTemperature(temperature float32) *HuggingFace

WithTemperature sets the temperature to use for the LLM

func (*HuggingFace) WithToken

func (h *HuggingFace) WithToken(token string) *HuggingFace

WithToken sets the API key to use for the LLM

func (*HuggingFace) WithTopK

func (h *HuggingFace) WithTopK(topK int) *HuggingFace

WithTopK sets the topK to use for the LLM

func (*HuggingFace) WithTopP

func (h *HuggingFace) WithTopP(topP float32) *HuggingFace

WithTopP sets the topP to use for the LLM

func (*HuggingFace) WithVerbose

func (h *HuggingFace) WithVerbose(verbose bool) *HuggingFace

WithVerbose sets the verbose flag to use for the LLM

type Mode

type Mode int

const (
	ModeCoversational Mode = iota
	ModeTextGeneration
)