Images - Generate
テキスト キャプションから画像のバッチを生成します
POST {endpoint}/openai/images/generations:submit?api-version=2023-10-01-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string (url) |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など: https://aoairesource.openai.azure.com。"aoairesource" を Azure OpenAI アカウント名に置き換えます)。 |
api-version
|
query | True |
string |
要求された API バージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
api-key | True |
string |
コグニティブ サービスの Azure OpenAI アカウント キーをここで指定します。 |
Operation-Id |
string (uuid) |
操作の状態モニターの ID。 Operation-Id ヘッダーが既存の操作と一致し、要求が前の要求と同じでない場合、400 Bad Request で失敗します。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
prompt | True |
string minLength: 1 |
目的のイメージのテキストの説明。 |
n |
integer (int32) minimum: 1 |
生成するイメージの数。 |
|
size |
大きさ |
||
user |
string |
エンド ユーザーを表す一意の識別子。不正使用の監視と検出に役立ちます。 |
応答
名前 | 型 | 説明 |
---|---|---|
202 Accepted |
受け入れ られる ヘッダー
|
|
Other Status Codes |
エラーが発生しました。 ヘッダー
|
セキュリティ
api-key
コグニティブ サービスの Azure OpenAI アカウント キーをここで指定します。
型:
apiKey
/:
header
例
Creating an image generation operation.
要求のサンプル
POST https://aoairesource.openai.azure.com/openai/images/generations:submit?api-version=2023-10-01-preview
{
"prompt": "An avocado chair",
"size": "512x512",
"n": 3
}
応答のサンプル
operation-location: https://aoairesource.openai.azure.com/openai/dalle/operations/images/f508bcf2-e651-4b4b-85a7-58ad77981ffa?api-version=2023-08-01-preview
x-ms-request-id: 29fd3fe5-ab2f-44e0-aefa-0dfe9bd1c03f
{
"id": "f508bcf2-e651-4b4b-85a7-58ad77981ffa",
"status": "notRunning"
}
定義
名前 | 説明 |
---|---|
Error |
エラー |
Error |
ErrorCode |
Error |
ErrorResponse |
Generate |
GenerateImagesCreation |
Generate |
GenerateImagesResponse |
Inner |
InnerError |
Inner |
InnerErrorCode |
Operation |
OperationState |
Size |
大きさ |
Error
エラー
名前 | 型 | 説明 |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
エラーの詳細 (使用可能な場合)。 |
innererror |
InnerError |
|
message |
string minLength: 1 |
このエラーのメッセージ。 |
target |
string |
エラーが発生した場所 (使用可能な場合)。 |
ErrorCode
ErrorCode
値 | 説明 |
---|---|
conflict |
要求された操作が現在のリソースの状態と競合しています。 |
contentFilter |
安全システムの結果、画像の生成に失敗しました。 |
fileImportFailed |
ファイルのインポートに失敗しました。 |
forbidden |
この操作は、現在のユーザー/API キーでは禁止されています。 |
internalFailure |
内部エラー。 再試行してください。 |
invalidPayload |
要求データがこの操作に対して無効です。 |
itemDoesAlreadyExist |
項目は既に存在します。 |
jsonlValidationFailed |
jsonl データの検証に失敗しました。 |
notFound |
リソースが見つかりません。 |
quotaExceeded |
クォータを超えました。 |
serviceUnavailable |
このサービスは現在使用できません。 |
tooManyRequests |
要求が多すぎます。 後で再試行してください。 |
unauthorized |
現在のユーザー/API キーは、操作に対して承認されていません。 |
unexpectedEntityState |
この操作は、現在のリソースの状態では実行できません。 |
ErrorResponse
ErrorResponse
名前 | 型 | 説明 |
---|---|---|
error |
エラー |
GenerateImagesCreation
GenerateImagesCreation
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
n |
integer (int32) minimum: 1 |
1 |
生成するイメージの数。 |
prompt |
string minLength: 1 |
目的のイメージのテキストの説明。 |
|
size | 1024x1024 |
大きさ |
|
user |
string |
エンド ユーザーを表す一意の識別子。不正使用の監視と検出に役立ちます。 |
GenerateImagesResponse
GenerateImagesResponse
名前 | 型 | 説明 |
---|---|---|
id |
string (uuid) |
後でその状態を照会するために使用できる非同期操作の ID。 |
status |
OperationState |
InnerError
InnerError
名前 | 型 | 説明 |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
InnerErrorCode
値 | 説明 |
---|---|
invalidPayload |
要求データがこの操作に対して無効です。 |
OperationState
OperationState
値 | 説明 |
---|---|
failed |
操作はエラーで処理を完了しており、それ以上使用することはできません。 |
notRunning |
この操作は、今後処理されるキューにまだありません。 |
running |
操作の処理が開始されました。 |
succeeded |
操作が正常に処理され、使用する準備が整いました。 |
Size
大きさ
値 | 説明 |
---|---|
1024x1024 |
生成されるイメージの目的のサイズは 1024 x 1024 ピクセルです。 |
256x256 |
生成されるイメージの目的のサイズは 256 x 256 ピクセルです。 |
512x512 |
生成されるイメージの目的のサイズは 512 x 512 ピクセルです。 |