Skip to main content

画像消去/補完 API リファレンス

このトピックでは、画像消去/補完モデルの入力パラメーターと出力パラメーターについて説明します。このモデルは、マスクを使用して除去する領域を指定し、背景を維持しながら、人物、ペット、オブジェクト、テキスト、ウォーターマークなどの要素を画像から除去します。

関連ガイド:画像消去/補完
  • このドキュメントは、中国 (北京) リージョンにのみ適用されます。モデルを試すには、[モデル] ページに移動してください。
  • image-erase-completion は現在、無料トライアルとしてのみ利用可能です。無料クォータを使い切ると、モデルを呼び出すことができなくなり、有料での使用はサポートされません。代替ソリューションについては、「画像編集 - Qwen」または「画像編集 - Wan」をご参照ください。

前提条件

API キーを取得し、API キーを環境変数として設定する必要があります。

HTTP

待ち時間を短縮し、リクエストのタイムアウトを防ぐために、このサービスは非同期で実行されます。2 つのリクエストを送信する必要があります:
  • タスクの作成: リクエストを送信してテキストから画像へのタスクを作成し、タスク ID を返します。
  • タスク ID による結果のクエリ: 前のステップのタスク ID を使用して、モデルによって生成された結果を取得します。

ステップ 1: タスクを作成してタスク ID を取得する

POST https://dashscope.aliyuncs.com/api/v1/services/aigc/image2image/image-synthesis

リクエストヘッダー

Content-Typestring必須リクエストのコンテントタイプ。値を application/json に設定します。Authorizationstring必須Model Studio API キーを使用します。例: Bearer d1xxx2a。X-DashScope-Asyncstring必須非同期処理を有効にするかどうかを指定します。このパラメーターを enable に設定する必要があります。

リクエストボディ

modelstring必須呼び出すモデル。inputobject必須入力画像の URL などの基本情報。

プロパティ

image_urlstring必須入力画像の URL または Base64 エンコードされたデータ。URL は、一般にアクセス可能なアドレスであり、HTTP または HTTPS プロトコルをサポートしている必要があります。画像制限:
  • フォーマット: JPEG、PNG、JPG、BMP、または WEBP。
  • 解像度: 512 × 512 ピクセルから 4096 × 4096 ピクセルまで。
  • 片側の長さ: 512 から 4096 ピクセル。
  • サイズ: 10 MB 以下。
  • URL には中国語の文字を含めることはできません。
mask_urlstring必須消去する領域のマスク画像の URL または Base64 エンコードされたデータ。URL は、一般にアクセス可能なアドレスであり、HTTP または HTTPS プロトコルをサポートしている必要があります。画像制限:
  • フォーマット: JPG、JPEG、PNG、HEIF、または WEBP。
  • 解像度: 512 × 512 ピクセルから 4096 × 4096 ピクセルまで。
  • 片側の長さ: 512 から 4096 ピクセル。
  • サイズ: 10 MB 以下。
ソース画像と同じディメンションを持つ空白のキャンバスにペイントすることでマスクを作成できます。ペイントされた領域 (ゼロ以外の値を持つ) が消去マスクを定義します。または、「人物インスタンスセグメンテーション」を使用して人物のセグメンテーション結果を生成し、それを消去マスクとして使用することもできます。foreground_urlstring オプション保持する領域のマスク画像の URL または Base64 エンコードされたデータ。URL は、一般にアクセス可能なアドレスであり、HTTP または HTTPS プロトコルをサポートしている必要があります。画像制限:
  • フォーマット: JPG、JPEG、PNG、HEIF、または WEBP。
  • 解像度: 512 × 512 ピクセルから 4096 × 4096 ピクセルまで。
  • 片側の長さ: 512 から 4096 ピクセル。
  • サイズ: 10 MB 以下。
ソース画像と同じディメンションを持つ空白のキャンバスにペイントすることで前景マスクを作成できます。ペイントされた領域 (ゼロ以外の値を持つ) が保持する領域を定義します。または、「人物インスタンスセグメンテーション」を使用して、特定の人物の ID を提供することでその人物のマスクを生成することもできます。これにより、その人物が保持され、消去されないことが保証されます。
parametersobject オプション画像編集パラメーター。

プロパティ

fast_modebool オプション高速モードを使用するかどうかを指定します。デフォルト値は false です。高速モードでは、推論時間は標準モードで必要な時間の約 4 分の 1 です。このモードは、高いレベルの詳細を必要としないシナリオに適しています。dilate_flagbool オプションデフォルト値は true です。消去マスクがアルゴリズムによって生成される場合はこのパラメーターを true に設定し、ペイントによって作成される場合は false に設定します。add_watermark booleanオプションGenerated by AI ウォーターマークを追加するかどうかを指定します。デフォルト値は true で、出力画像の左下隅にウォーターマークが追加されます。
  • 画像消去/補完
