Azure OpenAI Service の REST API リファレンス

  • [アーティクル]

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

認証

Azure OpenAI には、2 つの認証方法が用意されています。 API キーまたは Microsoft Entra ID を使用できます。

  • API キー認証: この種類の認証の場合、すべての API 要求で、api-key HTTP ヘッダーに API キーを含める必要があります。 クイック スタートに、この種類の認証を使用して呼び出しを行う方法に関するガイダンスが用意されています。

  • Microsoft Entra ID 認証: Microsoft Entra トークンを使用して API 呼び出しを認証できます。 認証トークンは、Authorization ヘッダーとして要求に含まれます。 指定するトークンの前に Bearer を付ける必要があります (例: Bearer YOUR_AUTH_TOKEN)。 Microsoft Entra ID を使用した認証に関する攻略ガイドをお読みください。

REST API のバージョン管理

サービス API は、api-version クエリ パラメーターを使用してバージョン管理されます。 すべてのバージョンは、YYYY-MM-DD 日付構造に従います。 たとえば、次のように入力します。

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/completions?api-version=2024-02-01

入力候補

入力候補操作では、入力したプロンプトに基づいて 1 つ以上の予測入力候補がモデルによって生成されます。 サービスでは、それぞれの位置で代替トークンの確率を返すこともできます。

入力候補の作成

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/completions?api-version={api-version}

パス パラメーター

パラメーター Type 必須 説明
your-resource-name string 必須 Azure OpenAI リソースの名前。
deployment-id string 必須 モデルのデプロイ時に選択したデプロイ名。
api-version string 必須 この操作に使用する API バージョン。 これは、YYYY-MM-DD 形式に従います。

サポートされているバージョン

要求本文

パラメーター Type 必須 Default 説明
prompt 文字列または配列 省略可能 <\|endoftext\|> 文字列、または文字列の配列としてエンコードされた、入力候補を生成するプロンプト。 <\|endoftext\|> はトレーニング中にモデルが確認するドキュメント区切り記号であるため、プロンプトを指定しない場合、モデルは新しいドキュメントの先頭からの場合と同様に生成します。
max_tokens integer 省略可能 16 入力候補に生成するトークンの最大数。 プロンプトのトークン数と max_tokens の合計は、モデルのコンテキスト長を超えることはできません。 ほとんどのモデルのコンテキスト長は 2048 トークンです (4096 をサポートする最新のモデルを除く)。
temperature number オプション 1 使用するサンプリング温度 (0 から 2)。 値が大きいほど、モデルはより多くのリスクを負います。 よりクリエイティブなアプリケーションの場合は 0.9、明確に定義された回答の場合は 0 (argmax sampling) をお試しください。 一般的に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
top_p number オプション 1 核サンプリングと呼ばれる、温度によるサンプリングの代替で、モデルはで top_p 確率質量を持つトークンの結果が考慮されます。 したがって、0.1 は、上位 10% の確率質量を含むトークンのみが考慮されることを意味します。 一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
logit_bias map オプション null 指定したトークンが入力候補に表示される可能性を変更します。 トークン (GPT トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする json オブジェクトを受け入れます。 このトークナイザー ツール (GPT-2 と GPT-3 の両方で機能) を使用して、テキストをトークン ID に変換できます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの選択が禁止されるか、または排他的になります。 たとえば、{"50256": -100} を渡して、<|endoftext|> トークンが生成されないようにすることができます。
user string 省略可能 エンド ユーザーを表す一意の識別子。不正使用の監視と検出に役立ちます
n 整数 (integer) 省略可能 1 プロンプトごとに生成する入力候補の数。 注: このパラメーターにより多くの入力候補が生成されるため、トークン クォータがすぐに消費される可能性があります。 慎重に使用し、max_tokens と stop の設定が合理的であることを確認してください。
stream boolean 省略可能 False 部分的な進行状況をストリーム バックするかどうか。 設定した場合、トークンは、使用可能になると data-only server-sent イベントとして送信され、ストリームは data: [DONE] メッセージで終了します。
logprobs integer 省略可能 null logprobs の最も可能性の高いトークンと、選択したトークンのログ確率を含めます。 たとえば、logprobs が 10 の場合、API は可能性が最も高い 10 個のトークンの一覧を返します。 API は、常にサンプリングされたトークンの logprob を返します。そのため、応答には、最大 logprobs+ 1 要素が含まれている場合があります。 このパラメーターは gpt-35-turbo では使用できません。
suffix string 省略可能 null 挿入されたテキストの入力候補の後に付加されるサフィックス。
echo boolean 省略可能 False 入力候補に加えてプロンプトをエコーバックします。 このパラメーターは gpt-35-turbo では使用できません。
stop 文字列または配列 オプション null API がそれ以上のトークンの生成を停止する、最大 4 つのシーケンス。 返されるテキストに停止シーケンスは含まれません。 GPT-4 Turbo with Vision では、最大 2 つのシーケンスがサポートされています。
presence_penalty 数値 オプション 0 -2.0 から 2.0 の数値。 正の値を指定すると、これまでのテキストに出現するかどうかに基づいて新しいトークンにペナルティが課せられ、モデルが新しいトピックを扱う可能性が高まります。
frequency_penalty number オプション 0 -2.0 から 2.0 の数値。 値を正にすると、これまでのテキストに存在する頻度に基づいて新しいトークンにペナルティが課せられ、モデルが同じ行を逐語的に繰り返す可能性が低下します。
best_of 整数 (integer) 省略可能 1 サーバー側 best_of 入力候補を生成し、"best" (トークンあたりのログ確率が最低のもの) を返します。 結果をストリーミングすることはできません。 n と共に使用する場合、best_of は入力候補の数を制御し、n は返す数を指定します。best_of は n より大きくする必要があります。 注: このパラメーターにより多くの入力候補が生成されるため、トークン クォータがすぐに消費される可能性があります。 慎重に使用し、max_tokens と stop の設定が合理的であることを確認してください。 このパラメーターは gpt-35-turbo では使用できません。

要求の例

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/completions?api-version=2024-02-01\
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d "{
  \"prompt\": \"Once upon a time\",
  \"max_tokens\": 5
}"

