huggingfaceclient

package

v1.0.12 Latest Latest Go to latest Published: Sep 1, 2024 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/3dsinteractive/langchaingo

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type Client
- func New(token, model, url string) (*Client, error)
- func (c *Client) CreateEmbedding(ctx context.Context, model string, task string, r *EmbeddingRequest) ([][]float32, error)
- func (c *Client) RunInference(ctx context.Context, request *InferenceRequest) (*InferenceResponse, error)
type EmbeddingRequest
type InferenceRequest
type InferenceResponse
type InferenceTask

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrInvalidToken  = errors.New("invalid token")
	ErrEmptyResponse = errors.New("empty response")
)

View Source

var ErrUnexpectedStatusCode = errors.New("unexpected status code")

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	Token string
	Model string
	// contains filtered or unexported fields
}

func New ¶

func New(token, model, url string) (*Client, error)

func (*Client) CreateEmbedding ¶

func (c *Client) CreateEmbedding(
	ctx context.Context,
	model string,
	task string,
	r *EmbeddingRequest,
) ([][]float32, error)

CreateEmbedding creates embeddings.

func (*Client) RunInference ¶

func (c *Client) RunInference(ctx context.Context, request *InferenceRequest) (*InferenceResponse, error)

type EmbeddingRequest ¶

type EmbeddingRequest struct {
	Options map[string]any `json:"options"`
	Inputs  []string       `json:"inputs"`
}

EmbeddingRequest is a request to create an embedding.

type InferenceRequest ¶

type InferenceRequest struct {
	Model             string        `json:"repositoryId"`
	Prompt            string        `json:"prompt"`
	Task              InferenceTask `json:"task"`
	Temperature       float64       `json:"temperature"`
	TopP              float64       `json:"top_p,omitempty"`
	TopK              int           `json:"top_k,omitempty"`
	MinLength         int           `json:"min_length,omitempty"`
	MaxLength         int           `json:"max_length,omitempty"`
	RepetitionPenalty float64       `json:"repetition_penalty,omitempty"`
	Seed              int           `json:"seed,omitempty"`
}

type InferenceResponse ¶

type InferenceResponse struct {
	Text string `json:"generated_text"`
}

type InferenceTask ¶

type InferenceTask string

InferenceTask is the type of inference task to run.

const (
	InferenceTaskTextGeneration      InferenceTask = "text-generation"
	InferenceTaskText2TextGeneration InferenceTask = "text2text-generation"
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL