代替テキスト生成
Generations APIは、Imgix画像のAI生成代替テキストを生成できます。これはスクリーンリーダーなどの支援技術向けに書かれます。1回の呼び出しで複数の言語の代替テキストをリクエストできます。
動画生成とは異なり、代替テキスト生成は同期です。生成されたテキストはレスポンスで直接返され、ポーリングすべきジョブはありません。
認証
Generations APIへのすべての呼び出しには、任意の権限(請求、アセットマネージャー読み取りなど)を持つAPIキーが必要です。キーを作成するには、ダッシュボードのAPIキービューに移動してください。APIキーのアカウントは、画像を配信するソースを所有している必要があります。
代替テキスト操作
| エンドポイント | メソッド | 説明 |
|---|---|---|
/v1/generations/alt-text | GET | 1つ以上の言語で画像の代替テキストを生成します。 |
代替テキストの生成
代替テキストを生成するには、urlまたはurl64で画像を指定して、/v1/generations/alt-textにGETリクエストを送信します。
リクエストパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
url | String | url/url64のいずれか | クエリパラメータを含まないプレーンなImgixレンダリングURL(例:https://assets.imgix.net/photo.jpg)。 |
url64 | String | url/url64のいずれか | base64urlでエンコードされたImgixレンダリングURL。URLがAI生成パラメータなどのクエリパラメータを含む場合に使用します。 |
language | String | いいえ | BCP-47言語コード。複数の言語を指定するには、パラメータを繰り返すか、カンマ区切りのリストを渡します。デフォルトはenです。 |
regenerate | Boolean | いいえ | キャッシュをスキップして代替テキストを再生成します。デフォルトはfalseです。 |
注意: urlまたはurl64のいずれか一方のみを指定してください。クリーンな画像URLにはurlを使用し、
URLにクエリパラメータが含まれる場合(例:text2imageで生成された画像)はurl64を使用します。
サポート言語
代替テキストは以下の言語で生成できます。これら以外の言語をリクエストすると、400レスポンスが返されます。
| コード | 言語 |
|---|---|
en | 英語 |
fr | フランス語 |
de | ドイツ語 |
it | イタリア語 |
es | スペイン語 |
レスポンス
レスポンスには、リクエストした言語コードをキーとするalt_textオブジェクトと、生成できなかったリクエスト済み言語を列挙するfailed_languages配列が含まれます。
| 属性 | 型 | 説明 |
|---|---|---|
alt_text | Object | リクエストした各言語について、言語コードと生成された代替テキスト文字列のマップ。 |
failed_languages | Array | リクエストされたが生成できなかった言語コード。完全に成功した場合は空です。 |
GET api/v1/generations/alt-text?url=https://assets.imgix.net/photo.jpg&language=en,frパラメータを含むURLの代替テキストを生成する
画像URLにクエリパラメータが含まれる場合(例:text2imageで作成されたAI画像)は、完全なURLをbase64urlでエンコードしてurl64として渡します。
# プレーンなURL(クエリパラメータを含む):
# https://assets.imgix.net/ai?text2image=true&prompt=a serene mountain lake at sunset
GET api/v1/generations/alt-text?url64=aHR0cHM6Ly9hc3NldHMuaW1naXgubmV0L2FpP3RleHQyaW1hZ2U9dHJ1ZSZwcm9tcHQ9YSBzZXJlbmUgbW91bnRhaW4gbGFrZSBhdCBzdW5zZXQ&language=enステータスコード
| ステータスコード | 説明 |
|---|---|
200 | OK - 代替テキストが正常に生成(またはキャッシュから配信)されました。 |
400 | Bad Request - url/url64が欠落または無効、もしくはサポートされていないlanguage値です。 |
402 | Payment Required - アカウントのAIクレジットが枯渇しています(plan_credits_depleted_payment_required)。 |
403 | Forbidden - ソースで代替テキスト生成が有効になっていない、またはAPIキーがソースを所有していません。 |
500 | Internal Server Error - 画像を取得できなかったか、リクエストされたすべての言語で生成に失敗しました。 |
クレジットの使用
代替テキスト生成は、アカウントのAIクレジットに対して計上されます。402レスポンスは
アカウントのクレジットが枯渇していることを示します。残高が補充されると生成が再開されます。
例
curl -X GET "https://api.imgix.com/api/v1/generations/alt-text?url=https://assets.imgix.net/photo.jpg&language=en,es" \
-H "Authorization: Bearer YOUR_API_KEY"
# Response:
# {
# "alt_text": {
# "en": "a havanese puppy sitting on a wooden floor, looking up at the camera",
# "es": "un cachorro habanero sentado en un suelo de madera, mirando a la cámara"
# },
# "failed_languages": []
# }