futurehouse-client 0.0.2__py3-none-any.whl → 0.0.4__py3-none-any.whl

futurehouse_client/__init__.py

@@ -1,12 +1,12 @@
 from .clients.job_client import JobClient, JobNames
-from .clients.rest_client import JobResponse, JobResponseVerbose, PQAJobResponse
+from .clients.rest_client import PQATaskResponse, TaskResponse, TaskResponseVerbose
 from .clients.rest_client import RestClient as FutureHouseClient
 
 __all__ = [
     "FutureHouseClient",
     "JobClient",
     "JobNames",
-    "JobResponse",
-    "JobResponseVerbose",
-    "PQAJobResponse",
+    "PQATaskResponse",
+    "TaskResponse",
+    "TaskResponseVerbose",
 ]

futurehouse_client/clients/__init__.py

@@ -1,12 +1,12 @@
 from .job_client import JobClient, JobNames
-from .rest_client import JobResponse, JobResponseVerbose, PQAJobResponse
+from .rest_client import PQATaskResponse, TaskResponse, TaskResponseVerbose
 from .rest_client import RestClient as FutureHouseClient
 
 __all__ = [
     "FutureHouseClient",
     "JobClient",
     "JobNames",
-    "JobResponse",
-    "JobResponseVerbose",
-    "PQAJobResponse",
+    "PQATaskResponse",
+    "TaskResponse",
+    "TaskResponseVerbose",
 ]

futurehouse_client/clients/rest_client.py

