Documentation
¶
Index ¶
- type CreateEmbeddingRequest
- type CreateEmbeddingResponse
- type HuggingFaceClient
- type HuggingFaceEmbeddingFunction
- func NewHuggingFaceEmbeddingFunction(apiKey string, model string) *HuggingFaceEmbeddingFunction
- func NewHuggingFaceEmbeddingFunctionFromOptions(opts ...Option) (*HuggingFaceEmbeddingFunction, error)
- func NewHuggingFaceEmbeddingInferenceFunction(baseURL string, opts ...Option) (*HuggingFaceEmbeddingFunction, error)
- type Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateEmbeddingRequest ¶
type CreateEmbeddingRequest struct {
Inputs []string `json:"inputs"`
Options map[string]interface{} `json:"options"`
}
func (*CreateEmbeddingRequest) JSON ¶
func (c *CreateEmbeddingRequest) JSON() (string, error)
type CreateEmbeddingResponse ¶
type CreateEmbeddingResponse struct {
Embeddings [][]float32 `json:"embeddings"`
}
type HuggingFaceClient ¶
type HuggingFaceClient struct {
BaseURL string
APIKey string
Model string
Client *http.Client
DefaultHeaders map[string]string
IsHFEIEndpoint bool
}
func NewHuggingFaceClient ¶
func NewHuggingFaceClient(apiKey string, model string) *HuggingFaceClient
func NewHuggingFaceClientFromOptions ¶
func NewHuggingFaceClientFromOptions(opts ...Option) (*HuggingFaceClient, error)
func (*HuggingFaceClient) CreateEmbedding ¶
func (c *HuggingFaceClient) CreateEmbedding(ctx context.Context, req *CreateEmbeddingRequest) (*CreateEmbeddingResponse, error)
type HuggingFaceEmbeddingFunction ¶
type HuggingFaceEmbeddingFunction struct {
// contains filtered or unexported fields
}
func NewHuggingFaceEmbeddingFunction ¶
func NewHuggingFaceEmbeddingFunction(apiKey string, model string) *HuggingFaceEmbeddingFunction
func NewHuggingFaceEmbeddingFunctionFromOptions ¶
func NewHuggingFaceEmbeddingFunctionFromOptions(opts ...Option) (*HuggingFaceEmbeddingFunction, error)
func NewHuggingFaceEmbeddingInferenceFunction ¶
func NewHuggingFaceEmbeddingInferenceFunction(baseURL string, opts ...Option) (*HuggingFaceEmbeddingFunction, error)
func (*HuggingFaceEmbeddingFunction) EmbedDocuments ¶
func (e *HuggingFaceEmbeddingFunction) EmbedDocuments(ctx context.Context, documents []string) ([]embeddings.Embedding, error)
func (*HuggingFaceEmbeddingFunction) EmbedQuery ¶
func (e *HuggingFaceEmbeddingFunction) EmbedQuery(ctx context.Context, document string) (embeddings.Embedding, error)
type Option ¶
type Option func(p *HuggingFaceClient) error
func WithAPIKey ¶
func WithBaseURL ¶
func WithDefaultHeaders ¶
func WithEnvAPIKey ¶
func WithEnvAPIKey() Option
func WithIsHFEIEndpoint ¶ added in v0.2.3
func WithIsHFEIEndpoint() Option
Click to show internal directories.
Click to hide internal directories.