Azure AI Foundry Models REST API v1 プレビュー リファレンスの Azure OpenAI について

この記事では、Azure OpenAI の推論 REST API エンドポイントについて詳しく説明します。

データ プレーン推論

この記事の残りの部分では、Azure OpenAI データ プレーン推論仕様の新しい v1 プレビュー API リリースについて説明します。 詳細については、 API ライフサイクル ガイドを参照してください。

最新の GA API リリースに関するドキュメントをお探しの場合は、最新の GA データ プレーン推論 API に関する記事を参照してください

音声を作成する

POST {endpoint}/openai/v1/audio/speech?api-version=preview

入力テキストから音声を生成します。

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

要求本文

Content-Type: マルチパート/フォームデータ

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

例示

例

指定されたテキストからオーディオを合成します。

POST {endpoint}/openai/v1/audio/speech?api-version=preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3",
 "model": "tts-1"
}

応答: 状態コード: 200

{
  "body": "101010101"
}

文字起こしを作成する

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

オーディオを入力言語に文字起こしします。

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

要求本文

Content-Type: マルチパート/フォームデータ

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

例示

例

指定された音声オーディオ データから、文字起こしされたテキストと関連するメタデータを取得します。

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "verbose_json"
}

応答: 状態コード: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

例

指定された音声オーディオ データから、文字起こしされたテキストと関連するメタデータを取得します。

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

応答: 状態コード: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

チャットの完了手続きを作成する

POST {endpoint}/openai/v1/chat/completions?api-version=preview

チャット入力候補を作成します。

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

要求本文

コンテンツ タイプ: アプリケーション/json

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

例示

例

指定されたプロンプト、パラメーターと、選択されたモデルに対する補完を作成します。

POST {endpoint}/openai/v1/chat/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

応答: 状態コード: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

入力候補を作成する

POST {endpoint}/openai/v1/completions?api-version=preview

入力候補を作成します。

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

要求本文

コンテンツ タイプ: アプリケーション/json

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

例示

例

指定されたプロンプト、パラメーターと、選択されたモデルに対する補完を作成します。

POST {endpoint}/openai/v1/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

応答: 状態コード: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

埋め込みの作成

POST {endpoint}/openai/v1/embeddings?api-version=preview

入力テキストを表す埋め込みベクトルを作成します。

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

要求本文

コンテンツ タイプ: アプリケーション/json

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

例示

例

指定されたプロンプトの埋め込みを返却します。

POST {endpoint}/openai/v1/embeddings?api-version=preview

{
 "model": "text-embedding-ada-002",
 "input": [
  "this is a test"
 ]
}

応答: 状態コード: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

画像生成 - 編集

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

特定の gpt-image-1 モデル デプロイのテキスト キャプションからイメージを編集します

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

要求本文

Content-Type: マルチパート/フォームデータ

応答

状態コード: 200

説明: OK

状態コード: 既定値

説明: エラーが発生しました。

イメージの作成

POST {endpoint}/openai/v1/images/generations?api-version=preview

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

要求本文

コンテンツ タイプ: アプリケーション/json

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

例示

例

プロンプトの指定を受けて画像を作成します。

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

応答: 状態コード: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

応答を作成する

POST {endpoint}/openai/v1/responses?api-version=preview

モデル応答を作成します。

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

要求本文

コンテンツ タイプ: アプリケーション/json

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

例示

例

モデル応答を作成する

POST {endpoint}/openai/v1/responses?api-version=preview

応答を取得する

GET {endpoint}/openai/v1/responses/{response_id}?api-version=preview

指定された ID を持つモデル応答を取得します。

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

応答の削除

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

ID で応答を削除します。

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

Listinputitems

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=preview

特定の応答の入力項目の一覧を返します。

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

ビデオ生成ジョブ - 作成

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

要求本文

コンテンツ タイプ: アプリケーション/json

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

例示

例

ビデオ生成ジョブを作成する

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

{
 "prompt": "A cat playing piano in a jazz bar.",
 "model": "video-gen-001"
}

応答: 状態コード: 200

