hyperforge-nucliadb 1.0.0.post99__tar.gz → 1.0.0.post105__tar.gz

{hyperforge_nucliadb-1.0.0.post99 → hyperforge_nucliadb-1.0.0.post105}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyperforge_nucliadb
-Version: 1.0.0.post99
+Version: 1.0.0.post105
 Summary: NucliaDB Hyperforge agent
 Author-email: Nuclia <nucliadb@nuclia.com>
 License-Expression: Apache-2.0

{hyperforge_nucliadb-1.0.0.post99 → hyperforge_nucliadb-1.0.0.post105}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hyperforge_nucliadb"
-version = "1.0.0.post99"
+version = "1.0.0.post105"
 license = "Apache-2.0"
 description = "NucliaDB Hyperforge agent"
 authors = [{ name = "Nuclia", email = "nucliadb@nuclia.com" }]

{hyperforge_nucliadb-1.0.0.post99 → hyperforge_nucliadb-1.0.0.post105}/src/hyperforge_nucliadb/sync/agent.py

@@ -3,6 +3,7 @@ import itertools
 from typing import Dict, List, Optional, cast
 from uuid import uuid4
 
+from hyperforge import logger
 from hyperforge.configure import agent
 from hyperforge.interaction import (
     Feedback,
@@ -109,13 +110,159 @@ class SyncAskAgent(BasicAskAgent):
         memory: QuestionMemory,
         manager: Manager,
         resources: Dict[str, List[str]],
+    ) -> Dict[str, Dict[str, List[str]]]:
+        connections = self.get_connections(manager)
+        filtered_resources: Dict[str, Dict[str, List[str]]] = {}
+        for kb_source_id, resource_ids in resources.items():
+            if connections[kb_source_id].config.connection_ids:
+                source_resources = await self._post_filter_configured_resources(
+                    memory=memory,
+                    manager=manager,
+                    resources={kb_source_id: resource_ids},
+                )
+            else:
+                source_resources = await self._post_filter_hybrid_resources(
+                    memory=memory,
+                    manager=manager,
+                    kb_source_id=kb_source_id,
+                    resource_ids=resource_ids,
+                )
+            filtered_resources.update(source_resources)
+        return filtered_resources
+
+    async def _post_filter_hybrid_resources(
+        self,
+        memory: QuestionMemory,
+        manager: Manager,
+        kb_source_id: str,
+        resource_ids: List[str],
+    ) -> Dict[str, Dict[str, List[str]]]:
+        driver = self.sources[kb_source_id]
+        ndb = get_ndb_driver(manager, kb_source_id)
+        resource_objs: List[NucliaDBResource] = await asyncio.gather(
+            *[
+                ndb.driver.get_resource_by_id(
+                    kbid=ndb.config.kbid,
+                    rid=resource_id,
+                    query_params={"show": [ResourceProperties.ORIGIN.value]},
+                )
+                for resource_id in resource_ids
+            ]
+        )
+
+        public_resource_ids: List[str] = []
+        connected_resources: Dict[str, List[str]] = {}
+        for resource_obj in resource_objs:
+            origin = resource_obj.origin
+            if origin is None:
+                public_resource_ids.append(resource_obj.id)
+                continue
+
+            if not origin.source_id or not origin.source_id.startswith("sync_config_"):
+                if origin.sync_metadata is None:
+                    public_resource_ids.append(resource_obj.id)
+                else:
+                    logger.warning(
+                        "Excluding resource with inconsistent Sync origin metadata",
+                        extra={"resource_id": resource_obj.id},
+                    )
+                continue
+
+            source_id = origin.source_id
+            sync_config_id = source_id.removeprefix("sync_config_")
+            if not sync_config_id or origin.sync_metadata is None:
+                logger.warning(
+                    "Excluding synced resource with incomplete origin metadata",
+                    extra={"resource_id": resource_obj.id, "source_id": source_id},
+                )
+                continue
+            connected_resources.setdefault(sync_config_id, []).append(resource_obj.id)
+
+        resolved_resource_ids: List[str] = []
+        resolved_connection_ids: set[str] = set()
+        for sync_config_id, connection_resource_ids in connected_resources.items():
+            try:
+                await driver.resolve_sync_config(sync_config_id)
+            except Exception as exc:
+                logger.warning(
+                    "Excluding resources for an unavailable sync configuration",
+                    extra={
+                        "sync_config_id": sync_config_id,
+                        "resource_count": len(connection_resource_ids),
+                        "exception_type": type(exc).__name__,
+                    },
+                )
+                continue
+            resolved_resource_ids.extend(connection_resource_ids)
+            resolved_connection_ids.add(sync_config_id)
+
+        public_resource_id_set = set(public_resource_ids)
+        if not resolved_resource_ids:
+            return {
+                kb_source_id: {
+                    "__hybrid__": [
+                        resource_id
+                        for resource_id in resource_ids
+                        if resource_id in public_resource_id_set
+                    ]
+                }
+            }
+
+        try:
+            connected_filtered_resources = await self._post_filter_configured_resources(
+                memory=memory,
+                manager=manager,
+                resources={kb_source_id: resolved_resource_ids},
+                allowed_connection_ids=resolved_connection_ids,
+            )
+        except Exception as exc:
+            logger.warning(
+                "Excluding synced resources after authorization failed",
+                extra={
+                    "source_id": kb_source_id,
+                    "exception_type": type(exc).__name__,
+                },
+            )
+            connected_filtered_resources = {}
+
+        authorized_resource_ids = {
+            resource_id
+            for connection_resource_ids in connected_filtered_resources.get(
+                kb_source_id, {}
+            ).values()
+            for resource_id in connection_resource_ids
+        }
+        return {
+            kb_source_id: {
+                "__hybrid__": [
+                    resource_id
+                    for resource_id in resource_ids
+                    if resource_id in public_resource_id_set
+                    or resource_id in authorized_resource_ids
+                ]
+            }
+        }
+
+    async def _post_filter_configured_resources(
+        self,
+        memory: QuestionMemory,
+        manager: Manager,
+        resources: Dict[str, List[str]],
+        allowed_connection_ids: Optional[set[str]] = None,
     ) -> Dict[str, Dict[str, List[str]]]:
         """We have a list of ARAG resources per KB source. Now we need to filter them by connection"""
         filtered_resources: Dict[str, Dict[str, List[str]]] = {}
