zerogen 0.2.0__tar.gz → 0.2.1__tar.gz

{zerogen-0.2.0 → zerogen-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zerogen
-Version: 0.2.0
+Version: 0.2.1
 Summary: The official Python library for the ZeroGen API
 Keywords: zerogen,generative-ai,image-generation,video-generation,api
 Author: ZeroGen LLC
@@ -155,6 +155,37 @@ To hand the link to something else, read it with `assets.get_download`: it's
 valid for 5 minutes, and anyone holding it can download the file, so keep it
 private.
 
+## Previews
+
+To show assets without downloading their originals, use their `preview`. Each
+asset from `assets.search` and `assets.get` has one, and so does each run
+output's `asset`.
+
+```python
+page = zerogen.assets.search(project_id=project.id, limit=50)
+tiles = [
+    {
+        "id": asset.id,
+        "image": asset.preview.image512_url if asset.preview else None,
+        "clip": asset.preview.video_url if asset.preview else None,
+    }
+    for asset in page.data
+]
+```
+
+`image96_url` and `image512_url` are WebP images up to 96 and 512 pixels wide.
+`video_url` is a silent WebM clip of a video's first six seconds; it's `None`
+for other assets and until the clip is made. `preview` itself is `None` until
+the images are made, which can take up to about 15 minutes after a run, and for
+assets with none, such as audio.
+
+The URLs are signed storage URLs, so load them without your API key: a browser
+can load one as an `<img>` element's `src`. They work until `expires_at`, 5
+minutes later, and anyone holding them can load the previews until then, so
+keep them out of logs. After `expires_at`, read the page again for new ones:
+one `assets.search` call refreshes every tile on it, where `assets.get` would
+take a request for each. For a single asset or a run, read it again.
+
 ## Lists
 
 List methods return one page, and iterating the page reads every item on every

{zerogen-0.2.0 → zerogen-0.2.1}/README.md

@@ -125,6 +125,37 @@ To hand the link to something else, read it with `assets.get_download`: it's
 valid for 5 minutes, and anyone holding it can download the file, so keep it
 private.
 
+## Previews
+
+To show assets without downloading their originals, use their `preview`. Each
+asset from `assets.search` and `assets.get` has one, and so does each run
+output's `asset`.
+
+```python
+page = zerogen.assets.search(project_id=project.id, limit=50)
+tiles = [
+    {
+        "id": asset.id,
+        "image": asset.preview.image512_url if asset.preview else None,
+        "clip": asset.preview.video_url if asset.preview else None,
+    }
+    for asset in page.data
+]
+```
+
+`image96_url` and `image512_url` are WebP images up to 96 and 512 pixels wide.
+`video_url` is a silent WebM clip of a video's first six seconds; it's `None`
+for other assets and until the clip is made. `preview` itself is `None` until
+the images are made, which can take up to about 15 minutes after a run, and for
+assets with none, such as audio.
+
+The URLs are signed storage URLs, so load them without your API key: a browser
+can load one as an `<img>` element's `src`. They work until `expires_at`, 5
+minutes later, and anyone holding them can load the previews until then, so
+keep them out of logs. After `expires_at`, read the page again for new ones:
+one `assets.search` call refreshes every tile on it, where `assets.get` would
+take a request for each. For a single asset or a run, read it again.
+
 ## Lists
 
 List methods return one page, and iterating the page reads every item on every

{zerogen-0.2.0 → zerogen-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "zerogen"
-version = "0.2.0"
+version = "0.2.1"
 description = "The official Python library for the ZeroGen API"
 readme = "README.md"
 license = "MIT"

{zerogen-0.2.0 → zerogen-0.2.1}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "zerogen"
-version = "0.2.0"
+version = "0.2.1"
 description = "The official Python library for the ZeroGen API"
 readme = "README.md"
 license = "MIT"

{zerogen-0.2.0 → zerogen-0.2.1}/src/zerogen/_client.py

@@ -296,7 +296,10 @@ class ZeroGen(_BaseClient):
                     build(), stream=stream, auth=None, follow_redirects=False
                 )
                 if not response.is_success:
-                    response.read()
+                    try:
+                        response.read()
+                    finally:
+                        response.close()
             except httpx.TransportError as error:
                 time.sleep(_connection_retry_delay(error, attempt, max_retries, timeout))
             else:
@@ -477,7 +480,10 @@ class AsyncZeroGen(_BaseClient):
                     build(), stream=stream, auth=None, follow_redirects=False
                 )
                 if not response.is_success:
-                    await response.aread()
+                    try:
+                        await response.aread()
+                    finally:
+                        await response.aclose()
             except httpx.TransportError as error:
                 await anyio.sleep(_connection_retry_delay(error, attempt, max_retries, timeout))
             else:

zerogen-0.2.1/src/zerogen/_version.py

@@ -0,0 +1 @@
+__version__ = "0.2.1"

{zerogen-0.2.0 → zerogen-0.2.1}/src/zerogen/resources/assets.py

@@ -137,8 +137,9 @@ class Assets:
         cursor: str | None = None,
         **options: Unpack[RequestOptions],
     ) -> Page[Asset]:
