smooth-py 0.2.0__tar.gz → 0.2.1.post0__tar.gz

{smooth_py-0.2.0 → smooth_py-0.2.1.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: smooth-py
-Version: 0.2.0
+Version: 0.2.1.post0
 Summary: 
 Author: Luca Pinchetti
 Author-email: luca@circlemind.co

{smooth_py-0.2.0 → smooth_py-0.2.1.post0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "smooth-py"
-version = "0.2.0"
+version = "0.2.1.post0"
 description = ""
 authors = [
     {name = "Luca Pinchetti",email = "luca@circlemind.co"}

{smooth_py-0.2.0 → smooth_py-0.2.1.post0}/src/smooth/__init__.py

@@ -49,8 +49,13 @@ class TaskRequest(BaseModel):
 
   task: str = Field(description="The task to run.")
   response_model: dict[str, Any] | None = Field(
-    default=None, description="If provided, the schema describing the desired output structure. Default is None"
+    default=None, description="If provided, the JSON schema describing the desired output structure. Default is None"
   )
+  url: str | None = Field(
+    default=None,
+    description="(Optional) The starting URL for the task. If not provided, the agent will infer it from the task.",
+  )
+  metadata: dict[str, str | int | float | bool] | None = Field(default=None, description="Optional metadata for the task.")
   agent: Literal["smooth"] = Field(default="smooth", description="The agent to use for the task.")
   max_steps: int = Field(default=32, ge=2, le=128, description="Maximum number of steps the agent can take (min 2, max 128).")
   device: Literal["desktop", "mobile"] = Field(default="mobile", description="Device type for the task. Default is mobile.")
@@ -136,7 +141,7 @@ class BaseClient:
     self.headers = {
       "apikey": self.api_key,
       "Content-Type": "application/json",
-      "User-Agent": "smooth-python-sdk/0.1.1",
+      "User-Agent": "smooth-python-sdk/0.2.0",
     }
 
   def _handle_response(self, response: requests.Response | httpx.Response) -> dict[str, Any]:
@@ -187,7 +192,11 @@ class TaskHandle:
     self._client = client
     self._task_response: TaskResponse | None = None
 
-    self.id = task_id
+    self._id = task_id
+
+  def id(self):
+    """Returns the task ID."""
+    return self._id
 
   def result(self, timeout: int | None = None, poll_interval: float = 1) -> TaskResponse:
     """Waits for the task to complete and returns the result."""
@@ -201,12 +210,12 @@ class TaskHandle:
 
     start_time = time.time()
     while timeout is None or (time.time() - start_time) < timeout:
-      task_response = self._client._get_task(self.id)  # pyright: ignore [reportPrivateUsage]
+      task_response = self._client._get_task(self.id())
       self._task_response = task_response
       if task_response.status not in ["running", "waiting"]:
         return task_response
       time.sleep(poll_interval)
-    raise TimeoutError(f"Task {self.id} did not complete within {timeout} seconds.")
+    raise TimeoutError(f"Task {self.id()} did not complete within {timeout} seconds.")
 
   def live_url(self, interactive: bool = True, embed: bool = False, timeout: int | None = None):
     """Returns the live URL for the task."""
@@ -215,13 +224,13 @@ class TaskHandle:
 
     start_time = time.time()
     while timeout is None or (time.time() - start_time) < timeout:
-      task_response = self._client._get_task(self.id)  # pyright: ignore [reportPrivateUsage]
+      task_response = self._client._get_task(self.id())
       self._task_response = task_response
       if self._task_response.live_url:
         return _encode_url(self._task_response.live_url, interactive=interactive, embed=embed)
       time.sleep(1)
 
-    raise TimeoutError(f"Live URL not available for task {self.id}.")
+    raise TimeoutError(f"Live URL not available for task {self.id()}.")
 
   def recording_url(self, timeout: int | None = None) -> str:
     """Returns the recording URL for the task."""
@@ -230,12 +239,12 @@ class TaskHandle:
 
     start_time = time.time()
     while timeout is None or (time.time() - start_time) < timeout:
-      task_response = self._client._get_task(self.id)  # pyright: ignore [reportPrivateUsage]
+      task_response = self._client._get_task(self.id())
       self._task_response = task_response
       if task_response.recording_url is not None:
         return task_response.recording_url
       time.sleep(1)
-    raise TimeoutError(f"Recording URL not available for task {self.id}.")
+    raise TimeoutError(f"Recording URL not available for task {self.id()}.")
 
 
 class SmoothClient(BaseClient):
@@ -287,6 +296,8 @@ class SmoothClient(BaseClient):
     self,
     task: str,
     response_model: dict[str, Any] | Type[BaseModel] | None = None,
+    url: str | None = None,
+    metadata: dict[str, str | int | float | bool] | None = None,
     agent: Literal["smooth"] = "smooth",
     max_steps: int = 32,
     device: Literal["desktop", "mobile"] = "mobile",
@@ -305,6 +316,8 @@ class SmoothClient(BaseClient):
     Args:
         task: The task to run.
         response_model: If provided, the schema describing the desired output structure.
+        url: The starting URL for the task. If not provided, the agent will infer it from the task.
+        metadata: Optional metadata for the task.
         agent: The agent to use for the task.
         max_steps: Maximum number of steps the agent can take (max 64).
         device: Device type for the task. Default is mobile.
@@ -324,6 +337,8 @@ class SmoothClient(BaseClient):
     payload = TaskRequest(
       task=task,
       response_model=response_model.model_json_schema() if issubclass(response_model, BaseModel) else response_model,
+      url=url,
+      metadata=metadata,
       agent=agent,
       max_steps=max_steps,
       device=device,
@@ -400,7 +415,11 @@ class AsyncTaskHandle:
     self._client = client
     self._task_response: TaskResponse | None = None
 
-    self.id = task_id
+    self._id = task_id
+
+  def id(self):
+    """Returns the task ID."""
+    return self._id
 
   async def result(self, timeout: int | None = None, poll_interval: float = 1) -> TaskResponse:
     """Waits for the task to complete and returns the result."""
@@ -414,12 +433,12 @@ class AsyncTaskHandle:
 
     start_time = time.time()
     while timeout is None or (time.time() - start_time) < timeout:
-      task_response = await self._client._get_task(self.id)  # pyright: ignore [reportPrivateUsage]
+      task_response = await self._client._get_task(self.id())
       self._task_response = task_response
       if task_response.status not in ["running", "waiting"]:
         return task_response
       await asyncio.sleep(poll_interval)
-    raise TimeoutError(f"Task {self.id} did not complete within {timeout} seconds.")
+    raise TimeoutError(f"Task {self.id()} did not complete within {timeout} seconds.")
 
   async def live_url(self, interactive: bool = True, embed: bool = False, timeout: int | None = None):
     """Returns the live URL for the task."""
@@ -428,13 +447,13 @@ class AsyncTaskHandle:
 
     start_time = time.time()
     while timeout is None or (time.time() - start_time) < timeout:
-      task_response = await self._client._get_task(self.id)  # pyright: ignore [reportPrivateUsage]
+      task_response = await self._client._get_task(self.id())
       self._task_response = task_response
       if task_response.live_url is not None:
         return _encode_url(self._task_response.live_url, interactive=interactive, embed=embed)
       await asyncio.sleep(1)
 
-    raise TimeoutError(f"Live URL not available for task {self.id}.")
+    raise TimeoutError(f"Live URL not available for task {self.id()}.")
 
   async def recording_url(self, timeout: int | None = None):
     """Returns the recording URL for the task."""
@@ -443,13 +462,13 @@ class AsyncTaskHandle:
 
     start_time = time.time()
     while timeout is None or (time.time() - start_time) < timeout:
-      task_response = await self._client._get_task(self.id)  # pyright: ignore [reportPrivateUsage]
+      task_response = await self._client._get_task(self.id())
       self._task_response = task_response
       if task_response.recording_url is not None:
         return task_response.recording_url
       await asyncio.sleep(1)
 
-    raise TimeoutError(f"Recording URL not available for task {self.id}.")
+    raise TimeoutError(f"Recording URL not available for task {self.id()}.")
 
 
 class SmoothAsyncClient(BaseClient):
@@ -495,6 +514,8 @@ class SmoothAsyncClient(BaseClient):
     self,
     task: str,
     response_model: dict[str, Any] | Type[BaseModel] | None = None,
+    url: str | None = None,
+    metadata: dict[str, str | int | float | bool] | None = None,
     agent: Literal["smooth"] = "smooth",
     max_steps: int = 32,
     device: Literal["desktop", "mobile"] = "mobile",
@@ -513,6 +534,8 @@ class SmoothAsyncClient(BaseClient):
     Args:
         task: The task to run.
         response_model: If provided, the schema describing the desired output structure.
+        url: The starting URL for the task. If not provided, the agent will infer it from the task.
+        metadata: Optional metadata for the task.
         agent: The agent to use for the task.
         max_steps: Maximum number of steps the agent can take (max 64).
         device: Device type for the task. Default is mobile.
@@ -534,6 +557,8 @@ class SmoothAsyncClient(BaseClient):
     payload = TaskRequest(
       task=task,
       response_model=response_model.model_json_schema() if issubclass(response_model, BaseModel) else response_model,
+      url=url,
+      metadata=metadata,
       agent=agent,
       max_steps=max_steps,
       device=device,