-        connections_by_resource: Dict[str, List[str]] = {}
-        sync_metadata_by_resource: Dict[str, SyncMetadata] = {}
         connections = self.get_connections(manager)
         for kb_source_id, resource_ids in resources.items():
+            driver = self.sources[kb_source_id]
+            configured_connection_ids = (
+                allowed_connection_ids
+                if allowed_connection_ids is not None
+                else set(driver.config.connection_ids)
+            )
+            connections_by_resource: Dict[str, List[str]] = {}
+            sync_metadata_by_resource: Dict[str, SyncMetadata] = {}
+
             # Get resource source connection for each resource
             ndb = get_ndb_driver(manager, kb_source_id)
             get_resource_ids_tasks = []
@@ -131,24 +278,28 @@ class SyncAskAgent(BasicAskAgent):
                 *get_resource_ids_tasks
             )
             for resource_obj in resource_objs:
+                origin = resource_obj.origin
                 if (
-                    resource_obj.origin is not None
-                    and resource_obj.origin.source_id is not None
+                    origin is None
+                    or not origin.source_id
+                    or not origin.source_id.startswith("sync_config_")
+                    or origin.sync_metadata is None
                 ):
-                    source_id = resource_obj.origin.source_id.replace(
-                        "sync_config_", ""
-                    )
-                    connections_by_resource.setdefault(source_id, []).append(
-                        resource_obj.id
-                    )
-                    if resource_obj.origin.sync_metadata is not None:
-                        sync_metadata_by_resource[resource_obj.id] = (
-                            resource_obj.origin.sync_metadata
-                        )
+                    continue
+
+                source_id = origin.source_id.removeprefix("sync_config_")
+                if source_id not in configured_connection_ids:
+                    continue
+
+                connections_by_resource.setdefault(source_id, []).append(
+                    resource_obj.id
+                )
+                sync_metadata_by_resource[resource_obj.id] = origin.sync_metadata
 
             # Get providers needed for the resources allocated
             needed_providers_ids = list(connections_by_resource.keys())
