Version: 0.0.4
agrag.embedding.settings.EmbeddingSettings
Bases: BaseSettings
Sentence-transformers embedder configuration.
All fields are overridable via environment variables with the
EMBEDDING_ prefix.
Attributes:
- model (
str) – The sentence-transformers model name or path. Env:EMBEDDING_MODEL. - device (
str | None) – The device to load the model on, such as"cpu"or"cuda".Noneuses sentence-transformers' own default detection. Env:EMBEDDING_DEVICE. - normalize (
bool) – Whether to L2-normalize output vectors. Env:EMBEDDING_NORMALIZE. - batch_size (
int) – The number of texts encoded permodel.encodecall. Env:EMBEDDING_BATCH_SIZE. - cache_folder (
str | None) – Where sentence-transformers caches downloaded models.Noneuses the library default. Env:EMBEDDING_CACHE_FOLDER.
batch_size
batch_size: int = 32
cache_folder
cache_folder: str | None = None
device
device: str | None = None
model
model: str = 'ibm-granite/granite-embedding-small-english-r2'
model_config
model_config = SettingsConfigDict(env_prefix='EMBEDDING_', env_file='.env', extra='ignore', hide_input_in_errors=True)
normalize
normalize: bool = True