mirror of
https://github.com/hwchase17/langchain
synced 2024-11-06 03:20:49 +00:00
6b2a57161a
- **Description:** add support for kwargs in`MlflowEmbeddings` `embed_document()` and `embed_query()` so that all the arguments required by Cohere API (and others?) can be passed down to the server. - **Issue:** #15234 - **Dependencies:** MLflow with MLflow Deployments (`pip install mlflow[genai]`) **Tests** Now this code [adapted from the docs](https://python.langchain.com/docs/integrations/providers/mlflow#embeddings-example) for the Cohere API works locally. ```python """ Setup ----- export COHERE_API_KEY=... mlflow deployments start-server --config-path examples/deployments/cohere/config.yaml Run --- python /path/to/this/file.py """ embeddings = MlflowCohereEmbeddings(target_uri="http://127.0.0.1:5000", endpoint="embeddings") print(embeddings.embed_query("hello")[:3]) print(embeddings.embed_documents(["hello", "world"])[0][:3]) ``` Output ``` [0.060455322, 0.028793335, -0.025848389] [0.031707764, 0.021057129, -0.009361267] ```
89 lines
2.9 KiB
Python
89 lines
2.9 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import Any, Dict, Iterator, List
|
|
from urllib.parse import urlparse
|
|
|
|
from langchain_core.embeddings import Embeddings
|
|
from langchain_core.pydantic_v1 import BaseModel, PrivateAttr
|
|
|
|
|
|
def _chunk(texts: List[str], size: int) -> Iterator[List[str]]:
|
|
for i in range(0, len(texts), size):
|
|
yield texts[i : i + size]
|
|
|
|
|
|
class MlflowEmbeddings(Embeddings, BaseModel):
|
|
"""Wrapper around embeddings LLMs in MLflow.
|
|
|
|
To use, you should have the `mlflow[genai]` python package installed.
|
|
For more information, see https://mlflow.org/docs/latest/llms/deployments/server.html.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
from langchain_community.embeddings import MlflowEmbeddings
|
|
|
|
embeddings = MlflowEmbeddings(
|
|
target_uri="http://localhost:5000",
|
|
endpoint="embeddings",
|
|
)
|
|
"""
|
|
|
|
endpoint: str
|
|
"""The endpoint to use."""
|
|
target_uri: str
|
|
"""The target URI to use."""
|
|
_client: Any = PrivateAttr()
|
|
"""The parameters to use for queries."""
|
|
query_params: Dict[str, str] = {}
|
|
"""The parameters to use for documents."""
|
|
documents_params: Dict[str, str] = {}
|
|
|
|
def __init__(self, **kwargs: Any):
|
|
super().__init__(**kwargs)
|
|
self._validate_uri()
|
|
try:
|
|
from mlflow.deployments import get_deploy_client
|
|
|
|
self._client = get_deploy_client(self.target_uri)
|
|
except ImportError as e:
|
|
raise ImportError(
|
|
"Failed to create the client. "
|
|
f"Please run `pip install mlflow{self._mlflow_extras}` to install "
|
|
"required dependencies."
|
|
) from e
|
|
|
|
@property
|
|
def _mlflow_extras(self) -> str:
|
|
return "[genai]"
|
|
|
|
def _validate_uri(self) -> None:
|
|
if self.target_uri == "databricks":
|
|
return
|
|
allowed = ["http", "https", "databricks"]
|
|
if urlparse(self.target_uri).scheme not in allowed:
|
|
raise ValueError(
|
|
f"Invalid target URI: {self.target_uri}. "
|
|
f"The scheme must be one of {allowed}."
|
|
)
|
|
|
|
def embed(self, texts: List[str], params: Dict[str, str]) -> List[List[float]]:
|
|
embeddings: List[List[float]] = []
|
|
for txt in _chunk(texts, 20):
|
|
resp = self._client.predict(
|
|
endpoint=self.endpoint, inputs={"input": txt, **params}
|
|
)
|
|
embeddings.extend(r["embedding"] for r in resp["data"])
|
|
return embeddings
|
|
|
|
def embed_documents(self, texts: List[str]) -> List[List[float]]:
|
|
return self.embed(texts, params=self.documents_params)
|
|
|
|
def embed_query(self, text: str) -> List[float]:
|
|
return self.embed([text], params=self.query_params)[0]
|
|
|
|
|
|
class MlflowCohereEmbeddings(MlflowEmbeddings):
|
|
query_params: Dict[str, str] = {"input_type": "search_query"}
|
|
documents_params: Dict[str, str] = {"input_type": "search_document"}
|