blaxel 0.2.34__py3-none-any.whl → 0.2.35__py3-none-any.whl

blaxel/core/client/api/jobs/delete_job.py

@@ -45,9 +45,10 @@ def sync_detailed(
     *,
     client: Client,
 ) -> Response[Job]:
-    """Delete job
+    """Delete batch job
 
-     Deletes a job by name.
+     Permanently deletes a batch job definition and cancels any running executions. Historical execution
+    data will be retained for a limited time.
 
     Args:
         job_id (str):
@@ -76,9 +77,10 @@ def sync(
     *,
     client: Client,
 ) -> Job | None:
-    """Delete job
+    """Delete batch job
 
-     Deletes a job by name.
+     Permanently deletes a batch job definition and cancels any running executions. Historical execution
+    data will be retained for a limited time.
 
     Args:
         job_id (str):
@@ -102,9 +104,10 @@ async def asyncio_detailed(
     *,
     client: Client,
 ) -> Response[Job]:
-    """Delete job
+    """Delete batch job
 
-     Deletes a job by name.
+     Permanently deletes a batch job definition and cancels any running executions. Historical execution
+    data will be retained for a limited time.
 
     Args:
         job_id (str):
@@ -131,9 +134,10 @@ async def asyncio(
     *,
     client: Client,
 ) -> Job | None:
-    """Delete job
+    """Delete batch job
 
-     Deletes a job by name.
+     Permanently deletes a batch job definition and cancels any running executions. Historical execution
+    data will be retained for a limited time.
 
     Args:
         job_id (str):

blaxel/core/client/api/jobs/delete_job_execution.py

@@ -58,9 +58,10 @@ def sync_detailed(
     *,
     client: Client,
 ) -> Response[Union[Any, JobExecution]]:
-    """Delete job execution
+    """Cancel job execution
 
-     Stop an execution for a job by name.
+     Cancels a running job execution. Tasks already in progress will complete, but no new tasks will be
+    started. The execution status changes to 'cancelling' then 'cancelled'.
 
     Args:
         job_id (str):
@@ -92,9 +93,10 @@ def sync(
     *,
     client: Client,
 ) -> Union[Any, JobExecution] | None:
-    """Delete job execution
+    """Cancel job execution
 
-     Stop an execution for a job by name.
+     Cancels a running job execution. Tasks already in progress will complete, but no new tasks will be
+    started. The execution status changes to 'cancelling' then 'cancelled'.
 
     Args:
         job_id (str):
@@ -121,9 +123,10 @@ async def asyncio_detailed(
     *,
     client: Client,
 ) -> Response[Union[Any, JobExecution]]:
-    """Delete job execution
+    """Cancel job execution
 
-     Stop an execution for a job by name.
+     Cancels a running job execution. Tasks already in progress will complete, but no new tasks will be
+    started. The execution status changes to 'cancelling' then 'cancelled'.
 
     Args:
         job_id (str):
@@ -153,9 +156,10 @@ async def asyncio(
     *,
     client: Client,
 ) -> Union[Any, JobExecution] | None:
-    """Delete job execution
+    """Cancel job execution
 
-     Stop an execution for a job by name.
+     Cancels a running job execution. Tasks already in progress will complete, but no new tasks will be
+    started. The execution status changes to 'cancelling' then 'cancelled'.
 
     Args:
         job_id (str):

blaxel/core/client/api/jobs/get_job.py

@@ -5,7 +5,7 @@ import httpx
 
 from ... import errors
 from ...client import Client
-from ...models.model import Model
+from ...models.job import Job
 from ...types import UNSET, Response, Unset
 
 
