magic_hour 0.9.5__py3-none-any.whl → 0.44.0__py3-none-any.whl

magic_hour/resources/v1/ai_gif_generator/client.py

@@ -0,0 +1,257 @@
+import typing
+import typing_extensions
+
+from magic_hour.helpers.logger import get_sdk_logger
+from magic_hour.resources.v1.image_projects.client import (
+    AsyncImageProjectsClient,
+    ImageProjectsClient,
+)
+from magic_hour.types import models, params
+from make_api_request import (
+    AsyncBaseClient,
+    RequestOptions,
+    SyncBaseClient,
+    default_request_options,
+    to_encodable,
+    type_utils,
+)
+
+
+logger = get_sdk_logger(__name__)
+
+
+class AiGifGeneratorClient:
+    def __init__(self, *, base_client: SyncBaseClient):
+        self._base_client = base_client
+
+    def generate(
+        self,
+        *,
+        style: params.V1AiGifGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        output_format: typing.Union[
+            typing.Optional[typing_extensions.Literal["gif", "mp4", "webm"]],
+            type_utils.NotGiven,
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate GIF (alias for create with additional functionality).
+
+        Create an AI GIF. Each GIF costs 5 credits.
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the image.
+            style: The art style to use for GIF generation
+            wait_for_completion: Whether to wait for the image project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1ImageProjectsGetResponseWithDownloads: The response from the AI GIF Generator API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = client.v1.ai_gif_generator.generate(
+            style={"prompt": "Cute dancing cat, pixel art"},
+            name="Dancing Cat GIF",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        create_response = self.create(
+            style=style,
+            name=name,
+            output_format=output_format,
+            request_options=request_options,
+        )
+        logger.info(f"AI GIF Generator response: {create_response}")
+
+        image_projects_client = ImageProjectsClient(base_client=self._base_client)
+        response = image_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
+    def create(
+        self,
+        *,
+        style: params.V1AiGifGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        output_format: typing.Union[
+            typing.Optional[typing_extensions.Literal["gif", "mp4", "webm"]],
+            type_utils.NotGiven,
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1AiGifGeneratorCreateResponse:
+        """
+        AI GIF Generator
+
+        Create an AI GIF. Each GIF costs 50 credits.
+
+        POST /v1/ai-gif-generator
+
+        Args:
+            name: The name of gif. This value is mainly used for your own identification of the gif.
+            output_format: The output file format for the generated animation.
+            style: V1AiGifGeneratorCreateBodyStyle
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            Success
+
+        Raises:
+            ApiError: A custom exception class that provides additional context
+                for API errors, including the HTTP status code and response body.
+
+        Examples:
+        ```py
+        client.v1.ai_gif_generator.create(
+            style={"prompt": "Cute dancing cat, pixel art"},
+            name="Ai Gif gif",
+            output_format="gif",
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "output_format": output_format, "style": style},
+            dump_with=params._SerializerV1AiGifGeneratorCreateBody,
+        )
+        return self._base_client.request(
+            method="POST",
+            path="/v1/ai-gif-generator",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1AiGifGeneratorCreateResponse,
+            request_options=request_options or default_request_options(),
+        )
+
+
+class AsyncAiGifGeneratorClient:
+    def __init__(self, *, base_client: AsyncBaseClient):
+        self._base_client = base_client
+
+    async def generate(
+        self,
+        *,
+        style: params.V1AiGifGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate GIF (alias for create with additional functionality).
+
+        Create an AI GIF. Each GIF costs 5 credits.
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the image.
+            style: The art style to use for GIF generation
+            wait_for_completion: Whether to wait for the image project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1ImageProjectsGetResponseWithDownloads: The response from the AI GIF Generator API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = await client.v1.ai_gif_generator.generate(
+            style={"prompt": "Cute dancing cat, pixel art"},
+            name="Dancing Cat GIF",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        create_response = await self.create(
+            style=style, name=name, request_options=request_options
+        )
+        logger.info(f"AI GIF Generator response: {create_response}")
+
+        image_projects_client = AsyncImageProjectsClient(base_client=self._base_client)
+        response = await image_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
+    async def create(
+        self,
+        *,
+        style: params.V1AiGifGeneratorCreateBodyStyle,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        output_format: typing.Union[
+            typing.Optional[typing_extensions.Literal["gif", "mp4", "webm"]],
+            type_utils.NotGiven,
+        ] = type_utils.NOT_GIVEN,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> models.V1AiGifGeneratorCreateResponse:
+        """
+        AI GIF Generator
+
+        Create an AI GIF. Each GIF costs 50 credits.
+
+        POST /v1/ai-gif-generator
+
+        Args:
+            name: The name of gif. This value is mainly used for your own identification of the gif.
+            output_format: The output file format for the generated animation.
+            style: V1AiGifGeneratorCreateBodyStyle
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            Success
+
+        Raises:
+            ApiError: A custom exception class that provides additional context
+                for API errors, including the HTTP status code and response body.
+
+        Examples:
+        ```py
+        await client.v1.ai_gif_generator.create(
+            style={"prompt": "Cute dancing cat, pixel art"},
+            name="Ai Gif gif",
+            output_format="gif",
+        )
+        ```
+        """
+        _json = to_encodable(
+            item={"name": name, "output_format": output_format, "style": style},
+            dump_with=params._SerializerV1AiGifGeneratorCreateBody,
+        )
+        return await self._base_client.request(
+            method="POST",
+            path="/v1/ai-gif-generator",
+            auth_names=["bearerAuth"],
+            json=_json,
+            cast_to=models.V1AiGifGeneratorCreateResponse,
+            request_options=request_options or default_request_options(),
+        )

magic_hour/resources/v1/ai_headshot_generator/README.md

@@ -1,11 +1,77 @@
+# v1.ai_headshot_generator
 
-### create <a name="create"></a>
-AI Headshots
+## Module Functions
 
-Create an AI headshot. Each headshot costs 50 frames.
+<!-- CUSTOM DOCS START -->
+
+### Ai Headshot Generator Generate Workflow <a name="generate"></a>
+
+The workflow performs the following action
+
+1. upload local assets to Magic Hour storage. So you can pass in a local path instead of having to upload files yourself
+2. trigger a generation
+3. poll for a completion status. This is configurable
+4. if success, download the output to local directory
+
+> [!TIP]
+> This is the recommended way to use the SDK unless you have specific needs where it is necessary to split up the actions.
+
+#### Parameters
+
+In Additional to the parameters listed in the `.create` section below, `.generate` introduces 3 new parameters:
+
+- `wait_for_completion` (bool, default True): Whether to wait for the project to complete.
+- `download_outputs` (bool, default True): Whether to download the generated files
+- `download_directory` (str, optional): Directory to save downloaded files (defaults to current directory)
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.ai_headshot_generator.generate(
+    assets={"image_file_path": "/path/to/1234.png"}, name="Ai Headshot image"
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.ai_headshot_generator.generate(
+    assets={"image_file_path": "/path/to/1234.png"}, name="Ai Headshot image"
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+<!-- CUSTOM DOCS END -->
+
+### AI Headshot Generator <a name="create"></a>
+
+Create an AI headshot. Each headshot costs 50 credits.
 
 **API Endpoint**: `POST /v1/ai-headshot-generator`
 
+#### Parameters
+
+| Parameter            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                              | Example                                         |
+| -------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
+| `assets`             |    ✓     | Provide the assets for headshot photo                                                                                                                                                                                                                                                                                                                                                                                                    | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `└─ image_file_path` |    ✓     | The image used to generate the headshot. This image must contain one detectable face. This value is either - a direct URL to the video file - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls). Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more. | `"api-assets/id/1234.png"`                      |
+| `name`               |    ✗     | The name of image. This value is mainly used for your own identification of the image.                                                                                                                                                                                                                                                                                                                                                   | `"Ai Headshot image"`                           |
+| `style`              |    ✗     |                                                                                                                                                                                                                                                                                                                                                                                                                                          | `{}`                                            |
+| `└─ prompt`          |    ✗     | Prompt used to guide the style of your headshot. We recommend omitting the prompt unless you want to customize your headshot. You can visit [AI headshot generator](https://magichour.ai/create/ai-headshot-generator) to view an example of a good prompt used for our 'Professional' style.                                                                                                                                            | `"string"`                                      |
+
 #### Synchronous Client
 
 ```python
@@ -29,3 +95,15 @@ res = await client.v1.ai_headshot_generator.create(
     assets={"image_file_path": "api-assets/id/1234.png"}, name="Ai Headshot image"
 )
 ```
+
+#### Response
+
+##### Type
+
+[V1AiHeadshotGeneratorCreateResponse](/magic_hour/types/models/v1_ai_headshot_generator_create_response.py)
+
+##### Example
+
+```python
+{"credits_charged": 50, "frame_cost": 50, "id": "cuid-example"}
+```

magic_hour/resources/v1/ai_headshot_generator/client.py

@@ -1,6 +1,13 @@
 import typing
 
-from magic_hour.core import (
+from magic_hour.helpers.logger import get_sdk_logger
+from magic_hour.resources.v1.files.client import AsyncFilesClient, FilesClient
+from magic_hour.resources.v1.image_projects.client import (
+    AsyncImageProjectsClient,
+    ImageProjectsClient,
+)
+from magic_hour.types import models, params
+from make_api_request import (
     AsyncBaseClient,
     RequestOptions,
     SyncBaseClient,
@@ -8,31 +15,103 @@ from magic_hour.core import (
     to_encodable,
     type_utils,
 )
-from magic_hour.types import models, params
+
+
+logger = get_sdk_logger(__name__)
 
 
 class AiHeadshotGeneratorClient:
     def __init__(self, *, base_client: SyncBaseClient):
         self._base_client = base_client
 
+    def generate(
+        self,
+        *,
+        assets: params.V1AiHeadshotGeneratorGenerateBodyAssets,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        style: typing.Union[
+            typing.Optional[params.V1AiHeadshotGeneratorCreateBodyStyle],
+            type_utils.NotGiven,
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate headshot (alias for create with additional functionality).
+
+        Generate professional headshots using AI. Each headshot costs 5 credits.
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the image.
+            assets: Provide the assets for headshot generation
+            style: Headshot generation parameters
+            wait_for_completion: Whether to wait for the image project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1ImageProjectsGetResponseWithDownloads: The response from the AI Headshot Generator API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = client.v1.ai_headshot_generator.generate(
+            assets={"image_file_path": "path/to/person.jpg"},
+            name="Professional Headshot",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        file_client = FilesClient(base_client=self._base_client)
+
+        image_file_path = assets["image_file_path"]
+        assets["image_file_path"] = file_client.upload_file(file=image_file_path)
+
+        create_response = self.create(
+            assets=assets, style=style, name=name, request_options=request_options
+        )
+        logger.info(f"AI Headshot Generator response: {create_response}")
+
+        image_projects_client = ImageProjectsClient(base_client=self._base_client)
+        response = image_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
     def create(
         self,
         *,
-        assets: params.PostV1AiHeadshotGeneratorBodyAssets,
+        assets: params.V1AiHeadshotGeneratorCreateBodyAssets,
         name: typing.Union[
             typing.Optional[str], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
+        style: typing.Union[
+            typing.Optional[params.V1AiHeadshotGeneratorCreateBodyStyle],
+            type_utils.NotGiven,
+        ] = type_utils.NOT_GIVEN,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> models.PostV1AiHeadshotGeneratorResponse:
+    ) -> models.V1AiHeadshotGeneratorCreateResponse:
         """
-        AI Headshots
+        AI Headshot Generator
 
-        Create an AI headshot. Each headshot costs 50 frames.
+        Create an AI headshot. Each headshot costs 50 credits.
 
         POST /v1/ai-headshot-generator
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the image.
+            style: V1AiHeadshotGeneratorCreateBodyStyle
             assets: Provide the assets for headshot photo
             request_options: Additional options to customize the HTTP request
 
@@ -52,15 +131,15 @@ class AiHeadshotGeneratorClient:
         ```
         """
         _json = to_encodable(
-            item={"name": name, "assets": assets},
-            dump_with=params._SerializerPostV1AiHeadshotGeneratorBody,
+            item={"name": name, "style": style, "assets": assets},
+            dump_with=params._SerializerV1AiHeadshotGeneratorCreateBody,
         )
         return self._base_client.request(
             method="POST",
             path="/v1/ai-headshot-generator",
             auth_names=["bearerAuth"],
             json=_json,
-            cast_to=models.PostV1AiHeadshotGeneratorResponse,
+            cast_to=models.V1AiHeadshotGeneratorCreateResponse,
             request_options=request_options or default_request_options(),
         )
 
@@ -69,24 +148,94 @@ class AsyncAiHeadshotGeneratorClient:
     def __init__(self, *, base_client: AsyncBaseClient):
         self._base_client = base_client
 
+    async def generate(
+        self,
+        *,
+        assets: params.V1AiHeadshotGeneratorGenerateBodyAssets,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        style: typing.Union[
+            typing.Optional[params.V1AiHeadshotGeneratorCreateBodyStyle],
+            type_utils.NotGiven,
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate headshot (alias for create with additional functionality).
+
+        Generate professional headshots using AI. Each headshot costs 5 credits.
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the image.
+            assets: Provide the assets for headshot generation
+            style: Headshot generation parameters
+            wait_for_completion: Whether to wait for the image project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1ImageProjectsGetResponseWithDownloads: The response from the AI Headshot Generator API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = await client.v1.ai_headshot_generator.generate(
+            assets={"image_file_path": "path/to/person.jpg"},
+            name="Professional Headshot",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        file_client = AsyncFilesClient(base_client=self._base_client)
+
+        image_file_path = assets["image_file_path"]
+        assets["image_file_path"] = await file_client.upload_file(file=image_file_path)
+
+        create_response = await self.create(
+            assets=assets, style=style, name=name, request_options=request_options
+        )
+        logger.info(f"AI Headshot Generator response: {create_response}")
+
+        image_projects_client = AsyncImageProjectsClient(base_client=self._base_client)
+        response = await image_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
     async def create(
         self,
         *,
-        assets: params.PostV1AiHeadshotGeneratorBodyAssets,
+        assets: params.V1AiHeadshotGeneratorCreateBodyAssets,
         name: typing.Union[
             typing.Optional[str], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
+        style: typing.Union[
+            typing.Optional[params.V1AiHeadshotGeneratorCreateBodyStyle],
+            type_utils.NotGiven,
+        ] = type_utils.NOT_GIVEN,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> models.PostV1AiHeadshotGeneratorResponse:
+    ) -> models.V1AiHeadshotGeneratorCreateResponse:
         """
-        AI Headshots
+        AI Headshot Generator
 
-        Create an AI headshot. Each headshot costs 50 frames.
+        Create an AI headshot. Each headshot costs 50 credits.
 
         POST /v1/ai-headshot-generator
 
         Args:
-            name: The name of image
+            name: The name of image. This value is mainly used for your own identification of the image.
+            style: V1AiHeadshotGeneratorCreateBodyStyle
             assets: Provide the assets for headshot photo
             request_options: Additional options to customize the HTTP request
 
@@ -106,14 +255,14 @@ class AsyncAiHeadshotGeneratorClient:
         ```
         """
         _json = to_encodable(
-            item={"name": name, "assets": assets},
-            dump_with=params._SerializerPostV1AiHeadshotGeneratorBody,
+            item={"name": name, "style": style, "assets": assets},
+            dump_with=params._SerializerV1AiHeadshotGeneratorCreateBody,
         )
         return await self._base_client.request(
             method="POST",
             path="/v1/ai-headshot-generator",
             auth_names=["bearerAuth"],
             json=_json,
-            cast_to=models.PostV1AiHeadshotGeneratorResponse,
+            cast_to=models.V1AiHeadshotGeneratorCreateResponse,
             request_options=request_options or default_request_options(),
         )