{
  "body": {
    "id": "vidjob_1234567890",
    "object": "video_generation_job",
    "created": 1680000000,
    "status": "queued",
    "prompt": "A cat playing piano in a jazz bar.",
    "model": "video-gen-001"
  }
}

ビデオ生成ジョブ - リスト

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

ビデオ生成ジョブ - Get

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

ビデオ生成ジョブ - 削除

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

応答

状態コード: 204

説明: この要求に送信するコンテンツはありませんが、ヘッダーが役立つ場合があります。

状態コード: 既定値

説明: 予期しないエラー応答。

ビデオ生成 - Get

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

ビデオの生成 - サムネイルを取得する

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

ビデオ生成 - ビデオを取得する

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

URI パラメーター

リクエストヘッダー

トークン ベースの認証または API キーを使用します。 トークン ベースの認証を使用した認証が推奨され、より安全です。

応答

状態コード: 200

説明: 要求は成功しました。

状態コード: 既定値

説明: 予期しないエラー応答。

コンポーネント

オーディオタスクラベル

使用可能なオーディオ操作応答に使用できる記述子を定義します。

AzureAIFoundryModelsApiVersion

AzureAudioTranscriptionResponse

音声をテキストに文字起こしする操作の結果情報。

AzureChatCompletionResponseMessage

Azure OpenAI サービスでのチャット完了応答メッセージの拡張応答モデル コンポーネント。 このモデルでは、意図、引用、および実行される検索拡張生成に関連するその他の情報のために On Your Data 機能によって使用されるチャット メッセージ コンテキストのサポートが追加されます。

AzureChatCompletionStreamResponseDelta

Azure OpenAI サービスでのストリーミング チャット応答メッセージの拡張応答モデル。 このモデルでは、意図、引用、および実行される検索拡張生成に関連するその他の情報のために On Your Data 機能によって使用されるチャット メッセージ コンテキストのサポートが追加されます。

AzureChatDataSource

1 つの Azure OpenAI チャット データ ソースの構成データの表現。 これは、応答動作を拡張するために Azure OpenAI チャット拡張機能を使用する必要があるチャット補完要求によって使用されます。 この構成の使用は、Azure OpenAI とのみ互換性があります。

AzureChatDataSource の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

Azureチャットデータソースアクセストークン認証オプション

AzureChatDataSourceApiKeyAuthenticationOptions (Azure Chat データソース API キー認証オプション)

AzureChatDataSourceAuthenticationOptions

AzureChatDataSourceAuthenticationOptions の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

AzureChatDataSourceAuthenticationOptionsType

AzureChatデータソース接続文字列認証オプション

AzureChatDataSourceDeploymentNameVectorizationSource

Azure OpenAI 埋め込みモデルデプロイに対して内部サービス呼び出しを行うベクター化ソースを表します。 エンドポイントベースのベクター化ソースとは異なり、デプロイ名ベースのベクター化ソースは同じ Azure OpenAI リソースの一部である必要がありますが、プライベート ネットワークでも使用できます。

AzureチャットデータソースエンコードされたAPIキー認証オプション

アジュールチャットデータソースエンドポイントベクトル化ソース

Azure OpenAI 埋め込みモデルデプロイに対してパブリック サービス呼び出しを行うベクター化ソースを表します。

Azureチャットデータソース統合ベクトル化ソース

サポートする検索リソース内で定義されている統合ベクター化ソースを表します。

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

AzureChatDataSourceModelIdVectorizationSource

検索サービス モデル ID に基づいてサービス呼び出しを行うベクター化ソースを表します。 現在、このソースの種類は Elasticsearch でのみサポートされています。

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Azureチャットデータソースタイプ

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions（アジュールチャットデータソースユーザーアサインドマネージドアイデンティティオーセンティケーションオプションズ）

Azureチャットデータソースユーザーネームおよびパスワード認証オプション

Azureチャットデータソースベクトル化ソース

データ ソースとの埋め込みリソースとして使用できるデータ ベクター化ソースの表現。

AzureChatDataSourceVectorizationSource の識別子

このコンポーネントでは、プロパティ type を使用して、さまざまな型を区別します。

AzureChatDataSourceVectorizationSourceType

