Add embedder docs and config changes (#1684)

This commit is contained in:
Dev Khant
2024-08-12 16:09:01 +05:30
committed by GitHub
parent 464a188662
commit b245309242
12 changed files with 130 additions and 28 deletions

View File

@@ -9,9 +9,12 @@ class BaseEmbedderConfig(ABC):
def __init__(
self,
model: Optional[str] = None,
api_key: Optional[str] = None,
embedding_dims: Optional[int] = None,
# Ollama specific
base_url: Optional[str] = None,
ollama_base_url: Optional[str] = None,
# Huggingface specific
model_kwargs: Optional[dict] = None
):
@@ -20,20 +23,23 @@ class BaseEmbedderConfig(ABC):
:param model: Embedding model to use, defaults to None
:type model: Optional[str], optional
:param api_key: API key to be use, defaults to None
:type api_key: Optional[str], optional
:param embedding_dims: The number of dimensions in the embedding, defaults to None
:type embedding_dims: Optional[int], optional
:param base_url: Base URL for the Ollama API, defaults to None
:type base_url: Optional[str], optional
:param ollama_base_url: Base URL for the Ollama API, defaults to None
:type ollama_base_url: Optional[str], optional
:param model_kwargs: key-value arguments for the huggingface embedding model, defaults a dict inside init
:type model_kwargs: Optional[Dict[str, Any]], defaults a dict inside init
"""
self.model = model
self.api_key = api_key
self.embedding_dims = embedding_dims
# Ollama specific
self.base_url = base_url
self.ollama_base_url = ollama_base_url
# Huggingface specific
self.model_kwargs = model_kwargs or {}