nuclia 4.9.1__py3-none-any.whl → 4.9.3__py3-none-any.whl

nuclia/lib/kb.py

@@ -23,6 +23,7 @@ from nuclia_models.events.activity_logs import (  # type: ignore
 )
 from nuclia_models.events.remi import RemiQuery
 from nuclia_models.worker.tasks import TaskStartKB
+from nuclia_models.config.proto import ExtractConfig
 from nuclia.exceptions import RateLimitError
 from nuclia.lib.utils import handle_http_sync_errors, handle_http_async_errors
 from datetime import datetime
@@ -58,6 +59,8 @@ STOP_TASK = "/task/{task_id}/stop"
 DELETE_TASK = "/task/{task_id}"
 GET_TASK = "/task/{task_id}/inspect"
 RESTART_TASK = "/task/{task_id}/restart"
+EXTRACT_STRATEGIES = "/extract_strategies"
+DELETE_EXTRACT_STRATEGY = "/extract_strategies/strategy/{id}"
 
 DOWNLOAD_FORMAT_HEADERS = {
     DownloadFormat.CSV: "text/csv",
@@ -487,6 +490,37 @@ class NucliaDBClient(BaseNucliaDBClient):
         handle_http_sync_errors(response)
         return response
 
+    def list_extract_strategies(self) -> httpx.Response:
+        if self.reader_session is None:
+            raise Exception("KB not configured")
+
+        response: httpx.Response = self.reader_session.get(
+            f"{self.url}{EXTRACT_STRATEGIES}"
+        )
+        handle_http_sync_errors(response)
+        return response
+
+    def add_extract_strategy(self, config: ExtractConfig) -> httpx.Response:
+        if self.writer_session is None:
+            raise Exception("KB not configured")
+
+        response: httpx.Response = self.writer_session.post(
+            f"{self.url}{EXTRACT_STRATEGIES}",
+            json=config.model_dump(mode="json", exclude_unset=True),
+        )
+        handle_http_sync_errors(response)
+        return response
+
+    def delete_extract_strategy(self, strategy_id: str) -> httpx.Response:
+        if self.writer_session is None:
+            raise Exception("KB not configured")
+
+        response: httpx.Response = self.writer_session.delete(
+            f"{self.url}{DELETE_EXTRACT_STRATEGY.format(id=strategy_id)}",
+        )
+        handle_http_sync_errors(response)
+        return response
+
 
 class AsyncNucliaDBClient(BaseNucliaDBClient):
     reader_session: Optional[httpx.AsyncClient] = None
@@ -813,3 +847,34 @@ class AsyncNucliaDBClient(BaseNucliaDBClient):
         )
         await handle_http_async_errors(response)
         return response
+
+    async def list_extract_strategies(self) -> httpx.Response:
+        if self.reader_session is None:
+            raise Exception("KB not configured")
+
+        response: httpx.Response = await self.reader_session.get(
+            f"{self.url}{EXTRACT_STRATEGIES}"
+        )
+        await handle_http_async_errors(response)
+        return response
+
+    async def add_extract_strategy(self, config: ExtractConfig) -> httpx.Response:
+        if self.writer_session is None:
+            raise Exception("KB not configured")
+
+        response: httpx.Response = await self.writer_session.post(
+            f"{self.url}{EXTRACT_STRATEGIES}",
+            json=config.model_dump(mode="json", exclude_unset=True),
+        )
+        await handle_http_async_errors(response)
+        return response
+
+    async def delete_extract_strategy(self, strategy_id: str) -> httpx.Response:
+        if self.writer_session is None:
+            raise Exception("KB not configured")
+
+        response: httpx.Response = await self.writer_session.delete(
+            f"{self.url}{DELETE_EXTRACT_STRATEGY.format(id=strategy_id)}",
+        )
+        await handle_http_async_errors(response)
+        return response

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/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/sdk/extract_strategy.py

