Documentation
¶
Overview ¶
Package defaultef exposes the legacy default ONNX embedding function package path.
Deprecated: Use github.com/amikos-tech/chroma-go/pkg/embeddings/ort instead.
Index ¶
- Constants
- func EnsureDefaultEmbeddingFunctionModel() error
- func EnsureOnnxRuntimeSharedLibrary() error
- type Config
- type DefaultEmbeddingFunction
- func (e *DefaultEmbeddingFunction) Close() error
- func (e *DefaultEmbeddingFunction) DefaultSpace() embeddings.DistanceMetric
- func (e *DefaultEmbeddingFunction) EmbedDocuments(_ context.Context, documents []string) ([]embeddings.Embedding, error)
- func (e *DefaultEmbeddingFunction) EmbedQuery(_ context.Context, document string) (embeddings.Embedding, error)
- func (e *DefaultEmbeddingFunction) GetConfig() embeddings.EmbeddingFunctionConfig
- func (e *DefaultEmbeddingFunction) Name() string
- func (e *DefaultEmbeddingFunction) SupportedSpaces() []embeddings.DistanceMetric
- type Option
Constants ¶
const (
ChromaCacheDir = ".cache/chroma/"
)
Variables ¶
This section is empty.
Functions ¶
func EnsureDefaultEmbeddingFunctionModel ¶
func EnsureDefaultEmbeddingFunctionModel() error
func EnsureOnnxRuntimeSharedLibrary ¶
func EnsureOnnxRuntimeSharedLibrary() error
Types ¶
type Config ¶ added in v0.3.0
type Config struct {
LibOnnxRuntimeVersion string
LibCacheDir string
OnnxCacheDir string
OnnxLibPath string
OnnxModelsCachePath string
OnnxModelCachePath string
OnnxModelPath string
OnnxModelTokenizerConfigPath string
}
Config holds all computed configuration paths for ONNX Runtime
type DefaultEmbeddingFunction ¶
type DefaultEmbeddingFunction struct {
// contains filtered or unexported fields
}
func NewDefaultEmbeddingFunction
deprecated
func NewDefaultEmbeddingFunction(opts ...Option) (*DefaultEmbeddingFunction, func() error, error)
Deprecated: Use github.com/amikos-tech/chroma-go/pkg/embeddings/ort.NewDefaultEmbeddingFunction instead.
func NewDefaultEmbeddingFunctionFromConfig
deprecated
added in
v0.3.0
func NewDefaultEmbeddingFunctionFromConfig(_ embeddings.EmbeddingFunctionConfig) (*DefaultEmbeddingFunction, error)
NewDefaultEmbeddingFunctionFromConfig creates a default embedding function from a config map. The returned EmbeddingFunction implements Closeable; callers should type-assert and call Close() when done to release ONNX runtime and tokenizer resources.
Deprecated: Use github.com/amikos-tech/chroma-go/pkg/embeddings/ort.NewDefaultEmbeddingFunctionFromConfig instead.
func (*DefaultEmbeddingFunction) Close ¶
func (e *DefaultEmbeddingFunction) Close() error
func (*DefaultEmbeddingFunction) DefaultSpace ¶ added in v0.3.0
func (e *DefaultEmbeddingFunction) DefaultSpace() embeddings.DistanceMetric
func (*DefaultEmbeddingFunction) EmbedDocuments ¶
func (e *DefaultEmbeddingFunction) EmbedDocuments(_ context.Context, documents []string) ([]embeddings.Embedding, error)
func (*DefaultEmbeddingFunction) EmbedQuery ¶
func (e *DefaultEmbeddingFunction) EmbedQuery(_ context.Context, document string) (embeddings.Embedding, error)
func (*DefaultEmbeddingFunction) GetConfig ¶ added in v0.3.0
func (e *DefaultEmbeddingFunction) GetConfig() embeddings.EmbeddingFunctionConfig
func (*DefaultEmbeddingFunction) Name ¶ added in v0.3.0
func (e *DefaultEmbeddingFunction) Name() string
func (*DefaultEmbeddingFunction) SupportedSpaces ¶ added in v0.3.0
func (e *DefaultEmbeddingFunction) SupportedSpaces() []embeddings.DistanceMetric
type Option ¶
type Option func(p *DefaultEmbeddingFunction) error
Option mutates the embedding function during construction while initLock is held. Implementations must not call Close(), which would try to reacquire initLock and deadlock.
Source Files