futurehouse-client 0.3.20.dev63__py3-none-any.whl → 0.3.20.dev112__py3-none-any.whl

futurehouse_client/__init__.py

@@ -8,6 +8,11 @@ from .models.app import (
     TaskResponse,
     TaskResponseVerbose,
 )
+from .utils.world_model_tools import (
+    create_world_model_tool,
+    search_world_model_tool,
+    make_world_model_tools,
+)
 
 __all__ = [
     "FinchTaskResponse",
@@ -19,4 +24,7 @@ __all__ = [
     "TaskRequest",
     "TaskResponse",
     "TaskResponseVerbose",
+    "create_world_model_tool",
+    "search_world_model_tool",
+    "make_world_model_tools",
 ]

futurehouse_client/clients/job_client.py

@@ -73,7 +73,7 @@ class JobNames(StrEnum):
 
     @staticmethod
     def get_response_object_from_job(job_name: str) -> type[TaskResponse]:
-        return JobNames._get_response_mapping()[job_name]
+        return JobNames._get_response_mapping().get(job_name, TaskResponse)
 
     def get_response_object(self) -> type[TaskResponse]:
         return self._get_response_mapping()[self.name]

futurehouse_client/clients/rest_client.py

@@ -111,6 +111,8 @@ class WorldModelFetchError(RestClientError):
 class WorldModelCreationError(RestClientError):
     """Raised when there's an error creating a world model."""
 
+class WorldModelDeletionError(RestClientError):
+    """Raised when there's an error deleting a world model."""
 
 class InvalidTaskDescriptionError(Exception):
     """Raised when the task description is invalid or empty."""
@@ -139,6 +141,7 @@ retry_if_connection_error = retry_if_exception_type((
 DEFAULT_AGENT_TIMEOUT: int = 2400  # seconds
 
 
+# pylint: disable=too-many-public-methods
 class RestClient:
     REQUEST_TIMEOUT: ClassVar[float] = 30.0  # sec
     MAX_RETRY_ATTEMPTS: ClassVar[int] = 3
@@ -1419,15 +1422,9 @@ class RestClient:
         if not (world_model_id or name) or (world_model_id and name):
             raise ValueError("Provide either 'world_model_id' or 'name', but not both.")
 
-        params = {
-            "id": str(world_model_id) if world_model_id else None,
-            "name": name,
-        }
-        # Filter out None values before making the request
-        params = {k: v for k, v in params.items() if v is not None}
-
         try:
-            response = self.client.get("/v0.1/world-model", params=params)
+            identifier = str(world_model_id) if world_model_id else name
+            response = self.client.get(f"/v0.1/world-models/{identifier}")
             response.raise_for_status()
             return WorldModelResponse.model_validate(response.json())
         except HTTPStatusError as e:
@@ -1465,14 +1462,9 @@ class RestClient:
         if not (world_model_id or name) or (world_model_id and name):
             raise ValueError("Provide either 'world_model_id' or 'name', but not both.")
 
-        params = {
-            "id": str(world_model_id) if world_model_id else None,
-            "name": name,
-        }
-        params = {k: v for k, v in params.items() if v is not None}
-
         try:
-            response = await self.async_client.get("/v0.1/world-model", params=params)
+            identifier = str(world_model_id) if world_model_id else name
+            response = await self.async_client.get(f"/v0.1/world-models/{identifier}")
             response.raise_for_status()
             return WorldModelResponse.model_validate(response.json())
         except HTTPStatusError as e:
@@ -1486,6 +1478,25 @@ class RestClient:
         except Exception as e:
             raise WorldModelFetchError(f"An unexpected error occurred: {e}") from e
 
+    @retry(
+        stop=stop_after_attempt(MAX_RETRY_ATTEMPTS),
+        wait=wait_exponential(multiplier=RETRY_MULTIPLIER, max=MAX_RETRY_WAIT),
+        retry=retry_if_connection_error,
+    )
+    def search_world_models(self, query: str, size: int = 10) -> list[str]:
+        """Search for world models.
+
+        Args:
+            query: The search query.
+            size: The number of results to return.
+
+        Returns:
+            A list of world model names.
+        """
+        response = self.client.get(f"/v0.1/world-models/search/{query}", params={"size": size})
+        response.raise_for_status()
+        return response.json()
+
     @retry(
         stop=stop_after_attempt(MAX_RETRY_ATTEMPTS),
         wait=wait_exponential(multiplier=RETRY_MULTIPLIER, max=MAX_RETRY_WAIT),
@@ -1559,7 +1570,30 @@ class RestClient:
                 f"An unexpected error occurred during world model creation: {e}"
             ) from e
 
+    @retry(
+        stop=stop_after_attempt(MAX_RETRY_ATTEMPTS),
+        wait=wait_exponential(multiplier=RETRY_MULTIPLIER, max=MAX_RETRY_WAIT),
+        retry=retry_if_connection_error,
+    )
+    async def delete_world_model(self, world_model_id: UUID) -> None:
+        """Delete a world model snapshot by its ID.
+
+        Args:
+            world_model_id: The unique ID of the world model snapshot to delete.
 
+        Raises:
+            WorldModelDeletionError: If the API call fails.
+        """
+        try:
+            response = await self.async_client.delete(f"/v0.1/world-models/{world_model_id}")
+            response.raise_for_status()
+        except HTTPStatusError as e:
+            raise WorldModelDeletionError(
+                f"Error deleting world model: {e.response.status_code} - {e.response.text}"
+            ) from e
+        except Exception as e:
+            raise WorldModelDeletionError(f"An unexpected error occurred: {e}") from e
+    
 def get_installed_packages() -> dict[str, str]:
     """Returns a dictionary of installed packages and their versions."""
     return {

futurehouse_client/models/app.py

@@ -610,7 +610,7 @@ class RuntimeConfig(BaseModel):
         default=None,
         description="Optional job identifier for a continued job",
     )
-    world_model_id: UUID | None = Field(
+    world_model_id: UUID | str | None = Field(
         default=None,
         description="Optional world model identifier for the task",
     )

futurehouse_client/models/rest.py

@@ -46,10 +46,10 @@ class WorldModel(BaseModel):
     """
 
     content: str
-    prior: UUID | None = None
+    prior: UUID | str | None = None
     name: str | None = None
     description: str | None = None
-    trajectory_id: UUID | None = None
+    trajectory_id: UUID | str | None = None
     model_metadata: JsonValue | None = None
 
 
@@ -60,12 +60,12 @@ class WorldModelResponse(BaseModel):
     This model is received from the API.
     """
 
-    id: UUID
-    prior: UUID | None
+    id: UUID | str
+    prior: UUID | str | None
     name: str
     description: str | None
     content: str
-    trajectory_id: UUID | None
+    trajectory_id: UUID | str | None
     email: str | None
     model_metadata: JsonValue | None
     enabled: bool

futurehouse_client/utils/world_model_tools.py

@@ -0,0 +1,52 @@
+from futurehouse_client.clients.rest_client import RestClient
+from futurehouse_client.models.app import Stage
+from futurehouse_client.models.rest import WorldModel
+from uuid import UUID
+from aviary.core import Tool
+
+
+class WorldModelTools:
+    CLIENT = RestClient(
+            stage = Stage.DEV,
+            api_key="Dk7WJRLpqTFNxp5dYRoj6A.platformv01.eyJqdGkiOiI4ODAyZmZiNy1hNjM2LTRkMWYtYWE4NC1lZTQzYTMzMzRjZGMiLCJzdWIiOiJuN1dJbGU5VDljZ1BkTjd2OUJlM0pEUlpZVTgyIiwiaWF0IjoxNzQ5MDc2NzYzfQ.vThmFNLChP54DZBwB+qeMTB6CvAQ1IVXkTcpB0+efZ0",
+        )
+    
+    @staticmethod
+    def create_world_model(name: str, description: str, content: str) -> UUID:
+        """Create a new world model.
+        
+        Args:
+            name: The name of the world model.
+            description: A description of the world model.
+            content: The content/data of the world model.
+            
+        Returns:
+            UUID: The ID of the newly created world model.
+        """
+        world_model = WorldModel(
+            name=name,
+            description=description,
+            content=content,
+        )
+        return WorldModelTools.CLIENT.create_world_model(world_model)
+    
+    @staticmethod
+    def search_world_models(query: str) -> list[str]:
+        """Search for world models using a text query.
+        
+        Args:
+            query: The search query string to match against world model content.
+            
+        Returns:
+            list[str]: A list of world model IDs that match the search query.
+        """
+        return WorldModelTools.CLIENT.search_world_models(query, size=1)
+    
+create_world_model_tool = Tool.from_function(WorldModelTools.create_world_model)
+search_world_model_tool = Tool.from_function(WorldModelTools.search_world_models)
+
+def make_world_model_tools() -> list[Tool]:
+    return [
+        search_world_model_tool,
+        create_world_model_tool,
+    ]

futurehouse_client/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.20.dev63'
-__version_tuple__ = version_tuple = (0, 3, 20, 'dev63')
+__version__ = version = '0.3.20.dev112'
+__version_tuple__ = version_tuple = (0, 3, 20, 'dev112')

{futurehouse_client-0.3.20.dev63.dist-info → futurehouse_client-0.3.20.dev112.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: futurehouse-client
-Version: 0.3.20.dev63
+Version: 0.3.20.dev112
 Summary: A client for interacting with endpoints of the FutureHouse service.
 Author-email: FutureHouse technical staff <hello@futurehouse.org>
 License:                                  Apache License

futurehouse_client-0.3.20.dev112.dist-info/RECORD

@@ -0,0 +1,21 @@
+futurehouse_client/__init__.py,sha256=rRAJFxDI0nDHiMkyB-d7Q8Y2vVKFVnIFwOuRdjClTPw,707
+futurehouse_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+futurehouse_client/version.py,sha256=nAw6MsWnD67V5v8vArdCA5jF1Rjl2uTamVcuYk2lPQo,530
+futurehouse_client/clients/__init__.py,sha256=-HXNj-XJ3LRO5XM6MZ709iPs29YpApss0Q2YYg1qMZw,280
+futurehouse_client/clients/job_client.py,sha256=D51_qTxya6g5Wfg_ZfJdP031TV_YDJeXkGMiYAJ1qRc,11962
+futurehouse_client/clients/rest_client.py,sha256=hDV1Pr9gemChBKtklnlZlrwSYVUfHEGNGGmVDhoByIw,63015
+futurehouse_client/models/__init__.py,sha256=5x-f9AoM1hGzJBEHcHAXSt7tPeImST5oZLuMdwp0mXc,554
+futurehouse_client/models/app.py,sha256=TrfSorJlxyuc9ZzJpd2tL1pzKOp3jNBYRqFMfmmUue0,28954
+futurehouse_client/models/client.py,sha256=n4HD0KStKLm6Ek9nL9ylP-bkK10yzAaD1uIDF83Qp_A,1828
+futurehouse_client/models/rest.py,sha256=AwPMcB1ruoqaI8NIhX2ZzN8UuX6XsaQ7uzeSE8EpwKk,1573
+futurehouse_client/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+futurehouse_client/utils/auth.py,sha256=tgWELjKfg8eWme_qdcRmc8TjQN9DVZuHHaVXZNHLchk,2960
+futurehouse_client/utils/general.py,sha256=A_rtTiYW30ELGEZlWCIArO7q1nEmqi8hUlmBRYkMQ_c,767
+futurehouse_client/utils/module_utils.py,sha256=aFyd-X-pDARXz9GWpn8SSViUVYdSbuy9vSkrzcVIaGI,4955
+futurehouse_client/utils/monitoring.py,sha256=UjRlufe67kI3VxRHOd5fLtJmlCbVA2Wqwpd4uZhXkQM,8728
+futurehouse_client/utils/world_model_tools.py,sha256=f-Q1X55HuisYyfTEHhhLMY_VamSMCkdXuHHp_V509bc,1899
+futurehouse_client-0.3.20.dev112.dist-info/licenses/LICENSE,sha256=oQ9ZHjUi-_6GfP3gs14FlPb0OlGwE1QCCKFGnJ4LD2I,11341
+futurehouse_client-0.3.20.dev112.dist-info/METADATA,sha256=a4IX4zQbKP51L71qkqjS8--fvdyIGVQZqneJn7DZuLg,26118
+futurehouse_client-0.3.20.dev112.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+futurehouse_client-0.3.20.dev112.dist-info/top_level.txt,sha256=TRuLUCt_qBnggdFHCX4O_BoCu1j2X43lKfIZC-ElwWY,19
+futurehouse_client-0.3.20.dev112.dist-info/RECORD,,

futurehouse_client-0.3.20.dev63.dist-info/RECORD

@@ -1,20 +0,0 @@
-futurehouse_client/__init__.py,sha256=BztM_ntbgmIEjzvnBWcvPhvLjM8xGDFCK0Upf3-nIn8,488
-futurehouse_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-futurehouse_client/version.py,sha256=isTppsUF5LzE3BUYjhyccnSnZwGsbVa_dNrIiEiEViQ,528
-futurehouse_client/clients/__init__.py,sha256=-HXNj-XJ3LRO5XM6MZ709iPs29YpApss0Q2YYg1qMZw,280
-futurehouse_client/clients/job_client.py,sha256=JgB5IUAyCmnhGRsYc3bgKldA-lkM1JLwHRwwUeOCdus,11944
-futurehouse_client/clients/rest_client.py,sha256=fltCx1kCSZKLD-2QNPmK2PbXPa0q0zW9Q3837xS_6TQ,61554
-futurehouse_client/models/__init__.py,sha256=5x-f9AoM1hGzJBEHcHAXSt7tPeImST5oZLuMdwp0mXc,554
-futurehouse_client/models/app.py,sha256=fIWATuetex9GuNzGAWQz-9Dc63ifEFl-Mv-UN7nGSfA,28948
-futurehouse_client/models/client.py,sha256=n4HD0KStKLm6Ek9nL9ylP-bkK10yzAaD1uIDF83Qp_A,1828
-futurehouse_client/models/rest.py,sha256=QqOhRT-qTMfLtNge458qyBv6JFZvoQULnGIjjcDvMy8,1543
-futurehouse_client/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-futurehouse_client/utils/auth.py,sha256=tgWELjKfg8eWme_qdcRmc8TjQN9DVZuHHaVXZNHLchk,2960
-futurehouse_client/utils/general.py,sha256=A_rtTiYW30ELGEZlWCIArO7q1nEmqi8hUlmBRYkMQ_c,767
-futurehouse_client/utils/module_utils.py,sha256=aFyd-X-pDARXz9GWpn8SSViUVYdSbuy9vSkrzcVIaGI,4955
-futurehouse_client/utils/monitoring.py,sha256=UjRlufe67kI3VxRHOd5fLtJmlCbVA2Wqwpd4uZhXkQM,8728
-futurehouse_client-0.3.20.dev63.dist-info/licenses/LICENSE,sha256=oQ9ZHjUi-_6GfP3gs14FlPb0OlGwE1QCCKFGnJ4LD2I,11341
-futurehouse_client-0.3.20.dev63.dist-info/METADATA,sha256=4hmqtHLV-eHTN3l8vXmtIW4L6TFAkBDymbjyg7_rBJQ,26117
-futurehouse_client-0.3.20.dev63.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-futurehouse_client-0.3.20.dev63.dist-info/top_level.txt,sha256=TRuLUCt_qBnggdFHCX4O_BoCu1j2X43lKfIZC-ElwWY,19
-futurehouse_client-0.3.20.dev63.dist-info/RECORD,,