-            driver = self.sources[kb_source_id]
+            if not needed_providers_ids:
+                continue
 
             creds_providers = {}
             for sync_config_id in needed_providers_ids:
@@ -258,13 +409,19 @@ class SyncAskAgent(BasicAskAgent):
                     raise Exception("Connection not found")
 
                 credential = connection_credentials[inner_connection_id]
+                connection_resource_ids = connections_by_resource[connection_id]
+                connection_sync_metadata = {
+                    resource_id: sync_metadata_by_resource[resource_id]
+                    for resource_id in connection_resource_ids
+                    if resource_id in sync_metadata_by_resource
+                }
                 filtered_resource_ids = await self.validate_resources_by_connection(
                     connection=source,
                     credentials=credential,
-                    resource_ids=resource_ids,
+                    resource_ids=connection_resource_ids,
                     connection_id=inner_connection_id,
                     sync_config_id=connection_id,
-                    sync_metadata_by_resource=sync_metadata_by_resource,
+                    sync_metadata_by_resource=connection_sync_metadata,
                 )
 
                 filtered_resources.setdefault(kb_source_id, {})[connection_id] = (
@@ -279,13 +436,24 @@ class SyncAskAgent(BasicAskAgent):
         self,
         catalog_filter: Optional[CatalogFilterExpression] = None,
     ):
+        if any(
+            not self.sources[source].config.connection_ids
+            for source in self.config.sources
+        ):
+            return catalog_filter
+
+        connection_ids = [
+            connection_id
+            for source in self.config.sources
+            for connection_id in self.sources[source].config.connection_ids
+        ]
+
         if catalog_filter is None:
             catalog_filter = CatalogFilterExpression(
                 resource=Or(
                     operands=[
                         OriginSource(id=f"sync_config_{connection_id}")
-                        for source in self.config.sources
-                        for connection_id in self.sources[source].sync_configs.keys()
+                        for connection_id in connection_ids
                     ]
                 )
             )
@@ -296,10 +464,7 @@ class SyncAskAgent(BasicAskAgent):
                     Or(
                         operands=[
                             OriginSource(id=f"sync_config_{connection_id}")
-                            for source in self.config.sources
-                            for connection_id in self.sources[
-                                source
-                            ].sync_configs.keys()
+                            for connection_id in connection_ids
                         ]
                     ),
                 ]
@@ -316,6 +481,7 @@ class SyncAskAgent(BasicAskAgent):
         catalog_filter: Optional[CatalogFilterExpression] = None,
         **kwargs,
     ) -> Dict[str, List[str]]:
+        self.get_connections(manager)
         catalog_filter = self.enrich_catalog_filter(catalog_filter)
         resources = await super().search_by_title(
             memory=memory,

hyperforge_nucliadb-1.0.0.post105/src/hyperforge_nucliadb/sync/config_driver.py

@@ -0,0 +1,40 @@
+from typing import Literal
+
+from httpx import Timeout
+from hyperforge.driver import DriverConfig
+from pydantic import Field, field_validator
+from pydantic.config import ConfigDict
+
+from hyperforge_nucliadb.driver_config import (
+    NucliaDBConnection,
+)
+
+SYNC_HTTP_TIMEOUT = Timeout(connect=5.0, read=30.0, write=10.0, pool=5.0)
+
+
+class SyncConnection(NucliaDBConnection):
+    connection_ids: list[str] = Field(
+        default_factory=list,
+        description=(
+            "Sync configuration IDs to restrict searches to. When omitted or empty, "
+            "the entire knowledge box is searched and synced resources are authorized "
+            "individually."
+        ),
+    )
+
+    @field_validator("connection_ids")
+    @classmethod
+    def validate_connection_ids(cls, connection_ids: list[str]) -> list[str]:
+        if any(not connection_id.strip() for connection_id in connection_ids):
+            raise ValueError("connection_ids cannot contain blank values")
+        return connection_ids
+
+    @property
+    def kb_url(self) -> str:
+        return f"{self.url}/v1/kb/{self.kbid}"
+
+
+class SyncDriverConfig(DriverConfig[SyncConnection]):
+    model_config = ConfigDict(title="Knowledge Box Sync Service connection")
+    provider: Literal["sync"]
+    config: SyncConnection

{hyperforge_nucliadb-1.0.0.post99 → hyperforge_nucliadb-1.0.0.post105}/src/hyperforge_nucliadb/sync/driver.py

@@ -90,29 +90,47 @@ class SyncDriver(NucliaDBDriver):
     async def init(cls, driver: Any) -> "SyncDriver":
         sync_driver = cast(SyncDriverConfig, driver)
         client = await sync_connect(sync_driver.config)
-        information = {}
-        sync_configs: Dict[str, list[str]] = {}
-        for sync_config_id in sync_driver.config.connection_ids:
-            response = await client.get(f"/sync_config/{sync_config_id}")
-            response.raise_for_status()
-            data = response.json()
-            connection_id = data["external_connection"]["id"]
-            response = await client.get(f"/external_connection/{connection_id}")
-            response.raise_for_status()
-            sync_configs.setdefault(sync_config_id, []).append(connection_id)
-            data = response.json()
-            information[connection_id] = ExternalConnectionOutput(**data)
-        return cls(
+        instance = cls(
             provider=sync_driver.provider,
             name=sync_driver.name,
             async_driver=client,
-            information=information,
-            sync_configs=sync_configs,
+            information={},
+            sync_configs={},
             config=sync_driver.config,
             driver=await connect(cast(NucliaDBConnection, sync_driver.config)),
             manager=await manager_connect(cast(NucliaDBConnection, sync_driver.config)),
             _synonyms=None,
         )
+        for sync_config_id in sync_driver.config.connection_ids:
+            await instance.resolve_sync_config(sync_config_id)
+        return instance
+
+    async def resolve_sync_config(
+        self, sync_config_id: str
+    ) -> ExternalConnectionOutput:
+        if (
+            self.config.connection_ids
+            and sync_config_id not in self.config.connection_ids
+        ):
+            raise ValueError(
+                f"Sync configuration {sync_config_id} is not configured for this driver"
+            )
+
+        existing_connection_ids = self.sync_configs.get(sync_config_id, [])
+        if existing_connection_ids:
+            return self.information[existing_connection_ids[0]]
+
+        UUID(sync_config_id)
+        response = await self.async_driver.get(f"/sync_config/{sync_config_id}")
+        response.raise_for_status()
+        connection_id = response.json()["external_connection"]["id"]
+
+        response = await self.async_driver.get(f"/external_connection/{connection_id}")
+        response.raise_for_status()
+        information = ExternalConnectionOutput(**response.json())
+        self.sync_configs[sync_config_id] = [connection_id]
+        self.information[connection_id] = information
+        return information
 
     async def get_oauth_url(
         self,

{hyperforge_nucliadb-1.0.0.post99 → hyperforge_nucliadb-1.0.0.post105}/src/hyperforge_nucliadb.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyperforge_nucliadb
-Version: 1.0.0.post99
+Version: 1.0.0.post105
 Summary: NucliaDB Hyperforge agent
 Author-email: Nuclia <nucliadb@nuclia.com>
 License-Expression: Apache-2.0