@@ -29,10 +29,9 @@ from futurehouse_client.clients import JobNames
 from futurehouse_client.models.app import (
     APIKeyPayload,
     AuthType,
-    # TODO: Rename this to JobDeploymentConfig. But other parts of the code depend on this name, so I'm not changing it now
-    CrowDeploymentConfig,
-    JobRequest,
+    JobDeploymentConfig,
     Stage,
+    TaskRequest,
 )
 from futurehouse_client.utils.module_utils import (
     OrganizationSelector,
@@ -41,7 +40,7 @@ from futurehouse_client.utils.module_utils import (
 
 logger = logging.getLogger(__name__)
 
-JobRequest.model_rebuild()
+TaskRequest.model_rebuild()
 
 FILE_UPLOAD_IGNORE_PARTS = {
     ".ruff_cache",
@@ -57,6 +56,10 @@ class RestClientError(Exception):
     """Base exception for REST client errors."""
 
 
+class TaskFetchError(RestClientError):
+    """Raised when there's an error fetching a task."""
+
+
 class JobFetchError(RestClientError):
     """Raised when there's an error fetching a job."""
 
@@ -73,13 +76,13 @@ class InvalidTaskDescriptionError(Exception):
 JWT_TOKEN_CACHE_EXPIRY: int = 300  # seconds
 
 
-class JobResponse(BaseModel):
-    """Base class for job responses. This holds attributes shared over all futurehouse jobs."""
+class TaskResponse(BaseModel):
+    """Base class for task responses. This holds attributes shared over all futurehouse jobs."""
 
     model_config = ConfigDict(extra="ignore")
 
     status: str
-    task: str
+    query: str
     user: str
     created_at: datetime
     job_name: str
@@ -88,7 +91,7 @@ class JobResponse(BaseModel):
     build_owner: str | None = None
     environment_name: str | None = None
     agent_name: str | None = None
-    job_id: UUID | None = None
+    task_id: UUID | None = None
 
     @model_validator(mode="before")
     @classmethod
@@ -96,13 +99,13 @@ class JobResponse(BaseModel):
         # Extract fields from environment frame state
         if not isinstance(data, dict):
             return data
-        data["job_name"] = data.get(
-            "crow"
-        )  # TODO: remove this once we have the new job_name field.
+        # TODO: We probably want to remove these two once we define the final names.
+        data["job_name"] = data.get("crow")
+        data["query"] = data.get("task")
         if not (env_frame := data.get("environment_frame", {})):
             return data
         state = env_frame.get("state", {}).get("state", {})
-        data["job_id"] = cast(UUID, state.get("id")) if state.get("id") else None
+        data["task_id"] = cast(UUID, state.get("id")) if state.get("id") else None
         if not (metadata := data.get("metadata", {})):
             return data
         data["environment_name"] = metadata.get("environment_name")
@@ -110,7 +113,7 @@ class JobResponse(BaseModel):
         return data
 
 
-class PQAJobResponse(JobResponse):
+class PQATaskResponse(TaskResponse):
     model_config = ConfigDict(extra="ignore")
 
     answer: str | None = None
@@ -143,15 +146,15 @@ class PQAJobResponse(JobResponse):
 
         return data
 
-    def clean_verbose(self) -> "JobResponse":
+    def clean_verbose(self) -> "TaskResponse":
         """Clean the verbose response from the server."""
         self.request = None
         self.response = None
         return self
 
 
-class JobResponseVerbose(JobResponse):
-    """Class for responses to include all the fields of a job response."""
+class TaskResponseVerbose(TaskResponse):
+    """Class for responses to include all the fields of a task response."""
 
     model_config = ConfigDict(extra="allow")
 
@@ -170,7 +173,7 @@ class RestClient:
 
     def __init__(
         self,
-        stage: Stage = Stage.DEV,
+        stage: Stage = Stage.PROD,
         service_uri: str | None = None,
         organization: str | None = None,
         auth_type: AuthType = AuthType.API_KEY,
@@ -330,66 +333,66 @@ class RestClient:
             path: Path that was searched for files
 
         Raises:
-            JobFetchError: If no files were found
+            TaskFetchError: If no files were found
 
         """
         if not files:
-            raise JobFetchError(f"No files found in {path}")
+            raise TaskFetchError(f"No files found in {path}")
 
     @retry(
         stop=stop_after_attempt(MAX_RETRY_ATTEMPTS),
         wait=wait_exponential(multiplier=RETRY_MULTIPLIER, max=MAX_RETRY_WAIT),
         retry=retry_if_exception_type(Timeout),
     )
-    def get_job(
-        self, job_id: str | None = None, history: bool = False, verbose: bool = False
-    ) -> "JobResponse":
-        """Get details for a specific job."""
+    def get_task(
+        self, task_id: str | None = None, history: bool = False, verbose: bool = False
+    ) -> "TaskResponse":
+        """Get details for a specific task."""
         try:
-            job_id = job_id or self.trajectory_id
+            task_id = task_id or self.trajectory_id
             response = self.client.get(
-                f"/v0.1/trajectories/{job_id}",
+                f"/v0.1/trajectories/{task_id}",
                 params={"history": history},
             )
             response.raise_for_status()
-            verbose_response = JobResponseVerbose(**response.json())
+            verbose_response = TaskResponseVerbose(**response.json())
             if verbose:
                 return verbose_response
             if any(
                 JobNames.from_string(job_name) in verbose_response.job_name
                 for job_name in ["crow", "falcon", "owl", "dummy"]
             ):
-                return PQAJobResponse(**response.json())
-            return JobResponse(**response.json())
+                return PQATaskResponse(**response.json())
+            return TaskResponse(**response.json())
         except ValueError as e:
-            raise ValueError("Invalid job ID format. Must be a valid UUID.") from e
+            raise ValueError("Invalid task ID format. Must be a valid UUID.") from e
         except Exception as e:
-            raise JobFetchError(f"Error getting job: {e!s}") from e
+            raise TaskFetchError(f"Error getting task: {e!s}") from e
 
     @retry(
         stop=stop_after_attempt(MAX_RETRY_ATTEMPTS),
         wait=wait_exponential(multiplier=RETRY_MULTIPLIER, max=MAX_RETRY_WAIT),
         retry=retry_if_exception_type(Timeout),
     )
-    def create_job(self, job_data: JobRequest | dict[str, Any]):
-        """Create a new futurehouse job."""
-        if isinstance(job_data, dict):
-            job_data = JobRequest.model_validate(job_data)
-
-        if isinstance(job_data.name, JobNames):
-            job_data.name = job_data.name.from_stage(
-                job_data.name.name,
+    def create_task(self, task_data: TaskRequest | dict[str, Any]):
+        """Create a new futurehouse task."""
+        if isinstance(task_data, dict):
+            task_data = TaskRequest.model_validate(task_data)
+
+        if isinstance(task_data.name, JobNames):
+            task_data.name = task_data.name.from_stage(
+                task_data.name.name,
                 self.stage,
             )
 
         try:
             response = self.client.post(
-                "/v0.1/crows", json=job_data.model_dump(mode="json")
+                "/v0.1/crows", json=task_data.model_dump(mode="json")
             )
             response.raise_for_status()
             self.trajectory_id = response.json()["trajectory_id"]
         except Exception as e:
-            raise JobFetchError(f"Error creating job: {e!s}") from e
+            raise TaskFetchError(f"Error creating task: {e!s}") from e
         return self.trajectory_id
 
     @retry(
@@ -405,17 +408,16 @@ class RestClient:
         return response.json()
 
     # TODO: Refactor later so we don't have to ignore PLR0915
-    # TODO: Rename this to create_job. I'm not doing it now to avoid breaking the infrastructure.
     @retry(
         stop=stop_after_attempt(MAX_RETRY_ATTEMPTS),
         wait=wait_exponential(multiplier=RETRY_MULTIPLIER, max=MAX_RETRY_WAIT),
         retry=retry_if_exception_type(Timeout),
     )
-    def create_crow(self, config: CrowDeploymentConfig) -> dict[str, Any]:  # noqa: PLR0915
-        """Creates a crow deployment from the environment and environment files.
+    def create_job(self, config: JobDeploymentConfig) -> dict[str, Any]:  # noqa: PLR0915
+        """Creates a futurehouse job deployment from the environment and environment files.
 
         Args:
-            config: Configuration object containing all necessary parameters for crow deployment.
+            config: Configuration object containing all necessary parameters for job deployment.
 
         Returns:
             A response object containing metadata of the build.
@@ -434,7 +436,7 @@ class RestClient:
             raise InvalidTaskDescriptionError(
                 "Task description cannot be None or empty. Ensure your from_task environment function has a valid docstring."
                 " If you are deploying with your Environment as a dependency, "
-                "you must add a `task_description` to your `CrowDeploymentConfig`.",
+                "you must add a `task_description` to your `JobDeploymentConfig`.",
             )
         selected_org = OrganizationSelector.select_organization(self.organizations)
         if selected_org is None:
@@ -583,9 +585,11 @@ class RestClient:
             except HTTPStatusError as e:
                 error_detail = response.json()
                 error_message = error_detail.get("detail", str(e))
-                raise JobFetchError(f"Server validation error: {error_message}") from e
+                raise JobCreationError(
+                    f"Server validation error: {error_message}"
+                ) from e
         except Exception as e:
-            raise JobFetchError(f"Error generating docker image: {e!s}") from e
+            raise JobCreationError(f"Error generating docker image: {e!s}") from e
         return build_context
 
 

futurehouse_client/models/__init__.py

@@ -1,21 +1,21 @@
 from .app import (
     AuthType,
-    CrowDeploymentConfig,
     DockerContainerConfiguration,
     FramePath,
-    JobRequest,
+    JobDeploymentConfig,
     RuntimeConfig,
     Stage,
     Step,
+    TaskRequest,
 )
 
 __all__ = [
     "AuthType",
-    "CrowDeploymentConfig",
     "DockerContainerConfiguration",
     "FramePath",
-    "JobRequest",
+    "JobDeploymentConfig",
     "RuntimeConfig",
     "Stage",
     "Step",
+    "TaskRequest",
 ]

futurehouse_client/models/app.py

@@ -342,7 +342,7 @@ class DockerContainerConfiguration(BaseModel):
         return self
 
 
-class CrowDeploymentConfig(BaseModel):
+class JobDeploymentConfig(BaseModel):
     model_config = ConfigDict(
         extra="forbid",
         arbitrary_types_allowed=True,  # Allows for agent: Agent | str
@@ -581,7 +581,7 @@ class RuntimeConfig(BaseModel):
         default=None,
         description=(
             "Agent configuration to use for this job. If None, it will default to the "
-            "agent selected during Crow deployment in the CrowDeploymentConfig object."
+            "agent selected during Crow deployment in the JobDeploymentConfig object."
         ),
     )
     continued_job_id: UUID | None = Field(
@@ -607,10 +607,10 @@ class RuntimeConfig(BaseModel):
         return value
 
 
-class JobRequest(BaseModel):
-    job_id: UUID | None = Field(
+class TaskRequest(BaseModel):
+    task_id: UUID | None = Field(
         default=None,
-        description="Optional job identifier",
+        description="Optional task identifier",
         alias="id",
     )
     name: "str | JobNames" = Field(

{futurehouse_client-0.0.2.dist-info → futurehouse_client-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: futurehouse-client
-Version: 0.0.2
+Version: 0.0.4
 Summary: A client for interacting with endpoints of the FutureHouse service.
 Author-email: FutureHouse technical staff <hello@futurehouse.org>
 Classifier: Operating System :: OS Independent
@@ -70,7 +70,7 @@ from aviary.core import DummyEnv
 import ldp
 
 client = CrowClient(
-    stage=Stage.DEV,
+    stage=Stage.PROD,
     auth_type=AuthType.API_KEY,
     api_key="your_api_key",
 )
@@ -110,7 +110,7 @@ from crow_client import CrowClient
 from crow_client.models import Stage, AuthType
 
 client = CrowClient(
-    stage=Stage.DEV,
+    stage=Stage.PROD,
     organization="your_organization",
     auth_type=AuthType.API_KEY,
     api_key="your_api_key",
@@ -150,7 +150,7 @@ from crow_client import CrowClient, JobNames
 from crow_client.models import AuthType, Stage
 
 client = CrowClient(
-    stage=Stage.DEV,
+    stage=Stage.PROD,
     auth_type=AuthType.API_KEY,
     api_key="your_api_key",
 )
@@ -186,7 +186,7 @@ from crow_client import CrowClient, JobNames
 from crow_client.models import AuthType, Stage
 
 client = CrowClient(
-    stage=Stage.DEV,
+    stage=Stage.PROD,
     auth_type=AuthType.API_KEY,
     api_key="your_api_key",
 )

futurehouse_client-0.0.4.dist-info/RECORD

@@ -0,0 +1,14 @@
+futurehouse_client/__init__.py,sha256=ddxO7JE97c6bt7LjNglZZ2Ql8bYCGI9laSFeh9MP6VU,344
+futurehouse_client/clients/__init__.py,sha256=tFWqwIAY5PvwfOVsCje4imjTpf6xXNRMh_UHIKVI1_0,320
+futurehouse_client/clients/job_client.py,sha256=RNgdSJVI1vjQSypdfswHX0Gvv_XnKG4bZjklf3WdSuk,8828
+futurehouse_client/clients/rest_client.py,sha256=GtHDTGHdz0f6xzBWaufqh3f76Life66df6abrJrSKvA,25116
+futurehouse_client/models/__init__.py,sha256=ta3jFLM_LsDz1rKDmx8rja8sT7WtSKoFvMgLF0yFpvA,342
+futurehouse_client/models/app.py,sha256=G8_-I3aQnRIyxFJT3snTSWsPcZZ2nEvYkRaE5sVdeys,22299
+futurehouse_client/models/client.py,sha256=n4HD0KStKLm6Ek9nL9ylP-bkK10yzAaD1uIDF83Qp_A,1828
+futurehouse_client/models/rest.py,sha256=W-wNFTN7HALYFFphw-RQYRMm6_TSa1cl4T-mZ1msk90,393
+futurehouse_client/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+futurehouse_client/utils/module_utils.py,sha256=aFyd-X-pDARXz9GWpn8SSViUVYdSbuy9vSkrzcVIaGI,4955
+futurehouse_client-0.0.4.dist-info/METADATA,sha256=mb918ca4LdaKsctNjrzswLkfq-NAfD0s6CmjWqyvo3I,8898
+futurehouse_client-0.0.4.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+futurehouse_client-0.0.4.dist-info/top_level.txt,sha256=TRuLUCt_qBnggdFHCX4O_BoCu1j2X43lKfIZC-ElwWY,19
+futurehouse_client-0.0.4.dist-info/RECORD,,

futurehouse_client-0.0.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-futurehouse_client/__init__.py,sha256=QhDraw1J-DNc2kEq8E3iMIMokbllTHuVEOXgUCIT8qc,338
-futurehouse_client/clients/__init__.py,sha256=JpqWhXNRo4-xe9-SA_9QI5Z5P3xlJ-b4STGaljQpj3k,314
-futurehouse_client/clients/job_client.py,sha256=RNgdSJVI1vjQSypdfswHX0Gvv_XnKG4bZjklf3WdSuk,8828
-futurehouse_client/clients/rest_client.py,sha256=Qu6Ui-ot_pAJG-55Ll_IjOWLOkFELDaTObLkay7vxEY,25101
-futurehouse_client/models/__init__.py,sha256=VBKYb_2kmxtDwp9LvTL7BEFyioekggQsrQg5I_dhZoI,342
-futurehouse_client/models/app.py,sha256=_MO31xvKJaAztWz4KrV13ty4POg-RuWrGgqmvS9w2bc,22298
-futurehouse_client/models/client.py,sha256=n4HD0KStKLm6Ek9nL9ylP-bkK10yzAaD1uIDF83Qp_A,1828
-futurehouse_client/models/rest.py,sha256=W-wNFTN7HALYFFphw-RQYRMm6_TSa1cl4T-mZ1msk90,393
-futurehouse_client/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-futurehouse_client/utils/module_utils.py,sha256=aFyd-X-pDARXz9GWpn8SSViUVYdSbuy9vSkrzcVIaGI,4955
-futurehouse_client-0.0.2.dist-info/METADATA,sha256=lOwcSqbXH6Y1MDN22bW4j7VlsLItc0aG3lHaysdA-TU,8894
-futurehouse_client-0.0.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-futurehouse_client-0.0.2.dist-info/top_level.txt,sha256=TRuLUCt_qBnggdFHCX4O_BoCu1j2X43lKfIZC-ElwWY,19
-futurehouse_client-0.0.2.dist-info/RECORD,,