AzureChatMessageContext

拡張機能の動作を使用するときに Azure OpenAI サービスによって生成される、チャット完了応答メッセージに追加された追加のプロパティ。 これには、On Your Data 機能の意図と引用情報が含まれます。

Azureコンテンツフィルターブロックリスト結果

構成されたカスタム ブロックリストの true/false フィルター結果のコレクション。

AzureContentFilterCompletionTextSpan

Azure OpenAI コンテンツフィルターの結果で使用される補完テキストの範囲の表現。

AzureContentFilterCompletionTextSpanDetectionResult

Azureコンテンツフィルタ検出結果

コンテンツが検出されたかどうか、およびコンテンツがフィルター処理されたかどうかを示すラベル付きのコンテンツ フィルター結果アイテム。

Azureコンテンツフィルター画像プロンプト結果

イメージ生成操作の入力要求コンテンツのコンテンツ フィルター結果。

Azureコンテンツフィルター画像応答結果

画像生成操作の出力応答コンテンツのコンテンツ フィルター結果。

Azureコンテンツフィルター結果選択用

生成 AI システムによって生成された 1 つの応答項目のコンテンツ フィルター結果。

Azureコンテンツフィルター結果フォームプロンプト

生成 AI システムへの単一の入力プロンプト項目に関連付けられたコンテンツ フィルターの結果。

AzureContentFilterSeverityResult

カテゴリのコンテンツ フィルター構成に対して評価された、コンテンツがフィルター処理されたかどうか、およびコンテンツの定性的な重大度レベルを示すラベル付きのコンテンツ フィルター結果アイテム。

AzureCosmosDBチャットデータソース

Azure CosmosDB リソースを使用するデータ ソース構成を表します。

AzureCreateChatCompletionRequest

Azure OpenAI サービスに対するチャット完了の拡張要求モデル。 これにより、On Your Data 機能のデータ ソースを提供する機能が追加されます。

AzureCreateChatCompletionResponse

Azure OpenAI サービスの拡張最上位レベルのチャット完了応答モデル。 このモデルでは、プロンプト入力用の責任ある AI コンテンツ フィルター注釈が追加されます。

AzureCreateChatCompletionStreamResponse

アジュールクリエイトコンプレーションリクエスト

AzureCreateCompletionResponse

API からの入力候補応答を表します。 注: (チャット エンドポイントとは異なり) ストリーム応答オブジェクトと非ストリーム応答オブジェクトはどちらも同じシェイプを共有します。

AzureCreateEmbeddingRequest (アジュール・クリエイト・エンベディング・リクエスト)

AzureCreateImageEditRequestMultiPart

Azure画像作成リクエスト

AzureCreateResponse

AzureCreateSpeechRequestMultiPart (アジュール クリエイト スピーチ リクエスト マルチパート)

テキスト読み上げ操作の動作を制御する要求オプションの表現。

AzureCreateTranscriptionRequestMultiPart

オーディオ文字起こし要求の構成情報。

Azureエラーレスポンス

AzureImage

AzureImagesResponse

AzureOpenAIVideoGenerationErrorResponse

AzureResponse

AzureSearchChatDataSource

Azure Search リソースを使用するデータ ソース構成を表します。

Azureユーザーセキュリティコンテキスト (AzureUserSecurityContext)

ユーザー セキュリティ コンテキストには、アプリケーション自体と、アプリケーションと対話するエンド ユーザーを記述する複数のパラメーターが含まれています。 これらのフィールドは、包括的な AI アプリケーション保護アプローチを提供することで、セキュリティ運用チームがセキュリティ インシデントを調査し軽減するのを支援します。 Microsoft Defender for Cloud を使用した AI アプリケーションの保護に関する詳細については、こちらを参照してください。

AzureVideoGenerationError

型: オブジェクト

チャット完了メッセージツール呼び出しアイテム

関数呼び出しなど、モデルによって生成されるツール呼び出し。

以下から成る配列: OpenAI.ChatCompletionMessageToolCall

CompletionChoice

動画生成リクエストの作成

ElasticsearchChatDataSource

ジョブステータス

MongoDBChatDataSource