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

@@ -10,6 +10,7 @@ class BaseLlmConfig(ABC):
self,
model: Optional[str] = None,
temperature: float = 0,
api_key: Optional[str] = None,
max_tokens: int = 3000,
top_p: float = 0,
top_k: int = 1,
@@ -32,6 +33,8 @@ class BaseLlmConfig(ABC):
:param temperature: Controls the randomness of the model's output.
Higher values (closer to 1) make output more random, lower values make it more deterministic, defaults to 0
:type temperature: float, optional
:param api_key: OpenAI API key to be use, defaults to None
:type api_key: Optional[str], optional
:param max_tokens: Controls how many tokens are generated, defaults to 3000
:type max_tokens: int, optional
:param top_p: Controls the diversity of words. Higher values (closer to 1) make word selection more diverse,
@@ -39,15 +42,15 @@ class BaseLlmConfig(ABC):
:type top_p: float, optional
:param top_k: Controls the diversity of words. Higher values make word selection more diverse, defaults to 0
:type top_k: int, optional
:param models: Controls the Openrouter models used, defaults to None
:param models: Openrouter models to use, defaults to None
:type models: Optional[list[str]], optional
:param route: Controls the Openrouter route used, defaults to "fallback"
:param route: Openrouter route to be used, defaults to "fallback"
:type route: Optional[str], optional
:param openrouter_base_url: Controls the Openrouter base URL used, defaults to "https://openrouter.ai/api/v1"
:param openrouter_base_url: Openrouter base URL to be use, defaults to "https://openrouter.ai/api/v1"
:type openrouter_base_url: Optional[str], optional
:param site_url: Controls the Openrouter site URL used, defaults to None
:param site_url: Openrouter site URL to use, defaults to None
:type site_url: Optional[str], optional
:param app_name: Controls the Openrouter app name used, defaults to None
:param app_name: Openrouter app name to use, defaults to None
:type app_name: Optional[str], optional
:param ollama_base_url: The base URL of the LLM, defaults to None
:type ollama_base_url: Optional[str], optional
@@ -55,6 +58,7 @@ class BaseLlmConfig(ABC):
self.model = model
self.temperature = temperature
self.api_key = api_key
self.max_tokens = max_tokens
self.top_p = top_p
self.top_k = top_k