応答の例

{
    "id": "cmpl-4kGh7iXtjW4lc9eGhff6Hp8C7btdQ",
    "object": "text_completion",
    "created": 1646932609,
    "model": "ada",
    "choices": [
        {
            "text": ", a dark line crossed",
            "index": 0,
            "logprobs": null,
            "finish_reason": "length"
        }
    ]
}

応答の例では、finish_reason と stop は等しくなります。 finish_reason と content_filter が等しい場合は、コンテンツのフィルター処理のガイドを参照して、これが発生している理由を理解してください。

埋め込み

機械学習モデルやその他のアルゴリズムで簡単に使用できる、特定の入力のベクター表現を取得します。

Note

OpenAI では現在、text-embedding-ada-002 を使用して、より多くの配列入力を許可しています。 Azure OpenAI は現在、text-embedding-ada-002 (Version 2) に対して最大 16 個の入力配列をサポートしています。 どちらの場合も、このモデルでは API 要求あたりの最大入力トークン制限を 8191 未満に抑える必要があります。

埋め込みの作成

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/embeddings?api-version={api-version}

パス パラメーター

パラメーター Type 必須 説明
your-resource-name string 必須 Azure OpenAI リソースの名前。
deployment-id string 必須 モデル デプロイの名前。 呼び出しを行うためにはまずモデルをデプロイすることが必要です。
api-version string 必須 この操作に使用する API バージョン。 これは、YYYY-MM-DD 形式に従います。

サポートされているバージョン

要求本文

パラメーター Type 必須 Default 説明
input 文字列または配列 はい 該当なし 配列または文字列としてエンコードされた、埋め込みを取得する入力テキスト。 入力トークンの数は、使用しているモデルによって異なります。 text-embedding-ada-002 (Version 2) のみが配列入力をサポートしています。
user string No [Null] エンドユーザーを表す一意の識別子。 Azure OpenAI による不正使用の監視と検出に役立ちます。 PII 識別子を渡さないでください。代わりに GUID などの仮名化された値を使用してください
encoding_format string いいえ float 埋め込みを返す形式。 float または base64 を指定できます。 既定値は float です。

[2024-03-01-preview で追加されました]。
dimensions integer いいえ 結果として出力される埋め込みに必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。

[2024-03-01-preview で追加されました]

要求の例

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings?api-version=2024-02-01 \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d "{\"input\": \"The food was delicious and the waiter...\"}"

応答の例

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.018990106880664825,
        -0.0073809814639389515,
        .... (1024 floats total for ada)
        0.021276434883475304,
      ],
      "index": 0
    }
  ],
  "model": "text-similarity-babbage:001"
}

