futurehouse-client 0.3.20.dev55__py3-none-any.whl → 0.3.20.dev105__py3-none-any.whl

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

@@ -139,6 +139,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
@@ -169,7 +170,7 @@ class RestClient:
         self.base_url = service_uri or stage.value
         self.stage = stage
         self.auth_type = auth_type
-        self.api_key = api_key
+        self.api_key = api_key or os.environ.get("FUTUREHOUSE_API_KEY")
         self._clients: dict[str, Client | AsyncClient] = {}
         self.headers = headers or {}
         self.jwt = jwt
@@ -1419,15 +1420,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 +1460,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:

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/version.py

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

{futurehouse_client-0.3.20.dev55.dist-info → futurehouse_client-0.3.20.dev105.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: futurehouse-client
-Version: 0.3.20.dev55
+Version: 0.3.20.dev105
 Summary: A client for interacting with endpoints of the FutureHouse service.
 Author-email: FutureHouse technical staff <hello@futurehouse.org>
 License:                                  Apache License
@@ -274,20 +274,19 @@ uv pip install futurehouse-client
 
 ```python
 from futurehouse_client import FutureHouseClient, JobNames
-from pathlib import Path
-from aviary.core import DummyEnv
-import ldp
 
-client = FutureHouseClient(
-    api_key="your_api_key",
-)
+# Set your API key to FUTUREHOUSE_API_KEY environment variable,
+# or pass it as a string literal to the api_key parameter
+client = FutureHouseClient()
 
 task_data = {
     "name": JobNames.CROW,
-    "query": "Which neglected diseases had a treatment developed by artificial intelligence?",
+    "query": (
+        "Which neglected diseases had a treatment developed"
+        " by artificial intelligence?"
+    ),
 }
-
-task_response = client.run_tasks_until_done(task_data)
+(task_response,) = client.run_tasks_until_done(task_data)
 ```
 
 A quickstart example can be found in the [client_notebook.ipynb](https://futurehouse.gitbook.io/futurehouse-cookbook/futurehouse-client/docs/client_notebook) file, where we show how to submit and retrieve a job task, pass runtime configuration to the agent, and ask follow-up questions to the previous job.
@@ -304,9 +303,10 @@ To create a `FutureHouseClient`, you need to pass an FutureHouse platform api ke
 ```python
 from futurehouse_client import FutureHouseClient
 
-client = FutureHouseClient(
-    api_key="your_api_key",
-)
+# Set your API key to FUTUREHOUSE_API_KEY environment variable
+client = FutureHouseClient()
+# Or pass it as a string literal to the api_key parameter
+client = FutureHouseClient(api_key="your_api_key")
 ```
 
 ## Authentication
@@ -333,17 +333,13 @@ Using `JobNames`, the task submission looks like this:
 ```python
 from futurehouse_client import FutureHouseClient, JobNames
 
-client = FutureHouseClient(
-    api_key="your_api_key",
-)
+client = FutureHouseClient()
 
 task_data = {
     "name": JobNames.OWL,
     "query": "Has anyone tested therapeutic exerkines in humans or NHPs?",
 }
-
-task_response = client.run_tasks_until_done(task_data)
-
+(task_response,) = client.run_tasks_until_done(task_data)
 print(task_response.answer)
 ```
 
@@ -363,8 +359,7 @@ async def main():
         "name": JobNames.OWL,
         "query": "Has anyone tested therapeutic exerkines in humans or NHPs?",
     }
-
-    task_response = await client.arun_tasks_until_done(task_data)
+    (task_response,) = await client.arun_tasks_until_done(task_data)
     print(task_response.answer)
     return task_id
 
@@ -382,9 +377,7 @@ from futurehouse_client import FutureHouseClient, JobNames
 
 
 async def main():
-    client = FutureHouseClient(
-        api_key="your_api_key",
-    )
+    client = FutureHouseClient()
 
     task_data = [
         {
@@ -393,10 +386,12 @@ async def main():
         },
         {
             "name": JobNames.CROW,
-            "query": "Are there any clinically validated therapeutic exerkines for humans?",
+            "query": (
+                "Are there any clinically validated"
+                " therapeutic exerkines for humans?"
+            ),
         },
     ]
-
     task_responses = await client.arun_tasks_until_done(task_data)
     print(task_responses[0].answer)
     print(task_responses[1].answer)
@@ -423,17 +418,14 @@ if __name__ == "__main__":
 from futurehouse_client import FutureHouseClient, JobNames
 from futurehouse_client.models.app import TaskRequest
 
-client = FutureHouseClient(
-    api_key="your_api_key",
-)
+client = FutureHouseClient()
 
-task_response = client.run_tasks_until_done(
+(task_response,) = client.run_tasks_until_done(
     TaskRequest(
         name=JobNames.OWL,
         query="Has anyone tested therapeutic exerkines in humans or NHPs?",
     )
 )
-
 print(task_response.answer)
 ```
 
@@ -455,14 +447,13 @@ client = FutureHouseClient(
     api_key="your_api_key",
 )
 
-task_response = client.run_tasks_until_done(
+(task_response,) = client.run_tasks_until_done(
     TaskRequest(
         name=JobNames.OWL,
         query="Has anyone tested therapeutic exerkines in humans or NHPs?",
     ),
     verbose=True,
 )
-
 print(task_response.environment_frame)
 ```
 
@@ -487,17 +478,21 @@ client = FutureHouseClient(
     api_key="your_api_key",
 )
 
-task_data = {"name": JobNames.CROW, "query": "How many species of birds are there?"}
-
+task_data = {
+    "name": JobNames.CROW,
+    "query": "How many species of birds are there?",
+}
 task_id = client.create_task(task_data)
 
 continued_task_data = {
     "name": JobNames.CROW,
-    "query": "From the previous answer, specifically,how many species of crows are there?",
+    "query": (
+        "From the previous answer,"
+        " specifically, how many species of crows are there?"
+    ),
     "runtime_config": {"continued_task_id": task_id},
 }
-
-task_result = client.run_tasks_until_done(continued_task_data)
+(task_response,) = client.run_tasks_until_done(continued_task_data)
 ```
 
 ## Asynchronous tasks
@@ -505,14 +500,14 @@ task_result = client.run_tasks_until_done(continued_task_data)
 Sometimes you may want to submit many jobs, while querying results at a later time. In this way you can do other things while waiting for a response. The platform API supports this as well rather than waiting for a result.
 
 ```python
-from futurehouse_client import FutureHouseClient
-
-client = FutureHouseClient(
-    api_key="your_api_key",
-)
+from futurehouse_client import FutureHouseClient, JobNames
 
-task_data = {"name": JobNames.CROW, "query": "How many species of birds are there?"}
+client = FutureHouseClient()
 
+task_data = {
+    "name": JobNames.CROW,
+    "query": "How many species of birds are there?",
+}
 task_id = client.create_task(task_data)
 
 # move on to do other things

futurehouse_client-0.3.20.dev105.dist-info/RECORD

@@ -0,0 +1,20 @@
+futurehouse_client/__init__.py,sha256=BztM_ntbgmIEjzvnBWcvPhvLjM8xGDFCK0Upf3-nIn8,488
+futurehouse_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+futurehouse_client/version.py,sha256=dggvSZjGalP38yUZTaRgokHrf_7S9wpjF6xrQ5xRQlk,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=zfGMFzLWsNWggTDrZpQZm9habxSQ0bJ2Zd5w_dZrJhU,61301
+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-0.3.20.dev105.dist-info/licenses/LICENSE,sha256=oQ9ZHjUi-_6GfP3gs14FlPb0OlGwE1QCCKFGnJ4LD2I,11341
+futurehouse_client-0.3.20.dev105.dist-info/METADATA,sha256=bKotJE6rkwyPwipLmyOVe8hNoEoniaDi87CrnCU1C2w,26118
+futurehouse_client-0.3.20.dev105.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+futurehouse_client-0.3.20.dev105.dist-info/top_level.txt,sha256=TRuLUCt_qBnggdFHCX4O_BoCu1j2X43lKfIZC-ElwWY,19
+futurehouse_client-0.3.20.dev105.dist-info/RECORD,,

futurehouse_client-0.3.20.dev55.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=R0N9IlSoJfca-REsgOruf0uQwzcxQP-poQaa9iM3N3g,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=XHHofNT-tOhS-jyLiAloUUnj6AiZh1hF5Fb8SeV6SNE,61513
-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.dev55.dist-info/licenses/LICENSE,sha256=oQ9ZHjUi-_6GfP3gs14FlPb0OlGwE1QCCKFGnJ4LD2I,11341
-futurehouse_client-0.3.20.dev55.dist-info/METADATA,sha256=3E-5Yu1s0Oo3PFcGHd4gts5HnDyqB2yDL7VRpaOyyGw,25926
-futurehouse_client-0.3.20.dev55.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-futurehouse_client-0.3.20.dev55.dist-info/top_level.txt,sha256=TRuLUCt_qBnggdFHCX4O_BoCu1j2X43lKfIZC-ElwWY,19
-futurehouse_client-0.3.20.dev55.dist-info/RECORD,,