@@ -0,0 +1,98 @@
+from nuclia.data import get_auth, get_async_auth
+from nuclia.decorators import kb, pretty
+from nuclia.lib.kb import NucliaDBClient, AsyncNucliaDBClient
+from nuclia.sdk.auth import NucliaAuth, AsyncNucliaAuth
+from nuclia_models.config.proto import ExtractConfig
+from typing import Dict
+
+
+class NucliaExtractStrategy:
+    @property
+    def _auth(self) -> NucliaAuth:
+        auth = get_auth()
+        return auth
+
+    @kb
+    @pretty
+    def list(self, *args, **kwargs) -> Dict[str, ExtractConfig]:
+        """
+        List extract strategies
+        """
+        ndb: NucliaDBClient = kwargs["ndb"]
+        response = ndb.list_extract_strategies()
+        return response.json()
+
+    @kb
+    def add(
+        self,
+        *args,
+        config: ExtractConfig,
+        **kwargs,
+    ) -> str:
+        """
+        Add extract strategy
+
+        :param config: strategy configuration
+        """
+        if isinstance(config, dict):
+            config = ExtractConfig.model_validate(config)
+
+        ndb: NucliaDBClient = kwargs["ndb"]
+        response = ndb.add_extract_strategy(config=config)
+        return response.json()
+
+    @kb
+    def delete(self, *args, id: str, **kwargs):
+        """
+        Delete extract strategy
+
+        :param id: ID of the strategy to delete
+        """
+        ndb: NucliaDBClient = kwargs["ndb"]
+        ndb.delete_extract_strategy(strategy_id=id)
+
+
+class AsyncNucliaExtractStrategy:
+    @property
+    def _auth(self) -> AsyncNucliaAuth:
+        auth = get_async_auth()
+        return auth
+
+    @kb
+    @pretty
+    async def list(self, *args, **kwargs) -> Dict[str, ExtractConfig]:
+        """
+        List extract strategies
+        """
+        ndb: AsyncNucliaDBClient = kwargs["ndb"]
+        response = await ndb.list_extract_strategies()
+        return response.json()
+
+    @kb
+    async def add(
+        self,
+        *args,
+        config: ExtractConfig,
+        **kwargs,
+    ) -> str:
+        """
+        Add extract strategy
+
+        :param config: strategy configuration
+        """
+        if isinstance(config, dict):
+            config = ExtractConfig.model_validate(config)
+
+        ndb: AsyncNucliaDBClient = kwargs["ndb"]
+        response = await ndb.add_extract_strategy(config=config)
+        return response.json()
+
+    @kb
+    async def delete(self, *args, id: str, **kwargs):
+        """
+        Delete extract strategy
+
+        :param id: ID of the strategy to delete
+        """
+        ndb: AsyncNucliaDBClient = kwargs["ndb"]
+        await ndb.delete_extract_strategy(strategy_id=id)

nuclia/sdk/kb.py

@@ -30,6 +30,10 @@ from nuclia.sdk.remi import NucliaRemi, AsyncNucliaRemi
 from nuclia.sdk.resource import AsyncNucliaResource, NucliaResource
 from nuclia.sdk.search import AsyncNucliaSearch, NucliaSearch
 from nuclia.sdk.task import NucliaTask, AsyncNucliaTask
+from nuclia.sdk.extract_strategy import (
+    NucliaExtractStrategy,
+    AsyncNucliaExtractStrategy,
+)
 from nuclia.sdk.upload import AsyncNucliaUpload, NucliaUpload
 
 
@@ -48,6 +52,7 @@ class NucliaKB:
         self.logs = NucliaLogs()
         self.task = NucliaTask()
         self.remi = NucliaRemi()
+        self.extract_strategies = NucliaExtractStrategy()
 
     @kb
     def list(
@@ -459,6 +464,7 @@ class AsyncNucliaKB:
         self.logs = AsyncNucliaLogs()
         self.task = AsyncNucliaTask()
         self.remi = AsyncNucliaRemi()
+        self.extract_strategies = AsyncNucliaExtractStrategy()
 
     @kb
     async def list(self, **kwargs) -> ResourceList:

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/tests/test_kb/test_extract_strategies.py

@@ -0,0 +1,16 @@
+from nuclia.sdk.kb import NucliaKB
+
+
+def test_extract_strategies(testing_config):
+    nkb = NucliaKB()
+    # preventive clean up
+    for id in nkb.extract_strategies.list().keys():
+        nkb.extract_strategies.delete(id=id)
+
+    # tests
+    nkb.extract_strategies.add(config={"name": "strategy1", "vllm_config": {}})
+    all = nkb.extract_strategies.list()
+    assert len(all.keys()) == 1
+    nkb.extract_strategies.delete(id=list(all.keys())[0])
+    all = nkb.extract_strategies.list()
+    assert len(all.keys()) == 0

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.1.dist-info → nuclia-4.9.3.dist-info}/METADATA

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

{nuclia-4.9.1.dist-info → nuclia-4.9.3.dist-info}/RECORD

@@ -9,11 +9,11 @@ nuclia/cli/run.py,sha256=B1hP0upSbSCqqT89WAwsd93ZxkAoF6ajVyLOdYmo8fU,1560
 nuclia/cli/utils.py,sha256=iZ3P8juBdAGvaRUd2BGz7bpUXNDHdPrC5p876yyZ2Cs,1223
 nuclia/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nuclia/lib/conversations.py,sha256=M6qhL9NPEKroYF767S-Q2XWokRrjX02kpYTzRvZKwUE,149