チャット入力候補

GPT-35-Turbo と GPT-4 モデルを使用して、チャット メッセージの入力候補を作成します。

チャット入力候補を作成する

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/chat/completions?api-version={api-version}

パス パラメーター

パラメーター Type 必須 説明
your-resource-name string 必須 Azure OpenAI リソースの名前。
deployment-id string 必須 モデル デプロイの名前。 呼び出しを行うためにはまずモデルをデプロイすることが必要です。
api-version string 必須 この操作に使用する API バージョン。 これは YYYY-MM-DD または YYYY-MM-DD-preview 形式に従います。

サポートされているバージョン

要求本文

要求本文は一連のメッセージで構成されます。 モデルでは、以前のメッセージをコンテキストとして使用して、最後のメッセージへの応答を生成します。

パラメーター Type 必須 Default 説明
messages array はい 該当なし このチャット完了要求に関連付けられている一連のメッセージ。 会話には以前のメッセージを含める必要があります。 各メッセージには role と content があります。
role string はい 該当なし 現在のメッセージを提供しているユーザーを示します。 system、user、assistant、tool、または function にできます。
content 文字列または配列 はい 該当なし メッセージのコンテンツ。 これは、Vision 対応のシナリオの場合を除き、文字列である必要があります。 最新の API バージョンで GPT-4 Turbo with Vision モデルを使用し、user メッセージの一部である場合は、各項目がテキストかイメージを表す content 構造体の配列にする必要があります。
  • text: 入力テキストは、次のプロパティを持つ構造体として表されます。
    • type = "text"
    • text = 入力テキスト
  • images: 入力イメージは、次のプロパティを持つ構造体として表されます。
    • type = "image_url"
    • image_url = 次のプロパティを持つ構造体。
      • url = イメージ URL
      • (省略可能) detail = high、low、または auto
contentPart object いいえ 該当なし ユーザーのマルチモーダル メッセージの一部。 テキストの種類または画像の種類を指定できます。 テキストの場合は、テキスト文字列になります。 画像の場合は、contentPartImage オブジェクトになります。
contentPartImage object いいえ 該当なし ユーザーがアップロードした画像を表します。 url プロパティがあります。これは、画像の URL または base 64 でエンコードされた画像データです。 auto、low、または high にできる detail プロパティもあります。
enhancements object いいえ 該当なし チャットで要求された Vision 拡張機能を表します。 grounding と ocr のプロパティがあり、それぞれにブール型の enabled プロパティがあります。 これらを使用して、OCR サービスや物体検出/グラウンディング サービスを要求します [このプレビュー パラメータは、2024-02-01 GA API では使用できず、2024-03-01-preview 以降、プレビュー API で利用できなくなります]
dataSources object いいえ 該当なし 追加のリソース データを表します。 Vision 拡張機能には、Computer Vision リソース データが必要です。 "AzureComputerVision" にする必要がある type プロパティと、endpoint および key プロパティを持つ parameters プロパティがあります。 これらの文字列は、Computer Vision リソースのエンドポイント URL とアクセス キーに設定する必要があります。

要求の例

テキストのみのチャット

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-02-01 \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{"messages":[{"role": "system", "content": "You are a helpful assistant."},{"role": "user", "content": "Does Azure OpenAI support customer managed keys?"},{"role": "assistant", "content": "Yes, customer managed keys are supported by Azure OpenAI."},{"role": "user", "content": "Do other Azure AI services support this too?"}]}'

Vision を使用したチャット

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2023-12-01-preview \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{"messages":[{"role":"system","content":"You are a helpful assistant."},{"role":"user","content":[{"type":"text","text":"Describe this picture:"},{ "type": "image_url", "image_url": { "url": "https://learn.microsoft.com/azure/ai-services/computer-vision/media/quickstarts/presentation.png", "detail": "high" } }]}]}'

Vision を使用した拡張チャット

  • GPT-4 Turbo GA モデルgpt-4バージョン:turbo-2024-04-09 ではサポートされていません
  • 2024-02-01 と 2024-04-01-preview 以降の API リリースではサポートされていません。
curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/extensions/chat/completions?api-version=2023-12-01-preview \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{"enhancements":{"ocr":{"enabled":true},"grounding":{"enabled":true}},"dataSources":[{"type":"AzureComputerVision","parameters":{"endpoint":" <Computer Vision Resource Endpoint> ","key":"<Computer Vision Resource Key>"}}],"messages":[{"role":"system","content":"You are a helpful assistant."},{"role":"user","content":[{"type":"text","text":"Describe this picture:"},{"type":"image_url","image_url":"https://learn.microsoft.com/azure/ai-services/computer-vision/media/quickstarts/presentation.png"}]}]}'

