mirror of
https://github.com/hwchase17/langchain
synced 2024-11-02 09:40:22 +00:00
7cf2d2759d
Added missed docstrings. Format docstings to the consistent form.
104 lines
3.2 KiB
Python
104 lines
3.2 KiB
Python
from __future__ import annotations
|
|
|
|
import warnings
|
|
from typing import Any, Dict, List, Mapping, Optional
|
|
|
|
from langchain_core.callbacks import CallbackManagerForLLMRun
|
|
from langchain_core.language_models.llms import LLM
|
|
from langchain_core.pydantic_v1 import BaseModel, Extra
|
|
|
|
|
|
# Ignoring type because below is valid pydantic code
|
|
# Unexpected keyword argument "extra" for "__init_subclass__" of "object"
|
|
class Params(BaseModel, extra=Extra.allow): # type: ignore[call-arg]
|
|
"""Parameters for the MLflow AI Gateway LLM."""
|
|
|
|
temperature: float = 0.0
|
|
candidate_count: int = 1
|
|
"""The number of candidates to return."""
|
|
stop: Optional[List[str]] = None
|
|
max_tokens: Optional[int] = None
|
|
|
|
|
|
class MlflowAIGateway(LLM):
|
|
"""MLflow AI Gateway LLMs.
|
|
|
|
To use, you should have the ``mlflow[gateway]`` python package installed.
|
|
For more information, see https://mlflow.org/docs/latest/gateway/index.html.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
from langchain_community.llms import MlflowAIGateway
|
|
|
|
completions = MlflowAIGateway(
|
|
gateway_uri="<your-mlflow-ai-gateway-uri>",
|
|
route="<your-mlflow-ai-gateway-completions-route>",
|
|
params={
|
|
"temperature": 0.1
|
|
}
|
|
)
|
|
"""
|
|
|
|
route: str
|
|
gateway_uri: Optional[str] = None
|
|
params: Optional[Params] = None
|
|
|
|
def __init__(self, **kwargs: Any):
|
|
warnings.warn(
|
|
"`MlflowAIGateway` is deprecated. Use `Mlflow` or `Databricks` instead.",
|
|
DeprecationWarning,
|
|
)
|
|
try:
|
|
import mlflow.gateway
|
|
except ImportError as e:
|
|
raise ImportError(
|
|
"Could not import `mlflow.gateway` module. "
|
|
"Please install it with `pip install mlflow[gateway]`."
|
|
) from e
|
|
|
|
super().__init__(**kwargs)
|
|
if self.gateway_uri:
|
|
mlflow.gateway.set_gateway_uri(self.gateway_uri)
|
|
|
|
@property
|
|
def _default_params(self) -> Dict[str, Any]:
|
|
params: Dict[str, Any] = {
|
|
"gateway_uri": self.gateway_uri,
|
|
"route": self.route,
|
|
**(self.params.dict() if self.params else {}),
|
|
}
|
|
return params
|
|
|
|
@property
|
|
def _identifying_params(self) -> Mapping[str, Any]:
|
|
return self._default_params
|
|
|
|
def _call(
|
|
self,
|
|
prompt: str,
|
|
stop: Optional[List[str]] = None,
|
|
run_manager: Optional[CallbackManagerForLLMRun] = None,
|
|
**kwargs: Any,
|
|
) -> str:
|
|
try:
|
|
import mlflow.gateway
|
|
except ImportError as e:
|
|
raise ImportError(
|
|
"Could not import `mlflow.gateway` module. "
|
|
"Please install it with `pip install mlflow[gateway]`."
|
|
) from e
|
|
|
|
data: Dict[str, Any] = {
|
|
"prompt": prompt,
|
|
**(self.params.dict() if self.params else {}),
|
|
}
|
|
if s := (stop or (self.params.stop if self.params else None)):
|
|
data["stop"] = s
|
|
resp = mlflow.gateway.query(self.route, data=data)
|
|
return resp["candidates"][0]["text"]
|
|
|
|
@property
|
|
def _llm_type(self) -> str:
|
|
return "mlflow-ai-gateway"
|