curl --location --request POST 'https://dashscope.aliyuncs.com/api/v1/services/aigc/image2image/image-synthesis' \
--header 'X-DashScope-Async: enable' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "image-erase-completion",
    "input": {
            "image_url": "http://xxx/input.png",
            "mask_url": "http://xxx/mask.png",
            "foreground_url": "http://xxx/foreground.png"
        },
    "parameters":{
        "dilate_flag":true
    }
}'

応答

output objectタスクの出力。

プロパティ

task_id stringタスクの一意の ID。task_status stringタスクのステータス。
  • PENDING
  • RUNNING
  • SUSPENDED
  • SUCCEEDED
  • FAILED
code stringエラーコード。このパラメーターは、リクエストが失敗した場合にのみ返されます。message stringエラーメッセージ。このパラメーターは、リクエストが失敗した場合にのみ返されます。request_id stringリクエストの一意の ID。この ID を使用して、問題を追跡およびトラブルシューティングします。
{
    "output": {
        "task_status": "PENDING",
        "task_id": "53950fb7-281a-4e60-b543-xxxxxxxxxxxx"
    },
    "request_id": "1027557e-8c3f-9db5-8cd2-xxxxxxxxxxxx"
}

ステップ 2: タスク ID で結果をクエリする

GET https://dashscope.aliyuncs.com/api/v1/tasks/{task_id}

リクエストヘッダー

Authorizationstring必須API キー。例: Bearer d1**2a。

パスパラメーター

task_idstring必須タスク ID。
  • タスク結果の取得
curl -X GET \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
https://dashscope.aliyuncs.com/api/v1/tasks/53950fb7-281a-4e60-b543-xxxxxxxxxxxx

応答

output objectタスクの出力。

プロパティ

task_id stringタスク ID。task_status stringタスクのステータス。
  • PENDING
  • RUNNING
  • SUSPENDED
  • SUCCEEDED
  • FAILED
task_metrics objectタスクに関する統計。

プロパティ

TOTAL integerサブタスクの総数。SUCCEEDED integer成功したサブタスクの数。FAILED integer失敗したサブタスクの数。
submit_time stringタスクが送信された時刻。scheduled_time stringタスクの実行が開始された時刻。end_time stringタスクが完了した時刻。output_image_url string出力画像の URL。code stringエラーコード。このパラメーターは、タスクが失敗した場合にのみ返されます。message stringエラーメッセージ。このパラメーターは、タスクが失敗した場合にのみ返されます。
usage object使用状況の統計。

プロパティ

image_count integer生成された画像の数。
request_id stringリクエストの一意の ID。この ID を使用して、問題を追跡およびトラブルシューティングします。
  • タスク成功
  • 進行中のタスク
  • タスク失敗
完了したタスクのステータスと結果は 24 時間保持され、その間タスクをクエリできます。この期間が過ぎると、タスクとその結果はシステムから消去されます。タスクの結果には、生成された画像の URL が含まれます。この URL もセキュリティ上の理由から 24 時間のみ有効です。URL の有効期限が切れる前に画像をダウンロードまたは保存する必要があります。
{
    "request_id": "b67df059-ca6a-9d51-afcd-9b3c4456b1e2",
    "output": {
        "task_id": "53950fb7-281a-4e60-b543-xxxxxxxxxxxx",
        "task_status": "SUCCEEDED",
        "submit_time": "2024-05-16 13:50:01.247",
        "scheduled_time": "2024-05-16 13:50:01.354",
        "end_time": "2024-05-16 13:50:27.795",
        "output_image_url": "http://xxx/result.png"
    },
    "usage": {
        "image_count": 1
    }
}

ステータスコード

DashScope の Model Studio サービスの一般的なステータスコードの詳細については、「エラーメッセージ」をご参照ください。 この API は、次の特定のステータスコードも返します:

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400

InvalidParameter.JsonPhrase

input json error

入力 JSON が無効です。

400

InvalidParameter.FileDownload

oss download error

入力画像のダウンロードに失敗しました。

400

InvalidParameter.ImageFormat

read image error

画像の読み取りに失敗しました。

400

InvalidParameter.ImageContent

The image content does not comply with green network verification

画像コンテンツが準拠していません。

400

InvalidParameter

the parameters must conform to the specification: xxx

入力パラメーターが有効範囲外です。

400

InvalidParameter.ImageResolution

the size of input image is too small or too large

入力画像の解像度が小さすぎるか、大きすぎます。

500

InternalError.Algo

algorithm process error

アルゴリズムエラーが発生しました。

500

InternalError.FileUpload

oss upload error

ファイルのアップロードに失敗しました。