応答の例

{
    "id": "chatcmpl-6v7mkQj980V1yBec6ETrKPRqFjNw9",
    "object": "chat.completion",
    "created": 1679072642,
    "model": "gpt-35-turbo",
    "usage":
    {
        "prompt_tokens": 58,
        "completion_tokens": 68,
        "total_tokens": 126
    },
    "choices":
    [
        {
            "message":
            {
                "role": "assistant",
                "content": "Yes, other Azure AI services also support customer managed keys.
                    Azure AI services offer multiple options for customers to manage keys, such as
                    using Azure Key Vault, customer-managed keys in Azure Key Vault or
                    customer-managed keys through Azure Storage service. This helps customers ensure
                    that their data is secure and access to their services is controlled."
            },
            "finish_reason": "stop",
            "index": 0
        }
    ]
}

読みやすいように出力形式が調整されています。実際の出力は改行のない単一のテキスト ブロックです。

応答の例では、finish_reason と stop は等しくなります。 finish_reason と content_filter が等しい場合は、コンテンツのフィルター処理のガイドを参照して、これが発生している理由を理解してください。

重要

API の 2023-12-01-preview バージョンのリリースに伴い、functions および function_call パラメーターは非推奨になりました。 functions に置き換わるのは tools パラメーターです。 function_call に置き換わるのは tool_choice パラメーターです。 2023-12-01-preview の一部として導入された平行関数呼び出しは、gpt-35-turbo (1106) および gpt-4 (1106-プレビュー、別名 GPT-4 Turbo Preview) でのみサポートされています。

