refactor the rerankers to conform to new pydantic

Author: tylerhutcherson

redisvl/utils/rerank/base.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 from typing import Any, Dict, List, Optional, Tuple, Union
 
-from pydantic.v1 import BaseModel, validator
+from pydantic import BaseModel, field_validator
 
 
 class BaseReranker(BaseModel, ABC):
@@ -10,15 +10,15 @@ class BaseReranker(BaseModel, ABC):
     limit: int
     return_score: bool
 
-    @validator("limit")
+    @field_validator("limit")
     @classmethod
     def check_limit(cls, value):
         """Ensures the limit is a positive integer."""
         if value <= 0:
             raise ValueError("Limit must be a positive integer.")
         return value
 
-    @validator("rank_by")
+    @field_validator("rank_by")
     @classmethod
     def check_rank_by(cls, value):
         """Ensures that rank_by is a list of strings if provided."""

redisvl/utils/rerank/cohere.py

@@ -1,7 +1,7 @@
 import os
 from typing import Any, Dict, List, Optional, Tuple, Union
 
-from pydantic.v1 import PrivateAttr
+from pydantic import PrivateAttr
 
 from redisvl.utils.rerank.base import BaseReranker
 
@@ -45,7 +45,8 @@ def __init__(
         limit: int = 5,
         return_score: bool = True,
         api_config: Optional[Dict] = None,
-    ) -> None:
+        **kwargs,
+    ):
         """
         Initialize the CohereReranker with specified model, ranking criteria,
         and API configuration.
@@ -71,9 +72,9 @@ def __init__(
         super().__init__(
             model=model, rank_by=rank_by, limit=limit, return_score=return_score
         )
-        self._initialize_clients(api_config)
+        self._initialize_clients(api_config, **kwargs)
 
-    def _initialize_clients(self, api_config: Optional[Dict]):
+    def _initialize_clients(self, api_config: Optional[Dict], **kwargs):
         """
         Setup the Cohere clients using the provided API key or an
         environment variable.
@@ -96,8 +97,8 @@ def _initialize_clients(self, api_config: Optional[Dict]):
                 "Cohere API key is required. "
                 "Provide it in api_config or set the COHERE_API_KEY environment variable."
             )
-        self._client = Client(api_key=api_key, client_name="redisvl")
-        self._aclient = AsyncClient(api_key=api_key, client_name="redisvl")
+        self._client = Client(api_key=api_key, client_name="redisvl", **kwargs)
+        self._aclient = AsyncClient(api_key=api_key, client_name="redisvl", **kwargs)
 
     def _preprocess(
         self, query: str, docs: Union[List[Dict[str, Any]], List[str]], **kwargs

redisvl/utils/rerank/hf_cross_encoder.py

@@ -1,6 +1,6 @@
 from typing import Any, Dict, List, Optional, Tuple, Union
 
-from pydantic.v1 import PrivateAttr
+from pydantic import PrivateAttr
 
 from redisvl.utils.rerank.base import BaseReranker
 
@@ -39,7 +39,7 @@ def __init__(
         limit: int = 3,
         return_score: bool = True,
         **kwargs,
-    ) -> None:
+    ):
         """
         Initialize the HFCrossEncoderReranker with a specified model and ranking criteria.
 

redisvl/utils/rerank/voyageai.py

@@ -1,7 +1,7 @@
 import os
 from typing import Any, Dict, List, Optional, Tuple, Union
 
-from pydantic.v1 import PrivateAttr
+from pydantic import PrivateAttr
 
 from redisvl.utils.rerank.base import BaseReranker
 
@@ -45,7 +45,8 @@ def __init__(
         limit: int = 5,
         return_score: bool = True,
         api_config: Optional[Dict] = None,
-    ) -> None:
+        **kwargs,
+    ):
         """
         Initialize the VoyageAIReranker with specified model, ranking criteria,
         and API configuration.
@@ -70,9 +71,9 @@ def __init__(
         super().__init__(
             model=model, rank_by=rank_by, limit=limit, return_score=return_score
         )
-        self._initialize_clients(api_config)
+        self._initialize_clients(api_config, **kwargs)
 
-    def _initialize_clients(self, api_config: Optional[Dict]):
+    def _initialize_clients(self, api_config: Optional[Dict], **kwargs):
         """
         Setup the VoyageAI clients using the provided API key or an
         environment variable.
@@ -95,8 +96,8 @@ def _initialize_clients(self, api_config: Optional[Dict]):
                 "VoyageAI API key is required. "
                 "Provide it in api_config or set the VOYAGE_API_KEY environment variable."
             )
-        self._client = Client(api_key=api_key)
-        self._aclient = AsyncClient(api_key=api_key)
+        self._client = Client(api_key=api_key, **kwargs)
+        self._aclient = AsyncClient(api_key=api_key, **kwargs)
 
     def _preprocess(
         self, query: str, docs: Union[List[Dict[str, Any]], List[str]], **kwargs