Sentence Transformer
Parameter reference for SentenceTransformerEmbedder, which runs open-source sentence-transformers models locally.
Sentence Transformer Embedder embeds documents using Hugging Face's sentence-transformers library, providing access to a wide range of open-source embedding models that can run locally.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
id | str | sentence-transformers/all-MiniLM-L6-v2 | The name of the SentenceTransformers model to use |
dimensions | int | 384 | The dimensionality of the generated embeddings |
sentence_transformer_client | Optional[SentenceTransformer] | None | Optional pre-configured SentenceTransformers client instance |
prompt | Optional[str] | None | Optional prompt to prepend to input text |
normalize_embeddings | bool | False | Whether to normalize returned vectors to have length 1 |
enable_batch | bool | False | Has no effect. This embedder embeds one text per call |
batch_size | int | 100 | Number of texts per batch. Unused by this embedder |