-nuclia/lib/kb.py,sha256=jV-L8-a5oFVHIbFfeGO17hXf2IQk9UuW-9fq5D3LO6Y,28508
+nuclia/lib/kb.py,sha256=vSLfmV6HqPvWJwPVw4iIzkDnm0M96_ImTH3QMZdkd_I,30985
 nuclia/lib/models.py,sha256=ekEQrVIFU3aFvt60yQh-zpWkGNORBMSc7c5Hd_VzPzI,1564
-nuclia/lib/nua.py,sha256=sUVFdCjvLigTqUUhILywdHpiC0qKCtKPABn5kUXfuxQ,27064
+nuclia/lib/nua.py,sha256=jVUV8I50iJpUQD6yn4V7wNDDSDP8oEWrRxnmrs33hnI,27591
 nuclia/lib/nua_chat.py,sha256=ApL1Y1FWvAVUt-Y9a_8TUSJIhg8-UmBSy8TlDPn6tD8,3874
-nuclia/lib/nua_responses.py,sha256=RJB7bbgZEpYr29aOmaT2nb1X0g6wds4MOngq7N-ZcTg,13382
+nuclia/lib/nua_responses.py,sha256=FyCedSKHVGn4w380obV9B3D1JaqVyNTqda4-OCs4A9A,13637
 nuclia/lib/utils.py,sha256=9l6DxBk-11WqUhXRn99cqeuVTUOJXj-1S6zckal7wOk,6312
 nuclia/sdk/__init__.py,sha256=-nAw8i53XBdmbfTa1FJZ0FNRMNakimDVpD6W4OdES-c,1374
 nuclia/sdk/accounts.py,sha256=7XQ3K9_jlSuk2Cez868FtazZ05xSGab6h3Mt1qMMwIE,647
@@ -21,13 +21,14 @@ nuclia/sdk/agent.py,sha256=ot_oA4yi7TkXahPnhcRIxztq9Dtskc85-A57WN1BNGg,1961
 nuclia/sdk/auth.py,sha256=o9CiWt3P_UHQW_L5Jq_9IOB-KpSCXFsVTouQcZp8BJM,25072
 nuclia/sdk/backup.py,sha256=adbPcNEbHGZW698o028toXKfDkDrmk5QRIDSiN6SPys,6529
 nuclia/sdk/export_import.py,sha256=y5cTOxhILwRPIvR2Ya12bk-ReGbeDzA3C9TPxgnOHD4,9756
-nuclia/sdk/kb.py,sha256=iDJimbzw_R9VeUu7a4F5wXoLdLxCim7W3UeEaAQ5dGI,26820
+nuclia/sdk/extract_strategy.py,sha256=NZBLLThdLyQYw8z1mT9iRhFjkE5sQP86-3QhsTiyV9o,2540
+nuclia/sdk/kb.py,sha256=2-H9FOvPgsG-ZYNUA8D4FYAJhX3K8m2VwbwSQy1JV7c,27044
 nuclia/sdk/kbs.py,sha256=nXEvg5ddZYdDS8Kie7TrN-s1meU9ecYLf9FlT5xr-ro,9131
 nuclia/sdk/logger.py,sha256=UHB81eS6IGmLrsofKxLh8cmF2AsaTj_HXP0tGqMr_HM,57
 nuclia/sdk/logs.py,sha256=3jfORpo8fzZiXFFSbGY0o3Bre1ZgJaKQCXgxP1keNHw,9614
 nuclia/sdk/nua.py,sha256=6t0m0Sx-UhqNU2Hx9v6vTwy0m3a30K4T0KmP9G43MzY,293
 nuclia/sdk/nucliadb.py,sha256=bOESIppPgY7IrNqrYY7T3ESoxwttbOSTm5zj1xUS1jI,1288
-nuclia/sdk/predict.py,sha256=KF7iT2aasaB9DIEAwqktXbOl2H_Y_ne-6-SEErN7YOk,9095
+nuclia/sdk/predict.py,sha256=Gom-BlISXawThNq-f7fb1te5tY4catlIdmO-pMJyqkk,9815
 nuclia/sdk/process.py,sha256=WuNnqaWprp-EABWDC_z7O2woesGIlYWnDUKozh7Ibr4,2241
 nuclia/sdk/remi.py,sha256=BEb3O9R2jOFlOda4vjFucKKGO1c2eTkqYZdFlIy3Zmo,4357
 nuclia/sdk/resource.py,sha256=0lSvD4e1FpN5iM9W295dOKLJ8hsXfIe8HKdo0HsVg20,13976
