{"templateId":"api_docs","sharedDataIds":{"apiDocsStore":"api-docs-@l10n/ja/reference/ai_face_swap.yaml","sidebar":"sidebar-@l10n/ja/reference/sidebars.yaml"},"props":{"definitionId":"@l10n/ja/reference/ai_face_swap.yaml","settings":{"baseUrlPath":"/ja/reference/ai_face_swap"},"disableAutoScroll":true,"seo":{"title":"AI 顔交換","description":"YouCam API documentation by Perfect Corp. Learn how to use Skin analysis API, Virtual try-on API, Image editing API, and Video generative AI APIs.","siteUrl":"https://docs.perfectcorp.com","keywords":"AI Skin Analysis, AI Clothes, AI Hairstyle, AI Outfits","image":"/assets/favicon.cd6fa4d833b2a573b3c6dae68386b293da205b203402cb0c97b80bd2acc07ea2.8351e24f.png"},"dynamicMarkdocComponents":[],"metadata":{"type":"openapi","title":"AI 顔交換","version":"","description":"# 概要\nAI 顔交換では、写真内の顔を交換します。1 つまたは複数の顔の交換に対応しています。\n\n## 統合ガイド\n* AI 顔交換の実装方法\n\n   * ステップ 1: ソース画像と参照画像のアップロード\n\n      1. API からアップロード URL をリクエストします:\n\n        ```\n        POST https://yce-api-01.makeupar.com/s2s/v2.0/file\n        Authorization: Bearer YOUR_API_KEY\n        Content-Type: application/json\n        ```\n\n        ボディ:\n\n        ```json\n        {\n            \"files\": [\n            {\n                \"file_name\": \"target.jpg\",\n                \"file_size\": 123456,\n                \"content_type\": \"image/jpeg\"\n            }\n            ]\n        }\n        ```\n        1. レスポンスには、事前署名付きの **アップロード URL** と `file_id` が含まれます。\n        2. 指定された URL に対して HTTP PUT リクエストでファイルをアップロードします。\n        3. 後で使用するために `file_id` を保存します。**ターゲット**画像と**参照**画像の両方に対してこの手順を繰り返します。\n\n      2. 実際のファイルを **アップロード URL** にアップロードします。\n\n---\n\n   * ステップ 2: ソース画像と参照画像の前処理（顔検出）\n\n        1. 前処理タスクを作成します:\n\n        ```\n        POST https://yce-api-01.makeupar.com/s2s/v2.0/task/face-swap/pre-process\n        Authorization: Bearer YOUR_API_KEY\n        Content-Type: application/json\n        ```\n\n        ボディ:\n\n        ```json\n        {\n            \"request_id\": 1,\n            \"payload\": {\n            \"file_sets\": {\n                \"src_ids\": [\"TARGET_FILE_ID\"]\n            },\n            \"actions\": [\n                { \"id\": 0 }\n            ]\n            }\n        }\n        ```\n        1. API は `task_id` を返します。\n        2. タスクのステータスを次の URL でポーリングします:\n\n        ```\n        GET https://yce-api-01.makeupar.com/s2s/v2.0/task/face-swap/pre-process?task_id=TASK_ID\n        ```\n        1. 完了すると、バウンディングボックス付きの検出された顔のリストを受け取ります。\n\n---\n\n   * ステップ 3: 顔交換タスクの実行\n        1. どの参照画像が各ソース画像を置き換えるかを定義します\n        `face_mapping` 配列は、**ソース画像**内の顔が**参照画像**内の顔によってどのように置き換えられるかを定義します。これは、ソース内で検出された顔を特定の参照画像に接続するリンクリストとして機能します。\n\n        * 構造\n\n            配列内の各要素は、2 つのプロパティを含むオブジェクトです:\n\n            | パラメータ | 型 | 説明 |\n            | :--- | :--- | :--- |\n            | `position` | `integer` | **ソース画像**内で検出された顔のインデックス（例: 0, 1, 2）。 |\n            | `index` | `integer` | 交換対象となる**参照画像リスト**内の顔画像のインデックス。 |\n\n                * ロジックルール\n            1.  **インデックスマッピング:** `index` は、参照リストに提供された画像の順序に直接対応します。\n                *   `0`: 1 番目の参照画像。\n                *   `1`: 2 番目の参照画像。\n            2.  **交換のスキップ:** ソース内で検出された特定の顔の交換をスキップするには、`index` と `position` の両方を `-1` に設定します。\n            3.  **配列の順序:** 配列内のオブジェクトの順序は、`position` に基づいて一致させる必要があります。\n\n                * 使用例\n\n            **シナリオ:**\n            *   **参照リスト:** 2 枚の画像を提供（画像 A、画像 B）。\n            *   **ソース画像:** 3 つの顔が検出される（顔 0、顔 1、顔 2）。\n\n            **目標:**\n            *   **顔 0**（ソース）を**画像 1**（参照）と交換する。\n            *   **顔 1**（ソース）の交換をスキップする。\n            *   **顔 2**（ソース）を**画像 0**（参照）と交換する。\n\n            **設定:**\n\n            ```json\n            \"face_mapping\": [\n                {\n                    \"index\": 1,  // Use the second reference image\n                    \"position\": 0 // Apply to the first detected face in source\n                },\n                {\n                    \"index\": -1, // Skip swapping\n                    \"position\": -1 // Skip swapping\n                },\n                {\n                    \"index\": 0,  // Use the first reference image\n                    \"position\": 2 // Apply to the third detected face in source\n                }\n            ]\n            ```\n\n        1. メインタスクリクエストを送信します:\n\n        ```\n        POST https://yce-api-01.makeupar.com/s2s/v2.0/task/face-swap\n        Authorization: Bearer YOUR_API_KEY\n        Content-Type: application/json\n        ```\n\n        ボディ:\n\n        ```json\n        {\n            \"request_id\": 2,\n            \"payload\": {\n            \"file_sets\": {\n                \"src_ids\": [\"TARGET_FILE_ID\"],\n                \"ref_ids\": [\"REFERENCE_FILE_ID\"]\n            },\n            \"actions\": [\n                {\n                \"id\": 0,\n                \"params\": {\n                    \"face_mapping\": [\n                    { \"index\": 0, \"position\": 0 },\n                    { \"index\": -1, \"position\": -1 }\n                    ]\n                }\n                }\n            ]\n            }\n        }\n        ```\n        1. レスポンスには `task_id` が返されます。\n\n---\n\n   * ステップ 4: タスクステータスのポーリングと結果の取得\n        許可されたポーリングウィンドウ内で、一定の間隔でタスクステータスを照会するタイミングループを実装する必要があります。\n        1. 次の URL でポーリングします:\n\n        ```\n        GET https://yce-api-01.makeupar.com/s2s/v2.0/task/face-swap?task_id=TASK_ID\n        ```\n        2. `status` が `success` になると、レスポンスには生成された画像の URL が含まれます。\n        3. その URL から画像をダウンロードまたは表示します。\n\n---\n\n   * ステップ 5: プラットフォームへの統合\n\n        * **Web フロントエンド**では、fetch または Axios を使用して JavaScript で直接実装できます。\n        * **バックエンド**（Node.js、Python、Java、PHP など）では、標準的な HTTP ライブラリを使用して同じエンドポイントを使用できます。\n        * タスクは非同期で実行されるため、リトライとエラーハンドリングを実装してください。\n\n---\n\n    * デバッグガイド\n        1. **Invalid TaskId エラー**\n            </br>**理由:** タイムアウトしたタスクのステータスを確認しようとすると、InvalidTaskId エラーが発生します。したがって、AI タスクが開始されたら、ステータスが success または error に変わるまで、polling_interval 内でステータスをポーリングする必要があります。\n            </br>**解決策:** タスクが無効になるのを避けるために、許可されたポーリングウィンドウ内で一定の間隔でタスクステータスを照会するタイミングループを実装する必要があります。\n\n        2. **ソース画像で一部の顔が検出されない理由**\n            </br>**理由:** 顔がはっきりと見えており、覆われたり遮られたりしておらず、画像内で十分に大きい必要があります。\n            </br>**解決策:** 顔が大きく写っており、覆いや遮りがなくはっきりと見える写真を撮影してみてください。\n\n---\n\n## 入力と出力\n\n* 実際の例:\n複数顔交換サンプル:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/dt_yce_face_swap_S2_img_04_d4b747a41d.jpg)\n\n単一顔交換サンプル:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/dt_yce_face_swap_S2_img_05_8e68faff2c.jpg)\n\n* 撮影方法の提案:\n![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/webp_AI%20Skin%20Analysis_camera_f93315b088.png)\n\n\n## ファイル仕様とエラー\n* 対応フォーマットと寸法\n\n|AI 機能|対応寸法|対応ファイルサイズ|対応フォーマット|\n|  ----  | ----  | ----  | ----  |\n|AI 顔交換|入力と出力: 長辺が 4096 ピクセル以下|< 10MB|jpg/jpeg/png|\n\n\n* エラーコード\n\n| エラーコード | 説明 |\n| ------------------ | ----------- |\n| exceed_max_filesize | 入力ファイルサイズが最大制限を超えています |\n| invalid_parameter | パラメータ値が無効です |\n| error_download_image | ソース画像のダウンロード中にエラーが発生しました |\n| error_download_mask | マスク画像のダウンロード中にエラーが発生しました |\n| error_decode_image | ソース画像のデコード中にエラーが発生しました |\n| error_decode_mask | マスク画像のデコード中にエラーが発生しました |\n| error_download_video | ソース動画のダウンロード中にエラーが発生しました |\n| error_decode_video | ソース動画のデコード中にエラーが発生しました |\n| error_nsfw_content_detected | ソース画像で NSFW コンテンツが検出されました |\n| error_no_face | ソース画像で顔が検出されませんでした |\n| error_pose | ソース画像でポーズの検出に失敗しました |\n| error_face_parsing | ソース画像での顔解析に失敗しました |\n| error_inference | 推論パイプラインでエラーが発生しました |\n| exceed_nsfw_retry_limits | NSFW 画像の生成を避けるためのリトライ制限を超えました |\n| error_upload | 結果画像のアップロード中にエラーが発生しました |\n| error_multiple_people | 人物の数が最大制限を超えています |\n| error_no_shoulder | ソース画像で肩が見えません |\n| error_large_face_angle | アップロード画像の顔の角度が大きすぎます |\n| error_unsupport_ratio | 入力画像のアスペクト比はサポートされていません |\n| unknown_internal_error | その他の内部エラー |\n\n---\n\n## ユニット消費量\n\n| AI 機能 | 消費ユニット |\n|---|---|\n| AI 顔交換 V1.0 | 1 |\n\n---\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.perfectcorp.com","port":4000,"ipAddress":"216.73.217.126"},"lang":"ja","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"master"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/ja/reference/ai_face_swap","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}