@@ -29,9 +29,9 @@ def _get_kwargs(
     return _kwargs
 
 
-def _parse_response(*, client: Client, response: httpx.Response) -> Model | None:
+def _parse_response(*, client: Client, response: httpx.Response) -> Job | None:
     if response.status_code == 200:
-        response_200 = Model.from_dict(response.json())
+        response_200 = Job.from_dict(response.json())
 
         return response_200
     if client.raise_on_unexpected_status:
@@ -40,7 +40,7 @@ def _parse_response(*, client: Client, response: httpx.Response) -> Model | None
         return None
 
 
-def _build_response(*, client: Client, response: httpx.Response) -> Response[Model]:
+def _build_response(*, client: Client, response: httpx.Response) -> Response[Job]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -54,10 +54,11 @@ def sync_detailed(
     *,
     client: Client,
     show_secrets: Union[Unset, bool] = UNSET,
-) -> Response[Model]:
-    """Get job
+) -> Response[Job]:
+    """Get batch job
 
-     Returns a job by name.
+     Returns detailed information about a batch job including its runtime configuration, execution
+    history, and deployment status.
 
     Args:
         job_id (str):
@@ -68,7 +69,7 @@ def sync_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[Model]
+        Response[Job]
     """
 
     kwargs = _get_kwargs(
@@ -88,10 +89,11 @@ def sync(
     *,
     client: Client,
     show_secrets: Union[Unset, bool] = UNSET,
-) -> Model | None:
-    """Get job
+) -> Job | None:
+    """Get batch job
 
-     Returns a job by name.
+     Returns detailed information about a batch job including its runtime configuration, execution
+    history, and deployment status.
 
     Args:
         job_id (str):
@@ -102,7 +104,7 @@ def sync(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Model
+        Job
     """
 
     return sync_detailed(
@@ -117,10 +119,11 @@ async def asyncio_detailed(
     *,
     client: Client,
     show_secrets: Union[Unset, bool] = UNSET,
-) -> Response[Model]:
-    """Get job
+) -> Response[Job]:
+    """Get batch job
 
-     Returns a job by name.
+     Returns detailed information about a batch job including its runtime configuration, execution
+    history, and deployment status.
 
     Args:
         job_id (str):
@@ -131,7 +134,7 @@ async def asyncio_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[Model]
+        Response[Job]
     """
 
     kwargs = _get_kwargs(
@@ -149,10 +152,11 @@ async def asyncio(
     *,
     client: Client,
     show_secrets: Union[Unset, bool] = UNSET,
-) -> Model | None:
-    """Get job
+) -> Job | None:
+    """Get batch job
 
-     Returns a job by name.
+     Returns detailed information about a batch job including its runtime configuration, execution
+    history, and deployment status.
 
     Args:
         job_id (str):
@@ -163,7 +167,7 @@ async def asyncio(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Model
+        Job
     """
 
     return (

blaxel/core/client/api/jobs/get_job_execution.py

@@ -60,7 +60,8 @@ def sync_detailed(
 ) -> Response[Union[Any, JobExecution]]:
     """Get job execution
 
-     Returns an execution for a job by name.
+     Returns detailed information about a specific job execution including status, task statistics
+    (success/failure/running counts), and timing information.
 
     Args:
         job_id (str):
@@ -94,7 +95,8 @@ def sync(
 ) -> Union[Any, JobExecution] | None:
     """Get job execution
 
-     Returns an execution for a job by name.
+     Returns detailed information about a specific job execution including status, task statistics
+    (success/failure/running counts), and timing information.
 
     Args:
         job_id (str):
@@ -123,7 +125,8 @@ async def asyncio_detailed(
 ) -> Response[Union[Any, JobExecution]]:
     """Get job execution
 
-     Returns an execution for a job by name.
+     Returns detailed information about a specific job execution including status, task statistics
+    (success/failure/running counts), and timing information.
 
     Args:
         job_id (str):
@@ -155,7 +158,8 @@ async def asyncio(
 ) -> Union[Any, JobExecution] | None:
     """Get job execution
 
-     Returns an execution for a job by name.
+     Returns detailed information about a specific job execution including status, task statistics
+    (success/failure/running counts), and timing information.
 
     Args:
         job_id (str):

blaxel/core/client/api/jobs/list_job_executions.py

@@ -76,7 +76,8 @@ def sync_detailed(
 ) -> Response[Union[Any, list["JobExecution"]]]:
     """List job executions
 
-     Returns a list of all executions for a job by name.
+     Returns paginated list of executions for a batch job, sorted by creation time. Each execution
+    contains status, task counts, and timing information.
 
     Args:
         job_id (str):
@@ -113,7 +114,8 @@ def sync(
 ) -> Union[Any, list["JobExecution"]] | None:
     """List job executions
 
-     Returns a list of all executions for a job by name.
+     Returns paginated list of executions for a batch job, sorted by creation time. Each execution
+    contains status, task counts, and timing information.
 
     Args:
         job_id (str):
@@ -145,7 +147,8 @@ async def asyncio_detailed(
 ) -> Response[Union[Any, list["JobExecution"]]]:
     """List job executions
 
-     Returns a list of all executions for a job by name.
+     Returns paginated list of executions for a batch job, sorted by creation time. Each execution
+    contains status, task counts, and timing information.
 
     Args:
         job_id (str):
@@ -180,7 +183,8 @@ async def asyncio(
 ) -> Union[Any, list["JobExecution"]] | None:
     """List job executions
 
-     Returns a list of all executions for a job by name.
+     Returns paginated list of executions for a batch job, sorted by creation time. Each execution
+    contains status, task counts, and timing information.
 
     Args:
         job_id (str):

blaxel/core/client/api/jobs/list_jobs.py

@@ -47,9 +47,10 @@ def sync_detailed(
     *,
     client: Client,
 ) -> Response[list["Job"]]:
-    """List jobs
+    """List batch jobs
 
-     Returns a list of all jobs in the workspace.
+     Returns all batch job definitions in the workspace. Each job can be triggered to run multiple
+    parallel tasks with configurable concurrency and retry settings.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -72,9 +73,10 @@ def sync(
     *,
     client: Client,
 ) -> list["Job"] | None:
-    """List jobs
+    """List batch jobs
 
-     Returns a list of all jobs in the workspace.
+     Returns all batch job definitions in the workspace. Each job can be triggered to run multiple
+    parallel tasks with configurable concurrency and retry settings.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -93,9 +95,10 @@ async def asyncio_detailed(
     *,
     client: Client,
 ) -> Response[list["Job"]]:
-    """List jobs
+    """List batch jobs
 
-     Returns a list of all jobs in the workspace.
+     Returns all batch job definitions in the workspace. Each job can be triggered to run multiple
+    parallel tasks with configurable concurrency and retry settings.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -116,9 +119,10 @@ async def asyncio(
     *,
     client: Client,
 ) -> list["Job"] | None:
-    """List jobs
+    """List batch jobs
 
-     Returns a list of all jobs in the workspace.
+     Returns all batch job definitions in the workspace. Each job can be triggered to run multiple
+    parallel tasks with configurable concurrency and retry settings.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

blaxel/core/client/api/jobs/update_job.py

@@ -59,13 +59,15 @@ def sync_detailed(
     client: Client,
     body: Job,
 ) -> Response[Job]:
-    """Create or update job
+    """Update batch job
 
-     Update a job by name.
+     Updates a batch job's configuration. Changes affect new executions; running executions continue with
+    their original configuration.
 
     Args:
         job_id (str):
-        body (Job): Job
+        body (Job): Batch processing job definition for running parallel AI tasks. Jobs can
+            execute multiple tasks concurrently with configurable parallelism, retries, and timeouts.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -93,13 +95,15 @@ def sync(
     client: Client,
     body: Job,
 ) -> Job | None:
-    """Create or update job
+    """Update batch job
 
-     Update a job by name.
+     Updates a batch job's configuration. Changes affect new executions; running executions continue with
+    their original configuration.
 
     Args:
         job_id (str):
-        body (Job): Job
+        body (Job): Batch processing job definition for running parallel AI tasks. Jobs can
+            execute multiple tasks concurrently with configurable parallelism, retries, and timeouts.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -122,13 +126,15 @@ async def asyncio_detailed(
     client: Client,
     body: Job,
 ) -> Response[Job]:
-    """Create or update job
+    """Update batch job
 
-     Update a job by name.
+     Updates a batch job's configuration. Changes affect new executions; running executions continue with
+    their original configuration.
 
     Args:
         job_id (str):
-        body (Job): Job
+        body (Job): Batch processing job definition for running parallel AI tasks. Jobs can
+            execute multiple tasks concurrently with configurable parallelism, retries, and timeouts.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -154,13 +160,15 @@ async def asyncio(
     client: Client,
     body: Job,
 ) -> Job | None:
-    """Create or update job
+    """Update batch job
 
-     Update a job by name.
+     Updates a batch job's configuration. Changes affect new executions; running executions continue with
+    their original configuration.
 
     Args:
         job_id (str):
-        body (Job): Job
+        body (Job): Batch processing job definition for running parallel AI tasks. Jobs can
+            execute multiple tasks concurrently with configurable parallelism, retries, and timeouts.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

blaxel/core/client/api/locations/list_locations.py

@@ -49,9 +49,10 @@ def sync_detailed(
     *,
     client: Client,
 ) -> Response[list["LocationResponse"]]:
-    """List locations
+    """List deployment regions
 
-     Returns a list of all locations available with status.
+     Returns all deployment regions with their current availability status and supported hardware
+    flavors. Use this to discover where resources can be deployed.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -74,9 +75,10 @@ def sync(
     *,
     client: Client,
 ) -> list["LocationResponse"] | None:
-    """List locations
+    """List deployment regions
 
-     Returns a list of all locations available with status.
+     Returns all deployment regions with their current availability status and supported hardware
+    flavors. Use this to discover where resources can be deployed.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -95,9 +97,10 @@ async def asyncio_detailed(
     *,
     client: Client,
 ) -> Response[list["LocationResponse"]]:
-    """List locations
+    """List deployment regions
 
-     Returns a list of all locations available with status.
+     Returns all deployment regions with their current availability status and supported hardware
+    flavors. Use this to discover where resources can be deployed.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -118,9 +121,10 @@ async def asyncio(
     *,
     client: Client,
 ) -> list["LocationResponse"] | None:
-    """List locations
+    """List deployment regions
 
-     Returns a list of all locations available with status.
+     Returns all deployment regions with their current availability status and supported hardware
+    flavors. Use this to discover where resources can be deployed.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

blaxel/core/client/api/{default → mcphub}/list_mcp_hub_definitions.py

@@ -47,7 +47,11 @@ def sync_detailed(
     *,
     client: Client,
 ) -> Response[list["MCPDefinition"]]:
-    """
+    """List MCP Hub servers
+
+     Returns all pre-built MCP server definitions available in the Blaxel Hub. These can be deployed
+    directly to your workspace with pre-configured tools and integrations.
+
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.
@@ -69,7 +73,11 @@ def sync(
     *,
     client: Client,
 ) -> list["MCPDefinition"] | None:
-    """
+    """List MCP Hub servers
+
+     Returns all pre-built MCP server definitions available in the Blaxel Hub. These can be deployed
+    directly to your workspace with pre-configured tools and integrations.
+
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.
@@ -87,7 +95,11 @@ async def asyncio_detailed(
     *,
     client: Client,
 ) -> Response[list["MCPDefinition"]]:
-    """
+    """List MCP Hub servers
+
+     Returns all pre-built MCP server definitions available in the Blaxel Hub. These can be deployed
+    directly to your workspace with pre-configured tools and integrations.
+
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.
@@ -107,7 +119,11 @@ async def asyncio(
     *,
     client: Client,
 ) -> list["MCPDefinition"] | None:
-    """
+    """List MCP Hub servers
+
+     Returns all pre-built MCP server definitions available in the Blaxel Hub. These can be deployed
+    directly to your workspace with pre-configured tools and integrations.
+
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.