@@ -42,6 +43,7 @@ nuclia/tests/assets/conversation.json,sha256=jLmVngHEW8QdAzSMa-MYgbJgYxOO8tHq6Ia
 nuclia/tests/test_kb/test_backup.py,sha256=67fAw1C_NB363G-wuI9LnSH6nG_YrYs-uBcFyBx6Peg,2932
 nuclia/tests/test_kb/test_conversation.py,sha256=plsWY_gEhK3P4CsIO9jkBmimZk3UDGeMYPu7YVFeuIQ,727
 nuclia/tests/test_kb/test_export_import.py,sha256=lQEww2jFNHZYcudFJqcHhoWAPrmtvvnPvcFqrijxLbo,1019
+nuclia/tests/test_kb/test_extract_strategies.py,sha256=aKNzE98H1sE4eFqh8XiwvzDT8-7SnMs0v3NTeubZ-XY,521
 nuclia/tests/test_kb/test_graph.py,sha256=ecAB-lWqm3_796HUuF-fSpGzlhsXV9NGZnAjvxXANps,2540
 nuclia/tests/test_kb/test_labels.py,sha256=IUdTq4mzv0OrOkwBWWy4UwKGKyJybtoHrgvXr676vyY,961
 nuclia/tests/test_kb/test_logs.py,sha256=Z9ELtiiU9NniITJzeWt92GCcERKYy9Nwc_fUVPboRU0,3121
@@ -55,15 +57,15 @@ nuclia/tests/test_manage/test_auth.py,sha256=I5ho9rKhrzCiP57cDVcs2zrXyy1uWlKxzfE
 nuclia/tests/test_manage/test_kb.py,sha256=gqBMxmIuPUKC6kP2V_IapS9u72QR99V8CDQlJOa8sHU,1959
 nuclia/tests/test_nua/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nuclia/tests/test_nua/test_agent.py,sha256=iPA8lVw7CyONS-0fVG7rDzv8T-LnUlNPMNynTnP-2ic,334
-nuclia/tests/test_nua/test_predict.py,sha256=SKASYohoZgDGHoVQsS2_jFwXVdMFU6REh5Suw8okIHQ,5347
+nuclia/tests/test_nua/test_predict.py,sha256=8by69GgXuOZKAgksjSjgmbNr98jCXanF1HOo29oNuMg,5798
 nuclia/tests/test_nucliadb/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nuclia/tests/test_nucliadb/test_crud.py,sha256=GuY76HRvt2DFaNgioKm5n0Aco1HnG7zzV_zKom5N8xc,1173
 nuclia/tests/unit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 nuclia/tests/unit/test_export_import.py,sha256=xo_wVbjUnNlVV65ZGH7LtZ38qy39EkJp2hjOuTHC1nU,980
 nuclia/tests/unit/test_nua_responses.py,sha256=t_hIdVztTi27RWvpfTJUYcCL0lpKdZFegZIwLdaPNh8,319
-nuclia-4.9.1.dist-info/licenses/LICENSE,sha256=Ops2LTti_HJtpmWcanuUTdTY3vKDR1myJ0gmGBKC0FA,1063
-nuclia-4.9.1.dist-info/METADATA,sha256=bScM2QXDcmlYLGp0pDG1ij02jclIV8u0Rk_CTFwkjvA,2337
-nuclia-4.9.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nuclia-4.9.1.dist-info/entry_points.txt,sha256=iZHOyXPNS54r3eQmdi5So20xO1gudI9K2oP4sQsCJRw,46
-nuclia-4.9.1.dist-info/top_level.txt,sha256=cqn_EitXOoXOSUvZnd4q6QGrhm04pg8tLAZtem-Zfdo,7
-nuclia-4.9.1.dist-info/RECORD,,
+nuclia-4.9.3.dist-info/licenses/LICENSE,sha256=Ops2LTti_HJtpmWcanuUTdTY3vKDR1myJ0gmGBKC0FA,1063
+nuclia-4.9.3.dist-info/METADATA,sha256=rxQGLEDjPHayY_NPuXkmXpfsp4_BfoBC2ZjLlOjhyoM,2337
+nuclia-4.9.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nuclia-4.9.3.dist-info/entry_points.txt,sha256=iZHOyXPNS54r3eQmdi5So20xO1gudI9K2oP4sQsCJRw,46
+nuclia-4.9.3.dist-info/top_level.txt,sha256=cqn_EitXOoXOSUvZnd4q6QGrhm04pg8tLAZtem-Zfdo,7
+nuclia-4.9.3.dist-info/RECORD,,