パラメーター Type 必須 Default 説明
messages array 必須 このチャット完了要求に関連付けられたコンテキスト メッセージのコレクション。 一般的な使用法は、アシスタントの動作に関する指示を提供するシステム ロールのチャット メッセージで始まり、その後、ユーザー ロールとアシスタント ロールの間でメッセージが交互に送信されます。
temperature 数値 オプション 1 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
n integer 省略可能 1 入力メッセージごとに生成するチャット入力候補の選択肢の数。
stream boolean 省略可能 false 設定すると、ChatGPT と同様に部分的なメッセージ デルタが送信されます。 トークンは、使用可能になると data-only server-sent イベントとして送信され、ストリームは data: [DONE] メッセージで終了します。
stop 文字列または配列 オプション null API がそれ以上のトークンの生成を停止する、最大 4 つのシーケンス。
max_tokens 整数 (integer) 省略可能 inf 生成された回答に許可されるトークンの最大数。 既定では、モデルが返すことができるトークンの数は (4096 - プロンプト トークン) になります。
presence_penalty number オプション 0 -2.0 から 2.0 の数値。 正の値を指定すると、これまでのテキストに出現するかどうかに基づいて新しいトークンにペナルティが課せられ、モデルが新しいトピックを扱う可能性が高まります。
frequency_penalty number オプション 0 -2.0 から 2.0 の数値。 値を正にすると、これまでのテキストに存在する頻度に基づいて新しいトークンにペナルティが課せられ、モデルが同じ行を逐語的に繰り返す可能性が低下します。
logit_bias object 省略可能 null 指定したトークンが入力候補に表示される可能性を変更します。 トークン (トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする json オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの選択が禁止されるか、または排他的になります。
user string 省略可能 エンド ユーザーを表す一意の識別子。これは、Azure OpenAI が不正使用を監視および検出するのに役立ちます。
function_call オプション [Deprecated in 2023-12-01-preview replacement parameter is tools_choice]モデルが関数呼び出しにどのように応答するかを制御します。 "none" は、モデルが関数を呼び出さず、エンドユーザーに応答することを意味します。 auto は、モデルがエンド ユーザーまたは関数の呼び出しのどちらかを選択できることを意味します。 {"name": "my_function"} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。 関数が存在しない場合は、"none" が既定値です。 関数が存在する場合は、auto が既定値です。 このパラメーターには API バージョン 2023-07-01-preview が必要です
functions FunctionDefinition[] 省略可能 [Deprecated in 2023-12-01-preview replacement paremeter is tools]モデルで JSON 入力を生成できる関数の一覧。 このパラメーターには API バージョン 2023-07-01-preview が必要です
tools string (ツールの種類。function のみがサポートされています) 省略可能 モデルで呼び出すことができるツールの一覧。 現在のところ、関数のみがツールとしてサポートされています。 これを使用して、モデルで JSON 入力を生成できる関数の一覧を提供します。 このパラメーターには API バージョン 2023-12-01-preview が必要です
tool_choice 文字列またはオブジェクト 省略可能 関数が存在しない場合は、none が既定値です。 関数が存在する場合は、auto が既定値です。 モデルによって呼び出される関数を制御します (そのような関数がある場合)。 none は、モデルによって関数が呼び出されることはなく、代わりにメッセージが生成されます。 auto の場合、メッセージを生成するか、関数を呼び出すか、モデルで選択できます。 {"type: "function", "function": {"name": "my_function"}} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。 このパラメーターには API バージョン 2023-12-01-preview 以降が必要です。

ChatMessage

チャット完了操作内の単一のロール属性メッセージ。

名前 種類 説明
コンテンツ string このメッセージ ペイロードに関連付けられたテキスト。
function_call FunctionCall モデルによって生成された、呼び出される関数の名前と引数。
name string このメッセージの作成者の name。 ロールが function の場合、name は必須であり、応答が content にある関数の名前である必要があります。 長さは最大で 64 文字で、a から z、A から Z、0 から 9、およびアンダースコアを含めることができます。
role ChatRole このメッセージ ペイロードに関連付けられたロール

ChatRole

チャット完了操作内のメッセージの意図された目的の説明。

名前 種類 説明
assistant string システム指示のユーザー入力に対する応答を提供するロール。
関数 string チャット完了の関数結果を提供するロール。
システム string アシスタントの動作を指示または設定するロール。
ユーザー string チャット完了の入力を提供するロール。

関数

これは、API バージョン 2023-12-01-preview で追加された tools パラメーターと共に使用されます。

名前 種類 説明
description string 関数を呼び出す状況と方法を選択する目的でモデルにより使用される、関数の機能の説明
name string 呼び出される関数の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です
parameters object 関数が受け取るパラメーター。JSON スキーマ オブジェクトとして記述されます。 形式に関するドキュメントが必要な場合、「JSON スキーマ参照」を参照してください。

FunctionCall-Deprecated

モデルによって生成された、呼び出される関数の名前と引数。 これには API バージョンが必要です 2023-07-01-preview

名前 種類 説明
引数 string モデルによって JSON 形式で生成された、関数を呼び出すための引数。 モデルによって常に有効な JSON が生成されるとは限りません。関数スキーマで定義されていないパラメーターが作成される場合もあります。 関数を呼び出す前に、コード内の引数を検証します。
name string 呼び出す関数の名前。

FunctionDefinition-Deprecated

チャットが完了すると、一致するユーザー入力に応答して呼び出すことができる、呼び出し元指定の関数の定義。 これには API バージョンが必要です 2023-07-01-preview

名前 種類 説明
description string 関数の動作の説明。 モデルで関数を選択し、そのパラメーターを解釈するときにこの説明が使用されます。
name string 呼び出される関数の名前。
parameters 関数が受け取るパラメーター。JSON スキーマ オブジェクトとして記述されます。

入力候補の拡張機能

このセクションのドキュメントは移動しています。 代わりに、Azure OpenAI On Your Data リファレンス ドキュメントを参照してください。

イメージの生成

生成されたイメージを要求する (DALL-E 3)

テキスト キャプションから画像のバッチを生成して取得します。

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/images/generations?api-version={api-version}

パス パラメーター

パラメーター Type 必須 説明
your-resource-name string 必須 Azure OpenAI リソースの名前。
deployment-id string 必須 MyDalle3 などの DALL-E 3 モデル デプロイの名前。 DALL-E 3 モデルをデプロイしてから呼び出しを実行する必要があります。
api-version string 必須 この操作に使用する API バージョン。 これは、YYYY-MM-DD 形式に従います。

サポートされているバージョン

要求本文

パラメーター Type 必須 Default 説明
prompt string 必須 目的のイメージのテキストの説明。 最大長は 4000 文字です。
n integer 省略可能 1 生成するイメージの数。 DALL-E 3 では、n=1 のみがサポートされています。
size string 省略可能 1024x1024 生成されたイメージのサイズ。 1792x1024、1024x1024、1024x1792 のいずれかである必要があります。
quality string 省略可能 standard 生成されたイメージの品質。 hd または standard にする必要があります。
response_format string 省略可能 url 生成されたイメージが返される形式は url (イメージを指す URL) または b64_json (JSON 形式の Base64 バイト コード) にする必要があります。
style string 省略可能 vivid 生成されたイメージのスタイル。 natural または vivid にする必要があります (超現実的/劇的なイメージの場合)。
user string 省略可能 エンド ユーザーを表す一意の識別子。これは不正使用を監視および検出するのに役立ちます。

要求の例

curl -X POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/images/generations?api-version=2023-12-01-preview \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{
    "prompt": "An avocado chair",
    "size": "1024x1024",
    "n": 1,
    "quality": "hd", 
    "style": "vivid"
  }'

応答の例

この操作によって、202 状態コードと、操作の ID と状態を含む GenerateImagesResponse JSON オブジェクトが返されます。

{ 
    "created": 1698116662, 
    "data": [ 
        { 
            "url": "url to the image", 
            "revised_prompt": "the actual prompt that was used" 
        }, 
        { 
            "url": "url to the image" 
        },
        ...
    ]
}

生成されたイメージを要求する (DALL-E 2 プレビュー)

テキスト キャプションから画像のバッチを生成します。

POST https://{your-resource-name}.openai.azure.com/openai/images/generations:submit?api-version={api-version}

パス パラメーター

パラメーター Type 必須 説明
your-resource-name string 必須 Azure OpenAI リソースの名前。
api-version string 必須 この操作に使用する API バージョン。 これは、YYYY-MM-DD 形式に従います。

サポートされているバージョン

要求本文

パラメーター Type 必須 Default 説明
prompt string 必須 目的のイメージのテキストの説明。 最大長は 1000 文字です。
n 整数 (integer) 省略可能 1 生成するイメージの数。 1 から 5 の間である必要があります。
size string 省略可能 1,024 x 1,024 生成されたイメージのサイズ。 256x256、512x512、1024x1024 のいずれかである必要があります。

要求の例

curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/images/generations:submit?api-version=2023-06-01-preview \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{
"prompt": "An avocado chair",
"size": "512x512",
"n": 3
}'

応答の例

この操作によって、202 状態コードと、操作の ID と状態を含む GenerateImagesResponse JSON オブジェクトが返されます。

{
  "id": "f508bcf2-e651-4b4b-85a7-58ad77981ffa",
  "status": "notRunning"
}

生成されたイメージの結果を取得する (DALL-E 2 プレビュー)

この API を使用して、イメージ生成操作の結果を取得します。 イメージの生成は現在、api-version=2023-06-01-preview でのみ使用できます。

GET https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version={api-version}

パス パラメーター

パラメーター Type 必須 説明
your-resource-name string 必須 Azure OpenAI リソースの名前。
operation-id string 必須 元のイメージ生成要求を識別する GUID。

サポートされているバージョン

要求の例

curl -X GET "https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version=2023-06-01-preview"
-H "Content-Type: application/json"
-H "Api-Key: {api key}"

応答の例

この操作が成功すると、200 状態コードと OperationResponse JSON オブジェクトが返されます。 status フィールドは "notRunning" (タスクはキューに登録されているがまだ開始されていない)、"running"、"succeeded"、"canceled" (タスクがタイムアウト)、"failed" または "deleted" になります。 succeeded 状態は、生成されたイメージが特定の URL でダウンロード可能であることを示します。 複数のイメージが生成された場合、それらの URL はすべて result.data フィールドに返されます。

{
  "created": 1685064331,
  "expires": 1685150737,
  "id": "4b755937-3173-4b49-bf3f-da6702a3971a",
  "result": {
    "data": [
      {
        "url": "<URL_TO_IMAGE>"
      },
      {
        "url": "<URL_TO_NEXT_IMAGE>"
      },
      ...
    ]
  },
  "status": "succeeded"
}

生成されたイメージをサーバーから削除する (DALL-E 2 プレビュー)

要求によって返される操作 ID を使用して、対応するイメージを Azure サーバーから削除することができます。 生成されたイメージは、既定では 24 時間後に自動的に削除されますが、必要に応じて、より早く削除をトリガーできます。

DELETE https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version={api-version}

パス パラメーター

パラメーター Type 必須 説明
your-resource-name string 必須 Azure OpenAI リソースの名前。
operation-id string 必須 元のイメージ生成要求を識別する GUID。

サポートされているバージョン

要求の例

curl -X DELETE "https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version=2023-06-01-preview"
-H "Content-Type: application/json"
-H "Api-Key: {api key}"

Response

操作が成功すると、204 状態コードが返されます。 この API は、操作が終了状態 (running ではなく) の場合にのみ成功します。

音声テキスト変換

音声テキスト変換の文字起こしまたは音声翻訳には、Azure OpenAI Service の Whisper モデルを使用できます。 Whisper モデルの使用の詳細については、クイックスタートと Whisper モデルの概要を参照してください。

音声からテキストへの文字起こしを要求する

オーディオ ファイルを文字起こしします。

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/audio/transcriptions?api-version={api-version}

パス パラメーター

パラメーター Type 必須 説明
your-resource-name string 必須 Azure OpenAI リソースの名前。
deployment-id string 必須 MyWhisperDeployment などの Whisper モデル デプロイの名前。 呼び出しを行うにはまず Whisper モデルをデプロイする必要があります。
api-version string 必須 この操作に使用する API バージョン。 この値は YYYY-MM-DD 形式に従います。

サポートされているバージョン

要求本文

パラメーター Type 必須 Default 説明
file file はい 該当なし flac、mp3、mp4、mpeg、mpga、m4a、ogg、wav、または webm のいずれかの形式で文字起こしするオーディオ ファイル オブジェクト (ファイル名ではありません)。

Azure OpenAI Service の Whisper モデルのファイル サイズ上限は 25 MB です。 25 MB より大きいファイルを文字起こしする必要がある場合は、それをチャンクに分割します。 または、Azure AI 音声のバッチ文字起こし API を使用することもできます。

GitHub の Azure AI 音声 SDK リポジトリからサンプル オーディオ ファイルを入手できます。
language string No [Null] fr などの入力オーディオの言語。 入力言語を ISO-639-1 形式で提供すると、精度と待機時間が向上します。

サポートされている言語の一覧については、OpenAI のドキュメントを参照してください。
prompt string No [Null] モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトはオーディオ言語と一致する必要があります。

ユース ケースの例を含むプロンプトの詳細については、OpenAI のドキュメントを参照してください。
response_format string いいえ json 次のいずれかのオプションのトランスクリプト出力の形式: json、text、srt、verbose_json、vtt。

既定値は json です。
temperature 数値 いいえ 0 0 から 1 の間のサンプリング温度。

0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルはログ確率を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。

既定値は0です。
timestamp_granularities 配列 省略可能 セグメント この文字起こしに入力するタイムスタンプの詳細度。 タイムスタンプの詳細度を使用するには response_format を verbose_json に設定する必要があります。 オプションの word と segment は一方または両方がサポートされます。 注: セグメント タイムスタンプに追加の待ち時間はありませんが、単語のタイムスタンプを生成すると追加の待ち時間が発生します。 [2024-04-01-preview で追加]

要求の例

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/audio/transcriptions?api-version=2023-09-01-preview \
  -H "Content-Type: multipart/form-data" \
  -H "api-key: $YOUR_API_KEY" \
  -F file="@./YOUR_AUDIO_FILE_NAME.wav" \
  -F "language=en" \
  -F "prompt=The transcript contains zoology terms and geographical locations." \
  -F "temperature=0" \
  -F "response_format=srt"

応答の例

1
00:00:00,960 --> 00:00:07,680
The ocelot, Lepardus paradalis, is a small wild cat native to the southwestern United States,

2
00:00:07,680 --> 00:00:13,520
Mexico, and Central and South America. This medium-sized cat is characterized by

3
00:00:13,520 --> 00:00:18,960
solid black spots and streaks on its coat, round ears, and white neck and undersides.

4
00:00:19,760 --> 00:00:27,840
It weighs between 8 and 15.5 kilograms, 18 and 34 pounds, and reaches 40 to 50 centimeters

5
00:00:27,840 --> 00:00:34,560
16 to 20 inches at the shoulders. It was first described by Carl Linnaeus in 1758.

6
00:00:35,360 --> 00:00:42,880
Two subspecies are recognized, L. p. paradalis and L. p. mitis. Typically active during twilight

7
00:00:42,880 --> 00:00:48,480
and at night, the ocelot tends to be solitary and territorial. It is efficient at climbing,

8
00:00:48,480 --> 00:00:54,480
leaping, and swimming. It preys on small terrestrial mammals such as armadillo, opossum,

9
00:00:54,480 --> 00:00:56,480
and lagomorphs.

音声からテキストへの翻訳を要求する

オーディオ ファイルを別の言語から英語に翻訳します。 サポートされている言語の一覧については、OpenAI のドキュメントを参照してください。

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/audio/translations?api-version={api-version}

パス パラメーター

パラメーター Type 必須 説明
your-resource-name string 必須 Azure OpenAI リソースの名前。
deployment-id string 必須 MyWhisperDeployment などの Whisper モデル デプロイの名前。 呼び出しを行うにはまず Whisper モデルをデプロイする必要があります。
api-version string 必須 この操作に使用する API バージョン。 この値は YYYY-MM-DD 形式に従います。

サポートされているバージョン

要求本文

パラメーター Type 必須 Default 説明
file file はい 該当なし 次のいずれかの形式で文字起こしするオーディオ ファイル オブジェクト (ファイル名ではありません): flac、mp3、mp4、mpeg、mpga、m4a、ogg、wav、webm。

Azure OpenAI の Whisper モデルのファイル サイズ上限は 25 MB です。 25 MB より大きいファイルを文字起こしする必要がある場合は、それをチャンクに分割します。

GitHub の Azure AI 音声 SDK リポジトリからサンプル オーディオ ファイルをダウンロードできます。
prompt string No [Null] モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトはオーディオ言語と一致する必要があります。

ユース ケースの例を含むプロンプトの詳細については、OpenAI のドキュメントを参照してください。
response_format string いいえ json 次のいずれかのオプションのトランスクリプト出力の形式: json、text、srt、verbose_json、vtt。

既定値は json です。
temperature 数値 いいえ 0 0 から 1 の間のサンプリング温度。

0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルはログ確率を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。

既定値は0です。

要求の例

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/audio/translations?api-version=2023-09-01-preview \
  -H "Content-Type: multipart/form-data" \
  -H "api-key: $YOUR_API_KEY" \
  -F file="@./YOUR_AUDIO_FILE_NAME.wav" \
  -F "temperature=0" \
  -F "response_format=json"

応答の例

{
  "text": "Hello, my name is Wolfgang and I come from Germany. Where are you heading today?"
}

テキスト読み上げ

テキストを音声に合成します。

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/audio/speech?api-version={api-version}

パス パラメーター

パラメーター Type 必須 説明
your-resource-name string 必須 Azure OpenAI リソースの名前。
deployment-id string 必須 テキスト読み上げモデルのデプロイ名 (例: MyTextToSpeechDeployment)。 呼び出しを行う前に、まずテキスト読み上げモデル (tts-1、tts-1-hd など) をデプロイする必要があります。
api-version string 必須 この操作に使用する API バージョン。 この値は YYYY-MM-DD 形式に従います。

サポートされているバージョン

要求本文

パラメーター Type 必須 Default 説明
model string はい 該当なし 使用可能な TTS モデルのいずれか (tts-1 または tts-1-hd)
input string はい 該当なし オーディオを生成するテキスト。 最大長は 4096 文字です。 入力テキストを任意の言語で指定します。1
voice string はい 該当なし オーディオを生成するときに使用する音声。 サポートされている音声は、alloy、echo、fable、onyx、nova、shimmer です。 音声のプレビューは、OpenAI テキスト読み上げガイドで確認できます。

1 テキスト読み上げモデルでは、通常、Whisper モデルと同じ言語がサポートされます。 サポートされている言語の一覧については、OpenAI のドキュメントを参照してください。

要求の例

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/audio/speech?api-version=2024-02-15-preview \
 -H "api-key: $YOUR_API_KEY" \
 -H "Content-Type: application/json" \
 -d '{
    "model": "tts-hd",
    "input": "I'm excited to try text to speech.",
    "voice": "alloy"
}' --output speech.mp3

応答の例

音声は、前の要求のオーディオ ファイルとして返されます。

管理 API

Azure OpenAI は、Azure AI サービスの一部としてデプロイされます。 すべての Azure AI サービスは、作成、更新、削除の操作で同じ一連の管理 API に依存します。 管理 API は、Azure OpenAI リソース内にモデルをデプロイするためにも使用されます。

管理 API リファレンス ドキュメント

次のステップ

モデルと REST API を使用した微調整について説明します。 Azure OpenAI をサポートする基となるモデルに関する記事を確認します。