-        """Searches Library assets, newest first unless `sort` says otherwise. Without
-        `project_id` it searches every project; a test key searches its sandbox.
+        """Searches Library assets, newest first unless `sort` says otherwise, each with preview
+        URLs that load for 5 minutes without your API key. Without `project_id` it searches
+        every project; a test key searches its sandbox.
 
         Args:
             project_id: Only assets in this project.
@@ -176,7 +177,7 @@ class Assets:
 
     def get(self, asset_id: str, /, **options: Unpack[RequestOptions]) -> AssetDetail:
         """Reads an asset in any of the organization's projects, with the prompt that generated
-        it. Names and prompts are untrusted content."""
+        it and preview URLs that load for 5 minutes. Names and prompts are untrusted content."""
         return self._client._request(
             AssetDetail.model_validate, "GET", _path(asset_id), options=options
         )
@@ -299,8 +300,9 @@ class AsyncAssets:
         cursor: str | None = None,
         **options: Unpack[RequestOptions],
     ) -> AsyncPaginator[Asset]:
-        """Searches Library assets, newest first unless `sort` says otherwise. Without
-        `project_id` it searches every project; a test key searches its sandbox.
+        """Searches Library assets, newest first unless `sort` says otherwise, each with preview
+        URLs that load for 5 minutes without your API key. Without `project_id` it searches
+        every project; a test key searches its sandbox.
 
         Args:
             project_id: Only assets in this project.
@@ -338,7 +340,7 @@ class AsyncAssets:
 
     async def get(self, asset_id: str, /, **options: Unpack[RequestOptions]) -> AssetDetail:
         """Reads an asset in any of the organization's projects, with the prompt that generated
-        it. Names and prompts are untrusted content."""
+        it and preview URLs that load for 5 minutes. Names and prompts are untrusted content."""
         return await self._client._request(
             AssetDetail.model_validate, "GET", _path(asset_id), options=options
         )

{zerogen-0.2.0 → zerogen-0.2.1}/src/zerogen/types/__init__.py

