nuclia 4.9.2__tar.gz → 4.9.3__tar.gz

{nuclia-4.9.2 → nuclia-4.9.3}/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
 
+## 4.9.3 (2025-06-16)
+
+
+- Add rerank funcion
+
+
 ## 4.9.2 (2025-06-12)
 
 

{nuclia-4.9.2 → nuclia-4.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nuclia
-Version: 4.9.2
+Version: 4.9.3
 Summary: Nuclia Python SDK
 Author-email: Nuclia <info@nuclia.com>
 License-Expression: MIT

nuclia-4.9.3/VERSION

@@ -0,0 +1 @@
+4.9.3

{nuclia-4.9.2 → nuclia-4.9.3}/nuclia/lib/nua.py

@@ -42,6 +42,8 @@ from nuclia.lib.nua_responses import (
     PushResponseV2,
     QueryInfo,
     RephraseModel,
+    RerankModel,
+    RerankResponse,
     RestrictedIDString,
     Sentence,
     Source,
@@ -77,6 +79,7 @@ PUSH_PROCESS = "/api/v2/processing/push"
 SCHEMA = "/api/v1/learning/configuration/schema"
 SCHEMA_KBID = "/api/v1/schema"
 CONFIG = "/api/v1/config"
+RERANK = "/api/v1/predict/rerank"
 
 ConvertType = TypeVar("ConvertType", bound=BaseModel)
 
@@ -410,6 +413,12 @@ class NuaClient:
         activity_endpoint = f"{self.url}{STATUS_PROCESS}/{process_id}"
         return self._request("GET", activity_endpoint, ProcessRequestStatus)
 
+    def rerank(self, model: RerankModel) -> RerankResponse:
+        endpoint = f"{self.url}{RERANK}"
+        return self._request(
+            "POST", endpoint, payload=model.model_dump(), output=RerankResponse
+        )
+
 
 class AsyncNuaClient:
     def __init__(
@@ -792,3 +801,9 @@ class AsyncNuaClient:
         return await self._request(
             "GET", activity_endpoint, output=ProcessRequestStatus
         )
+
+    async def rerank(self, model: RerankModel) -> RerankResponse:
+        endpoint = f"{self.url}{RERANK}"
+        return await self._request(
+            "POST", endpoint, payload=model.model_dump(), output=RerankResponse
+        )

{nuclia-4.9.2 → nuclia-4.9.3}/nuclia/lib/nua_responses.py

@@ -557,3 +557,15 @@ class QueryInfo(BaseModel):
     max_context: int
     entities: Optional[TokenSearch]
     sentence: Optional[SentenceSearch]
+
+
+class RerankModel(BaseModel):
+    question: str
+    user_id: str
+    context: dict[str, str] = {}
+
+
+class RerankResponse(BaseModel):
+    context_scores: dict[str, float] = Field(
+        description="Scores for each context given by the reranker"
+    )

{nuclia-4.9.2 → nuclia-4.9.3}/nuclia/sdk/predict.py

@@ -13,6 +13,8 @@ from nuclia.lib.nua_responses import (
     ConfigSchema,
     LearningConfigurationCreation,
     QueryInfo,
+    RerankModel,
+    RerankResponse,
     Sentence,
     StoredLearningConfiguration,
     SummarizedModel,
@@ -162,6 +164,17 @@ class NucliaPredict:
         nc: NuaClient = kwargs["nc"]
         return nc.remi(request)
 
+    @nua
+    def rerank(self, request: RerankModel, **kwargs) -> RerankResponse:
+        """
+        Perform a reranking of the results based on the question and context provided.
+
+        :param request: RerankModel
+        :return: RerankResponse
+        """
+        nc: NuaClient = kwargs["nc"]
+        return nc.rerank(request)
+
 
 class AsyncNucliaPredict:
     @property
@@ -299,3 +312,14 @@ class AsyncNucliaPredict:
 
         nc: AsyncNuaClient = kwargs["nc"]
         return await nc.remi(request)
+
+    @nua
+    async def rerank(self, request: RerankModel, **kwargs) -> RerankResponse:
+        """
+        Perform a reranking of the results based on the question and context provided.
+
+        :param request: RerankModel
+        :return: RerankResponse
+        """
+        nc: AsyncNuaClient = kwargs["nc"]
+        return await nc.rerank(request)

{nuclia-4.9.2 → nuclia-4.9.3}/nuclia/tests/test_nua/test_predict.py

@@ -1,6 +1,6 @@
 from nuclia_models.predict.generative_responses import TextGenerativeResponse
 
-from nuclia.lib.nua_responses import ChatModel, UserPrompt
+from nuclia.lib.nua_responses import ChatModel, RerankModel, UserPrompt
 from nuclia.sdk.predict import AsyncNucliaPredict, NucliaPredict
 import pytest
 from nuclia_models.predict.remi import RemiRequest
@@ -170,3 +170,18 @@ async def test_nua_async_remi(testing_config):
 
     assert results.context_relevance[1] < 2
     assert results.groundedness[1] < 2
+
+
+def test_nua_rerank(testing_config):
+    np = NucliaPredict()
+    results = np.rerank(
+        RerankModel(
+            user_id="Nuclia PY CLI",
+            question="What is the capital of France?",
+            context={
+                "1": "Paris is the capital of France.",
+                "2": "Berlin is the capital of Germany.",
+            },
+        )
+    )
+    assert results.context_scores["1"] > results.context_scores["2"]

{nuclia-4.9.2 → nuclia-4.9.3}/nuclia.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nuclia
-Version: 4.9.2
+Version: 4.9.3
 Summary: Nuclia Python SDK
 Author-email: Nuclia <info@nuclia.com>
 License-Expression: MIT

nuclia-4.9.2/VERSION

@@ -1 +0,0 @@
-4.9.2