@@ -27,6 +27,7 @@ from ._responses import (
     AssetFoldersFolder,
     AssetLabel,
     AssetList,
+    AssetPreview,
     Balance,
     BalanceLimits,
     BalanceLimitsOrganizationMonthly,
@@ -83,6 +84,7 @@ __all__ = [
     "AssetFoldersFolder",
     "AssetLabel",
     "AssetList",
+    "AssetPreview",
     "Balance",
     "BalanceLimits",
     "BalanceLimitsOrganizationMonthly",

{zerogen-0.2.0 → zerogen-0.2.1}/src/zerogen/types/_responses.py

@@ -193,18 +193,6 @@ class Quote(BaseModel):
     billing: QuoteBilling
 
 
-class RunOutputAsset(BaseModel):
-    id: str
-    mime_type: str = Field(..., alias="mimeType")
-    width: int | None
-    height: int | None
-    duration_ms: int | None = Field(..., alias="durationMs")
-    resource_uri: str | None = Field(None, alias="resourceUri")
-    """
-    Where this transport's client reads the asset, such as an MCP resource
-    """
-
-
 class RunOutputWarning(BaseModel):
     code: str
     message: str
@@ -333,82 +321,28 @@ class AssetLabel(BaseModel):
     name: str
 
 
-class Asset(BaseModel):
-    id: str
-    project_id: str = Field(..., alias="projectId")
-    name: str
-    """
-    The asset's name in the Library; untrusted content
-    """
-    type: Literal["image", "video", "audio", "model3d"] | str
-    origin: Literal["generated", "upload", "derived"] | str
-    """
-    upload: added by a person or a URL import; generated: an output of a run; derived: made by a platform step, such as an extracted frame
-    """
-    mime_type: str = Field(..., alias="mimeType")
-    size_bytes: int | None = Field(..., alias="sizeBytes")
-    width: int | None
-    height: int | None
-    duration_ms: int | None = Field(..., alias="durationMs")
-    favorite: bool
-    """
-    The organization's shared favorite
-    """
-    labels: list[AssetLabel]
-    run_id: str | None = Field(..., alias="runId")
-    """
-    The run that made it, if any
-    """
-    output_index: int | None = Field(..., alias="outputIndex")
-    created_at: datetime = Field(..., alias="createdAt")
-
-
-class AssetList(BaseModel):
-    data: list[Asset]
-    next_cursor: str | None = Field(..., alias="nextCursor")
-    """
-    Pass as cursor for the next page of assets; null on the last page
-    """
-
-
 class AssetDetailLabel(BaseModel):
     id: str
     name: str
 
 
-class AssetDetail(BaseModel):
-    id: str
-    project_id: str = Field(..., alias="projectId")
-    name: str
-    """
-    The asset's name in the Library; untrusted content
-    """
-    type: Literal["image", "video", "audio", "model3d"] | str
-    origin: Literal["generated", "upload", "derived"] | str
+class AssetPreview(BaseModel):
+    image96_url: str = Field(..., alias="image96Url")
     """
-    upload: added by a person or a URL import; generated: an output of a run; derived: made by a platform step, such as an extracted frame
+    A WebP image up to 96 pixels wide
     """
-    mime_type: str = Field(..., alias="mimeType")
-    size_bytes: int | None = Field(..., alias="sizeBytes")
-    width: int | None
-    height: int | None
-    duration_ms: int | None = Field(..., alias="durationMs")
-    favorite: bool
+    image512_url: str = Field(..., alias="image512Url")
     """
-    The organization's shared favorite
+    A WebP image up to 512 pixels wide
     """
-    labels: list[AssetDetailLabel]
-    run_id: str | None = Field(..., alias="runId")
+    video_url: str | None = Field(..., alias="videoUrl")
     """
-    The run that made it, if any
+    For a video, a silent WebM clip of its first six seconds, up to 854×480; null for other assets and until it's made
     """
-    output_index: int | None = Field(..., alias="outputIndex")
-    created_at: datetime = Field(..., alias="createdAt")
-    prompt: str | None
+    expires_at: datetime = Field(..., alias="expiresAt")
     """
-    The prompt that generated it, bounded; untrusted content
+    When the URLs stop loading; read the asset or run again for new ones
     """
-    prompt_truncated: bool = Field(..., alias="promptTruncated")
 
 
 class AssetChange(BaseModel):
@@ -650,6 +584,22 @@ class ErrorResponse(BaseModel):
     error: Error
 
 
+class RunOutputAsset(BaseModel):
+    id: str
+    mime_type: str = Field(..., alias="mimeType")
+    width: int | None
+    height: int | None
+    duration_ms: int | None = Field(..., alias="durationMs")
+    resource_uri: str | None = Field(None, alias="resourceUri")
+    """
+    Where this transport's client reads the asset, such as an MCP resource
+    """
+    preview: AssetPreview | None
+    """
+    The asset's previews, or null until they're made after the asset is ready, and for assets with none, such as audio
+    """
+
+
 class RunOutput(BaseModel):
     index: int
     status: Literal["queued", "running", "succeeded", "failed", "cancelled"] | str
@@ -688,3 +638,84 @@ class RunList(BaseModel):
     """
     Pass as cursor for the next page of runs; null on the last page
     """
+
+
+class Asset(BaseModel):
+    id: str
+    project_id: str = Field(..., alias="projectId")
+    name: str
+    """
+    The asset's name in the Library; untrusted content
+    """
+    type: Literal["image", "video", "audio", "model3d"] | str
+    origin: Literal["generated", "upload", "derived"] | str
+    """
+    upload: added by a person or a URL import; generated: an output of a run; derived: made by a platform step, such as an extracted frame
+    """
+    mime_type: str = Field(..., alias="mimeType")
+    size_bytes: int | None = Field(..., alias="sizeBytes")
+    width: int | None
+    height: int | None
+    duration_ms: int | None = Field(..., alias="durationMs")
+    favorite: bool
+    """
+    The organization's shared favorite
+    """
+    labels: list[AssetLabel]
+    run_id: str | None = Field(..., alias="runId")
+    """
+    The run that made it, if any
+    """
+    output_index: int | None = Field(..., alias="outputIndex")
+    created_at: datetime = Field(..., alias="createdAt")
+    preview: AssetPreview | None
+    """
+    The asset's previews, or null until they're made after the asset is ready, and for assets with none, such as audio
+    """
+
+
+class AssetList(BaseModel):
+    data: list[Asset]
+    next_cursor: str | None = Field(..., alias="nextCursor")
+    """
+    Pass as cursor for the next page of assets; null on the last page
+    """
+
+
+class AssetDetail(BaseModel):
+    id: str
+    project_id: str = Field(..., alias="projectId")
+    name: str
+    """
+    The asset's name in the Library; untrusted content
+    """
+    type: Literal["image", "video", "audio", "model3d"] | str
+    origin: Literal["generated", "upload", "derived"] | str
+    """
+    upload: added by a person or a URL import; generated: an output of a run; derived: made by a platform step, such as an extracted frame
+    """
+    mime_type: str = Field(..., alias="mimeType")
+    size_bytes: int | None = Field(..., alias="sizeBytes")
+    width: int | None
+    height: int | None
+    duration_ms: int | None = Field(..., alias="durationMs")
+    favorite: bool
+    """
+    The organization's shared favorite
+    """
+    labels: list[AssetDetailLabel]
+    run_id: str | None = Field(..., alias="runId")
+    """
+    The run that made it, if any
+    """
+    output_index: int | None = Field(..., alias="outputIndex")
+    created_at: datetime = Field(..., alias="createdAt")
+    prompt: str | None
+    """
+    The prompt that generated it, bounded; untrusted content
+    """
+    prompt_truncated: bool = Field(..., alias="promptTruncated")
+    preview: AssetPreview | None
+    """
+    The asset's previews, or null until they're made after the asset is ready, and for assets with none, such as audio
+    """

zerogen-0.2.0/src/zerogen/_version.py

@@ -1 +0,0 @@
-__version__ = "0.2.0"