Microsoft Foundry Models の Azure OpenAI REST API プレビュー リファレンス

この記事では、Azure OpenAI向けの推論REST APIエンドポイントについて詳細を提供します。

API 仕様

Azure OpenAIモデルやリソースの管理とやり取りは、主に3つのAPIサーフェスに分かれています。

• コントロール プレーン
• データプレーン - オーサリング
• データプレーン - 推論

各APIサーフェス/仕様は異なるAzure OpenAIの機能セットをカプセル化しています。 各APIは独自のプレビューおよび安定版/一般公開版(GA)APIリリースを持っています。 プレビューリリースは現在、月次のリリースリズムに従う傾向があります。

Important

現在、新しいプレビュー推論APIが登場しました。 API ライフサイクルガイドで詳しくご覧ください。

API	最新プレビューリリース	最新のGAリリース	Specifications	説明
コントロール プレーン	2025-07-01-preview	2025-06-01	仕様書ファイル	コントロールプレーンAPIは 、リソースの作成、 モデル展開、その他の高レベルのリソース管理タスクなどの操作に使用されます。 コントロールプレーンはまた、Azure Resource Manager、Bicep、Terraform、Azure CLIなどの機能で何が可能かも管理しています。
データ プレーン	v1 preview	v1	仕様書ファイル	データプレーンAPIは推論およびオーサリング操作を制御します。

認証

Azure OpenAIは認証のために2つの方法を提供しています。 APIキーかMicrosoft Entra IDのどちらかを使うことができます。

• APIキー認証:この種の認証では、すべてのAPIリクエストに api-key HTTPヘッダーにAPIキーを含める必要があります。 クイックスタートは、この種の認証で通話する方法についてのガイダンスを提供します。

• Microsoft Entra ID authentication:Microsoft Entraトークンを使ってAPI呼び出しを認証できます。 認証トークンはリクエストの中には Authorization ヘッダーとして含まれています。 提供されるトークンの前に Bearerが必ず付き、例えば Bearer YOUR_AUTH_TOKEN。 Microsoft Entra ID<>でのauthenticating の使い方ガイドをお読みいただけます。

REST API バージョン管理

サービスAPIは api-version クエリパラメータを用いてバージョン管理されています。 すべてのバージョンはYYYY-MM-DD 日付構造に従っています。 例えば次が挙げられます。

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

データプレーン推論

この記事の残りの部分では、Azure OpenAIデータプレーン推論仕様の2025-04-01-previewプレビューリリースについて扱っています。

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

完了 - 作成

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

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

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
デプロイメント ID	パス	はい	文字列
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
ベスト・オブ	整数	サーバー側で best_of 完結を生成し、「最良」(トークンあたりのログ確率が最も高いもの)を返します。 結果はストリーミングできません。 nと組み合わせて使用する場合、best_ofは候補の完了数を制御し、n ââ'¬â€œ best_ofnより大きくなければならない数を指定します。 注: このパラメータは多くの完了を生み出すため、トークンのクォータをすぐに消費してしまいます。 慎重に使い、 max_tokens と stopの設定を適切に設定してください。	いいえ	1
echo	boolean	完成に加えてプロンプトにもエコーを返してください	いいえ	いいえ
頻度ペナルティ (frequency_penalty)	number	数字は-2.0から2.0の間です。 正の値は、これまでテキスト内の既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行を逐語的に繰り返す可能性を減らします。	いいえ	0
ロジットバイアス	オブジェクト	完了に指定されたトークンが現れる確率を修正します。 GPTトークナイザーでトークンIDで指定されたトークンを、-100 から100までのバイアス値にマッピングするJSONオブジェクトを受け入れます。 数学的には、モデルが生成するロジットにバイアスを加えてサンプリングを行います。 正確な効果はモデルによって異なりますが、-1 から1の間の値は選択の可能性を下げたり増やしたりするはずです。-100 や100のような値が出ると、該当するトークンが禁止されるか、排他的に選択されるべきです。 例として、{"50256": -100}|endoftext|<トークンの生成を防ぐために>パスを送ることができます。	いいえ	None
logprobs	整数	最も可能性が高い出力トークン logprobs のログ確率を含め、選ばれたトークンを含めてください。 例えば、 logprobs が5の場合、APIは最も可能性が高い5つのトークンのリストを返します。 APIは常にサンプリングされたトークンの logprob を返すため、レスポンスには最大 logprobs+1 要素が存在することがあります。 logprobsの最大値は5です。	いいえ	None
マックス_トークン	整数	完了で生成可能な最大トークン数。 プロンプトのトークン数と max_tokens はモデルのコンテキストの長さを超えてはいけません。	いいえ	16
n	整数	各プロンプトごとに何回の完了を生成するか。 注: このパラメータは多くの完了を生み出すため、トークンのクォータをすぐに消費してしまいます。 慎重に使い、 max_tokens と stopの設定を適切に設定してください。	いいえ	1
presence_penalty	number	数字は-2.0から2.0の間です。 正の値は、テキストに現れたかどうかに基づいて新しいトークンにペナルティを与え、モデルが新しいトピックについて語る可能性を高めます。	いいえ	0
ダイアログを表示する	文字列または配列	完了を生成するプロンプトは、文字列、文字列の配列、トークンの配列、またはトークン配列の配列としてエンコードされます。 <|endoftext|>は、トレーニング中にモデルが認識する文書区切り器なので、プロンプトが指定されていない場合、モデルは新しいドキュメントの冒頭から生成します。	はい
seed	整数	仕様が指定されている場合、システムは決定論的にサンプリングするよう最善を尽くしており、同じ seed とパラメータで繰り返しリクエストしても同じ結果が返ってくるようにします。 決定性は保証されていないので、バックエンドの変更を監視するために system_fingerprint 応答パラメータを参照すべきです。	いいえ
stop	文字列または配列	APIがこれ以上のトークン生成を停止するシーケンスは最大4つあります。 返されたテキストには停止のシーケンスが含まれません。	いいえ
ストリーミング	boolean	部分的な進行をストリームバックするかどうか。 設定すると、トークンは利用可能なデータのみサーバー 送信イベント として送信され、ストリームは data: [DONE] メッセージで終了します。 例Pythonコード。	いいえ	いいえ
サフィックス	文字列	挿入されたテキストの完了後に付く接尾辞です。 このパラメータは gpt-3.5-turbo-instructのみサポートされています。	いいえ	None
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のような低い値はより集中して決定的になります。 一般的にはこれを変更するか、あるいは top_p を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこれを変更するか、あるいは temperature を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
ユーザー	文字列	エンドユーザーを表す一意の識別子であり、悪用の監視や検出に役立ちます。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	createCompletionResponse

ステータスコード: デフォルト

説明:サービス利用不可

Content-Type（コンテンツの種類）	Type	説明
application/json	errorResponse

Examples

例

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

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

{
 "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 https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

機械学習モデルやアルゴリズムで簡単に処理できる、与えられた入力のベクトル表現を得ること。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
デプロイメント ID	パス	はい	文字列	展開されたモデルのデプロイIDです。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
dimensions	整数	結果として得られる出力埋め込みが持つ次元の数。 text-embedding-3年以降のモデルのみでサポートされています。	いいえ
encoding_format	文字列	埋め込みを戻すためのフォーマット。 floatでもbase64でも構いません。 デフォルトは floatです。	いいえ
入力	文字列または配列	入力テキストを埋め込み、文字列またはトークン配列としてエンコードします。 単一のリクエストに複数の入力を埋め込むには、文字列の配列やトークン配列の配列を渡します。 入力はモデルの最大入力トークン数( text-embedding-ada-002は8,192トークン)を超えてはならず、空文字列であってはならず、配列の次元は2,048次元以下でなければなりません。 すべての埋め込みモデルでは、入力ごとのトークン制限に加えて、1 つの要求内のすべての入力に対して合計最大 300,000 個のトークンが適用されます。	はい
input_type	文字列	使用する埋め込み探索の入力タイプ	いいえ
ユーザー	文字列	エンドユーザーを表す一意の識別子で、悪用の監視や検出に役立ちます。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	オブジェクト

Examples

例

指定されたプロンプトに対して埋め込みを返します。

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

{
 "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.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

チャット完了 - 作成

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

チャットメッセージの完了を作成する

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
デプロイメント ID	パス	はい	文字列
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
オーディオ	オブジェクト	音声出力のパラメータ。 音声出力が modalities: ["audio"]で要求された場合に必須です。	いいえ
└─ フォーマット	列挙型	出力オーディオフォーマットを指定します。 wav、mp3、flac、opus、またはpcm16のいずれかでなければなりません。 可能な値: wav、 mp3、 flac、 opus、 pcm16	いいえ
└─ ボイス	列挙型	声のタイプを指定します。 サポートされる声は alloy、 echo、 fable、 onyx、 nova、 shimmerです。 可能な値: alloy、 echo、 fable、 onyx、 nova、 shimmer	いいえ
data_sources	アレイ	Azure OpenAIチャット拡張機能の構成エントリーです。 この追加仕様はAzure OpenAIのみに対応しています。	いいえ
頻度ペナルティ (frequency_penalty)	number	数字は-2.0から2.0の間です。 正の値は、これまでテキスト内の既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行を逐語的に繰り返す可能性を減らします。	いいえ	0
関数呼び出し	文字列または chatCompletionFunctionCallOption	tool_choiceに優先して廃止されました。 モデルが呼び出す関数(もしあれば)を制御します。 none モデルは関数を呼び出すのではなく、代わりにメッセージを生成します。 auto モデルはメッセージを生成するか関数を呼び出すかを選択できることを意味します。 {"name": "my_function"}で特定の関数を指定すると、モデルはその関数を呼び出すことを強制します。 none 関数が存在しない場合のデフォルトです。 auto 関数が存在する場合のデフォルトです。	いいえ
functions	アレイ	toolsに優先して廃止されました。 モデルがJSON入力を生成する関数のリスト。	いいえ
ロジットバイアス	オブジェクト	完了に指定されたトークンが現れる確率を修正します。 トークン(トークンIDで指定)を -100 から100までの付随するバイアス値にマッピングするJSONオブジェクトを受け付けます。 数学的には、モデルが生成するロジットにバイアスを加えてサンプリングを行います。 正確な効果はモデルによって異なりますが、-1 から1の間の値は選択の可能性を下げたり増やしたりするはずです。-100 や100のような値が出ると、該当するトークンが禁止されるか、排他的に選択されるべきです。	いいえ	None
logprobs	boolean	出力トークンのログ確率を返すかどうか。 もし真であれば、contentmessageで返された各出力トークンの対数確率を返します。	いいえ	いいえ
max_completion_tokens	整数	完了化で生成可能なトークン数の上限であり、可視出力トークンや推論トークンも含まれます。	いいえ
マックス_トークン	整数	チャット完了時に生成できるトークンの最大数。 入力トークンと生成トークンの総長は、モデルのコンテキスト長によって制限されます。	いいえ
messages	アレイ	これまでの会話のメッセージリスト。 例Pythonコード。	はい
メタデータ	オブジェクト	開発者が定義したタグや値を、保存された完了ダッシュボードで完了をフィルタリングするために使用します。	いいえ
modalities	ChatCompletionModalities	このリクエストのためにモデルに生成してほしい出力タイプ。 ほとんどのモデルはテキスト生成が可能であり、これがデフォルトです: ["text"] gpt-4o-audio-previewモデルは音声生成にも利用できます。 このモデルにテキストと音声の両方の応答を生成するよう依頼するには、以下を利用できます: ["text", "audio"]	いいえ
n	整数	入力メッセージごとに何つのチャット完了選択肢を生成するか。 すべての選択肢で生成されたトークンの数に基づいて料金が発生します。 コストを抑えるために、 n を常に保持 1 しましょう。	いいえ	1
並列ツール呼び出し	ParallelToolCalls	工具使用中に並列関数呼び出しを有効にするかどうか。	いいえ	正しい
予測	PredictionContent	予測出力の設定により、モデルの応答の大部分が事前に分かっている場合、応答時間が大幅に改善されます。 これは、ほとんどの内容にわずかな変更を加えたファイル再生成時に最も一般的です。	いいえ
presence_penalty	number	数字は-2.0から2.0の間です。 正の値は、テキストに現れたかどうかに基づいて新しいトークンにペナルティを与え、モデルが新しいトピックについて語る可能性を高めます。	いいえ	0
推論努力	列挙型	O1モデルのみ 推論モデルの推論にかかる労力を制限します。 現在サポートされている値は low、 medium、 highです。 推論の努力を減らすことで、応答の速さや推論に使われるトークンの削減につながる。 可能な値: low、 medium、 high	いいえ
response_format	ResponseFormatText または ResponseFormatJsonObject または ResponseFormatJsonSchema	モデルが出力すべきフォーマットを指定するオブジェクト。 GPT-4o、GPT-4o mini、GPT-4 Turbo、およびより新しいすべてのgpt-3.5-turbo-1106 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると構造化出力が有効になり、モデルが提供されたJSONスキーマに一致することを保証します。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることが保証されます。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	いいえ
seed	整数	この機能はベータ版です。 仕様が指定されている場合、システムは決定論的にサンプリングするよう最善を尽くしており、同じ seed とパラメータで繰り返しリクエストしても同じ結果が返ってくるようにします。 決定性は保証されていないので、バックエンドの変更を監視するために system_fingerprint 応答パラメータを参照すべきです。	いいえ
stop	文字列または配列	APIがこれ以上のトークン生成を停止するシーケンスは最大4つあります。	いいえ
保存する	boolean	このチャット完了リクエストの出力を、モデルの蒸留や評価製品で使用するために保存するかどうかについても判断しています。	いいえ
ストリーミング	boolean	設定すると、ChatGPTのように部分的なメッセージの差が送信されます。 トークンは利用可能なデータのみサーバー 送信イベント として送信され、ストリームは data: [DONE] メッセージで終了します。 例Pythonコード。	いいえ	いいえ
stream_options	chatCompletionStreamOptions	ストリーミング応答の選択肢。 設定したときにだけ設定 stream: true。	いいえ	None
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のような低い値はより集中して決定的になります。 一般的にはこれを変更するか、あるいは top_p を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
tool_choice	chatCompletionToolChoiceOption	モデルが呼び出すツール(もしあれば)を制御します。 none つまり、モデルはツールを呼び出さず、代わりにメッセージを生成します。 auto つまり、モデルはメッセージを生成するか、1つ以上のツールを呼び出すかを選べるということです。 required モデルは1つ以上のツールを呼び出しなければならないことを意味します。 {"type": "function", "function": {"name": "my_function"}}で特定のツールを指定すると、モデルはそのツールを呼び出すことを強制します。 none ツールがない場合のデフォルトです。 auto ツールがある場合はデフォルトです。	いいえ
ツール	アレイ	モデルが呼び出す可能性のあるツールのリスト。 現在、ツールとしてサポートされているのは関数のみです。 これを使って、モデルがJSON入力を生成する可能性のある関数のリストを提供します。 最大128の機能までサポートされています。	いいえ
top_logprobs	整数	0から20の間の整数で、各トークン位置で返される可能性が最も高いトークンの数を示し、それぞれに対数の確率が伴います。 logprobs このパラメータを使用する場合は true に設定されなければなりません。	いいえ
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこれを変更するか、あるいは temperature を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
ユーザー	文字列	エンドユーザーを表す一意の識別子であり、悪用の監視や検出に役立ちます。	いいえ
user_security_context	userSecurityContext	ユーザーセキュリティコンテキストには、AIアプリケーション自体やAIアプリケーションとやり取りするエンドユーザーを表す複数のパラメータが含まれます。 これらの分野は、セキュリティ運用チームがセキュリティインシデントの調査と軽減を支援し、AIアプリケーションを保護する包括的なアプローチを提供します。 詳細はMicrosoft Defender for Cloudを使ったAIアプリケーション保護について。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	オブジェクト

ステータスコード: デフォルト

説明:サービス利用不可

Content-Type（コンテンツの種類）	Type	説明
application/json	errorResponse

Examples

例

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

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

{
 "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? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

例

Azure Searchのデータとシステム割り当てのマネージデンティティに基づいて完了を作成します。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

例

Azure Searchの画像ベクターデータに基づいて完了を作成します。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

例

Azure Searchのベクターデータ、過去のアシスタントメッセージ、ユーザー割り当てのマネージデンティティに基づいて完了を作成します。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

例

提供されたAzure Cosmos DBの完了を作成する。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

例

提供されたMongoデータベースに対して完了を生成します。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

例

提供されたElasticsearchの完了処理を作成します。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

例

提供されたPineconeリソースの完了を生成します。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

書き起こし - 作成

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

音声を入力言語に書き起こします。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
デプロイメント ID	パス	はい	文字列
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
モデル	文字列	使用するモデルのIDです。 選択肢は gpt-4o-transcribe、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 whisper-1、 gpt-4o-transcribe-diarizeです。	はい
ファイル	文字列	音声ファイルオブジェクトを文字起こしします。	はい
言語	文字列	入力音声の言語。 入力言語をISO-639-1形式で提供することで、精度と遅延が向上します。	いいえ
ダイアログを表示する	文字列	モデルのスタイルをガイドしたり、前の音声セグメントを続けるためのオプションテキスト。 プロンプトは音声言語に合っているべきです。	いいえ
response_format	audioResponseFormat	出力のフォーマットを定義します。	いいえ
温度	number	サンプリング温度は0から1の間です。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。 0に設定された場合、モデルは対数確率を用いて特定の閾値に達するまで自動的に温度を上げます。	いいえ	0
timestamp_granularities[]	アレイ	この文字起こしのために入力するタイムスタンプの細さ。 response_format タイムスタンプの粒度を使わせるように verbose_json 設定する必要があります。 これらの選択肢のいずれか、または両方がサポートされています: wordまたは segment。 注:セグメントタイムスタンプに追加の遅延はありませんが、ワードタイムスタンプを生成すると追加の遅延が発生します。	いいえ	['segment']

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	オブジェクト
text/plain	文字列	出力形式で文字起こしされたテキスト(response_formatが text、 vtt 、または srtのいずれかだった場合)。

Examples

例

提供された音声データから文字起こしテキストと関連メタデータを取得します。

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

回答:ステータスコード:200

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

例

提供された音声データから文字起こしテキストと関連メタデータを取得します。

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回答:ステータスコード:200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

翻訳 - 作成

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

入力された音声を英語テキストに書き起こし・翻訳します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
デプロイメント ID	パス	はい	文字列
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
ファイル	文字列	翻訳用の音声ファイル。	はい
ダイアログを表示する	文字列	モデルのスタイルをガイドしたり、前の音声セグメントを続けるためのオプションテキスト。 プロンプトは英語で書かれるべきです。	いいえ
response_format	audioResponseFormat	出力のフォーマットを定義します。	いいえ
温度	number	サンプリング温度は0から1の間です。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。 0に設定された場合、モデルは対数確率を用いて特定の閾値に達するまで自動的に温度を上げます。	いいえ	0

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	オブジェクト
text/plain	文字列	テキストがテキスト、vtt、srtのいずれかであった場合response_format出力形式で文字起こしされました。

Examples

例

提供された音声データから英語の文字起こしテキストと関連するメタデータを取得します。

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回答:ステータスコード:200

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

例

提供された音声データから英語の文字起こしテキストと関連するメタデータを取得します。

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回答:ステータスコード:200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

スピーチ - 作成

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

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

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
デプロイメント ID	パス	はい	文字列
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
入力	文字列	音声合成のためのテキスト。 最大文字数は4,096文字です。	はい
response_format	列挙型	音声を合成するためのフォーマット。 可能な値: mp3、 opus、 aac、 flac、 wav、 pcm	いいえ
速度	number	合成音声の速度。 0.25から4.0の中から値を選びます。 1.0 はデフォルトです。	いいえ	1.0
音声	列挙型	音声合成に使う声。 可能な値: alloy、 echo、 fable、 onyx、 nova、 shimmer	はい

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/octet-stream	文字列

Examples

例

提供されたテキストから音声を合成します。

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

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

回答:ステータスコード:200

{
  "body": "101010101"
}

画像生成 - 作成

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

与えられた画像生成モデルの展開において、テキストキャプションから画像の一括を生成する

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
デプロイメント ID	パス	はい	文字列
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
バックグラウンド	imageBackground	生成画像の背景の透明度設定が可能です。 このパラメータはGPT-image-1シリーズモデルのみでサポートされています。	いいえ	自動
n	整数	生成すべき画像の数。 dall-e-3 では、n=1 のみがサポートされます。	いいえ	1
出力圧縮	整数	生成画像の圧縮レベル(0-100%)です。 このパラメータはjpeg出力フォーマットのgpt-image-1シリーズモデルのみに対応しています。	いいえ	100
出力形式 (output_format)	imagesOutputFormat	生成された画像が返されるファイル形式。 GPT-image-1シリーズモデルのみに対応しています。	いいえ	png
ダイアログを表示する	文字列	目的の画像のテキスト説明。 GPT-image-1シリーズの最大長さは32,000文字、dall-e-3では4,000文字です	はい
部分的な画像	整数	生成すべき部分画像の数。 このパラメータは部分的な画像を返すストリーミング応答に使用されます。 値は0から3の間でなければなりません。 0に設定すると、1つのストリーミングイベントで送信される単一の画像が応答します。 完全な画像がより速く生成される場合、最終画像が部分画像の全数が生成される前に送信される可能性があることに注意してください。	0
ストリーミング	boolean	ストリーミングモードで画像を編集してください。	いいえ	false
品質	imageQuality	生成される画像の品質。	いいえ	自動
response_format	imagesResponseFormat	生成された画像が返される形式。 このパラメータは、常にbase64エンコード画像を返す gpt-image-1シリーズモデルにはサポートされていません。 可能な値: url、 b64_json。	いいえ	url
size	imageSize	生成される画像のサイズ。	いいえ	自動
スタイル	imageStyle	生成された画像のスタイル。 dall-e-3のみ対応しています。	いいえ	vivid
ユーザー	文字列	エンドユーザーを表す一意の識別子であり、悪用の監視や検出に役立ちます。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	generateImagesResponse

ステータスコード: デフォルト

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

Content-Type（コンテンツの種類）	Type	説明
application/json	dalleErrorResponse

Examples

例

プロンプトを与えられた画像を作成します。

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

{
 "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 https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

与えられたGPT-image-1モデル展開上のテキストキャプションから画像を編集します

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
デプロイメント ID	パス	はい	文字列
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
イメージ	文字列または配列	編集する画像。 サポートされている画像ファイルまたは画像の配列でなければなりません。 各画像はpngファイルかjpgファイルで、50MB未満であるべきです。	はい
入力忠実度	文字列	モデルが入力画像のスタイルや特徴、特に顔の特徴にどれだけ努力をかけるかをコントロールします。 このパラメータはGPT-image-1シリーズモデルのみでサポートされています。 サポートは high と low。	いいえ	low。
マスク	文字列	完全に透明な領域(例:アルファがゼロ)で編集すべき場所を示す追加の画像があります。 複数の画像が提供されている場合、マスクは最初の画像に適用されます。 有効なPNGファイルで、4MB未満で、画像と同じサイズでなければなりません。	いいえ
n	整数	生成すべき画像の数。 1から10の間でなければなりません。	いいえ	1
ダイアログを表示する	文字列	目的の画像のテキスト説明。 最大文字数は32000文字です。	はい
品質	imageQuality	生成される画像の品質。	いいえ	自動
部分的な画像	生成すべき部分画像の数。 このパラメータは部分的な画像を返すストリーミング応答に使用されます。 値は0から3の間でなければなりません。 0に設定すると、1つのストリーミングイベントで送信される単一の画像が応答します。 完全な画像がより速く生成される場合、最終画像が部分画像の全数が生成される前に送信される可能性があることに注意してください。
ストリーミング	boolean	ストリーミングモードで画像を編集してください。	いいえ	false
response_format	imagesResponseFormat	生成された画像が返される形式。	いいえ	url
size	imageSize	生成される画像のサイズ。	いいえ	自動
ユーザー	文字列	エンドユーザーを表す一意の識別子であり、悪用の監視や検出に役立ちます。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	generateImagesResponse

ステータスコード: デフォルト

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

Content-Type（コンテンツの種類）	Type	説明
application/json	dalleErrorResponse

リスト - アシスタント

Note

アシスタントAPIは廃止され、2026年8月26日に廃止されます。 一般に利用可能なMicrosoftファウンドリーエージェントサービスを利用してください。 移行ガイドに従ってワークロードを更新してください。 詳細については、こちらを参照してください。

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

助手のリストを返す。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
limit	クエリ	いいえ	整数	返却すべき物の数に制限がある。 制限は1から100の範囲で、デフォルトは20です。
順序	クエリ	いいえ	文字列 可能な値: asc、 desc	オブジェクトの created_at タイムスタンプで順番を並べ替えてください。 asc 昇順は desc 、降順はです。
後	クエリ	いいえ	文字列	ページ付け用のカーソル。 after はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクトを受け取り、obj_fooで終わった場合、次の呼び出しで次のページを取得するためにafter=obj_fooを含めることができます。
以前は	クエリ	いいえ	文字列	ページ付け用のカーソル。 before はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクト(obj_fooから始まる)を受け取った場合、次の呼び出しでbefore=obj_fooを含めることでリストの前のページを取得することができます。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	listAssistantsResponse

Examples

例

助手のリストを返す。

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Create - アシスタント

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

モデルと指示を持つアシスタントを作成しましょう。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
説明	文字列	助手の説明。 最大文字数は512文字です。	いいえ
手順	文字列	アシスタントが使うシステム命令。 最大長さは256,000文字です。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
モデル	文字列		はい
name	文字列	助手の名前だ。 最大文字数は256文字です。	いいえ
response_format	assistantsApiResponseFormatOption	モデルが出力すべきフォーマットを指定します。 GPT-4o、GPT-4 Turbo、そして gpt-3.5-turbo-1106年以降のすべてのGPT-3.5 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 詳細はStructured Outptsガイドをご覧ください。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	いいえ
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。	いいえ	1
tool_resources	オブジェクト	アシスタントのツールが使用するリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	いいえ
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールで利用可能なファイルIDのリスト。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このアシスタントに付随するベクターストアです。 アシスタントには最大1つのベクターストアを接続できます。	いいえ
└─ ベクトルストア	アレイ	file_idsでベクターストアを作成し、このアシスタントにアタッチするための補助者です。 アシスタントには最大1つのベクターストアを接続できます。	いいえ
ツール	アレイ	アシスタントで有効になっているツールのリスト。 アシスタント1人あたり最大128個のツールを持てます。 道具は code_interpreter、 retrieval、または functionの種類があります。	いいえ	[]
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこの方法か温度を変えることを推奨しますが、両方はおすすめしません。	いいえ	1

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	assistantObject

Examples

例

モデルと指示を持つアシスタントを作成しましょう。

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

回答:ステータスコード:200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

取得 - アシスタント

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

助手を連れてくる。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
assistant_id	パス	はい	文字列	アシスタントのIDを取り戻す。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	assistantObject

Examples

例

助手を連れてくる。

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

モディフィケート - アシスタント

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

アシスタントを修正する。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
assistant_id	パス	はい	文字列	アシスタントのIDを修正してください。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
説明	文字列	助手の説明。 最大文字数は512文字です。	いいえ
手順	文字列	アシスタントが使うシステム命令。 最大文字数は32768文字です。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
モデル	文字列		いいえ
name	文字列	助手の名前だ。 最大文字数は256文字です。	いいえ
response_format	assistantsApiResponseFormatOption	モデルが出力すべきフォーマットを指定します。 GPT-4o、GPT-4 Turbo、そして gpt-3.5-turbo-1106年以降のすべてのGPT-3.5 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 詳細はStructured Outptsガイドをご覧ください。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	いいえ
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。	いいえ	1
tool_resources	オブジェクト	アシスタントのツールが使用するリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	いいえ
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールに提供されているファイルIDのリストを上書きします。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このアシスタントに付随するベクターストアを上書きします。 アシスタントには最大1つのベクターストアを接続できます。	いいえ
ツール	アレイ	アシスタントで有効になっているツールのリスト。 アシスタント1人あたり最大128個のツールを持てます。 道具は code_interpreter、 retrieval、または functionの種類があります。	いいえ	[]
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこの方法か温度を変えることを推奨しますが、両方はおすすめしません。	いいえ	1

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	assistantObject

Examples

例

アシスタントを修正する。

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

回答:ステータスコード:200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Delete - アシスタント

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

アシスタントを削除しましょう。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
assistant_id	パス	はい	文字列	アシスタントのIDを削除してください。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	deleteAssistantResponse

Examples

例

アシスタントを削除します。

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

作成 - スレッド

Note

アシスタントAPIは廃止され、2026年8月26日に廃止されます。 一般に利用可能なMicrosoftファウンドリーエージェントサービスを利用してください。 移行ガイドに従ってワークロードを更新してください。 詳細については、こちらを参照してください。

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

スレッドを立ててください。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
messages	アレイ	スレッドを始めるためのメッセージのリストです。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
tool_resources	オブジェクト	このスレッドでアシスタントのツールに提供されているリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	いいえ
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールで利用可能なファイルIDのリスト。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このスレッドに添付されたベクターストア。 スレッドには最大1つのベクトルストアを接続できます。	いいえ
└─ ベクトルストア	アレイ	file_idsでベクターストアを作成し、このスレッドに添付するためのヘルプです。 スレッドには最大1つのベクトルストアを接続できます。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	threadObject

Examples

例

スレッドができてしまいます。

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

入手 - スレッド

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

スレッドを取り戻す。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	取り戻すスレッドのIDです。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	threadObject

Examples

例

スレッドを取り戻す。

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Modify - スレッド

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

スレッドを修正します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	修正すべきスレッドのIDです。 変更できるのは metadata だけです。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
tool_resources	オブジェクト	このスレッドでアシスタントのツールに提供されているリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	いいえ
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールで利用可能なファイルIDの一覧。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このスレッドに添付されたベクターストア。 スレッドには最大1つのベクトルストアを接続できます。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	threadObject

Examples

例

スレッドを修正します。

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

回答:ステータスコード:200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

削除 - スレッド

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

スレッドを削除してください。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	削除すべきスレッドのIDです。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	deleteThreadResponse

Examples

例

スレッドを削除します。

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

リスト - メッセージ

Note

アシスタントAPIは廃止され、2026年8月26日に廃止されます。 一般に利用可能なMicrosoftファウンドリーエージェントサービスを利用してください。 移行ガイドに従ってワークロードを更新してください。 詳細については、こちらを参照してください。

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

与えられたスレッドのメッセージリストを返します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	メッセージが属するスレッドのIDです。
limit	クエリ	いいえ	整数	返却すべき物の数に制限がある。 制限は1から100の範囲で、デフォルトは20です。
順序	クエリ	いいえ	文字列 可能な値: asc、 desc	オブジェクトの created_at タイムスタンプで順番を並べ替えてください。 asc 昇順は desc 、降順はです。
後	クエリ	いいえ	文字列	ページ付け用のカーソル。 after はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクトを受け取り、obj_fooで終わった場合、次の呼び出しで次のページを取得するためにafter=obj_fooを含めることができます。
以前は	クエリ	いいえ	文字列	ページ付け用のカーソル。 before はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクト(obj_fooから始まる)を受け取った場合、次の呼び出しでbefore=obj_fooを含めることでリストの前のページを取得することができます。
run_id	クエリ	いいえ	文字列	メッセージを生成したランIDでフィルタリングします。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	listMessagesResponse

Examples

例

メッセージの一覧表示

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Create - メッセージ

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

メッセージを作成しましょう。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	メッセージを作成するスレッドのIDです。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
添付ファイル	アレイ	メッセージに添付されたファイルのリストと、それらが追加されるべきツール。	いいえ
コンテンツ	文字列	メッセージの内容。	はい
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
ロール	文字列	メッセージを作っている主体の役割。 許可される値は以下の通りです: - user: は実際のユーザーから送信されたメッセージを示し、ほとんどの場合、ユーザー生成メッセージを表すために使われるべきです。 - assistant: はメッセージがアシスタントによって生成されたことを示します。 この値を使い、アシスタントからのメッセージを会話に挿入します。	はい

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	messageObject

Examples

例

メッセージを作成しましょう。

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

回答:ステータスコード:200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

メッセージを取る

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

メッセージを回収する。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	このメッセージが属するスレッドのIDです。
message_id	パス	はい	文字列	回収すべきメッセージのIDです。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	messageObject

Examples

例

メッセージを回収する。

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Modify - メッセージ

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

メッセージを修正します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	このメッセージが属するスレッドのIDです。
message_id	パス	はい	文字列	修正すべきメッセージのIDです。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	messageObject

Examples

例

メッセージを修正してください。

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

回答:ステータスコード:200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Create - スレッド&ラン

Note

アシスタントAPIは廃止され、2026年8月26日に廃止されます。 一般に利用可能なMicrosoftファウンドリーエージェントサービスを利用してください。 移行ガイドに従ってワークロードを更新してください。 詳細については、こちらを参照してください。

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

スレッドを作成し、1つのリクエストで実行します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
assistant_id	文字列	この実行を実行するアシスタントのIDです。	はい
手順	文字列	アシスタントのデフォルトシステムメッセージを上書きします。 これは、実行ごとに動作を修正するのに便利です。	いいえ
max_completion_tokens	整数	プレイ中に使用できる最大数のクリアトークン。 このランは、指定された数だけの完成トークンを複数ターンにわたって使用するよう最善を尽くします。 実行が指定された完了トークン数を超えると、ステータス incompleteで終了します。 詳細は incomplete_details をご覧ください。	いいえ
max_prompt_tokens	整数	プレイ中に使用できるプロンプトトークンの最大数。 このランは、複数のターンにわたって指定されたプロンプトトークンの数だけを使うよう最善を尽くします。 実行が指定されたプロンプトトークンの数を超えると、ステータス incompleteで終了します。 詳細は incomplete_details をご覧ください。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
モデル	文字列	この実行に使うモデルのIDです。 ここで値が提供されると、アシスタントに関連付けられたモデルを上書きします。 そうでなければ、アシスタントに関連付けられたモデルが使用されます。	いいえ
並列ツール呼び出し	ParallelToolCalls	工具使用中に並列関数呼び出しを有効にするかどうか。	いいえ	正しい
response_format	assistantsApiResponseFormatOption	モデルが出力すべきフォーマットを指定します。 GPT-4o、GPT-4 Turbo、そして gpt-3.5-turbo-1106年以降のすべてのGPT-3.5 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 詳細はStructured Outptsガイドをご覧ください。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	いいえ
ストリーミング	boolean	trueの場合、Run中に発生したイベントのストリームをサーバー送信イベントとして返し、Runがターミナル状態に入りdata: [DONE]メッセージで終了します。	いいえ
stream_options	chatCompletionStreamOptions	ストリーミング応答の選択肢。 設定したときにだけ設定 stream: true。	いいえ	None
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。	いいえ	1
スレッド	createThreadRequest		いいえ
tool_choice	assistantsApiToolChoiceOption	モデルが呼び出すツール(もしあれば)を制御します。 none モデルはツールを呼び出さず、代わりにメッセージを生成します。 auto はデフォルト値であり、モデルがメッセージを生成するかツールを呼び出すかを選択できることを意味します。 {"type": "file_search"}や{"type": "function", "function": {"name": "my_function"}}のような特定のツールを指定すると、モデルはそのツールを呼び出すことを強制します。	いいえ
tool_resources	オブジェクト	アシスタントのツールが使用するリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	いいえ
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールで利用可能なファイルIDのリスト。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このアシスタントに紐づいたベクターストアのIDです。 アシスタントには最大1つのベクターストアを接続できます。	いいえ
ツール	アレイ	アシスタントがこのランで使えるツールを上書きしてください。 これは、実行ごとに動作を修正するのに便利です。	いいえ
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこの方法か温度を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
truncation_strategy	truncationObject	実行前にスレッドを切り詰めるコントロール。 これを使って、ランの最初のコンテキストウィンドウを制御します。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	runObject

Examples

例

スレッドを作成し、1つのリクエストで実行します。

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

回答:ステータスコード:200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

リスト - 得点

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

スレッドに属するランのリストを返します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	そのランが属するスレッドのIDです。
limit	クエリ	いいえ	整数	返却すべき物の数に制限がある。 制限は1から100の範囲で、デフォルトは20です。
順序	クエリ	いいえ	文字列 可能な値: asc、 desc	オブジェクトの created_at タイムスタンプで順番を並べ替えてください。 asc 昇順は desc 、降順はです。
後	クエリ	いいえ	文字列	ページ付け用のカーソル。 after はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクトを受け取り、obj_fooで終わった場合、次の呼び出しで次のページを取得するためにafter=obj_fooを含めることができます。
以前は	クエリ	いいえ	文字列	ページ付け用のカーソル。 before はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクト(obj_fooから始まる)を受け取った場合、次の呼び出しでbefore=obj_fooを含めることでリストの前のページを取得することができます。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	listRunsResponse

Examples

例

スレッドに属するランのリストを返します。

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

作成 - 実行

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

ランを作りましょう。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	実行するスレッドのIDです。
include[]	クエリ	いいえ	アレイ	回答に含める追加項目のリスト。 現在サポートされているのは、ファイル検索結果の内容を取得するための step_details.tool_calls[*].file_search.results[*].content のみです。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
additional_instructions	文字列	実行の命令の最後に追加の命令を追加します。 これは、他の命令を上書きせずに各実行ごとに動作を修正するのに有用です。	いいえ
additional_messages	アレイ	実行を作成する前にスレッドに追加メッセージを追加します。	いいえ
assistant_id	文字列	この実行を実行するアシスタントのIDです。	はい
手順	文字列	アシスタントのデフォルトシステムメッセージを上書きします。 これは、実行ごとに動作を修正するのに便利です。	いいえ
max_completion_tokens	整数	プレイ中に使用できる最大数のクリアトークン。 このランは、指定された数だけの完成トークンを複数ターンにわたって使用するよう最善を尽くします。 実行が指定された完了トークン数を超えると、ステータス incompleteで終了します。 詳細は incomplete_details をご覧ください。	いいえ
max_prompt_tokens	整数	プレイ中に使用できるプロンプトトークンの最大数。 このランは、複数のターンにわたって指定されたプロンプトトークンの数だけを使うよう最善を尽くします。 実行が指定されたプロンプトトークンの数を超えると、ステータス incompleteで終了します。 詳細は incomplete_details をご覧ください。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
モデル	文字列	この実行を実行するモデルのIDです。 ここで値が提供されると、アシスタントに関連付けられたモデルを上書きします。 そうでなければ、アシスタントに関連付けられたモデルが使用されます。	いいえ
並列ツール呼び出し	ParallelToolCalls	工具使用中に並列関数呼び出しを有効にするかどうか。	いいえ	正しい
response_format	assistantsApiResponseFormatOption	モデルが出力すべきフォーマットを指定します。 GPT-4o、GPT-4 Turbo、そして gpt-3.5-turbo-1106年以降のすべてのGPT-3.5 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 詳細はStructured Outptsガイドをご覧ください。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	いいえ
ストリーミング	boolean	trueの場合、Run中に発生したイベントのストリームをサーバー送信イベントとして返し、Runがターミナル状態に入りdata: [DONE]メッセージで終了します。	いいえ
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。	いいえ	1
tool_choice	assistantsApiToolChoiceOption	モデルが呼び出すツール(もしあれば)を制御します。 none モデルはツールを呼び出さず、代わりにメッセージを生成します。 auto はデフォルト値であり、モデルがメッセージを生成するかツールを呼び出すかを選択できることを意味します。 {"type": "file_search"}や{"type": "function", "function": {"name": "my_function"}}のような特定のツールを指定すると、モデルはそのツールを呼び出すことを強制します。	いいえ
ツール	アレイ	アシスタントがこのランで使えるツールを上書きしてください。 これは、実行ごとに動作を修正するのに便利です。	いいえ
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこの方法か温度を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
truncation_strategy	truncationObject	実行前にスレッドを切り詰めるコントロール。 これを使って、ランの最初のコンテキストウィンドウを制御します。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	runObject

Examples

例

ランを作りましょう。

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

回答:ステータスコード:200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

ゲット - ラン

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

ランを回収。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	実行されたスレッドのIDです。
run_id	パス	はい	文字列	回収した走路のIDだ。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	runObject

Examples

例

ランを取る。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

修正 - 走る

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

ランを修正します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	実行されたスレッドのIDです。
run_id	パス	はい	文字列	修正するランのIDです。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	runObject

Examples

例

ランを修正します。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

回答:ステータスコード:200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

送信 - 実行するツール出力

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

実行にstatus: "requires_action"がありrequired_action.typesubmit_tool_outputsされた場合、このエンドポイントを使ってツールコールの出力をすべて送信できます。 すべての出力は単一のリクエストで提出しなければなりません。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	このランが属するスレッドのIDです。
run_id	パス	はい	文字列	ツール出力の提出が必要なランのID。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
ストリーミング	boolean	trueの場合、Run中に発生したイベントのストリームをサーバー送信イベントとして返し、Runがターミナル状態に入りdata: [DONE]メッセージで終了します。	いいえ
tool_outputs	アレイ	出力が提出されているツールのリスト。	はい

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	runObject

Examples

例

実行にstatus: "requires_action"がありrequired_action.typesubmit_tool_outputsされた場合、このエンドポイントを使ってツールコールの出力をすべて送信できます。 すべての出力は単一のリクエストで提出しなければなりません。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

キャンセル - 逃げる

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

in_progressのランをキャンセルします。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	このランが属するスレッドのIDです。
run_id	パス	はい	文字列	キャンセルのIDです。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	runObject

Examples

例

in_progressのランをキャンセルします。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

リスト - ランステップ

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

ランに属する実行ステップのリストを返します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	実行および実行ステップが属するスレッドのIDです。
run_id	パス	はい	文字列	ランステップが属するランのIDです。
limit	クエリ	いいえ	整数	返却すべき物の数に制限がある。 制限は1から100の範囲で、デフォルトは20です。
順序	クエリ	いいえ	文字列 可能な値: asc、 desc	オブジェクトの created_at タイムスタンプで順番を並べ替えてください。 asc 昇順は desc 、降順はです。
後	クエリ	いいえ	文字列	ページ付け用のカーソル。 after はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクトを受け取り、obj_fooで終わった場合、次の呼び出しで次のページを取得するためにafter=obj_fooを含めることができます。
以前は	クエリ	いいえ	文字列	ページ付け用のカーソル。 before はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクト(obj_fooから始まる)を受け取った場合、次の呼び出しでbefore=obj_fooを含めることでリストの前のページを取得することができます。
api-version	クエリ	はい	文字列
include[]	クエリ	いいえ	アレイ	回答に含める追加項目のリスト。 現在サポートされているのは、ファイル検索結果の内容を取得するための step_details.tool_calls[*].file_search.results[*].content のみです。

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	listRunStepsResponse

Examples

例

ランに属する実行ステップのリストを返します。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

ゲット - ランステップ

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

ランステップを回収します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
thread_id	パス	はい	文字列	実行と実行ステップが属するスレッドのIDです。
run_id	パス	はい	文字列	ランステップが属するランのID。
step_id	パス	はい	文字列	取得する実行ステップのID。
include[]	クエリ	いいえ	アレイ	回答に含める追加項目のリスト。 現在サポートされているのは、ファイル検索結果の内容を取得するための step_details.tool_calls[*].file_search.results[*].content のみです。
api-version	クエリ	はい	文字列

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	runStepObject

Examples

例

ランステップを回収します。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

リスト - ベクターストア

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

ベクターストアのリストを返します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
limit	クエリ	いいえ	整数	返却すべき物の数に制限がある。 制限は1から100の範囲で、デフォルトは20です。
順序	クエリ	いいえ	文字列 可能な値: asc、 desc	オブジェクトの created_at タイムスタンプで順番を並べ替えてください。 asc 昇順は desc 、降順はです。
後	クエリ	いいえ	文字列	ページ付け用のカーソル。 after はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクトを受け取り、obj_fooで終わった場合、次の呼び出しで次のページを取得するためにafter=obj_fooを含めることができます。
以前は	クエリ	いいえ	文字列	ページ付け用のカーソル。 before はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクト(obj_fooから始まる)を受け取った場合、次の呼び出しでbefore=obj_fooを含めることでリストの前のページを取得することができます。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	listVectorStoresResponse

Examples

例

ベクターストアのリストを返します。

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Create - ベクターストア

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

ベクターストアを作成します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
chunking_strategy	autoChunkingStrategyRequestParam または staticChunkingStrategyRequestParam	ファイルをチャンク化するために使われたチャンク戦略。 設定していなければ、 auto 戦略を使います。 file_idsが空でない場合のみ適用されます。	いいえ
有効期限後	vectorStoreExpirationAfter	ベクターストアの有効期限ポリシー。	いいえ
ファイルID	アレイ	ベクターストアが使うべきファイルIDのリストです。 ファイルにアクセスできる file_search ツールには便利です。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
name	文字列	ベクターストアの名前です。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	vectorStoreObject

Examples

例

ベクターストアを作成します。

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

取得 - ベクターストア

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

ベクターストアを取得。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	取得するベクターストアのIDです。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	vectorStoreObject

Examples

例

ベクターストアを取得。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Modify - ベクトルストア

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

ベクターストアを修正します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	修正するベクターストアのIDです。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
有効期限後	vectorStoreExpirationAfter	ベクターストアの有効期限ポリシー。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
name	文字列	ベクターストアの名前です。	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	vectorStoreObject

Examples

例

ベクターストアを修正します。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

回答:ステータスコード:200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

削除 - ベクターストア

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

ベクターストアを削除してください。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	削除するベクターストアのIDです。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	deleteVectorStoreResponse

Examples

例

ベクターストアを削除します。

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

リスト - ベクターストアファイル

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

ベクターストアファイルのリストを返します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	ファイルが属するベクターストアのIDです。
limit	クエリ	いいえ	整数	返却すべき物の数に制限がある。 制限は1から100の範囲で、デフォルトは20です。
順序	クエリ	いいえ	文字列 可能な値: asc、 desc	オブジェクトの created_at タイムスタンプで順番を並べ替えてください。 asc 昇順は desc 、降順はです。
後	クエリ	いいえ	文字列	ページ付け用のカーソル。 after はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクトを受け取り、obj_fooで終わった場合、次の呼び出しで次のページを取得するためにafter=obj_fooを含めることができます。
以前は	クエリ	いいえ	文字列	ページ付け用のカーソル。 before はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクト(obj_fooから始まる)を受け取った場合、次の呼び出しでbefore=obj_fooを含めることでリストの前のページを取得することができます。
フィルタ	クエリ	いいえ	文字列 可能な値: in_progress、 completed、 failed、 cancelled	ファイルの状態でフィルタリングしてください。 in_progress、completed、failed、cancelledのどれかです。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	listVectorStoreFilesResponse

Examples

例

ベクターストアファイルのリストを返します。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Create - ベクターストアファイル

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

ベクターストアファイルを作成するには、ファイルをベクターストアにアタッチします。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	ファイルを作成するためのベクターストアのID。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
chunking_strategy	chunkingStrategyRequestParam	ファイルをチャンク化するために使われたチャンク戦略。 設定していなければ、 auto 戦略を使います。	いいえ
file_id	文字列	ベクターストアが使うべきファイルIDです。 ファイルにアクセスできる file_search ツールには便利です。	はい

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	vectorStoreFileObject

Examples

例

ベクターストアファイルを作成するには、ファイルをベクターストアにアタッチします。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

回答:ステータスコード:200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get - ベクターストアファイル

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

ベクターストアファイルを取得します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	ファイルが属するベクターストアのIDです。
file_id	パス	はい	文字列	取得されるファイルのIDです。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	vectorStoreFileObject

Examples

例

ベクターストアファイルを取得します。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

削除 - ベクターストアファイル

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

ベクターストアファイルを削除してください。 これでベクターストアからファイルは削除されますが、ファイル自体は削除されません。 ファイルを削除するには、delete fileエンドポイントを使います。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	ファイルが属するベクターストアのIDです。
file_id	パス	はい	文字列	削除すべきファイルのIDです。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	deleteVectorStoreFileResponse

Examples

例

ベクターストアファイルを削除してください。 これでベクターストアからファイルは削除されますが、ファイル自体は削除されません。 ファイルを削除するには、delete fileエンドポイントを使います。

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

ベクターストアファイルの属性を更新します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	ファイルが属するベクターストアのIDです。
file_id	パス	はい	文字列	属性を更新するためのファイルのID。

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
attributes	VectorStoreFileAttributes	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これは、オブジェクトに関する追加情報を構造化形式で保存したり、APIやダッシュボードを通じてオブジェクトをクエリしたりするのに役立ちます。 キーは最大64文字の文字列です。 値は最大512文字の文字列、ブール数、または数字のことです。	はい

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	vectorStoreFileObject

ベクターストアファイルの内容を取得

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

ベクターストアファイルの解析済み内容を取得します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	ベクターストアのIDです。
file_id	パス	はい	文字列	ベクターストア内のファイルのIDです。

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	VectorStoreFileContentResponse

探索ベクターストア

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

クエリとファイル属性フィルターを使って、関連するチャンクをベクターストアで検索してください。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	検索するベクターストアのIDです。

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
フィルター	比較フィルター または 複合フィルター	ファイル属性に基づいて適用するフィルターです。	いいえ
最大結果数	整数	返却すべき最大結果数。 この数字は1から50の間であるべきです。	いいえ	10
クエリ	文字列または配列	検索のためのクエリ文字列	はい
ランキングオプション	オブジェクト	検索のランキングオプション。	いいえ
└─ ランカー	列挙型	可能な値: auto、 default-2024-11-15	いいえ
└─ スコアのしきい値	number		いいえ	0
rewrite_query	boolean	ベクトル検索用に自然言語クエリを書き直すかどうか。	いいえ	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	VectorStoreSearchResultsPage

Create - ベクターストアファイルバッチ

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

ベクターストアのファイルのバッチを作成します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	ファイルバッチを作成するためのベクターストアのID。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
chunking_strategy	chunkingStrategyRequestParam	ファイルをチャンク化するために使われたチャンク戦略。 設定していなければ、 auto 戦略を使います。	いいえ
ファイルID	アレイ	ベクターストアが使うべきファイルIDのリストです。 ファイルにアクセスできる file_search ツールには便利です。	はい

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	vectorStoreFileBatchObject

Examples

例

ベクターストアのファイルのバッチを作成します。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

回答:ステータスコード:200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Get - ベクターストアファイルバッチ

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

ベクターストアファイルのバッチを取得します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	ファイルバッチが属するベクターストアのIDです。
batch_id	パス	はい	文字列	取得中のファイルバッチのIDです。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	vectorStoreFileBatchObject

Examples

例

ベクターストアファイルのバッチを取得します。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

キャンセル - ベクターストアファイルバッチ

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

ベクターストアのファイルバッチをキャンセルします。 これはこのバッチのファイル処理をできるだけ早くキャンセルしようと試みます。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	ファイルバッチが属するベクターストアのIDです。
batch_id	パス	はい	文字列	キャンセルするファイルのバッチのIDです。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	vectorStoreFileBatchObject

Examples

例

ベクターストアのファイルバッチをキャンセルします。 これはこのバッチのファイル処理をできるだけ早くキャンセルしようと試みます。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

リスト - ベクターストアファイルバッチファイル

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

バッチでベクターストアファイルのリストを返します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
vector_store_id（ベクターストアID）	パス	はい	文字列	ファイルが属するベクターストアのIDです。
batch_id	パス	はい	文字列	ファイルが属するファイルバッチのIDです。
limit	クエリ	いいえ	整数	返却すべき物の数に制限がある。 制限は1から100の範囲で、デフォルトは20です。
順序	クエリ	いいえ	文字列 可能な値: asc、 desc	オブジェクトの created_at タイムスタンプで順番を並べ替えてください。 asc 昇順は desc 、降順はです。
後	クエリ	いいえ	文字列	ページ付け用のカーソル。 after はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクトを受け取り、obj_fooで終わった場合、次の呼び出しで次のページを取得するためにafter=obj_fooを含めることができます。
以前は	クエリ	いいえ	文字列	ページ付け用のカーソル。 before はリスト内でのあなたの位置を定義するオブジェクトIDです。 例えば、リストリクエストを行って100個のオブジェクト(obj_fooから始まる)を受け取った場合、次の呼び出しでbefore=obj_fooを含めることでリストの前のページを取得することができます。
フィルタ	クエリ	いいえ	文字列 可能な値: in_progress、 completed、 failed、 cancelled	ファイルの状態でフィルタリングしてください。 in_progress、completed、failed、cancelledのどれかです。
api-version	クエリ	はい	文字列	api バージョン

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	listVectorStoreFilesResponse

Examples

例

ベクターストアファイルのリストを返します。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

作成 - Realtimesession

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

リアルタイムAPIを使ってクライアントサイドアプリケーションで使用するための一時的なAPIトークンを作成します。 session.updateクライアントイベントと同じセッションパラメータで設定可能です。 セッションオブジェクトと、リアルタイムAPIのブラウザクライアント認証に使用できる一時的なAPIトークンを含む client_secret キーで応答します。

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
input_audio_format	列挙型	入力音声のフォーマット。 選択肢は pcm16、 g711_ulaw、または g711_alawです。 pcm16の場合、入力音声は16ビットPCM、24kHzのサンプルレート、シングルチャンネル(モノラル)、リトルエンディアンのバイトオーダーでなければなりません。 可能な値: pcm16、 g711_ulaw、 g711_alaw	いいえ
input_audio_noise_reduction	オブジェクト	入力オーディオノイズリダクションの設定。 これを null に設定して電源を切ることができます。 ノイズリダクションフィルターは、VADやモデルに送られる前に入力オーディオバッファに追加された音声をフィルターします。 音声をフィルタリングすることで、VADやターン検出の精度(誤検知の減少)や入力音声の知覚を向上させるモデル性能が向上します。	いいえ
└─ タイプ	列挙型	ノイズリダクションの種類です。 near_field はヘッドホンのような近距離通話用マイク用で、 far_field はノートパソコンや会議室用マイクなどの遠距離マイク用です。 可能な値: near_field、 far_field	いいえ
音声トランスクリプション入力	オブジェクト	入力音声文字起こしの設定はデフォルトでオフにされ、オンになると null に設定できます。 入力音声の文字起こしはモデルのネイティブではありません。モデルは直接音声を消費するためです。 文字起こしは Transcriptionsエンドポイント を非同期で実行し、モデルが正確に聞いた音声ではなく、入力音声内容の誘導として扱うべきです。 クライアントは文字起こしの言語やプロンプトをオプションで設定でき、これらは文字起こしサービスに追加の指針を提供します。	いいえ
└─ 言語	文字列	入力音声の言語。 入力言語を ISO-639-1 (例: en)形式で提供することで、精度と遅延が向上します。	いいえ
└─ モデル	文字列	転写に使うモデルは、現在の選択肢として gpt-4o-transcribe、 gpt-4o-transcribe-diarize、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 whisper-1です。	いいえ
└─ プロンプト	文字列	モデルのスタイルをガイドしたり、前の音声セグメントを続けるためのオプションテキスト。 whisper-1の場合、プロンプトはキーワードのリストです。 gpt-4o-transcribeモデルの場合、プロンプトは「expect words related to technology」などのフリーテキスト文字列です。	いいえ
手順	文字列	デフォルトのシステム命令(すなわちシステムメッセージ)はモデル呼び出しの前に置かれていました。 このフィールドはクライアントが望ましい回答をモデルに導くことを可能にします。 モデルは回答内容や形式(例:「非常に簡潔にする」「親しみやすい行動をする」「良い反応の例がある」)や、音声行動(例:「話すのが早い」「声に感情を込める」「頻繁に笑う」など)について指導できます。 指示はモデルが必ずしも従うとは限りませんが、望ましい動作についてモデルに指針を提供します。 サーバーはデフォルト命令を設定し、このフィールドが設定されていない場合に使用され、セッション開始時の session.created イベントで表示されます。	いいえ
max_response_output_tokens	整数または文字列	ツール呼び出しを含む単一のアシスタント応答に対する最大出力トークン数。 出力トークン数を制限するために1から4096までの整数を用意するか、あるモデルで利用可能な最大トークン数を inf にします。 デフォルトは infです。	いいえ
modalities		モデルが応答できるモダリティの集合。 音声を無効にするには、["text"]に設定してください。	いいえ
モデル	文字列	このセッションで使用された展開の名前。	いいえ
output_audio_format	列挙型	出力音声のフォーマット。 選択肢は pcm16、 g711_ulaw、または g711_alawです。 pcm16の場合、出力音声は24kHzの周波数でサンプリングされます。 可能な値: pcm16、 g711_ulaw、 g711_alaw	いいえ
温度	number	モデルのサンプリング温度は[0.6, 1.2]に制限されています。 オーディオモデルでは、最高のパフォーマンスのために0.8度の温度が強く推奨されます。	いいえ	0.8
tool_choice	文字列	モデルがどのように道具を選ぶか。 オプションは auto、 none、 required、または関数を指定することができます。	いいえ	自動
ツール	アレイ	モデルが利用可能なツール(機能)。	いいえ
turn_detection	オブジェクト	ターン検出の設定、サーバーVADまたはセマンティックVADの設定。 これを null に設定してオフにすることもでき、その場合はクライアントが手動でモデル応答をトリガーする必要があります。 サーバーVADは、音声の音量に基づいて音声の開始と終了を検出し、ユーザーの音声の終わりに応答することを意味します。 セマンティックVADはより高度で、ターン検出モデル(VADと組み合わせて)を用いて、ユーザーが話し終えたかどうかを意味的に推定し、その確率に基づいて動的にタイムアウトを設定します。 例えば、ユーザーの音声が uhhmで途切れると、モデルはターン終了の確率を低く評価し、ユーザーが話すまで長く待ちます。 これはより自然な会話には役立ちますが、遅延が高くなることがあります。	いいえ
└─ 応答を作成	boolean	VAD停止イベントが発生した際に自動的に応答を生成するかどうか。	いいえ	正しい
└─ 熱心さ	列挙型	semantic_vadモード専用。 モデルの反応への熱意。 low ユーザーが話し続けるまでより長く待ち、 high より早く応答します。 auto はデフォルトであり、 mediumと同等です。 可能な値: low、 medium、 high、 auto	いいえ
└─ 割り込み対応 (interrupt_response)	boolean	VAD開始イベントが発生した際に、進行中の応答を自動的にデフォルト会話(すなわちconversationauto)に出力して中断するかどうか。	いいえ	正しい
└─ prefix_padding_ms（プリフィックス・パディング・ミリ秒）	整数	server_vadモード専用。 VADが音声を検出する前に含める音声量(ミリ秒単位)。 デフォルトは300msです。	いいえ
└─ 無音時間_ミリ秒	整数	server_vadモード専用。 発言停止を検出するための無音の持続時間(ミリ秒単位)。 デフォルトは500msです。 短い値を使えばモデルはより速く反応しますが、ユーザーの短い間入りに飛び込むことがあります。	いいえ
└─ しきい値	number	server_vadモード専用。 VADのアクティベーション閾値(0.0から1.0)はデフォルトで0.5です。 閾値が高いほど、モデルを起動するにはより大きな音が必要になり、騒がしい環境での性能が向上する可能性があります。	いいえ
└─ タイプ	列挙型	旋回検知の種類。 可能な値: server_vad、 semantic_vad	いいえ
音声	VoiceIdsShared		いいえ

Responses

ステータスコード: 200

説明:セッションが正常に作成されました。

Content-Type（コンテンツの種類）	Type	説明
application/json	RealtimeSessionCreateResponse

作成 - Transcriptionrealtimesession

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Realtime APIを使ってクライアントサイドアプリケーションで使う一時的なAPIトークンを作成し、リアルタイム文字起こし専用に作成してください。 transcription_session.updateクライアントイベントと同じセッションパラメータで設定可能です。 セッションオブジェクトと、リアルタイムAPIのブラウザクライアント認証に使用できる一時的なAPIトークンを含む client_secret キーで応答します。

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
含める	アレイ	書き起こしに含める項目のセット。 現在利用可能な品は以下の通りです: - item.input_audio_transcription.logprobs	いいえ
input_audio_format	列挙型	入力音声のフォーマット。 選択肢は pcm16、 g711_ulaw、または g711_alawです。 pcm16の場合、入力音声は16ビットPCM、24kHzのサンプルレート、シングルチャンネル(モノラル)、リトルエンディアンのバイトオーダーでなければなりません。 可能な値: pcm16、 g711_ulaw、 g711_alaw	いいえ
input_audio_noise_reduction	オブジェクト	入力オーディオノイズリダクションの設定。 これを null に設定して電源を切ることができます。 ノイズリダクションフィルターは、VADやモデルに送られる前に入力オーディオバッファに追加された音声をフィルターします。 音声をフィルタリングすることで、VADやターン検出の精度(誤検知の減少)や入力音声の知覚を向上させるモデル性能が向上します。	いいえ
└─ タイプ	列挙型	ノイズリダクションの種類です。 near_field はヘッドホンのような近距離通話用マイク用で、 far_field はノートパソコンや会議室用マイクなどの遠距離マイク用です。 可能な値: near_field、 far_field	いいえ
音声トランスクリプション入力	オブジェクト	入力音声文字起こしの設定。 クライアントは文字起こしの言語やプロンプトをオプションで設定でき、これらは文字起こしサービスに追加の指針を提供します。	いいえ
└─ 言語	文字列	入力音声の言語。 入力言語を ISO-639-1 (例: en)形式で提供することで、精度と遅延が向上します。	いいえ
└─ モデル	列挙型	転写に使うモデルは、現在の選択肢として gpt-4o-transcribe、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 whisper-1です。 可能な値: gpt-4o-transcribe、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 whisper-1	いいえ
└─ プロンプト	文字列	モデルのスタイルをガイドしたり、前の音声セグメントを続けるためのオプションテキスト。 whisper-1の場合、プロンプトはキーワードのリストです。 gpt-4o-transcribeモデルの場合、プロンプトは「expect words related to technology」などのフリーテキスト文字列です。	いいえ
modalities		モデルが応答できるモダリティの集合。 音声を無効にするには、["text"]に設定してください。	いいえ
turn_detection	オブジェクト	ターン検出の設定、サーバーVADまたはセマンティックVADの設定。 これを null に設定してオフにすることもでき、その場合はクライアントが手動でモデル応答をトリガーする必要があります。 サーバーVADは、音声の音量に基づいて音声の開始と終了を検出し、ユーザーの音声の終わりに応答することを意味します。 セマンティックVADはより高度で、ターン検出モデル(VADと組み合わせて)を用いて、ユーザーが話し終えたかどうかを意味的に推定し、その確率に基づいて動的にタイムアウトを設定します。 例えば、ユーザーの音声が uhhmで途切れると、モデルはターン終了の確率を低く評価し、ユーザーが話すまで長く待ちます。 これはより自然な会話には役立ちますが、遅延が高くなることがあります。	いいえ
└─ 応答を作成	boolean	VAD停止イベントが発生した際に自動的に応答を生成するかどうか。 文字起こしセッションは利用できません。	いいえ	正しい
└─ 熱心さ	列挙型	semantic_vadモード専用。 モデルの反応への熱意。 low ユーザーが話し続けるまでより長く待ち、 high より早く応答します。 auto はデフォルトであり、 mediumと同等です。 可能な値: low、 medium、 high、 auto	いいえ
└─ 割り込み対応 (interrupt_response)	boolean	VAD開始イベントが発生した際に、進行中の応答を自動的にデフォルト会話(すなわちconversationauto)に出力して中断するかどうか。 文字起こしセッションは利用できません。	いいえ	正しい
└─ prefix_padding_ms（プリフィックス・パディング・ミリ秒）	整数	server_vadモード専用。 VADが音声を検出する前に含める音声量(ミリ秒単位)。 デフォルトは300msです。	いいえ
└─ 無音時間_ミリ秒	整数	server_vadモード専用。 発言停止を検出するための無音の持続時間(ミリ秒単位)。 デフォルトは500msです。 短い値を使えばモデルはより速く反応しますが、ユーザーの短い間入りに飛び込むことがあります。	いいえ
└─ しきい値	number	server_vadモード専用。 VADのアクティベーション閾値(0.0から1.0)はデフォルトで0.5です。 閾値が高いほど、モデルを起動するにはより大きな音が必要になり、騒がしい環境での性能が向上する可能性があります。	いいえ
└─ タイプ	列挙型	旋回検知の種類。 可能な値: server_vad、 semantic_vad	いいえ

Responses

ステータスコード: 200

説明:セッションが正常に作成されました。

Content-Type（コンテンツの種類）	Type	説明
application/json	RealtimeTranscriptionSessionCreateResponse

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

モデル的な反応を作り出します。

リクエストボディ

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

名前	タイプ	説明	必須	デフォルト
含める	アレイ		いいえ
入力	文字列または配列	モデル入力	はい
手順	文字列	モデルのコンテキストの最初の項目としてシステム(または開発者)メッセージを挿入します。 previous_response_idと共に使用した場合、前の応答の指示は次の応答に引き継がれません。 これにより、新しい応答でシステム(または開発者)メッセージを簡単に切り替えることができます。	いいえ
max_output_tokens	整数	応答のために生成できるトークン数の上限で、可視出力トークンや会話状態も含まれます。	いいえ
並列ツール呼び出し	boolean	モデルがツールコールを並列実行できるようにするか。	いいえ	正しい
previous_response_id	文字列	モデルに対する前の応答の一意ID。 これを使って複数ターンにわたる会話を作りましょう。 会話状態について詳しく学びましょう。	いいえ
reasoning	Reasoning	推論モデルの設定オプション。	いいえ
保存する	boolean	生成されたモデル応答を保存し、後でAPI経由で取得するかどうか。	いいえ	正しい
ストリーミング	boolean	trueに設定すると、モデル応答データは サーバー送信イベントで生成される際にクライアントにストリーミングされます。 詳細は下記のストリーミングセクションをご覧ください。	いいえ	いいえ
SMS 送信	オブジェクト	モデルからのテキスト応答の設定オプション。 プレーンテキストでも構造化JSONデータでも構いません。 詳細情報： - テキスト入力および出力 - 構造化出力	いいえ
└─ フォーマット	TextResponseFormatConfiguration	モデルが出力すべきフォーマットを指定するオブジェクト。 { "type": "json_schema" }設定すると構造化出力が可能になり、モデルが提供されたJSONスキーマに合致します。 デフォルトのフォーマットは { "type": "text" } で、追加オプションはありません。 GPT-4o以降のモデルにはおすすめできません: { "type": "json_object" }に設定すると古いJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 json_schemaを使ったモデルでは、この方法をサポートするモデルが推奨されます。	いいえ
tool_choice	ToolChoiceOptions 、 ToolChoiceTypes 、または ToolChoiceFunction	モデルが応答を生成する際に使用するツールを選択する方法について。 モデルが呼び出せるツールを指定するには、 tools パラメータを参照してください。	いいえ
ツール	アレイ	モデルが応答を生成する際に呼び出す可能性のあるツールの配列です。 tool_choiceパラメータを設定することで、どのツールを使うかを指定できます。 モデルに提供できるツールの2つのカテゴリーがあります: - 組み込みツール:OpenAIが提供するツールで、 モデルの機能	いいえ
truncation	列挙型	モデル応答に用いる切断戦略。 - auto: この回答および以前の応答のコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中で入力項目を落として応答を切り詰めてコンテキストウィンドウに合わせます。 - disabled (デフォルト):モデルの応答がモデルのコンテキストウィンドウサイズを超える場合、リクエストは400エラーで失敗します。 可能な値: auto、 disabled	いいえ

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	response
text/event-stream	responseStreamEvent

ステータスコード: デフォルト

説明:サービス利用不可

Content-Type（コンテンツの種類）	Type	説明
application/json	errorResponse

Responses API - 入力項目

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

与えられたIDでモデル応答を取得します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
response_id	パス	はい	文字列	応答のIDを取り戻す。
含める	クエリ	いいえ	アレイ	回答に含める追加の項目。 詳細については、上記の「応答作成の include パラメータ」を参照してください。

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	response

ステータスコード: デフォルト

説明:サービス利用不可

Content-Type（コンテンツの種類）	Type	説明
application/json	errorResponse

応答の削除

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

指定されたIDのモデル応答を削除します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
response_id	パス	はい	文字列	削除する返信のIDです。

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

ステータスコード: 404

説明:見つかりません

Content-Type（コンテンツの種類）	Type	説明
application/json	error

ステータスコード: デフォルト

説明:サービス利用不可

Content-Type（コンテンツの種類）	Type	説明
application/json	errorResponse

Responses API - レスポンスアイテムリスト

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

与えられた応答に対して入力項目のリストを返します。

URI パラメーター

名前	In	必須	タイプ	説明
エンドポイント	パス	はい	文字列 URL	OpenAI Azureエンドポイント(プロトコルおよびホスト名、例:https://aoairesource.openai.azure.com)に対応しています。「aoairesource」をAzure OpenAIリソース名に置き換えてください。 https://{your-resource-name}.openai.azure.com
response_id	パス	はい	文字列	入力項目を取得する応答のIDです。
limit	クエリ	いいえ	整数	返却すべき物の数に制限がある。 制限は1から100の範囲で、デフォルトは20です。
順序	クエリ	いいえ	文字列 可能な値: asc、 desc	入力項目を返却する順序。 デフォルトは ascです。 - asc: 入力項目を昇順で返します。 - desc: 入力項目を降順に返します。
後	クエリ	いいえ	文字列	ページ付けで使われる項目IDを後にリストアップします。
以前は	クエリ	いいえ	文字列	ページ分けで使われるアイテムIDは、以前にアイテムをリストアップするためのものです。

リクエストヘッダー

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

名前	必須	タイプ	説明
Authorization	正しい	文字列	例：Authorization: Bearer {Azure_OpenAI_Auth_Token} 認証トークンを生成するにはAzure CLI: az account get-access-token --resource https://cognitiveservices.azure.com 型: oauth2 認証URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize 範囲: https://ai.azure.com/.default
APIキー	正しい	文字列	ここにAzure OpenAI API キーを提供してください

Responses

ステータスコード: 200

説明: OK

Content-Type（コンテンツの種類）	Type	説明
application/json	responseItemList

Components

errorResponse

名前	タイプ	説明	必須	デフォルト
エラー	error		いいえ

errorBase

名前	タイプ	説明	必須	デフォルト
コード	文字列		いいえ
メッセージ	文字列		いいえ

エラー

名前	タイプ	説明	必須	デフォルト
inner_error	innerError	内部の誤りに追加の詳細を加えた。	いいえ
param	文字列		いいえ
型	文字列		いいえ

innerError

内部の誤りに追加の詳細を加えた。

名前	タイプ	説明	必須	デフォルト
コード	innerErrorCode	内側のエラーオブジェクトのエラーコード。	いいえ
content_filter_results	contentFilterPromptResults	コンテンツフィルタリングのカテゴリ(ヘイト、性的、暴力、self_harm)、検出されたかどうか、そして有害なコンテンツの強度やリスクレベルを決定する重症度レベル(very_low、低、中、高)およびフィルタリングの有無に関する情報。 脱獄コンテンツや罵り言葉に関する情報、検出されたかどうか、フィルタリングされているかどうか。 顧客ブロックリストの情報(フィルタリング済みか)やIDも含めて。	いいえ

innerErrorCode

内側のエラーオブジェクトのエラーコード。

Property	価値
説明	内側のエラーオブジェクトのエラーコード。
Type	文字列
値	ResponsibleAIPolicyViolation

dalleErrorResponse

名前	タイプ	説明	必須	デフォルト
エラー	dalleError		いいえ

dalleError

名前	タイプ	説明	必須	デフォルト
inner_error	dalleInnerError	内部の誤りに追加の詳細を加えた。	いいえ
param	文字列		いいえ
型	文字列		いいえ

dalleInnerError

内部の誤りに追加の詳細を加えた。

名前	タイプ	説明	必須	デフォルト
コード	innerErrorCode	内側のエラーオブジェクトのエラーコード。	いいえ
content_filter_results	dalleFilterResults	コンテンツフィルタリングのカテゴリ(ヘイト、性的、暴力、self_harm)、検出されたかどうか、そして有害なコンテンツの強度やリスクレベルを決定する重症度レベル(very_low、低、中、高)およびフィルタリングの有無に関する情報。 脱獄コンテンツや罵り言葉に関する情報、検出されたかどうか、フィルタリングされているかどうか。 顧客ブロックリストの情報(フィルタリング済みか)やIDも含めて。	いいえ
修正版プロンプト	文字列	画像を生成するために使われたプロンプト、もしプロンプトに修正があったなら。	いいえ

contentFilterCompletionTextSpan

生成された完了テキスト内のスパンを記述します。 オフセット0は完了テキストの最初のUTF32コードポイントです。

名前	タイプ	説明	必須	デフォルト
completion_end_offset	整数	スパンから除外されている最初のUTF32コードポイントのオフセット。 この体は空のスパンに対して常に completion_start_offset に等しい。 この場は空でないスパンの場合、常にcompletion_start_offsetより大きい。	はい
completion_start_offset	整数	スパンの開始となるUTF32コードポイントのオフセット。	はい

contentFilterResultBase

名前	タイプ	説明	必須	デフォルト
filtered	boolean		はい

contentFilterSeverityResult

名前	タイプ	説明	必須	デフォルト
filtered	boolean		はい
severity	文字列		いいえ

contentFilterDetectedResult

名前	タイプ	説明	必須	デフォルト
detected	boolean		いいえ
filtered	boolean		はい

contentFilterDetectedWithCitationResult

名前	タイプ	説明	必須	デフォルト
citation	オブジェクト		いいえ
└─ URL (ユーアールエル)	文字列		いいえ
└─ ライセンス	文字列		いいえ

contentFilterDetectedWithCompletionTextSpansResult

名前	タイプ	説明	必須	デフォルト
details	アレイ		いいえ

contentFilterIdResult

名前	タイプ	説明	必須	デフォルト
filtered	boolean		はい
id	文字列		いいえ

contentFilterResultsBase

コンテンツフィルタリングの結果に関する情報。

名前	タイプ	説明	必須	デフォルト
custom_blocklists	contentFilterDetailedResults	コンテンツフィルタリングは、フィルタリングされたセグメントのコンテンツフィルターIDの詳細を表示します。	いいえ
エラー	errorBase		いいえ
hate	contentFilterSeverityResult		いいえ
profanity	contentFilterDetectedResult		いいえ
self_harm	contentFilterSeverityResult		いいえ
性的	contentFilterSeverityResult		いいえ
violence	contentFilterSeverityResult		いいえ

contentFilterPromptResults

コンテンツフィルタリングのカテゴリ(ヘイト、性的、暴力、self_harm)、検出されたかどうか、そして有害なコンテンツの強度やリスクレベルを決定する重症度レベル(very_low、低、中、高)およびフィルタリングの有無に関する情報。 脱獄コンテンツや罵り言葉に関する情報、検出されたかどうか、フィルタリングされているかどうか。 顧客ブロックリストの情報(フィルタリング済みか)やIDも含めて。

名前	タイプ	説明	必須	デフォルト
custom_blocklists	contentFilterDetailedResults	コンテンツフィルタリングは、フィルタリングされたセグメントのコンテンツフィルターIDの詳細を表示します。	いいえ
エラー	errorBase		いいえ
hate	contentFilterSeverityResult		いいえ
indirect_attack	contentFilterDetectedResult		いいえ
脱獄	contentFilterDetectedResult		いいえ
profanity	contentFilterDetectedResult		いいえ
self_harm	contentFilterSeverityResult		いいえ
性的	contentFilterSeverityResult		いいえ
violence	contentFilterSeverityResult		いいえ

contentFilterChoiceResults

コンテンツフィルタリングのカテゴリ(ヘイト、性的、暴力、self_harm)、検出されたかどうか、そして有害なコンテンツの強度やリスクレベルを決定する重症度レベル(very_low、低、中、高)およびフィルタリングの有無に関する情報。 第三者のテキストや罵り言葉に関する情報、検出されたかどうか、フィルタリングされているかどうか。 顧客ブロックリストの情報(フィルタリング済みか)やIDも含めて。

名前	タイプ	説明	必須	デフォルト
custom_blocklists	contentFilterDetailedResults	コンテンツフィルタリングは、フィルタリングされたセグメントのコンテンツフィルターIDの詳細を表示します。	いいえ
エラー	errorBase		いいえ
hate	contentFilterSeverityResult		いいえ
profanity	contentFilterDetectedResult		いいえ
protected_material_code	contentFilterDetectedWithCitationResult		いいえ
protected_material_text	contentFilterDetectedResult		いいえ
self_harm	contentFilterSeverityResult		いいえ
性的	contentFilterSeverityResult		いいえ
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		いいえ
violence	contentFilterSeverityResult		いいえ

contentFilterDetailedResults

コンテンツフィルタリングは、フィルタリングされたセグメントのコンテンツフィルターIDの詳細を表示します。

名前	タイプ	説明	必須	デフォルト
details	アレイ		いいえ
filtered	boolean		はい

promptFilterResult

リクエスト内の単一のプロンプトに対するコンテンツフィルタリングの結果。

名前	タイプ	説明	必須	デフォルト
content_filter_results	contentFilterPromptResults	コンテンツフィルタリングのカテゴリ(ヘイト、性的、暴力、self_harm)、検出されたかどうか、そして有害なコンテンツの強度やリスクレベルを決定する重症度レベル(very_low、低、中、高)およびフィルタリングの有無に関する情報。 脱獄コンテンツや罵り言葉に関する情報、検出されたかどうか、フィルタリングされているかどうか。 顧客ブロックリストの情報(フィルタリング済みか)やIDも含めて。	いいえ
prompt_index	整数		いいえ

promptFilterResults

リクエスト内のプロンプトが0つ以上に対してコンテンツフィルタリングの結果が出ます。 ストリーミングリクエストでは、異なるプロンプトの結果が異なる時間や順序で届くことがあります。

このコンポーネントにはプロパティが定義されていません。

dalleContentFilterResults

コンテンツフィルタリングの結果に関する情報。

名前	タイプ	説明	必須	デフォルト
hate	contentFilterSeverityResult		いいえ
self_harm	contentFilterSeverityResult		いいえ
性的	contentFilterSeverityResult		いいえ
violence	contentFilterSeverityResult		いいえ

dalleFilterResults

コンテンツフィルタリングのカテゴリ(ヘイト、性的、暴力、self_harm)、検出されたかどうか、そして有害なコンテンツの強度やリスクレベルを決定する重症度レベル(very_low、低、中、高)およびフィルタリングの有無に関する情報。 脱獄コンテンツや罵り言葉に関する情報、検出されたかどうか、フィルタリングされているかどうか。 顧客ブロックリストの情報(フィルタリング済みか)やIDも含めて。

名前	タイプ	説明	必須	デフォルト
custom_blocklists	contentFilterDetailedResults	コンテンツフィルタリングは、フィルタリングされたセグメントのコンテンツフィルターIDの詳細を表示します。	いいえ
hate	contentFilterSeverityResult		いいえ
脱獄	contentFilterDetectedResult		いいえ
profanity	contentFilterDetectedResult		いいえ
self_harm	contentFilterSeverityResult		いいえ
性的	contentFilterSeverityResult		いいえ
violence	contentFilterSeverityResult		いいえ

chatCompletionsRequestCommon

名前	タイプ	説明	必須	デフォルト
頻度ペナルティ (frequency_penalty)	number	数字は-2.0から2.0の間です。 正の値は、これまでテキスト内の既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行を逐語的に繰り返す可能性を減らします。	いいえ	0
ロジットバイアス	オブジェクト	完了に指定されたトークンが現れる確率を修正します。 トークン(トークナイザーのトークンIDで指定)を -100 から100までの付随するバイアス値にマッピングするjsonオブジェクトを受け入れます。 数学的には、バイアスはサンプリング前にモデルが生成するロジットに加算されます。 正確な効果はモデルによって異なりますが、-1 から1の間の値は選択の可能性を下げたり増やしたりするはずです。-100 や100のような値が出ると、該当するトークンが禁止されるか、排他的に選択されるべきです。	いいえ
max_completion_tokens	整数	完了化で生成可能なトークン数の上限であり、可視出力トークンや推論トークンも含まれます。	いいえ
マックス_トークン	整数	生成される答えに許される最大トークン数。 デフォルトでは、モデルが返せるトークンの数は(4096 - プロンプトトークン)となります。 これはO1シリーズモデルとは互換性がありません。	いいえ	4096
メタデータ	オブジェクト	開発者が定義したタグや値を、保存された完了ダッシュボードで完了をフィルタリングするために使用します。	いいえ
presence_penalty	number	数字は-2.0から2.0の間です。 正の値は、テキストに現れたかどうかに基づいて新しいトークンにペナルティを与え、モデルが新しいトピックについて語る可能性を高めます。	いいえ	0
stop	文字列または配列	APIがこれ以上のトークン生成を停止するシーケンスは最大4つあります。	いいえ
保存する	boolean	このチャット完了リクエストの出力を、モデルの蒸留や評価製品で使用するために保存するかどうかについても判断しています。	いいえ
ストリーミング	boolean	設定すると、ChatGPTのように部分的なメッセージの差が送信されます。 トークンは利用可能なデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージで終了します。	いいえ	いいえ
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。 一般的にはこれを変更するか、あるいは top_p を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこれを変更するか、あるいは temperature を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
ユーザー	文字列	エンドユーザーを表す一意の識別子で、Azure OpenAIが不正を監視・検出するのに役立ちます。	いいえ

createCompletionRequest

名前	タイプ	説明	必須	デフォルト
ベスト・オブ	整数	サーバー側で best_of 完結を生成し、「最良」(トークンあたりのログ確率が最も高いもの)を返します。 結果はストリーミングできません。 nと組み合わせて使う場合、best_ofは候補の完了数を制御し、n返すべき数を指定します。 best_of nより大きくなければなりません。 注: このパラメータは多くの完了を生み出すため、トークンのクォータをすぐに消費してしまいます。 慎重に使い、 max_tokens と stopの設定を適切に設定してください。	いいえ	1
echo	boolean	完成に加えてプロンプトにもエコーを返してください	いいえ	いいえ
頻度ペナルティ (frequency_penalty)	number	数字は-2.0から2.0の間です。 正の値は、これまでテキスト内の既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行を逐語的に繰り返す可能性を減らします。	いいえ	0
ロジットバイアス	オブジェクト	完了に指定されたトークンが現れる確率を修正します。 GPTトークナイザーでトークンIDで指定されたトークンを、-100 から100までのバイアス値にマッピングするJSONオブジェクトを受け入れます。 数学的には、バイアスはサンプリング前にモデルが生成するロジットに加算されます。 正確な効果はモデルによって異なりますが、-1 から1の間の値は選択の可能性を下げたり増やしたりするはずです。-100 や100のような値が出ると、該当するトークンが禁止されるか、排他的に選択されるべきです。 例として、{"50256": -100}|endoftext|<トークンの生成を防ぐために>パスを送ることができます。	いいえ	None
logprobs	整数	最も可能性が高い出力トークン logprobs のログ確率を含め、選ばれたトークンを含めてください。 例えば、 logprobs が5の場合、APIは最も可能性が高い5つのトークンのリストを返します。 APIは常にサンプリングされたトークンの logprob を返すため、レスポンスには最大 logprobs+1 要素が存在することがあります。 logprobsの最大値は5です。	いいえ	None
マックス_トークン	整数	完了で生成可能な最大トークン数。 プロンプトのトークン数と max_tokens はモデルのコンテキストの長さを超えてはいけません。	いいえ	16
n	整数	各プロンプトごとに何回の完了を生成するか。 注: このパラメータは多くの完了を生み出すため、トークンのクォータをすぐに消費してしまいます。 慎重に使い、 max_tokens と stopの設定を適切に設定してください。	いいえ	1
presence_penalty	number	数字は-2.0から2.0の間です。 正の値は、テキストに現れたかどうかに基づいて新しいトークンにペナルティを与え、モデルが新しいトピックについて語る可能性を高めます。	いいえ	0
ダイアログを表示する	文字列または配列	完了を生成するプロンプトは、文字列、文字列の配列、トークンの配列、またはトークン配列の配列としてエンコードされます。 <|endoftext|>は、トレーニング中にモデルが認識する文書の区切り子であるため、プロンプトが指定されていない場合、モデルは新しいドキュメントの冒頭から生成されます。	はい
seed	整数	仕様が指定されている場合、システムは決定論的にサンプリングするよう最善を尽くしており、同じ seed とパラメータで繰り返しリクエストしても同じ結果が返ってくるようにします。 決定性は保証されていないので、バックエンドの変更を監視するために system_fingerprint 応答パラメータを参照すべきです。	いいえ
stop	文字列または配列	APIがこれ以上のトークン生成を停止するシーケンスは最大4つあります。 返されたテキストには停止のシーケンスが含まれません。	いいえ
ストリーミング	boolean	部分的な進行をストリームバックするかどうか。 設定すると、トークンは利用可能なデータのみサーバー 送信イベント として送信され、ストリームは data: [DONE] メッセージで終了します。 例Pythonコード。	いいえ	いいえ
サフィックス	文字列	挿入されたテキストの完了後に付く接尾辞です。 このパラメータは gpt-3.5-turbo-instructのみサポートされています。	いいえ	None
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。 一般的にはこれを変更するか、あるいは top_p を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこれを変更するか、あるいは temperature を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
ユーザー	文字列	エンドユーザーを表す一意の識別子であり、悪用の監視や検出に役立ちます。	いいえ

createCompletionResponse

APIからの完了応答を表します。 注:ストリーミングされたレスポンスオブジェクトも非ストリーミングのレスポンスオブジェクトも同じ形状を共有しています(チャットエンドポイントとは異なります)。

名前	タイプ	説明	必須	デフォルト
選択肢	アレイ	モデルが入力プロンプトに対して生成した完了選択のリストです。	はい
created	整数	完了が作成されたUnixのタイムスタンプ(秒単位)です。	はい
id	文字列	完了の一意識別子。	はい
モデル	文字列	完成に用いられるモデル。	はい
オブジェクト	列挙型	オブジェクトタイプは常に「text_completion」です。 可能な値: text_completion	はい
prompt_filter_results	promptFilterResults	リクエスト内のプロンプトが0つ以上に対してコンテンツフィルタリングの結果が出ます。 ストリーミングリクエストでは、異なるプロンプトの結果が異なる時間や順序で届くことがあります。	いいえ
system_fingerprint	文字列	このフィンガープリントはモデルが動作するバックエンド構成を表します。 seedリクエストパラメータと組み合わせて、決定性に影響を与える可能性のあるバックエンドの変更がいつ行われたかを理解するために使用できます。	いいえ
使用	completionUsage	完了リクエストの使用統計。	いいえ

createChatCompletionRequest

名前	タイプ	説明	必須	デフォルト
オーディオ	オブジェクト	音声出力のパラメータ。 音声出力が modalities: ["audio"]で要求された場合に必須です。	いいえ
└─ フォーマット	列挙型	出力オーディオフォーマットを指定します。 wav、mp3、flac、opus、またはpcm16のいずれかでなければなりません。 可能な値: wav、 mp3、 flac、 opus、 pcm16	いいえ
└─ ボイス	列挙型	声のタイプを指定します。 サポートされる声は alloy、 echo、 fable、 onyx、 nova、 shimmerです。 可能な値: alloy、 echo、 fable、 onyx、 nova、 shimmer	いいえ
data_sources	アレイ	Azure OpenAIチャット拡張機能の構成エントリーです。 この追加仕様はAzure OpenAIのみと互換性があります。	いいえ
頻度ペナルティ (frequency_penalty)	number	数字は-2.0から2.0の間です。 正の値は、これまでテキスト内の既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行を逐語的に繰り返す可能性を減らします。	いいえ	0
関数呼び出し	文字列または chatCompletionFunctionCallOption	tool_choiceに優先して廃止されました。 モデルが呼び出す関数(もしあれば)を制御します。 none モデルは関数を呼び出すのではなく、代わりにメッセージを生成します。 auto モデルはメッセージを生成するか関数を呼び出すかを選択できることを意味します。 {"name": "my_function"}で特定の関数を指定すると、モデルはその関数を呼び出すことを強制します。 none 関数が存在しない場合のデフォルトです。 auto 関数が存在する場合のデフォルトです。	いいえ
functions	アレイ	toolsに優先して廃止されました。 モデルがJSON入力を生成する関数のリスト。	いいえ
ロジットバイアス	オブジェクト	完了に指定されたトークンが現れる確率を修正します。 トークン(トークンIDで指定)を -100 から100までの付随するバイアス値にマッピングするJSONオブジェクトを受け付けます。 数学的には、バイアスはサンプリング前にモデルが生成するロジットに加算されます。 正確な効果はモデルによって異なりますが、-1 から1の間の値は選択の可能性を下げたり増やしたりするはずです。-100 や100のような値が出ると、該当するトークンが禁止されるか、排他的に選択されるべきです。	いいえ	None
logprobs	boolean	出力トークンのログ確率を返すかどうか。 もし真であれば、contentmessageで返された各出力トークンの対数確率を返します。	いいえ	いいえ
max_completion_tokens	整数	完了化で生成可能なトークン数の上限であり、可視出力トークンや推論トークンも含まれます。	いいえ
マックス_トークン	整数	チャット完了時に生成できるトークンの最大数。 入力トークンと生成トークンの総長は、モデルのコンテキスト長によって制限されます。	いいえ
messages	アレイ	これまでの会話のメッセージリスト。 例Pythonコード。	はい
メタデータ	オブジェクト	開発者が定義したタグや値を、保存された完了ダッシュボードで完了をフィルタリングするために使用します。	いいえ
modalities	ChatCompletionModalities	このリクエストのためにモデルに生成してほしい出力タイプ。 ほとんどのモデルはテキスト生成が可能であり、これがデフォルトです: ["text"] gpt-4o-audio-previewモデルは音声生成にも利用できます。 このモデルにテキストと音声の両方の応答を生成するよう依頼するには、以下を利用できます: ["text", "audio"]	いいえ
n	整数	入力メッセージごとに何つのチャット完了選択肢を生成するか。 すべての選択肢で生成されたトークンの数に応じて料金が発生しますのでご注意ください。 コストを抑えるために、 n を常に保持 1 しましょう。	いいえ	1
並列ツール呼び出し	ParallelToolCalls	工具使用中に並列関数呼び出しを有効にするかどうか。	いいえ	正しい
予測	PredictionContent	予測出力の設定により、モデルの応答の大部分が事前に分かっている場合、応答時間が大幅に改善されます。 これは、ほとんどの内容にわずかな変更を加えたファイル再生成時に最も一般的です。	いいえ
presence_penalty	number	数字は-2.0から2.0の間です。 正の値は、テキストに現れたかどうかに基づいて新しいトークンにペナルティを与え、モデルが新しいトピックについて語る可能性を高めます。	いいえ	0
推論努力	列挙型	O1モデルのみ 推論モデルの推論にかかる労力を制限します。 現在サポートされている値は low、 medium、 highです。 推論の努力を減らすことで、応答の速さや推論に使われるトークンの削減につながる。 可能な値: low、 medium、 high	いいえ
response_format	ResponseFormatText または ResponseFormatJsonObject または ResponseFormatJsonSchema	モデルが出力すべきフォーマットを指定するオブジェクト。 GPT-4o、GPT-4o mini、GPT-4 Turbo、およびより新しいすべてのgpt-3.5-turbo-1106 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることが保証されます。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	いいえ
seed	整数	この機能はベータ版です。 仕様が指定されている場合、システムは決定論的にサンプリングするよう最善を尽くしており、同じ seed とパラメータで繰り返しリクエストしても同じ結果が返ってくるようにします。 決定性は保証されていないので、バックエンドの変更を監視するために system_fingerprint 応答パラメータを参照すべきです。	いいえ
stop	文字列または配列	APIがこれ以上のトークン生成を停止するシーケンスは最大4つあります。	いいえ
保存する	boolean	このチャット完了リクエストの出力を、モデルの蒸留や評価製品で使用するために保存するかどうかについても判断しています。	いいえ
ストリーミング	boolean	設定すると、ChatGPTのように部分的なメッセージの差が送信されます。 トークンは利用可能なデータのみサーバー 送信イベント として送信され、ストリームは data: [DONE] メッセージで終了します。 例Pythonコード。	いいえ	いいえ
stream_options	chatCompletionStreamOptions	ストリーミング応答の選択肢。 設定したときにだけ設定 stream: true。	いいえ	None
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。 一般的にはこれを変更するか、あるいは top_p を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
tool_choice	chatCompletionToolChoiceOption	モデルが呼び出すツール(もしあれば)を制御します。 none モデルはツールを呼び出さず、代わりにメッセージを生成します。 auto つまり、モデルはメッセージを生成するか、1つ以上のツールを呼び出すかを選べるということです。 required モデルは1つ以上のツールを呼び出しなければならないことを意味します。 {"type": "function", "function": {"name": "my_function"}}で特定のツールを指定すると、モデルはそのツールを呼び出すことを強制します。 none ツールがない場合のデフォルトです。 auto ツールがある場合はデフォルトです。	いいえ
ツール	アレイ	モデルが呼び出す可能性のあるツールのリスト。 現在、ツールとしてサポートされているのは関数のみです。 これを使って、モデルがJSON入力を生成する可能性のある関数のリストを提供します。 最大128の機能までサポートされています。	いいえ
top_logprobs	整数	0から20の間の整数で、各トークン位置で返される可能性が最も高いトークンの数を示し、それぞれに対数の確率が伴います。 logprobs このパラメータを使用する場合は true に設定されなければなりません。	いいえ
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこれを変更するか、あるいは temperature を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
ユーザー	文字列	エンドユーザーを表す一意の識別子であり、悪用の監視や検出に役立ちます。	いいえ
user_security_context	userSecurityContext	ユーザーセキュリティコンテキストには、AIアプリケーション自体やAIアプリケーションとやり取りするエンドユーザーを表す複数のパラメータが含まれます。 これらの分野は、セキュリティ運用チームがセキュリティインシデントの調査と軽減を支援し、AIアプリケーションを保護する包括的なアプローチを提供します。 詳細はMicrosoft Defender for Cloudを使ったAIアプリケーション保護について。	いいえ

userSecurityContext

ユーザーセキュリティコンテキストには、AIアプリケーション自体やAIアプリケーションとやり取りするエンドユーザーを表す複数のパラメータが含まれます。 これらの分野は、セキュリティ運用チームがセキュリティインシデントの調査と軽減を支援し、AIアプリケーションを保護する包括的なアプローチを提供します。 詳細はMicrosoft Defender for Cloudを使ったAIアプリケーション保護について。

名前	タイプ	説明	必須	デフォルト
application_name	文字列	申請書の名前です。 この分野には機密性の高い個人情報を含めるべきではありません。	いいえ
end_user_id	文字列	この識別子は、生成AIアプリケーション内でエンドユーザーを認証するために使われるMicrosoft Entra ID(旧称Azure Active Directory)ユーザーオブジェクトIDです。 この分野には機密性の高い個人情報を含めるべきではありません。	いいえ
end_user_tenant_id	文字列	エンドユーザーが属するMicrosoft 365テナントIDです。 生成AIアプリケーションがマルチテナントの場合、これは必須です。	いいえ
source_ip	文字列	元のクライアントのIPアドレスを取得し、IPv4とIPv6の両方のフォーマットに対応します。	いいえ

chatCompletionFunctions

名前	タイプ	説明	必須	デフォルト
説明	文字列	関数が何をするかの記述で、モデルがいつどのように関数を呼び出すかを決めるためのもの。	いいえ
name	文字列	呼び出す関数の名前。 a-z、A-Z、0-9、またはアンダースコアとダッシュを含む必要があり、最大64までの長さです。	はい
parameters	FunctionParameters	関数が受け入れるパラメータは、JSONスキーマオブジェクトとして記述されます。 例についてはガイドと、フォーマットに関するドキュメントについてはJSON Schemaの参考文献をご覧ください。 parametersを省略すると、パラメータリストが空の関数を定義します。	いいえ

chatCompletionFunctionCallOption

{"name": "my_function"}で特定の関数を指定すると、モデルはその関数を呼び出すことを強制します。

名前	タイプ	説明	必須	デフォルト
name	文字列	呼び出しする関数の名前。	はい

chatCompletionFunctionParameters

関数が受け入れるパラメータは、JSONスキーマオブジェクトとして記述されます。 例については ガイド/ と、フォーマットに関するドキュメントは JSONスキーマの参考 文献を参照してください。

このコンポーネントにはプロパティが定義されていません。

chatCompletionRequestMessage

このコンポーネントは以下のいずれかである:

• ChatCompletionRequestDeveloperMessage
• chatCompletionRequestSystemMessage
• chatCompletionRequestUserMessage
• chatCompletionRequestAssistantMessage
• chatCompletionRequestToolMessage
• chatCompletionRequestFunctionMessage

ChatCompletionRequestDeveloperMessage

ユーザーが送るメッセージに関わらず、モデルが従うべき開発者提供の指示。 o1モデル以降では、 developer メッセージが以前の system メッセージに代わるようになりました。

名前	タイプ	説明	必須	デフォルト
コンテンツ	文字列または配列	開発者メッセージの内容。	はい
name	文字列	参加者の任意の名前。 同じ役割の参加者を区別するためのモデル情報を提供します。	いいえ
ロール	列挙型	この場合、メッセージ作成者の役割は developer。 可能な値: developer	はい

chatCompletionRequestSystemMessage

名前	タイプ	説明	必須	デフォルト
コンテンツ	文字列または配列	システムメッセージの内容。	はい
name	文字列	参加者の任意の名前。 同じ役割の参加者を区別するためのモデル情報を提供します。	いいえ
ロール	列挙型	この場合、メッセージ作成者の役割は system。 可能な値: system	はい

chatCompletionRequestUserMessage

名前	タイプ	説明	必須	デフォルト
コンテンツ	文字列または配列	ユーザーメッセージの内容。	はい
name	文字列	参加者の任意の名前。 同じ役割の参加者を区別するためのモデル情報を提供します。	いいえ
ロール	列挙型	この場合、メッセージ作成者の役割は user。 可能な値: user	はい

chatCompletionRequestAssistantMessage

名前	タイプ	説明	必須	デフォルト
コンテンツ	文字列または配列	アシスタントメッセージの内容です。 tool_callsやfunction_callが指定されていない限り、必須です。	いいえ
関数呼び出し	オブジェクト	廃止され、 tool_callsに置き換えられました。 モデルが生成した関数の名前と引数を呼び出す必要があります。	いいえ
└─ 引数	文字列	モデルがJSON形式で生成した関数を呼び出す引数。 なお、モデルが必ずしも有効なJSONを生成するわけではなく、関数スキーマで定義されていないパラメータを誤認することがあります。 関数を呼び出す前に、コード内の引数を検証してください。	いいえ
└─ 名前	文字列	呼び出しする関数の名前。	いいえ
name	文字列	参加者の任意の名前。 同じ役割の参加者を区別するためのモデル情報を提供します。	いいえ
refusal	文字列	アシスタントからの拒否メッセージ。	いいえ
ロール	列挙型	この場合、メッセージ作成者の役割は assistant。 可能な値: assistant	はい
tool_calls	chatCompletionMessageToolCalls	モデルによって生成されるツール呼び出し、例えば関数呼び出しなどです。	いいえ

chatCompletionRequestToolMessage

名前	タイプ	説明	必須	デフォルト
コンテンツ	文字列または配列	ツールメッセージの内容。	はい
ロール	列挙型	この場合、メッセージ作成者の役割は tool。 可能な値: tool	はい
ツールコールID	文字列	このメッセージが応答しているツールコールです。	はい

chatCompletionRequestFunctionMessage

名前	タイプ	説明	必須	デフォルト
コンテンツ	文字列	関数メッセージの内容です。	はい
name	文字列	呼び出しする関数の名前。	はい
ロール	列挙型	この場合、メッセージ作成者の役割は function。 可能な値: function	はい

chatCompletionRequestDeveloperMessageContentPart

このコンポーネントは以下のいずれかである:

• chatCompletionRequestMessageContentPartText

chatCompletionRequestSystemMessageContentPart

このコンポーネントは以下のいずれかである:

• chatCompletionRequestMessageContentPartText

chatCompletionRequestUserMessageContentPart

このコンポーネントは以下のいずれかである:

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartImage
• chatCompletionRequestMessageContentPartAudio

chatCompletionRequestAssistantMessageContentPart

このコンポーネントは以下のいずれかである:

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartRefusal

chatCompletionRequestToolMessageContentPart

このコンポーネントは以下のいずれかである:

• chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartText

名前	タイプ	説明	必須	デフォルト
SMS 送信	文字列	テキストの内容。	はい
型	列挙型	内容の種類。 可能な値: text	はい

chatCompletionRequestMessageContentPartAudio

名前	タイプ	説明	必須	デフォルト
input_audio	オブジェクト		はい
└─ データ	文字列	Base64エンコード音声データ。	いいえ
└─ フォーマット	列挙型	エンコードされた音声データのフォーマット。 現在「wav」と「mp3」をサポートしています。 可能な値: wav、 mp3	いいえ
型	列挙型	内容の種類。 いつも input_audio。 可能な値: input_audio	はい

chatCompletionRequestMessageContentPartImage

名前	タイプ	説明	必須	デフォルト
image_url	オブジェクト		はい
└─ 詳細	列挙型	画像の詳細レベルを指定します。 詳細は ビジョンガイドをご覧ください。 可能な値: auto、 low、 high	いいえ
└─ URL	文字列	画像のURLかbase64でエンコードされた画像データのいずれかです。	いいえ
型	列挙型	内容の種類。 可能な値: image_url	はい

chatCompletionRequestMessageContentPartRefusal

名前	タイプ	説明	必須	デフォルト
refusal	文字列	モデルによって生成される拒否メッセージ。	はい
型	列挙型	内容の種類。 可能な値: refusal	はい

azureChatExtensionConfiguration

単一のAzure OpenAIチャット拡張の構成データの表現。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。

###azureChatExtensionConfiguration の識別子

このコンポーネントはプロパティ type を用いて異なるタイプを識別します:

型の値	Schema
azure_search	azureSearchChatExtensionConfiguration
azure_cosmos_db	azureCosmosDBChatExtensionConfiguration
elasticsearch	elasticsearchChatExtensionConfiguration
mongo_db	mongoDBChatExtensionConfiguration
pinecone	pineconeChatExtensionConfiguration

名前	タイプ	説明	必須	デフォルト
型	azureChatExtensionType	単一のAzure OpenAIチャット拡張の構成データの表現。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。	はい

azureChatExtensionType

単一のAzure OpenAIチャット拡張の構成データの表現。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。

Property	価値
説明	単一のAzure OpenAIチャット拡張の構成データの表現。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。
Type	文字列
値	azure_search azure_cosmos_db elasticsearch mongo_db pinecone

azureSearchChatExtensionConfiguration

Azure SearchをAzure OpenAIチャット拡張機能として使用した場合の設定可能なオプションの具体的な表現です。

名前	タイプ	説明	必須	デフォルト
parameters	azureSearchChatExtensionParameters	Azure OpenAIチャット拡張機能として使う場合のAzure検索のパラメータ。	いいえ
型	azureChatExtensionType	単一のAzure OpenAIチャット拡張の構成データの表現。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。	はい

azureSearchChatExtensionParameters

Azure OpenAIチャット拡張機能として使う場合のAzure検索のパラメータ。

名前	タイプ	説明	必須	デフォルト
allow_partial_result	boolean	trueと指定した場合、システムは部分的な検索結果の使用を許可し、すべてのクエリが失敗した場合にリクエストは失敗します。 指定されていないかfalseと指定された場合、検索クエリが失敗するとリクエストは失敗します。	いいえ	いいえ
認証	OnYourDataApiKeyAuthenticationOptionsやOnYourDataSystemAssignedManagedIdentityAuthenticationOptions、またはonYourDataUserAssignedManagedIdentityAuthenticationOptions、またはonYourDataAccessTokenAuthenticationOptions。		はい
embedding_dependency	onYourDataEndpointVectorizationSource または onYourDataDeploymentNameVectorizationSource または onYourDataIntegratedVectorizationSource		いいえ
エンドポイント	文字列	Azure Searchリソースが使う絶対的なエンドポイントパスです。	はい
fields_mapping	azureSearchIndexFieldMappingOptions	設定済みのAzure Searchリソースを使用した際のフィールド処理方法を制御するオプション設定。	いいえ
フィルタ	文字列	検索フィルター。	いいえ
in_scope	boolean	クエリはインデックス付きデータの使用に限定すべきか。	いいえ
include_contexts	アレイ	出力コンテキストに含まれるプロパティ。 指定しない場合、デフォルト値は citations と intentです。	いいえ
index_name	文字列	参照されているAzure検索リソースで利用可能なインデックス名。	はい
max_search_queries	整数	最大数の書き換えクエリは、1つのユーザーメッセージに対して検索プロバイダーに送信すべきです。 指定しない場合、システムは送信するクエリの数を決定します。	いいえ
クエリタイプ	azureSearchQueryType	Azure OpenAIチャット拡張機能として使用する際に実行すべきAzure検索検索クエリの種類。	いいえ
semantic_configuration	文字列	クエリの追加セマンティック構成。	いいえ
strictness	整数	検索関連性フィルタリングの設定厳密性。 厳密度が高いほど、答えの精度は高いですが、呼び起こす記憶力は低いです。	いいえ
top_n_documents	整数	設定されたクエリで機能するドキュメントの上限数。	いいえ

azureSearchIndexFieldMappingOptions

設定済みのAzure Searchリソースを使用した際のフィールド処理方法を制御するオプション設定。

名前	タイプ	説明	必須	デフォルト
content_fields	アレイ	コンテンツとして扱うべきインデックスフィールドの名前。	いいえ
content_fields_separator	文字列	コンテンツフィールドが使うべき区切りパターン。	いいえ
filepath_field	文字列	ファイルパスとして使うインデックスフィールドの名前。	いいえ
image_vector_fields	アレイ	画像ベクトルデータを表すフィールドの名前。	いいえ
title_field	文字列	タイトルとして使うインデックスフィールドの名前。	いいえ
url_field	文字列	URLとして使うインデックスフィールドの名前。	いいえ
vector_fields	アレイ	ベクトルデータを表すフィールドの名前。	いいえ

azureSearchQueryType

Azure OpenAIチャット拡張機能として使用する際に実行すべきAzure検索検索クエリの種類。

Property	価値
説明	Azure OpenAIチャット拡張機能として使用する際に実行すべきAzure検索検索クエリの種類。
Type	文字列
値	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

azureCosmosDBChatExtensionConfiguration

Azure Cosmos DBをAzure OpenAIチャット拡張機能として使用した場合の設定可能なオプションの具体的な表現です。

名前	タイプ	説明	必須	デフォルト
parameters	azureCosmosDBChatExtensionParameters	Azure OpenAI On Your Data チャット拡張を Azure Cosmos DB for MongoDB vCore で使用する際のパラメータ。	いいえ
型	azureChatExtensionType	単一のAzure OpenAIチャット拡張の構成データの表現。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。	はい

azureCosmosDBChatExtensionParameters

Azure OpenAI On Your Data チャット拡張を Azure Cosmos DB for MongoDB vCore で使用する際のパラメータ。

名前	タイプ	説明	必須	デフォルト
allow_partial_result	boolean	trueと指定した場合、システムは部分的な検索結果の使用を許可し、すべてのクエリが失敗した場合にリクエストは失敗します。 指定されていないかfalseと指定された場合、検索クエリが失敗するとリクエストは失敗します。	いいえ	いいえ
認証	onYourDataConnectionStringAuthenticationOptions	azure OpenAI On Your Data の認証オプションについて、接続文字列 を使用した場合のことです。	はい
container_name	文字列	Azure Cosmos DBリソースコンテナの名前です。	はい
database_name	文字列	Azure Cosmos DBで使うMongoDB vCoreデータベース名。	はい
embedding_dependency	onYourDataEndpointVectorizationSource または onYourDataDeploymentNameVectorizationSource		はい
fields_mapping	azureCosmosDBFieldMappingOptions	設定済みのAzure Cosmos DBリソースを使用する際のフィールド処理方法を制御するオプション設定。	はい
in_scope	boolean	クエリはインデックス付きデータの使用に限定すべきか。	いいえ
include_contexts	アレイ	出力コンテキストに含まれるプロパティ。 指定しない場合、デフォルト値は citations と intentです。	いいえ
index_name	文字列	Azure Cosmos DBで使用するMongoDB vCoreインデックス名。	はい
max_search_queries	整数	最大数の書き換えクエリは、1つのユーザーメッセージに対して検索プロバイダーに送信すべきです。 指定しない場合、システムは送信するクエリの数を決定します。	いいえ
strictness	整数	検索関連性フィルタリングの設定厳密性。 厳密度が高いほど、答えの精度は高いですが、呼び起こす記憶力は低いです。	いいえ
top_n_documents	整数	設定されたクエリで機能するドキュメントの上限数。	いいえ

azureCosmosDBFieldMappingOptions

設定済みのAzure Cosmos DBリソースを使用する際のフィールド処理方法を制御するオプション設定。

名前	タイプ	説明	必須	デフォルト
content_fields	アレイ	コンテンツとして扱うべきインデックスフィールドの名前。	はい
content_fields_separator	文字列	コンテンツフィールドが使うべき区切りパターン。	いいえ
filepath_field	文字列	ファイルパスとして使うインデックスフィールドの名前。	いいえ
title_field	文字列	タイトルとして使うインデックスフィールドの名前。	いいえ
url_field	文字列	URLとして使うインデックスフィールドの名前。	いいえ
vector_fields	アレイ	ベクトルデータを表すフィールドの名前。	はい

elasticsearchChatExtensionConfiguration

Azure OpenAIチャット拡張機能としてElasticsearchを使った際の設定可能なオプションの具体的な表現です。

名前	タイプ	説明	必須	デフォルト
parameters	elasticsearchChatExtensionParameters	Elasticsearch®をAzure OpenAIチャット拡張機能として設定する際のパラメータ。	いいえ
型	azureChatExtensionType	単一のAzure OpenAIチャット拡張の構成データの表現。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。	はい

elasticsearchChatExtensionParameters

Elasticsearch®をAzure OpenAIチャット拡張機能として設定する際のパラメータ。

名前	タイプ	説明	必須	デフォルト
allow_partial_result	boolean	trueと指定した場合、システムは部分的な検索結果の使用を許可し、すべてのクエリが失敗した場合にリクエストは失敗します。 指定されていないかfalseと指定された場合、検索クエリが失敗するとリクエストは失敗します。	いいえ	いいえ
認証	onYourDataKeyAndKeyIdAuthenticationOptions または OnYourDataEncodedApiKeyAuthenticationOptions		はい
embedding_dependency	onYourDataEndpointVectorizationSource または onYourDataDeploymentNameVectorizationSource または onYourDataModelIdVectorizationSource		いいえ
エンドポイント	文字列	Elasticsearch®のエンドポイントです。	はい
fields_mapping	elasticsearchIndexFieldMappingOptions	設定済みのElasticsearch®リソースを使用する際のフィールド処理方法を制御するオプション設定。	いいえ
in_scope	boolean	クエリはインデックス付きデータの使用に限定すべきか。	いいえ
include_contexts	アレイ	出力コンテキストに含まれるプロパティ。 指定しない場合、デフォルト値は citations と intentです。	いいえ
index_name	文字列	Elasticsearch®のインデックス名。	はい
max_search_queries	整数	最大数の書き換えクエリは、1つのユーザーメッセージに対して検索プロバイダーに送信すべきです。 指定しない場合、システムは送信するクエリの数を決定します。	いいえ
クエリタイプ	elasticsearchQueryType	Azure OpenAIチャット拡張機能として使う際に実行すべきElasticsearch®検索クエリの種類。	いいえ
strictness	整数	検索関連性フィルタリングの設定厳密性。 厳密度が高いほど、答えの精度は高いですが、呼び起こす記憶力は低いです。	いいえ
top_n_documents	整数	設定されたクエリで機能するドキュメントの上限数。	いいえ

elasticsearchIndexFieldMappingOptions

設定済みのElasticsearch®リソースを使用する際のフィールド処理方法を制御するオプション設定。

名前	タイプ	説明	必須	デフォルト
content_fields	アレイ	コンテンツとして扱うべきインデックスフィールドの名前。	いいえ
content_fields_separator	文字列	コンテンツフィールドが使うべき区切りパターン。	いいえ
filepath_field	文字列	ファイルパスとして使うインデックスフィールドの名前。	いいえ
title_field	文字列	タイトルとして使うインデックスフィールドの名前。	いいえ
url_field	文字列	URLとして使うインデックスフィールドの名前。	いいえ
vector_fields	アレイ	ベクトルデータを表すフィールドの名前。	いいえ

elasticsearchQueryType

Azure OpenAIチャット拡張機能として使う際に実行すべきElasticsearch®検索クエリの種類。

Property	価値
説明	Azure OpenAIチャット拡張機能として使う際に実行すべきElasticsearch®検索クエリの種類。
Type	文字列
値	simple vector

mongoDBChatExtensionConfiguration

Mongo DBをAzure OpenAIチャット拡張機能として使う際の設定可能なオプションの具体的な表現です。

名前	タイプ	説明	必須	デフォルト
parameters	mongoDBChatExtensionParameters	Mongo DBを使う際にAzure OpenAI On Your Dataチャット拡張機能を設定する際に使うパラメータ。	いいえ
型	azureChatExtensionType	単一のAzure OpenAIチャット拡張の構成データの表現。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。	はい

mongoDBChatExtensionParameters

Mongo DBを使う際にAzure OpenAI On Your Dataチャット拡張機能を設定する際に使うパラメータ。

名前	タイプ	説明	必須	デフォルト
allow_partial_result	boolean	trueと指定した場合、システムは部分的な検索結果の使用を許可し、すべてのクエリが失敗した場合にリクエストは失敗します。 指定されていないかfalseと指定された場合、検索クエリが失敗するとリクエストは失敗します。	いいえ	いいえ
app_name	文字列	Mongoデータベースアプリケーションの名前です。	はい
認証	onYourDataUsernameAndPasswordAuthenticationOptions	ユーザー名とパスワードを使用した場合のAzure OpenAIの認証オプションについて。	はい
collection_name	文字列	モンゴDBコレクションの名称です。	はい
database_name	文字列	Mongoデータベースの名前です。	はい
embedding_dependency	onYourDataEndpointVectorizationSource または onYourDataDeploymentNameVectorizationSource		はい
エンドポイント	文字列	MongoのDBクラスタエンドポイントの名前です。	はい
fields_mapping	mongoDBFieldMappingOptions	設定済みのMongoデータベースリソースを使用する際のフィールド処理方法を制御するオプション設定。	はい
in_scope	boolean	クエリはインデックス付きデータの使用に限定すべきか。	いいえ
include_contexts	アレイ	出力コンテキストに含まれるプロパティ。 指定しない場合、デフォルト値は citations と intentです。	いいえ
index_name	文字列	モンゴDBインデックスの名称です。	はい
max_search_queries	整数	最大数の書き換えクエリは、1つのユーザーメッセージに対して検索プロバイダーに送信すべきです。 指定しない場合、システムは送信するクエリの数を決定します。	いいえ
strictness	整数	検索関連性フィルタリングの設定厳密性。 厳密度が高いほど、答えの精度は高いですが、呼び起こす記憶力は低いです。	いいえ
top_n_documents	整数	設定されたクエリで機能するドキュメントの上限数。	いいえ

mongoDBFieldMappingOptions

設定済みのMongoデータベースリソースを使用する際のフィールド処理方法を制御するオプション設定。

名前	タイプ	説明	必須	デフォルト
content_fields	アレイ	コンテンツとして扱うべきインデックスフィールドの名前。	はい
content_fields_separator	文字列	コンテンツフィールドが使うべき区切りパターン。	いいえ
filepath_field	文字列	ファイルパスとして使うインデックスフィールドの名前。	いいえ
title_field	文字列	タイトルとして使うインデックスフィールドの名前。	いいえ
url_field	文字列	URLとして使うインデックスフィールドの名前。	いいえ
vector_fields	アレイ	ベクトルデータを表すフィールドの名前。	はい

pineconeChatExtensionConfiguration

Azure OpenAIチャット拡張機能としてPineconeを使った際の設定可能なオプションの具体的な表現です。

名前	タイプ	説明	必須	デフォルト
parameters	pineconeChatExtensionParameters	Azure OpenAI Pinecone chat extensions の設定パラメータ。	いいえ
型	azureChatExtensionType	単一のAzure OpenAIチャット拡張の構成データの表現。 これはチャット完了リクエストに使われ、Azure OpenAIのチャット拡張機能を使って応答動作を補強します。 この構成の使用はAzure OpenAIのみと互換性があります。	はい

pineconeChatExtensionParameters

Azure OpenAI Pinecone chat extensions の設定パラメータ。

名前	タイプ	説明	必須	デフォルト
allow_partial_result	boolean	trueと指定した場合、システムは部分的な検索結果の使用を許可し、すべてのクエリが失敗した場合にリクエストは失敗します。 指定されていないかfalseと指定された場合、検索クエリが失敗するとリクエストは失敗します。	いいえ	いいえ
認証	onYourDataApiKeyAuthenticationOptions	APIキーを使用した際のAzure OpenAI On Your Dataの認証オプションについて。	はい
embedding_dependency	onYourDataDeploymentNameVectorizationSource	Azure OpenAI On Your Dataがベクターサーチを適用する際に使用するベクトル化ソースの詳細は、同じAzure OpenAIリソース内の内部埋め込みモデル展開名に基づいています。	はい
環境	文字列	環境名はパインコーンです。	はい
fields_mapping	pineconeFieldMappingOptions	設定済みのPineconeリソースを使用した場合のフィールド処理方法を制御するオプション設定。	はい
in_scope	boolean	クエリはインデックス付きデータの使用に限定すべきか。	いいえ
include_contexts	アレイ	出力コンテキストに含まれるプロパティ。 指定しない場合、デフォルト値は citations と intentです。	いいえ
index_name	文字列	パインコーンデータベース索引の名称です。	はい
max_search_queries	整数	最大数の書き換えクエリは、1つのユーザーメッセージに対して検索プロバイダーに送信すべきです。 指定しない場合、システムは送信するクエリの数を決定します。	いいえ
strictness	整数	検索関連性フィルタリングの設定厳密性。 厳密度が高いほど、答えの精度は高いですが、呼び起こす記憶力は低いです。	いいえ
top_n_documents	整数	設定されたクエリで機能するドキュメントの上限数。	いいえ

pineconeFieldMappingOptions

設定済みのPineconeリソースを使用した場合のフィールド処理方法を制御するオプション設定。

名前	タイプ	説明	必須	デフォルト
content_fields	アレイ	コンテンツとして扱うべきインデックスフィールドの名前。	はい
content_fields_separator	文字列	コンテンツフィールドが使うべき区切りパターン。	いいえ
filepath_field	文字列	ファイルパスとして使うインデックスフィールドの名前。	いいえ
title_field	文字列	タイトルとして使うインデックスフィールドの名前。	いいえ
url_field	文字列	URLとして使うインデックスフィールドの名前。	いいえ

onYourDataAuthenticationOptions

あなたのデータに対するAzure OpenAIの認証オプション。

onYourDataAuthenticationOptionsの識別器

このコンポーネントはプロパティ type を用いて異なるタイプを識別します:

型の値	Schema
api_key	onYourDataApiKeyAuthenticationOptions
connection_string	onYourDataConnectionStringAuthenticationOptions
key_and_key_id	onYourDataKeyAndKeyIdAuthenticationOptions
encoded_api_key	onYourDataEncodedApiKeyAuthenticationOptions
access_token	onYourDataAccessTokenAuthenticationOptions
system_assigned_managed_identity	onYourDataSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity	onYourDataUserAssignedManagedIdentityAuthenticationOptions
username_and_password	onYourDataUsernameAndPasswordAuthenticationOptions

名前	タイプ	説明	必須	デフォルト
型	onYourDataAuthenticationType	Azure OpenAI On Your Dataでサポートされている認証タイプ。	はい

onYourDataContextProperty

コンテキストの性質です。

Property	価値
説明	コンテキストの性質です。
Type	文字列
値	citations intent all_retrieved_documents

onYourDataAuthenticationType

Azure OpenAI On Your Dataでサポートされている認証タイプ。

Property	価値
説明	Azure OpenAI On Your Dataでサポートされている認証タイプ。
Type	文字列
値	api_key connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity username_and_password

onYourDataApiKeyAuthenticationOptions

APIキーを使用した際のAzure OpenAI On Your Dataの認証オプションについて。

名前	タイプ	説明	必須	デフォルト
キー	文字列	認証に使うAPIキー。	いいえ
型	onYourDataAuthenticationType	Azure OpenAI On Your Dataでサポートされている認証タイプ。	はい

onYourDataConnectionStringAuthenticationOptions

azure OpenAI On Your Data の認証オプションについて、接続文字列 を使用した場合のことです。

名前	タイプ	説明	必須	デフォルト
connection_string	文字列	認証に使う接続文字列。	いいえ
型	onYourDataAuthenticationType	Azure OpenAI On Your Dataでサポートされている認証タイプ。	はい

onYourDataKeyAndKeyIdAuthenticationOptions

ElasticsearchキーとキーIDペアを使用した際のAzure OpenAI On Your Dataの認証オプション。

名前	タイプ	説明	必須	デフォルト
キー	文字列	認証に使うためのElasticsearchキー。	いいえ
key_id	文字列	認証に使うElasticsearchキーIDです。	いいえ
型	onYourDataAuthenticationType	Azure OpenAI On Your Dataでサポートされている認証タイプ。	はい

onYourDataEncodedApiKeyAuthenticationOptions

ElasticsearchでエンコードされたAPIキーを使用した場合のAzure OpenAI On Your Dataの認証オプション。

名前	タイプ	説明	必須	デフォルト
encoded_api_key	文字列	認証に使うためのElasticsearchエンコードAPIキー。	いいえ
型	onYourDataAuthenticationType	Azure OpenAI On Your Dataでサポートされている認証タイプ。	はい

onYourDataAccessTokenAuthenticationOptions

アクセストークンを使用した際のAzure OpenAI On Your Dataの認証オプションについて。

名前	タイプ	説明	必須	デフォルト
access_token	文字列	認証に使うアクセストークン。	いいえ
型	onYourDataAuthenticationType	Azure OpenAI On Your Dataでサポートされている認証タイプ。	はい

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

システム割り当て管理型IDを使用した際のAzure OpenAI On Your Dataの認証オプションについて。

名前	タイプ	説明	必須	デフォルト
型	onYourDataAuthenticationType	Azure OpenAI On Your Dataでサポートされている認証タイプ。	はい

onYourDataUserAssignedManagedIdentityAuthenticationOptions

ユーザー割り当て管理IDを使用した際のAzure OpenAI On Your Dataの認証オプションについて。

名前	タイプ	説明	必須	デフォルト
managed_identity_resource_id	文字列	認証に使用するユーザー割り当て管理IDのリソースID。	いいえ
型	onYourDataAuthenticationType	Azure OpenAI On Your Dataでサポートされている認証タイプ。	はい

onYourDataUsernameAndPasswordAuthenticationOptions

ユーザー名とパスワードを使用した場合のAzure OpenAIの認証オプションについて。

名前	タイプ	説明	必須	デフォルト
パスワード	文字列	パスワード。 認証に使うために。	いいえ
型	onYourDataAuthenticationType	Azure OpenAI On Your Dataでサポートされている認証タイプ。	はい
ユーザー名	文字列	認証用のユーザー名です。	いいえ

onYourDataVectorizationSource

Azure OpenAI On Your Dataのベクトル検索によるベクトル化ソースの抽象表現です。

このコンポーネントはプロパティ type を用いて異なるタイプを識別します:

型の値	Schema
endpoint	onYourDataEndpointVectorizationSource
deployment_name	onYourDataDeploymentNameVectorizationSource
integrated	onYourDataIntegratedVectorizationSource
model_id	onYourDataModelIdVectorizationSource

名前	タイプ	説明	必須	デフォルト
型	onYourDataVectorizationSourceType	Azure OpenAI On Your Dataがベクター検索用のベクトル化設定に使用できる利用可能なソースを表しています。	はい

onYourDataVectorizationSourceType

Azure OpenAI On Your Dataがベクター検索用のベクトル化設定に使用できる利用可能なソースを表しています。

Property	価値
説明	Azure OpenAI On Your Dataがベクター検索用のベクトル化設定に使用できる利用可能なソースを表しています。
Type	文字列
値	endpoint deployment_name integrated model_id

onYourDataEndpointVectorizationSource

ベクトル検索を適用する際にAzure OpenAI On Your Dataで使用されるベクトル化ソースの詳細。これは公開されたAzure OpenAIエンドポイントの埋め込み呼び出しに基づいています。

名前	タイプ	説明	必須	デフォルト
認証	onYourDataApiKeyAuthenticationOptions または onYourDataAccessTokenAuthenticationOptions		いいえ
dimensions	整数	埋め込みが持つべき次元の数。 text-embedding-3年以降のモデルのみでサポートされています。	いいえ
エンドポイント	文字列	埋め込みを取得するためのリソースエンドポイントURLを指定します。 https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddingsの形式であるべきです。 APIバージョンのクエリパラメータは許可されていません。	いいえ
型	onYourDataVectorizationSourceType	Azure OpenAI On Your Dataがベクター検索用のベクトル化設定に使用できる利用可能なソースを表しています。	はい

onYourDataDeploymentNameVectorizationSource

ベクトル検索を適用する際にAzure OpenAI On Your Dataで使用されるベクトル化ソースの詳細は、同じAzure OpenAIリソース内の内部埋め込みモデル展開名に基づいています。

名前	タイプ	説明	必須	デフォルト
デプロイメント名	文字列	ベクトル化に使用されるモデル展開名を指定します。 このモデル展開は同じAzure OpenAIリソース内で行う必要がありますが、On Your Dataでは公開コールではなく内部呼び出しを通じてこのモデル展開が使用されるため、プライベートネットワーク内でもベクターサーチが可能です。	いいえ
dimensions	整数	埋め込みが持つべき次元の数。 text-embedding-3年以降のモデルのみでサポートされています。	いいえ
型	onYourDataVectorizationSourceType	Azure OpenAI On Your Dataがベクター検索用のベクトル化設定に使用できる利用可能なソースを表しています。	はい

onYourDataIntegratedVectorizationSource

探索リソース内で定義された統合ベクトルライザーを表します。

名前	タイプ	説明	必須	デフォルト
型	onYourDataVectorizationSourceType	Azure OpenAI On Your Dataがベクター検索用のベクトル化設定に使用できる利用可能なソースを表しています。	はい

onYourDataModelIdVectorizationSource

Azure OpenAI On Your Dataがベクトル検索を適用する際に使用するベクトル化ソースの詳細で、検索サービスモデルIDに基づいています。 現在はElasticsearch®のみがサポートしています。

名前	タイプ	説明	必須	デフォルト
model_id	文字列	ベクトル化に使用するモデルIDを指定します。 このモデルIDは検索サービスで定義されなければなりません。	いいえ
型	onYourDataVectorizationSourceType	Azure OpenAI On Your Dataがベクター検索用のベクトル化設定に使用できる利用可能なソースを表しています。	はい

azureChatExtensionsMessageContext

Azure OpenAIチャット拡張機能が対応するチャット完了応答の生成に関与した際に追加のコンテキスト情報を表現したものです。 このコンテキスト情報は、対応する拡張機能を使用するように設定されたAzure OpenAIリクエストを使用した場合にのみ入力されます。

名前	タイプ	説明	必須	デフォルト
all_retrieved_documents	アレイ	回収されたすべての文書。	いいえ
citations	アレイ	データソースの取得結果は、応答のアシスタントメッセージを生成するために使用されます。	いいえ
意図	文字列	チャット履歴から検出された意図は、文脈を引き継ぐために次のターンに渡されていました。	いいえ

citation

チャット完了メッセージの引用情報。

名前	タイプ	説明	必須	デフォルト
chunk_id	文字列	引用のチャンクIDです。	いいえ
コンテンツ	文字列	引用内容。	はい
FilePath	文字列	引用のファイルパス。	いいえ
rerank_score	number	取得した文書の再ランクスコア。	いいえ
title	文字列	表彰状のタイトル。	いいえ
url	文字列	引用のURLです。	いいえ

retrievedDocument

回収された文書。

名前	タイプ	説明	必須	デフォルト
chunk_id	文字列	引用のチャンクIDです。	いいえ
コンテンツ	文字列	引用内容。	はい
data_source_index	整数	データソースのインデックス。	いいえ
FilePath	文字列	引用のファイルパス。	いいえ
filter_reason	filterReason	検索された文書のフィルタリング理由。	いいえ
original_search_score	number	取得した文書の元の検索スコア。	いいえ
rerank_score	number	取得した文書の再ランクスコア。	いいえ
search_queries	アレイ	文書を取得するために使われる検索クエリ。	いいえ
title	文字列	表彰状のタイトル。	いいえ
url	文字列	引用のURLです。	いいえ

filterReason

検索された文書のフィルタリング理由。

Property	価値
説明	検索された文書のフィルタリング理由。
Type	文字列
値	score rerank

chatCompletionMessageToolCall

名前	タイプ	説明	必須	デフォルト
関数	オブジェクト	モデルが呼び出した関数です。	はい
└─ 引数	文字列	モデルがJSON形式で生成した関数を呼び出す引数。 なお、モデルが必ずしも有効なJSONを生成するわけではなく、関数スキーマで定義されていないパラメータを誤認することがあります。 関数を呼び出す前に、コード内の引数を検証してください。	いいえ
└─ 名前	文字列	呼び出しする関数の名前。	いいえ
id	文字列	ツールコールのIDです。	はい
型	toolCallType	この場合、ツールコールの種類 function。	はい

toolCallType

この場合、ツールコールの種類 function。

Property	価値
説明	この場合、ツールコールの種類 function。
Type	文字列
値	function

chatCompletionRequestMessageTool

名前	タイプ	説明	必須	デフォルト
コンテンツ	文字列	メッセージの内容。	いいえ
ツールコールID	文字列	このメッセージが応答しているツールコールです。	いいえ

chatCompletionRequestMessageFunction

名前	タイプ	説明	必須	デフォルト
コンテンツ	文字列	メッセージの内容。	いいえ
name	文字列	メッセージの内容。	いいえ
ロール	列挙型	この場合、メッセージ作成者の役割は function。 可能な値: function	いいえ

createChatCompletionResponse

提供された入力に基づいてモデルから返されるチャット完了応答を表します。

名前	タイプ	説明	必須	デフォルト
選択肢	アレイ	チャット完了の選択肢一覧。 nが1より大きくなれば、1より多くなることもあります。	はい
created	整数	チャット完了が作成されたUnixのタイムスタンプ(秒単位)です。	はい
id	文字列	チャット完了のための一意識別子。	はい
モデル	文字列	チャット完了に使われたモデル。	はい
オブジェクト	列挙型	オブジェクトタイプは常に chat.completionです。 可能な値: chat.completion	はい
prompt_filter_results	promptFilterResults	リクエスト内のプロンプトが0つ以上に対してコンテンツフィルタリングの結果が出ます。 ストリーミングリクエストでは、異なるプロンプトの結果が異なる時間や順序で届くことがあります。	いいえ
system_fingerprint	文字列	このフィンガープリントはモデルが動作するバックエンド構成を表します。 seedリクエストパラメータと組み合わせて、決定性に影響を与える可能性のあるバックエンドの変更がいつ行われたかを理解するために使用できます。	いいえ
使用	completionUsage	完了リクエストの使用統計。	いいえ

createChatCompletionStreamResponse

提供された入力に基づいてモデルから返されるチャット完了応答のストリームチャンクを表します。

名前	タイプ	説明	必須	デフォルト
選択肢	アレイ	チャット完了の選択肢一覧。 nが1より大きい場合、複数の要素を含むことができます。	はい
created	整数	チャット完了が作成されたUnixのタイムスタンプ(秒単位)です。 各チャンクは同じタイムスタンプを持っています。	はい
id	文字列	チャット完了のための一意識別子。 各チャンクは同じIDを持っています。	はい
モデル	文字列	完備化を生成するモデル。	はい
オブジェクト	列挙型	オブジェクトタイプは常に chat.completion.chunkです。 可能な値: chat.completion.chunk	はい
system_fingerprint	文字列	このフィンガープリントはモデルが動作するバックエンド構成を表します。 seedリクエストパラメータと組み合わせて、決定性に影響を与える可能性のあるバックエンドの変更がいつ行われたかを理解するために使用できます。	いいえ

chatCompletionStreamResponseDelta

ストリーミングされたモデル応答によって生成されるチャット完了のデルタ。

名前	タイプ	説明	必須	デフォルト
コンテンツ	文字列	チャンクメッセージの内容です。	いいえ
関数呼び出し	オブジェクト	廃止され、 tool_callsに置き換えられました。 モデルが生成した関数の名前と引数を呼び出す必要があります。	いいえ
└─ 引数	文字列	モデルがJSON形式で生成した関数を呼び出す引数。 なお、モデルが必ずしも有効なJSONを生成するわけではなく、関数スキーマで定義されていないパラメータを誤認することがあります。 関数を呼び出す前に、コード内の引数を検証してください。	いいえ
└─ 名前	文字列	呼び出しする関数の名前。	いいえ
refusal	文字列	モデルによって生成される拒否メッセージ。	いいえ
ロール	列挙型	このメッセージの作者の役割。 可能な値: system、 user、 assistant、 tool	いいえ
tool_calls	アレイ		いいえ

chatCompletionMessageToolCallChunk

名前	タイプ	説明	必須	デフォルト
関数	オブジェクト		いいえ
└─ 引数	文字列	モデルがJSON形式で生成した関数を呼び出す引数。 なお、モデルが必ずしも有効なJSONを生成するわけではなく、関数スキーマで定義されていないパラメータを誤認することがあります。 関数を呼び出す前に、コード内の引数を検証してください。	いいえ
└─ 名前	文字列	呼び出しする関数の名前。	いいえ
id	文字列	ツールコールのIDです。	いいえ
インデックス	整数		はい
型	列挙型	道具の種類。 現在、サポートされているのは function のみです。 可能な値: function	いいえ

chatCompletionStreamOptions

ストリーミング応答の選択肢。 設定したときにだけ設定 stream: true。

名前	タイプ	説明	必須	デフォルト
include_usage	boolean	設定すると、 data: [DONE] メッセージの前に追加のチャンクがストリーミングされます。 このチャンクの usage フィールドはリクエスト全体のトークン使用統計を示し、 choices フィールドは常に空の配列になります。 その他のチャンクもまた usage フィールドを含みますが、nullの値が付いています。	いいえ

chatCompletionChoiceLogProbs

選択の確率情報を記録してください。

名前	タイプ	説明	必須	デフォルト
コンテンツ	アレイ	ログ確率情報を含むメッセージ内容トークンのリスト。	はい
refusal	アレイ	ログ確率情報付きのメッセージ拒否トークンのリスト。	いいえ

chatCompletionTokenLogprob

名前	タイプ	説明	必須	デフォルト
バイト	アレイ	トークンのUTF-8バイト表現を表す整数のリストです。 複数のトークンで表される文字や、それらのバイト表現を組み合わせて正しいテキスト表現を生成する場合に有用です。 トークンにバイト表現がなければ null 可能です。	はい
logprob	number	このトークンの対数確率。	はい
トークン	文字列	トークン。	はい
top_logprobs	アレイ	このトークン位置における最も可能性が高いトークンとその対数確率のリスト。 まれに、返却された top_logprobs 数が少ないこともあります。	はい

chatCompletionResponseMessage

モデルによって生成されるチャット完了メッセージ。

名前	タイプ	説明	必須	デフォルト
オーディオ	オブジェクト	音声出力モダリティが要求された場合、このオブジェクトにはモデルからの音声応答に関するデータが含まれます。	いいえ
└─ データ	文字列	モデルがリクエストで指定されたフォーマットで生成したBase64エンコードされたオーディオバイト。	いいえ
└─ 有効期限_終了	整数	この音声応答がサーバー上で複数ターンの会話で使用できなくなるUnixタイムスタンプ(秒単位)を示します。	いいえ
└─ 識別子	文字列	この音声応答の一意識別子。	いいえ
└─ トランスクリプト	文字列	モデルが生成した音声の書き起こし。	いいえ
コンテンツ	文字列	メッセージの内容。	はい
コンテキスト	azureChatExtensionsMessageContext	Azure OpenAIチャット拡張機能が対応するチャット完了応答の生成に関与した際に追加のコンテキスト情報を表現したものです。 このコンテキスト情報は、対応する拡張機能を使用するように設定されたAzure OpenAIリクエストを使用した場合にのみ入力されます。	いいえ
関数呼び出し	chatCompletionFunctionCall	廃止され、 tool_callsに置き換えられました。 モデルが生成した関数の名前と引数を呼び出す必要があります。	いいえ
refusal	文字列	モデルによって生成される拒否メッセージ。	はい
ロール	chatCompletionResponseMessageRole	レスポンスメッセージの作者の役割。	はい
tool_calls	アレイ	モデルによって生成されるツール呼び出し、例えば関数呼び出しなどです。	いいえ

chatCompletionResponseMessageRole

レスポンスメッセージの作者の役割。

Property	価値
説明	レスポンスメッセージの作者の役割。
Type	文字列
値	assistant

chatCompletionToolChoiceOption

モデルが呼び出すツール(もしあれば)を制御します。 none モデルはツールを呼び出さず、代わりにメッセージを生成します。 auto つまり、モデルはメッセージを生成するか、1つ以上のツールを呼び出すかを選べるということです。 required モデルは1つ以上のツールを呼び出しなければならないことを意味します。 {"type": "function", "function": {"name": "my_function"}}で特定のツールを指定すると、モデルはそのツールを呼び出すことを強制します。 none ツールがない場合のデフォルトです。 auto ツールがある場合はデフォルトです。

このコンポーネントは以下のいずれかである:

• chatCompletionNamedToolChoice

chatCompletionNamedToolChoice

モデルが使うべきツールを指定します。 モデルに特定の関数を強制的に呼び出すために使います。

名前	タイプ	説明	必須	デフォルト
関数	オブジェクト		はい
└─ 名前	文字列	呼び出しする関数の名前。	いいえ
型	列挙型	道具の種類。 現在、サポートされているのは function のみです。 可能な値: function	はい

ParallelToolCalls

工具使用中に並列関数呼び出しを有効にするかどうか。

このコンポーネントにはプロパティが定義されていません。

PredictionContent

静的予測出力コンテンツ、例えば再生中のテキストファイルの内容。

名前	タイプ	説明	必須	デフォルト
コンテンツ	文字列または配列	モデル応答を生成する際にマッチングすべき内容。 生成されたトークンがこの内容に一致すれば、モデル全体の応答をより速く返すことができます。	はい
型	列挙型	提供したい予測コンテンツの種類。 このタイプは常に contentされています。 可能な値: content	はい

chatCompletionMessageToolCalls

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

このコンポーネントにはプロパティが定義されていません。

ChatCompletionModalities

このリクエストのためにモデルに生成してほしい出力タイプ。 ほとんどのモデルはテキスト生成が可能であり、これがデフォルトです:

["text"]

gpt-4o-audio-previewモデルは音声生成にも利用できます。 このモデルにテキストと音声の両方の応答を生成するよう依頼するには、以下を利用できます:

["text", "audio"]

このコンポーネントにはプロパティが定義されていません。

chatCompletionFunctionCall

廃止され、 tool_callsに置き換えられました。 モデルが生成した関数の名前と引数を呼び出す必要があります。

名前	タイプ	説明	必須	デフォルト
arguments	文字列	モデルがJSON形式で生成した関数を呼び出す引数。 なお、モデルが必ずしも有効なJSONを生成するわけではなく、関数スキーマで定義されていないパラメータを誤認することがあります。 関数を呼び出す前に、コード内の引数を検証してください。	はい
name	文字列	呼び出しする関数の名前。	はい

completionUsage

完了リクエストの使用統計。

名前	タイプ	説明	必須	デフォルト
completion_tokens	整数	生成された完了項目のトークン数。	はい
completion_tokens_details	オブジェクト	完了で使われたトークンの内訳。	いいえ
└─ 受け入れられた予測トークン	整数	予測出力を使用する場合、予測中に完了に現れたトークンの数を示します。	いいえ
└─ オーディオトークン	整数	モデルによって生成されるオーディオ入力トークン。	いいえ
└─ 推論トークン	整数	推論のためにモデルによって生成されたトークン。	いいえ
└─ 予測拒否トークン	整数	予測出力を使用する場合、完了に現れなかったトークンの数を予測に含みます。 しかし、推論トークンと同様に、これらのトークンは請求、出力、コンテキストウィンドウの制限のために完了トークンの総数に含まれます。	いいえ
prompt_tokens	整数	プロンプト内のトークンの数。	はい
prompt_tokens_details	オブジェクト	プロンプトトークンの詳細。	いいえ
└─ オーディオトークン	整数	プロンプトに音声入力トークンが存在します。	いいえ
└─ キャッシュされたトークン	整数	キャッシュされたプロンプトトークンの数。	いいえ
total_tokens	整数	リクエストで使用されたトークンの総数(プロンプト+完了)。	はい

chatCompletionTool

名前	タイプ	説明	必須	デフォルト
関数	FunctionObject		はい
型	列挙型	道具の種類。 現在、サポートされているのは function のみです。 可能な値: function	はい

FunctionParameters

関数が受け入れるパラメータは、JSONスキーマオブジェクトとして記述されます。 例についてはガイドと、フォーマットに関するドキュメントについてはJSON Schemaの参考文献をご覧ください。

parametersを省略すると、パラメータリストが空の関数を定義します。

このコンポーネントにはプロパティが定義されていません。

FunctionObject

名前	タイプ	説明	必須	デフォルト
説明	文字列	関数が何をするかの記述で、モデルがいつどのように関数を呼び出すかを決めるためのもの。	いいえ
name	文字列	呼び出す関数の名前。 a-z、A-Z、0-9、またはアンダースコアとダッシュを含む必要があり、最大64までの長さです。	はい
parameters	FunctionParameters	関数が受け入れるパラメータは、JSONスキーマオブジェクトとして記述されます。 例についてはガイドと、フォーマットに関するドキュメントについてはJSON Schemaの参考文献をご覧ください。 parametersを省略すると、パラメータリストが空の関数を定義します。	いいえ
厳しい	boolean	関数呼び出しを生成する際に厳密なスキーマ準拠を有効にするかどうか。 trueに設定すると、モデルは parameters フィールドで定義された正確なスキーマに従います。 strict true時にはJSONスキーマの一部のみがサポートされます。	いいえ	いいえ

ResponseFormatText

名前	タイプ	説明	必須	デフォルト
型	列挙型	定義される応答形式の種類: text 可能な値: text	はい

ResponseFormatJsonObject

名前	タイプ	説明	必須	デフォルト
型	列挙型	定義される応答形式の種類: json_object 可能な値: json_object	はい

ResponseFormatJsonSchemaSchema

応答形式のスキーマは、JSONスキーマオブジェクトとして説明されます。

このコンポーネントにはプロパティが定義されていません。

ResponseFormatJsonSchema

名前	タイプ	説明	必須	デフォルト
JSON_スキーマ	オブジェクト		はい
└─ 説明	文字列	回答形式の説明であり、モデルがその形式での応答方法を決定するために用いられます。	いいえ
└─ 名前	文字列	レスポンス形式の名前です。 a-z、A-Z、0-9、またはアンダースコアとダッシュを含む必要があり、最大64までの長さです。	いいえ
└─ スキーマ	ResponseFormatJsonSchemaSchema	応答形式のスキーマは、JSONスキーマオブジェクトとして説明されます。	いいえ
└─ 厳密	boolean	出力を生成する際に厳格なスキーマ準拠を有効にするかどうか。 trueに設定すると、モデルは常に schema フィールドで定義された正確なスキーマに従います。 strict true時にはJSONスキーマの一部のみがサポートされます。	いいえ	いいえ
型	列挙型	定義される応答形式の種類: json_schema 可能な値: json_schema	はい

chatCompletionChoiceCommon

名前	タイプ	説明	必須	デフォルト
終了理由	文字列		いいえ
インデックス	整数		いいえ

createTranslationRequest

翻訳要求。

名前	タイプ	説明	必須	デフォルト
ファイル	文字列	翻訳用の音声ファイル。	はい
ダイアログを表示する	文字列	モデルのスタイルをガイドしたり、前の音声セグメントを続けるためのオプションテキスト。 プロンプトは英語で書かれるべきです。	いいえ
response_format	audioResponseFormat	出力のフォーマットを定義します。	いいえ
温度	number	サンプリング温度は0から1の間です。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。 0に設定された場合、モデルは対数確率を用いて特定の閾値に達するまで自動的に温度を上げます。	いいえ	0

audioResponse

json response_format翻訳または転写応答

名前	タイプ	説明	必須	デフォルト
SMS 送信	文字列	翻訳または文字起こしのテキスト。	はい

audioVerboseResponse

response_formatが翻訳または転写された応答verbose_json

名前	タイプ	説明	必須	デフォルト
duration	number	Duration.	いいえ
言語	文字列	Language.	いいえ
セグメント	アレイ		いいえ
タスク	文字列	音声タスクの種類。	いいえ
SMS 送信	文字列	翻訳または文字起こしのテキスト。	はい
言葉	アレイ		いいえ

audioResponseFormat

出力のフォーマットを定義します。

Property	価値
説明	出力のフォーマットを定義します。
Type	文字列
値	json text srt verbose_json vtt

createTranscriptionRequest

文字起こし要求。

名前	タイプ	説明	必須	デフォルト
ファイル	文字列	音声ファイルオブジェクトを文字起こしします。	はい
言語	文字列	入力音声の言語。 入力言語をISO-639-1形式で提供することで、精度と遅延が向上します。	いいえ
ダイアログを表示する	文字列	モデルのスタイルをガイドしたり、前の音声セグメントを続けるためのオプションテキスト。 プロンプトは音声言語に合っているべきです。	いいえ
response_format	audioResponseFormat	出力のフォーマットを定義します。	いいえ
温度	number	サンプリング温度は0から1の間です。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。 0に設定された場合、モデルは対数確率を用いて特定の閾値に達するまで自動的に温度を上げます。	いいえ	0
timestamp_granularities[]	アレイ	この文字起こしのために入力するタイムスタンプの細さ。 response_format タイムスタンプの粒度を使わせるように verbose_json 設定する必要があります。 これらの選択肢のいずれか、または両方がサポートされています: wordまたは segment。 注:セグメントタイムスタンプに追加の遅延はありませんが、ワードタイムスタンプを生成すると追加の遅延が発生します。	いいえ	['segment']

audioSegment

文字起こしまたは翻訳セグメント。

名前	タイプ	説明	必須	デフォルト
avg_logprob	number	平均対数確率。	いいえ
compression_ratio	number	圧縮率。	いいえ
end	number	セグメントの端がずれています。	いいえ
id	整数	セグメント識別子。	いいえ
no_speech_prob	number	「発言禁止」の確率。	いいえ
seek	number	セグメントのオフセット。	いいえ
start	number	セグメント開始はずれています。	いいえ
温度	number	温度。	いいえ
SMS 送信	文字列	テキストをセグメント化します。	いいえ
tokens	アレイ	テキストのトークン。	いいえ

audioWord

文字起こしまたは翻訳語。

名前	タイプ	説明	必須	デフォルト
end	number	Wordの終わりのオフセット。	いいえ
start	number	Wordはオフセットでスタートします。	いいえ
ワード	文字列	ワード	いいえ

createSpeechRequest

音声リクエスト。

名前	タイプ	説明	必須	デフォルト
入力	文字列	音声合成のためのテキスト。 最大文字数は4,096文字です。	はい
response_format	列挙型	音声を合成するためのフォーマット。 可能な値: mp3、 opus、 aac、 flac、 wav、 pcm	いいえ
速度	number	合成音声の速度。 0.25から4.0の中から値を選びます。 1.0 はデフォルトです。	いいえ	1.0
音声	列挙型	音声合成に使う声。 可能な値: alloy、 echo、 fable、 onyx、 nova、 shimmer	はい

imageQuality

生成される画像の品質。

Property	価値
説明	生成される画像の品質。
Type	文字列
デフォルト	自動
値	auto high medium low hd standard

imagesResponseFormat

生成された画像が返される形式。

Property	価値
説明	生成された画像が返される形式。
Type	文字列
デフォルト	url
値	url b64_json

imagesOutputFormat

生成された画像が返されるファイル形式。 シリーズモデルのみ対応。

Property	価値
説明	生成された画像が返されるファイル形式。 GPT-image-1シリーズモデルのみに対応しています。
Type	文字列
デフォルト	png
値	png jpeg

imageSize

生成される画像のサイズ。

Property	価値
説明	生成される画像のサイズ。
Type	文字列
デフォルト	自動
値	auto 1792x1024 1024x1792 1024x1024 1024x1536 1536x1024

imageStyle

生成された画像のスタイル。 dall-e-3のみ対応しています。

Property	価値
説明	生成された画像のスタイル。 dall-e-3のみ対応しています。
Type	文字列
デフォルト	vivid
値	vivid natural

imageBackground

生成画像の背景の透明度設定が可能です。 このパラメータはGPT-image-1シリーズモデルのみでサポートされています。

Property	価値
説明	生成画像の背景の透明度設定が可能です。 このパラメータはGPT-image-1シリーズモデルのみでサポートされています。
Type	文字列
デフォルト	自動
値	transparent opaque auto

imageGenerationsRequest

名前	タイプ	説明	必須	デフォルト
バックグラウンド	imageBackground	生成画像の背景の透明度設定が可能です。 このパラメータはGPT-image-1シリーズモデルのみでサポートされています。	いいえ	自動
n	整数	生成すべき画像の数。 dall-e-3 では、n=1 のみがサポートされます。	いいえ	1
出力圧縮	整数	生成画像の圧縮レベル(0-100%)です。 このパラメータはjpeg出力フォーマットのgpt-image-1シリーズモデルのみに対応しています。	いいえ	100
出力形式 (output_format)	imagesOutputFormat	生成された画像が返されるファイル形式。 GPT-image-1シリーズモデルのみに対応しています。	いいえ	png
ダイアログを表示する	文字列	目的の画像のテキスト説明。 GPT-image-1シリーズモデルの最大文字数は32,000文字、dall-e-3モデルでは4,000文字です	はい
品質	imageQuality	生成される画像の品質。	いいえ	自動
response_format	imagesResponseFormat	生成された画像が返される形式。 dall-e-3のみ対応しています。	いいえ	url
size	imageSize	生成される画像のサイズ。	いいえ	自動
スタイル	imageStyle	生成された画像のスタイル。 dall-e-3のみ対応しています。	いいえ	vivid
ユーザー	文字列	エンドユーザーを表す一意の識別子であり、悪用の監視や検出に役立ちます。	いいえ

imageEditsRequest

名前	タイプ	説明	必須	デフォルト
イメージ	文字列または配列	編集する画像。 サポートされている画像ファイルまたは画像の配列でなければなりません。 各画像はpngまたはjpgファイルで、25MB未満であるべきです。	はい
マスク	文字列	完全に透明な領域(例:アルファがゼロ)で編集すべき場所を示す追加の画像があります。 複数の画像が提供されている場合、マスクは最初の画像に適用されます。 有効なPNGファイルで、4MB未満で、画像と同じサイズでなければなりません。	いいえ
n	整数	生成すべき画像の数。	いいえ	1
ダイアログを表示する	文字列	目的の画像のテキスト説明。 最大文字数は32000文字です。	はい
品質	imageQuality	生成される画像の品質。	いいえ	自動
response_format	imagesResponseFormat	生成された画像が返される形式。	いいえ	url
size	imageSize	生成される画像のサイズ。	いいえ	自動
ユーザー	文字列	エンドユーザーを表す一意の識別子であり、悪用の監視や検出に役立ちます。	いいえ

generateImagesResponse

名前	タイプ	説明	必須	デフォルト
created	整数	操作が作られたUnixのタイムスタンプ。	はい
データ	アレイ	成功した場合の操作結果データ	はい
使用	imageGenerationsUsage	画像生成リクエストのためのトークン使用情報を表します。 GPT-image-1シリーズモデルのみです。	いいえ

imageResult

成功すれば画像のURLまたは符号化された画像が表示され、そうでなければエラーとなります。

名前	タイプ	説明	必須	デフォルト
b64_json	文字列	base64符号化画像	いいえ
content_filter_results	dalleContentFilterResults	コンテンツフィルタリングの結果に関する情報。	いいえ
prompt_filter_results	dalleFilterResults	コンテンツフィルタリングのカテゴリ(ヘイト、性的、暴力、self_harm)、検出されたかどうか、そして有害なコンテンツの強度やリスクレベルを決定する重症度レベル(very_low、低、中、高)およびフィルタリングの有無に関する情報。 脱獄コンテンツや罵り言葉に関する情報、検出されたかどうか、フィルタリングされているかどうか。 顧客ブロックリストの情報(フィルタリング済みか)やIDも含めて。	いいえ
修正版プロンプト	文字列	画像を生成するために使われたプロンプト、もしプロンプトに修正があったなら。	いいえ
url	文字列	画像のURLです。	いいえ

imageGenerationsUsage

画像生成リクエストのためのトークン使用情報を表します。 GPT-image-1シリーズモデルのみです。

名前	タイプ	説明	必須	デフォルト
input_tokens	整数	入力トークンの数。	いいえ
input_tokens_details	オブジェクト	入力トークンの詳細な内訳です。	いいえ
└─ 画像トークン	整数	画像トークンの数。	いいえ
└─ テキストトークン	整数	テキストトークンの数。	いいえ
output_tokens	整数	出力トークンの数。	いいえ
total_tokens	整数	使用されたトークンの総数。	いいえ

線

単語や選択マークなどの隣接するコンテンツ要素の連続からなるコンテンツラインオブジェクトです。

名前	タイプ	説明	必須	デフォルト
またがる	アレイ	検出されたオブジェクトとそのバウンディングボックス情報を表すスパンの配列です。	はい
SMS 送信	文字列		はい

span

検出されたオブジェクトとそのバウンディングボックス情報を表すスパンオブジェクト。

名前	タイプ	説明	必須	デフォルト
length	整数	スパンの長さ(文字単位)は、Unicodeコードポイントで測定されます。	はい
オフセット	整数	文字のスパンが始まるテキスト内の文字オフセット。 このオフセットは、テキストの開始からUnicodeコードポイントとして数えるスパンの最初の文字の位置として定義されます。	はい
多角形	アレイ	検出されたオブジェクトを囲む多角形内の点を表すオブジェクトの配列です。	はい
SMS 送信	文字列	検出対象を表すスパンのテキスト内容。	はい

runCompletionUsage

このランに関連する使用統計。 この値は、実行が終端状態(null、in_progressなど)でない場合にqueuedされます。

名前	タイプ	説明	必須	デフォルト
completion_tokens	整数	プレイ中に使用されたコンプリートトークンの数。	はい
prompt_tokens	整数	プレイ中に使用されたプロンプトトークンの数。	はい
total_tokens	整数	使用トークンの総数(プロンプト+完了)。	はい

runStepCompletionUsage

ランステップに関連する使用統計。 この値は、ランステップの状態がnullの間に in_progressされます。

名前	タイプ	説明	必須	デフォルト
completion_tokens	整数	ランステップ中に使用された完了トークンの数。	はい
prompt_tokens	整数	ランステップ中に使用されたプロンプトトークンの数。	はい
total_tokens	整数	使用トークンの総数(プロンプト+完了)。	はい

assistantsApiResponseFormatOption

モデルが出力すべきフォーマットを指定します。 GPT-4o、GPT-4 Turbo、そして gpt-3.5-turbo-1106年以降のすべてのGPT-3.5 Turboモデルに対応しています。

{ "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 詳細はStructured Outptsガイドをご覧ください。

{ "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。

重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。

このコンポーネントは以下のいずれかである:

• ResponseFormatText
• ResponseFormatJsonObject
• ResponseFormatJsonSchema

assistantsApiResponseFormat

モデルの期待出力を記述するオブジェクト。 json_object functionタイプのみがランに渡せるtools。 textであれば、モデルはテキストや必要な値を返すことができます。

名前	タイプ	説明	必須	デフォルト
型	文字列	textかjson_objectのどちらかに違いない。	いいえ	SMS 送信

型 Enum: AssistantsApiResponseFormat

価値	説明
SMS 送信
json_object

assistantObject

モデルを呼び出し、ツールを使うことができる assistant を表します。

名前	タイプ	説明	必須	デフォルト
作成日時	整数	アシスタントが作成された時点を示すUnixのタイムスタンプ(秒単位)です。	はい
説明	文字列	助手の説明。 最大文字数は512文字です。	はい
id	文字列	識別子はAPIエンドポイントで参照可能です。	はい
手順	文字列	アシスタントが使うシステム命令。 最大長さは256,000文字です。	はい
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	はい
モデル	文字列	使用するモデルのIDです。	はい
name	文字列	助手の名前だ。 最大文字数は256文字です。	はい
オブジェクト	文字列	オブジェクトタイプは常に assistantです。	はい
response_format	assistantsApiResponseFormatOption	モデルが出力すべきフォーマットを指定します。 GPT-4o、GPT-4 Turbo、そして gpt-3.5-turbo-1106年以降のすべてのGPT-3.5 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 詳細はStructured Outptsガイドをご覧ください。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	いいえ
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。	いいえ	1
tool_resources	オブジェクト	アシスタントのツールが使用するリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	いいえ
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールで利用可能なファイルIDのリスト。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このアシスタントに紐づいたベクターストアのIDです。 アシスタントには最大1つのベクターストアを接続できます。	いいえ
ツール	アレイ	アシスタントで有効になっているツールのリスト。 アシスタント1人あたり最大128個のツールを持てます。 道具は code_interpreter、 file_search、または functionの種類があります。	はい	[]
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこの方法か温度を変えることを推奨しますが、両方はおすすめしません。	いいえ	1

オブジェクト Enum: AssistantObjectType

価値	説明
アシスタント	オブジェクトタイプは常にアシスタントです

createAssistantRequest

名前	タイプ	説明	必須	デフォルト
説明	文字列	助手の説明。 最大文字数は512文字です。	いいえ
手順	文字列	アシスタントが使うシステム命令。 最大長さは256,000文字です。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
モデル	文字列		はい
name	文字列	助手の名前だ。 最大文字数は256文字です。	いいえ
response_format	assistantsApiResponseFormatOption	モデルが出力すべきフォーマットを指定します。 GPT-4o、GPT-4 Turbo、そして gpt-3.5-turbo-1106年以降のすべてのGPT-3.5 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 詳細はStructured Outptsガイドをご覧ください。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	いいえ
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。	いいえ	1
tool_resources	オブジェクト	アシスタントのツールが使用するリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	いいえ
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールで利用可能なファイルIDのリスト。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このアシスタントに付随するベクターストアです。 アシスタントには最大1つのベクターストアを接続できます。	いいえ
└─ ベクトルストア	アレイ	file_idsでベクターストアを作成し、このアシスタントにアタッチするための補助者です。 アシスタントには最大1つのベクターストアを接続できます。	いいえ
ツール	アレイ	アシスタントで有効になっているツールのリスト。 アシスタント1人あたり最大128個のツールを持てます。 道具は code_interpreter、 retrieval、または functionの種類があります。	いいえ	[]
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこの方法か温度を変えることを推奨しますが、両方はおすすめしません。	いいえ	1

modifyAssistantRequest

名前	タイプ	説明	必須	デフォルト
説明	文字列	助手の説明。 最大文字数は512文字です。	いいえ
手順	文字列	アシスタントが使うシステム命令。 最大文字数は32768文字です。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
モデル	文字列		いいえ
name	文字列	助手の名前だ。 最大文字数は256文字です。	いいえ
response_format	assistantsApiResponseFormatOption	モデルが出力すべきフォーマットを指定します。 GPT-4o、GPT-4 Turbo、そして gpt-3.5-turbo-1106年以降のすべてのGPT-3.5 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 詳細はStructured Outptsガイドをご覧ください。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	いいえ
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。	いいえ	1
tool_resources	オブジェクト	アシスタントのツールが使用するリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	いいえ
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールに提供されているファイルIDのリストを上書きします。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このアシスタントに付随するベクターストアを上書きします。 アシスタントには最大1つのベクターストアを接続できます。	いいえ
ツール	アレイ	アシスタントで有効になっているツールのリスト。 アシスタント1人あたり最大128個のツールを持てます。 道具は code_interpreter、 retrieval、または functionの種類があります。	いいえ	[]
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこの方法か温度を変えることを推奨しますが、両方はおすすめしません。	いいえ	1

deleteAssistantResponse

名前	タイプ	説明	必須	デフォルト
削除されました	boolean		はい
id	文字列		はい
オブジェクト	文字列		はい

オブジェクト Enum: DeleteAssistantResponseState

価値	説明
assistant.deleted

listAssistantsResponse

名前	タイプ	説明	必須	デフォルト
データ	アレイ		はい
ファーストID	文字列		はい
has_more	boolean		はい
last_id	文字列		はい
オブジェクト	文字列		はい

assistantToolsCode

名前	タイプ	説明	必須	デフォルト
型	文字列	定義される工具の種類: code_interpreter	はい

型 Enum: assistantToolsCodeType

価値	説明
code_interpreter

assistantToolsFileSearch

名前	タイプ	説明	必須	デフォルト
file_search	オブジェクト	ファイル検索ツールのオーバーライド。	いいえ
└─ 最大結果数 (max_num_results)	整数	ファイル検索ツールが出力すべき最大結果数。 デフォルトはGPT-4*モデルで20、GPT-3.5ターボモデルで5です。 この数字は1から50の間であるべきです。 ファイル検索ツールは max_num_results 件未満の結果しか出さない場合がありますのでご注意ください。	いいえ
型	文字列	定義される工具の種類: file_search	はい

タイプ Enum: assistantToolsFileSearchType

価値	説明
file_search

assistantToolsFileSearchTypeOnly

名前	タイプ	説明	必須	デフォルト
型	文字列	定義される工具の種類: file_search	はい

タイプ Enum: assistantToolsFileSearchType

価値	説明
file_search

assistantToolsFunction

名前	タイプ	説明	必須	デフォルト
関数	オブジェクト	関数の定義。	はい
└─ 説明	文字列	関数が何をするかの記述で、モデルがいつどのように関数を呼び出すかを決めるためのもの。	いいえ
└─ 名前	文字列	呼び出す関数の名前。 a-z、A-Z、0-9、またはアンダースコアとダッシュを含む必要があり、最大64までの長さです。	いいえ
└─ パラメーター	chatCompletionFunctionParameters	関数が受け入れるパラメータは、JSONスキーマオブジェクトとして記述されます。 例については ガイド/ と、フォーマットに関するドキュメントは JSONスキーマの参考 文献を参照してください。	いいえ
型	文字列	定義される工具の種類: function	はい

型 Enum: assistantToolsFunction

価値	説明
関数

truncationObject

実行前にスレッドを切り詰めるコントロール。 これを使って、ランの最初のコンテキストウィンドウを制御します。

名前	タイプ	説明	必須	デフォルト
last_messages	整数	実行のコンテキストを構築する際のスレッドからの最も最近のメッセージ数。	いいえ
型	文字列	スレッドに使うための切断戦略。 既定値は auto です。 last_messagesに設定されている場合、スレッドはスレッド内の直近n件のメッセージに切り詰められます。 autoに設定すると、スレッドの中央にあるメッセージはモデルのコンテキスト長に合わせて削除されますmax_prompt_tokens。	はい

型 Enum: TruncationType

価値	説明
自動
last_messages

assistantsApiToolChoiceOption

モデルが呼び出すツール(もしあれば)を制御します。 none モデルはツールを呼び出さず、代わりにメッセージを生成します。 auto はデフォルト値であり、モデルがメッセージを生成するかツールを呼び出すかを選択できることを意味します。 {"type": "file_search"}や{"type": "function", "function": {"name": "my_function"}}のような特定のツールを指定すると、モデルはそのツールを呼び出すことを強制します。

このコンポーネントは以下のいずれかである:

• assistantsNamedToolChoice

assistantsNamedToolChoice

モデルが使うべきツールを指定します。 モデルに特定のツールを強制的に呼び出しさせるために使います。

名前	タイプ	説明	必須	デフォルト
関数	オブジェクト		いいえ
└─ 名前	文字列	呼び出しする関数の名前。	いいえ
型	文字列	道具の種類。 型が functionの場合、関数名を設定しなければなりません	はい

type Enum: AssistantsNamedToolChoiceType

価値	説明
関数
code_interpreter
file_search

runObject

スレッド上の実行実行を表します。

名前	タイプ	説明	必須	デフォルト
assistant_id	文字列	このランの実行に使われたアシスタントのIDです。	はい
cancelled_at	整数	実行がキャンセルされた時点を示すUnixのタイムスタンプ(秒単位)。	はい
完了日時	整数	実行完了時のUnixタイムスタンプ(秒単位)です。	はい
作成日時	整数	実行が作成された時間を示すUnixのタイムスタンプ(秒単位)。	はい
有効期限	整数	実行が終了するタイミングを示すUnixのタイムスタンプ(秒単位)です。	はい
失敗時点	整数	実行が失敗した時のUnixタイムスタンプ(秒単位)です。	はい
id	文字列	識別子はAPIエンドポイントで参照可能です。	はい
incomplete_details	オブジェクト	なぜこの連載が未完なのかの詳細。 ランが未完でなければ null します。	はい
└─ 理由	文字列	このランが未完の理由です。 これにより、運行中にどのトークン制限が達成されたかが示されます。	いいえ
手順	文字列	この走りで助手が使った指示です。	はい
最後のエラー	オブジェクト	このランに関連する最後のエラーです。 エラーがなければ null します。	はい
└─ コード	文字列	server_errorかrate_limit_exceededのどちらかです。	いいえ
└─ メッセージ	文字列	人間が読みやすい誤りの説明。	いいえ
max_completion_tokens	整数	プレイ中に使用されたと指定された最大数のクリアトークン。	はい
max_prompt_tokens	整数	プレイ中に使用されたと指定されたプロンプトトークンの最大数。	はい
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	はい
モデル	文字列	この走りでアシスタントが使ったモデルだ。	はい
オブジェクト	文字列	オブジェクトタイプは常に thread.runです。	はい
並列ツール呼び出し	ParallelToolCalls	工具使用中に並列関数呼び出しを有効にするかどうか。	いいえ	正しい
required_action	オブジェクト	ランを続けるために必要な行動の詳細。 何の対応もなければ null します。	はい
└─ ツール出力の送信	オブジェクト	このランを続けるために必要なツール出力の詳細。	いいえ
└─ ツールコール	アレイ	関連するツールコールの一覧です。	いいえ
└─ タイプ	列挙型	今のところ、これが常に submit_tool_outputsです。 可能な値: submit_tool_outputs	いいえ
response_format	assistantsApiResponseFormatOption	モデルが出力すべきフォーマットを指定します。 GPT-4o、GPT-4 Turbo、そして gpt-3.5-turbo-1106年以降のすべてのGPT-3.5 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 詳細はStructured Outptsガイドをご覧ください。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	はい
started_at	整数	実行開始時刻のUnixタイムスタンプ(秒単位)です。	はい
状態	文字列	ランのステータスは、 queued、 in_progress、 requires_action、 cancelling、 cancelled、 failed、 completed、または expiredのいずれかです。	はい
温度	number	このランで使用されたサンプリング温度。 設定されていない場合はデフォルトで1になります。	いいえ
thread_id	文字列	この実行の一部として実行されたスレッドのIDです。	はい
tool_choice	assistantsApiToolChoiceOption	モデルが呼び出すツール(もしあれば)を制御します。 none モデルはツールを呼び出さず、代わりにメッセージを生成します。 auto はデフォルト値であり、モデルがメッセージを生成するかツールを呼び出すかを選択できることを意味します。 {"type": "file_search"}や{"type": "function", "function": {"name": "my_function"}}のような特定のツールを指定すると、モデルはそのツールを呼び出すことを強制します。	はい
ツール	アレイ	このランで助手が使った道具のリスト。	はい	[]
top_p	number	このランで使用された核サンプリング値。 設定されていない場合はデフォルトで1になります。	いいえ
truncation_strategy	truncationObject	実行前にスレッドを切り詰めるコントロール。 これを使って、ランの最初のコンテキストウィンドウを制御します。	はい
使用	runCompletionUsage	このランに関連する使用統計。 この値は、実行が終端状態(null、in_progressなど)でない場合にqueuedされます。	はい

object Enum: runObjectType

価値	説明
thread.run	run オブジェクトタイプは常に thread.run です

status Enum: RunObjectStatus

価値	説明
キュー	キュー状態
in_progress	in_progress州
requires_action	required_action州
cancelling	キャンセル状態
cancelled	廃止された国家
失敗	失敗国家
完了	完成した状態
期限 切れ	期限切れの状態

createRunRequest

名前	タイプ	説明	必須	デフォルト
additional_instructions	文字列	実行の命令の最後に追加の命令を追加します。 これは、他の命令を上書きせずに各実行ごとに動作を修正するのに有用です。	いいえ
additional_messages	アレイ	実行を作成する前にスレッドに追加メッセージを追加します。	いいえ
assistant_id	文字列	この実行を実行するアシスタントのIDです。	はい
手順	文字列	アシスタントのデフォルトシステムメッセージを上書きします。 これは、実行ごとに動作を修正するのに便利です。	いいえ
max_completion_tokens	整数	プレイ中に使用できる最大数のクリアトークン。 このランは、指定された数だけの完成トークンを複数ターンにわたって使用するよう最善を尽くします。 実行が指定された完了トークン数を超えると、ステータス incompleteで終了します。 詳細は incomplete_details をご覧ください。	いいえ
max_prompt_tokens	整数	プレイ中に使用できるプロンプトトークンの最大数。 このランは、複数のターンにわたって指定されたプロンプトトークンの数だけを使うよう最善を尽くします。 実行が指定されたプロンプトトークンの数を超えると、ステータス incompleteで終了します。 詳細は incomplete_details をご覧ください。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
モデル	文字列	この実行を実行するモデルのIDです。 ここで値が提供されると、アシスタントに関連付けられたモデルを上書きします。 そうでなければ、アシスタントに関連付けられたモデルが使用されます。	いいえ
並列ツール呼び出し	ParallelToolCalls	工具使用中に並列関数呼び出しを有効にするかどうか。	いいえ	正しい
response_format	assistantsApiResponseFormatOption	モデルが出力すべきフォーマットを指定します。 GPT-4o、GPT-4 Turbo、そして gpt-3.5-turbo-1106年以降のすべてのGPT-3.5 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 詳細はStructured Outptsガイドをご覧ください。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	いいえ
ストリーミング	boolean	trueの場合、Run中に発生したイベントのストリームをサーバー送信イベントとして返し、Runがターミナル状態に入りdata: [DONE]メッセージで終了します。	いいえ
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。	いいえ	1
tool_choice	assistantsApiToolChoiceOption	モデルが呼び出すツール(もしあれば)を制御します。 none モデルはツールを呼び出さず、代わりにメッセージを生成します。 auto はデフォルト値であり、モデルがメッセージを生成するかツールを呼び出すかを選択できることを意味します。 {"type": "file_search"}や{"type": "function", "function": {"name": "my_function"}}のような特定のツールを指定すると、モデルはそのツールを呼び出すことを強制します。	いいえ
ツール	アレイ	アシスタントがこのランで使えるツールを上書きしてください。 これは、実行ごとに動作を修正するのに便利です。	いいえ
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこの方法か温度を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
truncation_strategy	truncationObject	実行前にスレッドを切り詰めるコントロール。 これを使って、ランの最初のコンテキストウィンドウを制御します。	いいえ

listRunsResponse

名前	タイプ	説明	必須	デフォルト
データ	アレイ		はい
ファーストID	文字列		はい
has_more	boolean		はい
last_id	文字列		はい
オブジェクト	文字列		はい

modifyRunRequest

名前	タイプ	説明	必須	デフォルト
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ

submitToolOutputsRunRequest

名前	タイプ	説明	必須	デフォルト
ストリーミング	boolean	trueの場合、Run中に発生したイベントのストリームをサーバー送信イベントとして返し、Runがターミナル状態に入りdata: [DONE]メッセージで終了します。	いいえ
tool_outputs	アレイ	出力が提出されているツールのリスト。	はい

runToolCallObject

ツール呼び出しオブジェクト

名前	タイプ	説明	必須	デフォルト
関数	オブジェクト	関数の定義。	はい
└─ 引数	文字列	モデルが関数に渡すことを期待する引数です。	いいえ
└─ 名前	文字列	その機能の名前です。	いいえ
id	文字列	ツールコールのIDです。 このIDは、ツール出力を送信してエンドポイントを実行する際に参照しなければなりません。	はい
型	文字列	出力が求められるツール呼び出しの種類。 今のところ、これが常に functionです。	はい

型 Enum: RunToolCallObjectType

価値	説明
関数

createThreadAndRunRequest

名前	タイプ	説明	必須	デフォルト
assistant_id	文字列	この実行を実行するアシスタントのIDです。	はい
手順	文字列	アシスタントのデフォルトシステムメッセージを上書きします。 これは、実行ごとに動作を修正するのに便利です。	いいえ
max_completion_tokens	整数	プレイ中に使用できる最大数のクリアトークン。 このランは、指定された数だけの完成トークンを複数ターンにわたって使用するよう最善を尽くします。 実行が指定された完了トークン数を超えると、ステータス incompleteで終了します。 詳細は incomplete_details をご覧ください。	いいえ
max_prompt_tokens	整数	プレイ中に使用できるプロンプトトークンの最大数。 このランは、複数のターンにわたって指定されたプロンプトトークンの数だけを使うよう最善を尽くします。 実行が指定されたプロンプトトークンの数を超えると、ステータス incompleteで終了します。 詳細は incomplete_details をご覧ください。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
モデル	文字列	この実行に使うモデルのIDです。 ここで値が提供されると、アシスタントに関連付けられたモデルを上書きします。 そうでなければ、アシスタントに関連付けられたモデルが使用されます。	いいえ
並列ツール呼び出し	ParallelToolCalls	工具使用中に並列関数呼び出しを有効にするかどうか。	いいえ	正しい
response_format	assistantsApiResponseFormatOption	モデルが出力すべきフォーマットを指定します。 GPT-4o、GPT-4 Turbo、そして gpt-3.5-turbo-1106年以降のすべてのGPT-3.5 Turboモデルに対応しています。 { "type": "json_schema", "json_schema": {...} }に設定すると、モデルが提供されたJSONスキーマに一致する構造化出力が有効になります。 詳細はStructured Outptsガイドをご覧ください。 { "type": "json_object" }に設定するとJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 重要事項: JSONモードを使用する際は、システムやユーザーメッセージを通じてモデルに自分でJSONを作成するよう指示 する必要があります 。 これがなければ、モデルはトークンの上限に達するまで無限の空白ストリームを生成し、長期間実行され「詰まった」ように見えるリクエストを生み出します。 また、 finish_reason="length"の場合はメッセージ内容が部分的に切り離されている可能性があり、これは生成時間が max_tokens を超えたか、会話が最大コンテキスト長を超えていることを示しています。	いいえ
ストリーミング	boolean	trueの場合、Run中に発生したイベントのストリームをサーバー送信イベントとして返し、Runがターミナル状態に入りdata: [DONE]メッセージで終了します。	いいえ
stream_options	chatCompletionStreamOptions	ストリーミング応答の選択肢。 設定したときにだけ設定 stream: true。	いいえ	None
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。	いいえ	1
スレッド	createThreadRequest		いいえ
tool_choice	assistantsApiToolChoiceOption	モデルが呼び出すツール(もしあれば)を制御します。 none モデルはツールを呼び出さず、代わりにメッセージを生成します。 auto はデフォルト値であり、モデルがメッセージを生成するかツールを呼び出すかを選択できることを意味します。 {"type": "file_search"}や{"type": "function", "function": {"name": "my_function"}}のような特定のツールを指定すると、モデルはそのツールを呼び出すことを強制します。	いいえ
tool_resources	オブジェクト	アシスタントのツールが使用するリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	いいえ
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールで利用可能なファイルIDのリスト。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このアシスタントに紐づいたベクターストアのIDです。 アシスタントには最大1つのベクターストアを接続できます。	いいえ
ツール	アレイ	アシスタントがこのランで使えるツールを上書きしてください。 これは、実行ごとに動作を修正するのに便利です。	いいえ
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこの方法か温度を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
truncation_strategy	truncationObject	実行前にスレッドを切り詰めるコントロール。 これを使って、ランの最初のコンテキストウィンドウを制御します。	いいえ

threadObject

メッセージを含むスレッドを表します。

名前	タイプ	説明	必須	デフォルト
作成日時	整数	スレッド作成時刻のUnixタイムスタンプ(秒単位)です。	はい
id	文字列	識別子はAPIエンドポイントで参照可能です。	はい
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	はい
オブジェクト	文字列	オブジェクトタイプは常に threadです。	はい
tool_resources	オブジェクト	このスレッドでアシスタントのツールに提供されているリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	はい
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールで利用可能なファイルIDのリスト。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このスレッドに添付されたベクターストア。 スレッドには最大1つのベクトルストアを接続できます。	いいえ

オブジェクト Enum: ThreadObjectType

価値	説明
スレッド	スレッドオブジェクトの種類は、常に thread

createThreadRequest

名前	タイプ	説明	必須	デフォルト
messages	アレイ	スレッドを始めるためのメッセージのリストです。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
tool_resources	オブジェクト	このスレッドでアシスタントのツールに提供されているリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	いいえ
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールで利用可能なファイルIDのリスト。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このスレッドに添付されたベクターストア。 スレッドには最大1つのベクトルストアを接続できます。	いいえ
└─ ベクトルストア	アレイ	file_idsでベクターストアを作成し、このスレッドに添付するためのヘルプです。 スレッドには最大1つのベクトルストアを接続できます。	いいえ

modifyThreadRequest

名前	タイプ	説明	必須	デフォルト
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
tool_resources	オブジェクト	このスレッドでアシスタントのツールに提供されているリソースのセットです。 リソースは工具の種類ごとに異なります。 例えば、 code_interpreter ツールはファイルIDのリストを必要とし、 file_search ツールはベクターストアIDのリストを必要とします。	いいえ
└─ コードインタープリタ (code_interpreter)	オブジェクト		いいえ
└─ ファイル識別子	アレイ	code_interpreterツールで利用可能なファイルIDの一覧。 ツールに関連付けられるファイルは最大20個までです。	いいえ	[]
└─ ファイル検索	オブジェクト		いいえ
└─ ベクターストアID	アレイ	このスレッドに添付されたベクターストア。 スレッドには最大1つのベクトルストアを接続できます。	いいえ

deleteThreadResponse

名前	タイプ	説明	必須	デフォルト
削除されました	boolean		はい
id	文字列		はい
オブジェクト	文字列		はい

オブジェクト Enum: DeleteThreadResponseObjectState

価値	説明
thread.deleted	スレッドレスポンスオブジェクトの削除状態は thread.deleted

listThreadsResponse

名前	タイプ	説明	必須	デフォルト
データ	アレイ		はい
ファーストID	文字列		はい
has_more	boolean		はい
last_id	文字列		はい
オブジェクト	文字列		はい

messageObject

スレッド内のメッセージを表します。

名前	タイプ	説明	必須	デフォルト
assistant_id	文字列	該当する場合は、このメッセージを作成したアシスタントのIDを教えてください。	はい
添付ファイル	アレイ	メッセージに添付されたファイルのリストと、それらが追加されたツールのリスト。	はい
完了日時	整数	メッセージが完了した時間を示すUnixのタイムスタンプ(秒単位)。	はい
コンテンツ	アレイ	メッセージの内容はテキストや画像の配列で表示されます。	はい
作成日時	整数	Unixのタイムスタンプ(秒単位)は、メッセージが作成された時刻を示しています。	はい
id	文字列	識別子はAPIエンドポイントで参照可能です。	はい
incomplete_at	整数	メッセージが不完全とマークされた時のUnixタイムスタンプ(秒単位)です。	はい
incomplete_details	オブジェクト	不完全なメッセージについては、なぜそのメッセージが不完全なのかの詳細を記載します。	はい
└─ 理由	文字列	メッセージが不完全である理由。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	はい
オブジェクト	文字列	オブジェクトタイプは常に thread.messageです。	はい
ロール	文字列	メッセージを生み出した存在。 userかassistantのどちらかです。	はい
run_id	文字列	該当する場合は、このメッセージの作成に関連する実行のIDを記載します。	はい
状態	文字列	メッセージのステータスは、 in_progress、 incomplete、または completedのいずれかです。	はい
thread_id	文字列	このメッセージが属するスレッドのIDです。	はい

オブジェクト Enum: MessageObjectType

価値	説明
thread.message	メッセージオブジェクトタイプは thread.message

status Enum: MessageObjectStatus

価値	説明
in_progress
incomplete
完了

role Enum: MessageObjectRole

価値	説明
ユーザー
アシスタント

messageDeltaObject

メッセージのデルタ、すなわちストリーミング中にメッセージのフィールドが変更されたことを表す。

名前	タイプ	説明	必須	デフォルト
delta	オブジェクト	メッセージ上で変更されたフィールドを含むデルタ。	はい
└─ コンテンツ	アレイ	メッセージの内容はテキストや画像の配列で表示されます。	いいえ
└─ ロール	文字列	メッセージを生み出した存在。 userかassistantのどちらかです。	いいえ
id	文字列	APIエンドポイントで参照可能なメッセージの識別子です。	はい
オブジェクト	文字列	オブジェクトタイプは常に thread.message.deltaです。	はい

オブジェクト Enum: MessageDeltaObjectType

価値	説明
thread.message.delta

createMessageRequest

名前	タイプ	説明	必須	デフォルト
添付ファイル	アレイ	メッセージに添付されたファイルのリストと、それらが追加されるべきツール。	いいえ
コンテンツ	文字列	メッセージの内容。	はい
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
ロール	文字列	メッセージを作っている主体の役割。 許可される値は以下の通りです: - user: は実際のユーザーから送信されたメッセージを示し、ほとんどの場合、ユーザー生成メッセージを表すために使われるべきです。 - assistant: はメッセージがアシスタントによって生成されたことを示します。 この値を使い、アシスタントからのメッセージを会話に挿入します。	はい

role Enum: CreateMessageRequestRole

価値	説明
ユーザー
アシスタント

modifyMessageRequest

名前	タイプ	説明	必須	デフォルト
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ

deleteMessageResponse

名前	タイプ	説明	必須	デフォルト
削除されました	boolean		はい
id	文字列		はい
オブジェクト	文字列		はい

オブジェクト Enum: DeleteMessageResponseObject

価値	説明
thread.message.deleted	delete message response object state(メッセージ応答オブジェクトの状態)

listMessagesResponse

名前	タイプ	説明	必須	デフォルト
データ	アレイ		はい
ファーストID	文字列		はい
has_more	boolean		はい
last_id	文字列		はい
オブジェクト	文字列		はい

messageContentImageFileObject

メッセージの内容に画像ファイルを参照します。

名前	タイプ	説明	必須	デフォルト
image_file	オブジェクト		はい
└─ ファイルID	文字列	メッセージの内容にある画像のファイルID。	いいえ
型	文字列	いつも image_file。	はい

列挙型:MessageContentImageFileObjectType

価値	説明
image_file	メッセージコンテンツ画像ファイル形式

messageContentTextObject

メッセージの一部であるテキスト内容。

名前	タイプ	説明	必須	デフォルト
SMS 送信	オブジェクト		はい
└─ 注釈	アレイ		いいえ
└─ 値	文字列	テキストを構成するデータです。	いいえ
型	文字列	いつも text。	はい

タイプ Enum: messageContentTextObjectType

価値	説明
SMS 送信	メッセージの内容テキスト オブジェクトタイプ

messageContentTextAnnotationsFileCitationObject

メッセージ内の引用で、アシスタントやメッセージに関連する特定のファイルからの引用を指し示します。 アシスタントが「検索」ツールを使ってファイルを検索することで生成されます。

名前	タイプ	説明	必須	デフォルト
end_index	整数		はい
file_citation	オブジェクト		はい
└─ ファイルID	文字列	引用が出ている特定のファイルのIDです。	いいえ
start_index	整数		はい
SMS 送信	文字列	メッセージの内容に差し替えが必要なテキスト。	はい
型	文字列	いつも file_citation。	はい

タイプ Enum: FileCitationObjectType

価値	説明
file_citation	ファイル引用オブジェクトタイプ

messageContentTextAnnotationsFilePathObject

アシスタントが code_interpreter ツールを使ってファイルを生成したときに生成されたファイルのURL。

名前	タイプ	説明	必須	デフォルト
end_index	整数		はい
file_path	オブジェクト		はい
└─ ファイルID	文字列	生成されたファイルのIDです。	いいえ
start_index	整数		はい
SMS 送信	文字列	メッセージの内容に差し替えが必要なテキスト。	はい
型	文字列	いつも file_path。	はい

型 Enum: FilePathObjectType

価値	説明
file_path	ファイルパスオブジェクトタイプ

messageDeltaContentImageFileObject

メッセージの内容に画像ファイルを参照します。

名前	タイプ	説明	必須	デフォルト
image_file	オブジェクト		いいえ
└─ ファイルID	文字列	メッセージの内容にある画像のファイルID。	いいえ
インデックス	整数	メッセージ内のコンテンツの索引部分です。	はい
型	文字列	いつも image_file。	はい

列挙型:MessageDeltaContentImageFileObjectType

価値	説明
image_file

messageDeltaContentTextObject

メッセージの一部であるテキスト内容。

名前	タイプ	説明	必須	デフォルト
インデックス	整数	メッセージ内のコンテンツの索引部分です。	はい
SMS 送信	オブジェクト		いいえ
└─ 注釈	アレイ		いいえ
└─ 値	文字列	テキストを構成するデータです。	いいえ
型	文字列	いつも text。	はい

型 Enum: MessageDeltaContentTextObjectType

価値	説明
SMS 送信

messageDeltaContentTextAnnotationsFileCitationObject

メッセージ内の引用で、アシスタントやメッセージに関連する特定のファイルからの引用を指し示します。 アシスタントが「file_search」ツールを使ってファイルを検索することで生成されます。

名前	タイプ	説明	必須	デフォルト
end_index	整数		いいえ
file_citation	オブジェクト		いいえ
└─ ファイルID	文字列	引用が出ている特定のファイルのIDです。	いいえ
└─ 引用	文字列	ファイルの具体的な引用です。	いいえ
インデックス	整数	テキスト内容部分の注釈の索引。	はい
start_index	整数		いいえ
SMS 送信	文字列	メッセージの内容に差し替えが必要なテキスト。	いいえ
型	文字列	いつも file_citation。	はい

type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

価値	説明
file_citation

messageDeltaContentTextAnnotationsFilePathObject

アシスタントが code_interpreter ツールを使ってファイルを生成したときに生成されたファイルのURL。

名前	タイプ	説明	必須	デフォルト
end_index	整数		いいえ
file_path	オブジェクト		いいえ
└─ ファイルID	文字列	生成されたファイルのIDです。	いいえ
インデックス	整数	テキスト内容部分の注釈の索引。	はい
start_index	整数		いいえ
SMS 送信	文字列	メッセージの内容に差し替えが必要なテキスト。	いいえ
型	文字列	いつも file_path。	はい

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

価値	説明
file_path

runStepObject

ランの実行におけるステップを表します。

名前	タイプ	説明	必須	デフォルト
assistant_id	文字列	ランステップに関連付けられたアシスタントのID。	はい
cancelled_at	整数	実行ステップがキャンセルされた時のUnixタイムスタンプ(秒単位)です。	はい
完了日時	整数	実行ステップが完了したUnixのタイムスタンプ(秒単位)です。	はい
作成日時	整数	実行ステップが作成された時点を示すUnixのタイムスタンプ(秒単位)。	はい
有効期限日時	整数	実行ステップが切れた時点を示すUnixのタイムスタンプ(秒単位)。 親実行が期限切れの場合、ステップは期限切れとみなされます。	はい
失敗時点	整数	実行ステップが失敗した時点を示すUnixのタイムスタンプ(秒単位)。	はい
id	文字列	APIエンドポイントで参照可能な実行ステップの識別子です。	はい
最後のエラー	オブジェクト	この実行ステップに関連する最後のエラーです。 エラーがなければ null します。	はい
└─ コード	文字列	server_errorかrate_limit_exceededのどちらかです。	いいえ
└─ メッセージ	文字列	人間が読みやすい誤りの説明。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	はい
オブジェクト	文字列	オブジェクトタイプは常に assistant.run.stepです。	はい
run_id	文字列	このランステップが含まれるランのIDです。	はい
状態	文字列	ランの状態は in_progress、 cancelled、 failed、 completed、または expiredのいずれかです。	はい
step_details	runStepDetailsMessageCreationObject または runStepDetailsToolCallsObject	ランステップの詳細。	はい
thread_id	文字列	実行されたスレッドのIDです。	はい
型	文字列	ランステップの種類は、 message_creation または tool_callsのいずれかです。	はい

オブジェクト Enum: RunStepObjectType

価値	説明
assistant.run.step	オブジェクトタイプは、常に assistant.run.step

型 Enum: RunStepObjectType

価値	説明
message_creation	message_creationランステップ
tool_calls	tool_callsランステップ

status Enum: RunStepObjectStatus

価値	説明
in_progress	in_progressランの状況
cancelled	放送中止の状況
失敗	放送中止の状況
完了	放送中止の状況
期限 切れ	放送中止の状況

runStepDeltaObject

ランステップのデルタ、すなわちストリーミング中のランステップ上のフィールドが変更されたことを表す。

名前	タイプ	説明	必須	デフォルト
delta	オブジェクト	実行ステップで変化したフィールドを含むdeltaです。	はい
└─ ステップ詳細	runStepDeltaStepDetailsMessageCreationObject または runStepDeltaStepDetailsToolCallsObject	ランステップの詳細。	いいえ
id	文字列	APIエンドポイントで参照可能な実行ステップの識別子です。	はい
オブジェクト	文字列	オブジェクトタイプは常に thread.run.step.deltaです。	はい

object Enum: RunStepDeltaObjectType

価値	説明
thread.run.step.delta

listRunStepsResponse

名前	タイプ	説明	必須	デフォルト
データ	アレイ		はい
ファーストID	文字列		はい
has_more	boolean		はい
last_id	文字列		はい
オブジェクト	文字列		はい

runStepDetailsMessageCreationObject

ランステップによるメッセージ作成の詳細。

名前	タイプ	説明	必須	デフォルト
message_creation	オブジェクト		はい
└─ メッセージID	文字列	この実行ステップによって作成されたメッセージのIDです。	いいえ
型	文字列	いつも message_creation。	はい

型 Enum: RunStepDetailsMessageCreationObjectType

価値	説明
message_creation

runStepDeltaStepDetailsMessageCreationObject

ランステップによるメッセージ作成の詳細。

名前	タイプ	説明	必須	デフォルト
message_creation	オブジェクト		いいえ
└─ メッセージID	文字列	この実行ステップによって作成されたメッセージのIDです。	いいえ
型	文字列	いつも message_creation。	はい

型 Enum: RunStepDeltaDetailsMessageCreationObjectType

価値	説明
message_creation

runStepDetailsToolCallsObject

ツールコールの詳細。

名前	タイプ	説明	必須	デフォルト
tool_calls	アレイ	実行ステップには複数のツールコールが関わっていました。 これらは code_interpreter、 retrieval 、 functionの3種類のツールのいずれかに関連付けられます。	はい
型	文字列	いつも tool_calls。	はい

型 Enum: RunStepDetailsToolCallsObjectType

価値	説明
tool_calls

runStepDeltaStepDetailsToolCallsObject

ツールコールの詳細。

名前	タイプ	説明	必須	デフォルト
tool_calls	アレイ	実行ステップには複数のツールコールが関わっていました。 これらは code_interpreter、 file_search 、 functionの3種類のツールのいずれかに関連付けられます。	いいえ
型	文字列	いつも tool_calls。	はい

型 Enum: RunStepDeltaStepDetailsToolCallsObjectType

価値	説明
tool_calls

runStepDetailsToolCallsCodeObject

実行ステップが関与したコードインタプリタツールの呼び出しの詳細。

名前	タイプ	説明	必須	デフォルト
code_interpreter	オブジェクト	コードインタプリタツールの定義呼び出し。	はい
└─ 入力	文字列	コードインタプリタツールの呼び出しへの入力。	いいえ
└─ 出力	アレイ	コードインタプリタツールの呼び出しからの出力。 コードインプリタはテキスト(logs)や画像(image)を含む1つ以上の項目を出力できます。 それぞれ異なるオブジェクトタイプで表現されます。	いいえ
id	文字列	ツールコールのIDです。	はい
型	文字列	ツールコールの種類。 この種のツールコールには、常に code_interpreter です。	はい

型 Enum: RunStepDetailsToolCallsCodeObjectType

価値	説明
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

実行ステップが関与したコードインタプリタツールの呼び出しの詳細。

名前	タイプ	説明	必須	デフォルト
code_interpreter	オブジェクト	コードインタプリタツールの定義呼び出し。	いいえ
└─ 入力	文字列	コードインタプリタツールの呼び出しへの入力。	いいえ
└─ 出力	アレイ	コードインタプリタツールの呼び出しからの出力。 コードインプリタはテキスト(logs)や画像(image)を含む1つ以上の項目を出力できます。 それぞれ異なるオブジェクトタイプで表現されます。	いいえ
id	文字列	ツールコールのIDです。	いいえ
インデックス	整数	ツールコールのインデックスはツールコールの配列にあります。	はい
型	文字列	ツールコールの種類。 この種のツールコールには、常に code_interpreter です。	はい

型 Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

価値	説明
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

実行ステップの一部としてCode Interpreterツールからのテキスト出力を呼び出します。

名前	タイプ	説明	必須	デフォルト
ログ	文字列	コードインタプリタツールの呼び出しからのテキスト出力。	はい
型	文字列	いつも logs。	はい

型 Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType

価値	説明
ログ

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

実行ステップの一部としてCode Interpreterツールからのテキスト出力を呼び出します。

名前	タイプ	説明	必須	デフォルト
インデックス	整数	出力配列内の出力のインデックス。	はい
ログ	文字列	コードインタプリタツールの呼び出しからのテキスト出力。	いいえ
型	文字列	いつも logs。	はい

型 Enum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

価値	説明
ログ

runStepDetailsToolCallsCodeOutputImageObject

名前	タイプ	説明	必須	デフォルト
イメージ	オブジェクト		はい
└─ ファイルID	文字列	画像のファイルID。	いいえ
型	文字列	いつも image。	はい

型 Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

価値	説明
イメージ

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

名前	タイプ	説明	必須	デフォルト
イメージ	オブジェクト		いいえ
└─ ファイルID	文字列	画像のファイルIDです。	いいえ
インデックス	整数	出力配列内の出力のインデックス。	はい
型	文字列	いつも image。	はい

type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

価値	説明
イメージ

runStepDetailsToolCallsFileSearchObject

名前	タイプ	説明	必須	デフォルト
file_search	オブジェクト	今のところ、これは常に空のオブジェクトのままです。	はい
└─ 結果	アレイ	ファイル検索の結果。	いいえ
id	文字列	ツールコールオブジェクトのIDです。	はい
型	文字列	ツールコールの種類。 この種のツールコールには、常に file_search です。	はい

型 Enum: RunStepDetailsToolCallsFileSearchObjectType

価値	説明
file_search

runStepDetailsToolCallsFileSearchResultObject

ファイル検索の結果インスタンスです。

名前	タイプ	説明	必須	デフォルト
コンテンツ	アレイ	結果の内容が見つかった。 コンテンツはincludeクエリパラメータを通じてリクエストされた場合にのみ含まれます。	いいえ
file_id	文字列	その結果が見つかったファイルのIDです。	はい
ファイル名	文字列	その結果が見つかったファイル名です。	はい
スコア	number	結果のスコア。 すべての値は0から1の間の浮動小数点数でなければなりません。	はい

runStepDeltaStepDetailsToolCallsFileSearchObject

名前	タイプ	説明	必須	デフォルト
file_search	オブジェクト	今のところ、これは常に空のオブジェクトのままです。	はい
id	文字列	ツールコールオブジェクトのIDです。	いいえ
インデックス	整数	ツールコールのインデックスはツールコールの配列にあります。	はい
型	文字列	ツールコールの種類。 この種のツールコールには、常に retrieval です。	はい

type Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

価値	説明
file_search

runStepDetailsToolCallsFunctionObject

名前	タイプ	説明	必須	デフォルト
関数	オブジェクト	呼び出した関数の定義です。	はい
└─ 引数	文字列	関数に渡された引数。	いいえ
└─ 名前	文字列	その機能の名前です。	いいえ
└─ 出力	文字列	関数の出力です。 もし成果物がまだ提出されていなければ、これは null となります。	いいえ
id	文字列	ツールコールオブジェクトのIDです。	はい
型	文字列	ツールコールの種類。 この種のツールコールには、常に function です。	はい

型 Enum: RunStepDetailsToolCallsFunctionObjectType

価値	説明
関数

runStepDeltaStepDetailsToolCallsFunctionObject

名前	タイプ	説明	必須	デフォルト
関数	オブジェクト	呼び出した関数の定義です。	いいえ
└─ 引数	文字列	関数に渡された引数。	いいえ
└─ 名前	文字列	その機能の名前です。	いいえ
└─ 出力	文字列	関数の出力です。 もし成果物がまだ提出されていなければ、これは null となります。	いいえ
id	文字列	ツールコールオブジェクトのIDです。	いいえ
インデックス	整数	ツールコールのインデックスはツールコールの配列にあります。	はい
型	文字列	ツールコールの種類。 この種のツールコールには、常に function です。	はい

型 Enum: RunStepDetailsToolCallsFunctionObjectType

価値	説明
関数

vectorStoreExpirationAfter

ベクターストアの有効期限ポリシー。

名前	タイプ	説明	必須	デフォルト
アンカー	文字列	アンカータイムスタンプを付け、その後期限ポリシーが適用されます。 サポートアンカー: last_active_at。	はい
日間	整数	アンカー時刻からベクトルストアが期限切れになる日数です。	はい

アンカー数挙:ベクターストアExpirationAfterAnchor

価値	説明
最後のアクティブ日時	アンカーのタイムスタンプで、その後に有効期限ポリシーが適用されます。

vectorStoreObject

ベクターストアとは、 file_search ツールで使用可能な処理済みファイルの集合体です。

名前	タイプ	説明	必須	デフォルト
作成日時	整数	ベクターストアが作成された時点を示すUnixのタイムスタンプ(秒単位)。	はい
有効期限後	vectorStoreExpirationAfter	ベクターストアの有効期限ポリシー。	いいえ
有効期限	整数	ベクターストアが期限切れになるUnixのタイムスタンプ(秒単位)です。	いいえ
ファイル数	オブジェクト		はい
└─ 取り消されました	整数	キャンセルされたファイルの数。	いいえ
└─ 完了	整数	処理に成功したファイル数。	いいえ
└─ 失敗しました	整数	処理に失敗したファイルの数。	いいえ
└─ 進行中	整数	現在処理中のファイル数。	いいえ
└─ 合計	整数	ファイルの総数。	いいえ
id	文字列	識別子はAPIエンドポイントで参照可能です。	はい
最後のアクティブ日時	整数	ベクターストアが最後に稼働していた時間のUnixタイムスタンプ(秒単位)です。	はい
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	はい
name	文字列	ベクターストアの名前です。	はい
オブジェクト	列挙型	オブジェクトタイプは常に vector_storeです。 可能な値: vector_store	はい
状態	文字列	ベクターストアの状態は、 expired、 in_progress、または completedのいずれかです。 ステータスが completed の場合は、ベクターストアの使用準備が整ったことを示します。	はい
使用バイト数	整数	ベクターストア内のファイルが使用する総バイト数。	はい

status Enum: VectorStoreObjectStatus

価値	説明
期限 切れ
in_progress
完了

createVectorStoreRequest

名前	タイプ	説明	必須	デフォルト
chunking_strategy	autoChunkingStrategyRequestParam または staticChunkingStrategyRequestParam	ファイルをチャンク化するために使われたチャンク戦略。 設定していなければ、 auto 戦略を使います。 file_idsが空でない場合のみ適用されます。	いいえ
有効期限後	vectorStoreExpirationAfter	ベクターストアの有効期限ポリシー。	いいえ
ファイルID	アレイ	ベクターストアが使うべきファイルIDのリストです。 ファイルにアクセスできる file_search ツールには便利です。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
name	文字列	ベクターストアの名前です。	いいえ

updateVectorStoreRequest

名前	タイプ	説明	必須	デフォルト
有効期限後	vectorStoreExpirationAfter	ベクターストアの有効期限ポリシー。	いいえ
メタデータ	オブジェクト	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これはオブジェクトに関する追加情報を構造化された形式で保存するのに役立ちます。 キーの長さは最大64文字、値は最大512文字まで可能です。	いいえ
name	文字列	ベクターストアの名前です。	いいえ

listVectorStoresResponse

名前	タイプ	説明	必須	デフォルト
データ	アレイ		はい
ファーストID	文字列		はい
has_more	boolean		はい
last_id	文字列		はい
オブジェクト	文字列		はい

deleteVectorStoreResponse

名前	タイプ	説明	必須	デフォルト
削除されました	boolean		はい
id	文字列		はい
オブジェクト	文字列		はい

オブジェクト列挙:DeleteVectorStoreResponseObject

価値	説明
vector_store.deleted	削除ベクターストア応答オブジェクトの状態

vectorStoreFileObject

ベクターストアに添付されたファイルのリスト。

名前	タイプ	説明	必須	デフォルト
chunking_strategy	autoChunkingStrategyRequestParam または staticChunkingStrategyRequestParam	ファイルをチャンク化するために使われたチャンク戦略。 設定していなければ、 auto 戦略を使います。 file_idsが空でない場合のみ適用されます。	いいえ
作成日時	整数	ベクターストアファイルが作成された時点を示すUnixのタイムスタンプ(秒単位)。	はい
id	文字列	識別子はAPIエンドポイントで参照可能です。	はい
最後のエラー	オブジェクト	このベクターストアファイルに関連する最後のエラーです。 エラーがなければ null します。	はい
└─ コード	文字列	server_errorかinvalid_fileかunsupported_fileのどちらかです。	いいえ
└─ メッセージ	文字列	人間が読みやすい誤りの説明。	いいえ
オブジェクト	文字列	オブジェクトタイプは常に vector_store.fileです。	はい
状態	文字列	ベクターストアファイルの状態は、 in_progress、 completed、 cancelled、または failedのいずれかです。 ステータス completed はベクターストアファイルが使用可能であることを示します。	はい
使用バイト数	整数	ベクターストアの総使用量はバイト単位です。 これは元のファイルサイズとは異なる場合がありますのでご注意ください。	はい
vector_store_id（ベクターストアID）	文字列	ファイルが付随するベクターストアのIDです。	はい

オブジェクト列挙:VectorStoreFileObjectType

価値	説明
vector_store.file

status Enum: VectorStoreFileObjectStatus

価値	説明
in_progress
完了
cancelled
失敗

otherChunkingStrategyResponseParam

チャンキング戦略が未知の場合に返されます。 通常、これは chunking_strategy 概念がAPIに導入される前にファイルがインデックス化されていたためです。

名前	タイプ	説明	必須	デフォルト
型	文字列	いつも other。	はい

型 Enum: OtherChunkingStrategyResponseParamType

価値	説明
other

staticChunkingStrategyResponseParam

名前	タイプ	説明	必須	デフォルト
静的	staticChunkingStrategy		はい
型	文字列	いつも static。	はい

型 Enum: StaticChunkingStrategyResponseParamType

価値	説明
静的

staticChunkingStrategy

名前	タイプ	説明	必須	デフォルト
チャンク重複トークン	整数	チャンク間で重なるトークンの数。 デフォルト値は 400です。 重複は max_chunk_size_tokensの半分を超えてはならないことに注意してください。	はい
最大チャンクサイズトークン (max_chunk_size_tokens)	整数	各チャンクのトークン数の上限です。 デフォルト値は 800です。 最小値は 100 、最大値は 4096です。	はい

autoChunkingStrategyRequestParam

デフォルトの戦略です。 この戦略は現在、max_chunk_size_tokens800とchunk_overlap_tokens400を使用しています。

名前	タイプ	説明	必須	デフォルト
型	列挙型	いつも auto。 可能な値: auto	はい

staticChunkingStrategyRequestParam

名前	タイプ	説明	必須	デフォルト
静的	staticChunkingStrategy		はい
型	列挙型	いつも static。 可能な値: static	はい

chunkingStrategyRequestParam

ファイルをチャンク化するために使われたチャンク戦略。 設定していなければ、 auto 戦略を使います。

このコンポーネントは以下のいずれかである:

• autoChunkingStrategyRequestParam
• staticChunkingStrategyRequestParam

createVectorStoreFileRequest

名前	タイプ	説明	必須	デフォルト
chunking_strategy	chunkingStrategyRequestParam	ファイルをチャンク化するために使われたチャンク戦略。 設定していなければ、 auto 戦略を使います。	いいえ
file_id	文字列	ベクターストアが使うべきファイルIDです。 ファイルにアクセスできる file_search ツールには便利です。	はい

listVectorStoreFilesResponse

名前	タイプ	説明	必須	デフォルト
データ	アレイ		はい
ファーストID	文字列		はい
has_more	boolean		はい
last_id	文字列		はい
オブジェクト	文字列		はい

deleteVectorStoreFileResponse

名前	タイプ	説明	必須	デフォルト
削除されました	boolean		はい
id	文字列		はい
オブジェクト	文字列		はい

オブジェクト列挙:DeleteVectorStoreFileResponseObject

価値	説明
vector_store.file.deleted

vectorStoreFileBatchObject

ベクターストアに添付されたファイルの一括。

名前	タイプ	説明	必須	デフォルト
作成日時	整数	ベクターストアファイルのバッチ作成時のUnixタイムスタンプ(秒単位)です。	はい
ファイル数	オブジェクト		はい
└─ 取り消されました	整数	キャンセルされたファイルの数。	いいえ
└─ 完了	整数	処理されたファイルの数。	いいえ
└─ 失敗しました	整数	処理に失敗したファイルの数。	いいえ
└─ 進行中	整数	現在処理中のファイル数。	いいえ
└─ 合計	整数	ファイルの総数。	いいえ
id	文字列	識別子はAPIエンドポイントで参照可能です。	はい
オブジェクト	文字列	オブジェクトタイプは常に vector_store.file_batchです。	はい
状態	文字列	ベクターストアファイルのバッチ状態は、 in_progress、 completed、 cancelled 、または failedのいずれかです。	はい
vector_store_id（ベクターストアID）	文字列	ファイルが付随するベクターストアのIDです。	はい

オブジェクト列挙式:VectorStoreFileBatchObjectType

価値	説明
vector_store.files_batch

status Enum: VectorStoreFileBatchObjectStatus

価値	説明
in_progress
完了
cancelled
失敗

createVectorStoreFileBatchRequest

名前	タイプ	説明	必須	デフォルト
chunking_strategy	chunkingStrategyRequestParam	ファイルをチャンク化するために使われたチャンク戦略。 設定していなければ、 auto 戦略を使います。	いいえ
ファイルID	アレイ	ベクターストアが使うべきファイルIDのリストです。 ファイルにアクセスできる file_search ツールには便利です。	はい

assistantStreamEvent

ランのストリーミング時に発生するイベントを表します。

サーバー送信イベントストリーム内の各イベントには、 event と data プロパティがあります:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

新しいオブジェクトが作成されたり、新しい状態に移行したり、部分的にストリーミングされる(デルタ)ごとにイベントを発生させます。 例えば、新しいランが作成されるとき、thread.run.created実行完了時にthread.run.completedを放出します。 アシスタントがラン中にメッセージを作成することを選んだ場合、 thread.message.created event、 thread.message.in_progress イベント、多くの thread.message.delta イベント、そして最後には thread.message.completed イベントを発信します。

時間とともに追加のイベントを追加する可能性があるため、未知のイベントをコード内で丁寧に扱うことを推奨します。

このコンポーネントは以下のいずれかである:

• threadStreamEvent
• runStreamEvent
• runStepStreamEvent
• messageStreamEvent
• errorEvent
• doneEvent

threadStreamEvent

このコンポーネントは以下のいずれかである:

thread.created

新しいスレッドが作成されるときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	threadObject	メッセージを含むスレッドを表します。	はい
イベント	文字列		はい

Data: threadObject

イベント列挙型: ThreadStreamEventEnum

価値	説明
thread.created	スレッド作成イベント

---

runStreamEvent

このコンポーネントは以下のいずれかである:

thread.run.created

新しいランが作成されたときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runObject	スレッド上の実行実行を表します。	はい
イベント	文字列		はい

データ: runObject

イベント数:RunStreamEventCreated

価値	説明
thread.run.created

---

thread.run.queued

ランが queued 状態に移行したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runObject	スレッド上の実行実行を表します。	はい
イベント	文字列		はい

データ: runObject

イベント列挙:RunStreamEventQueued

価値	説明
thread.run.queued

---

thread.run.in_progress

ランが in_progress 状態に移行したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runObject	スレッド上の実行実行を表します。	はい
イベント	文字列		はい

データ: runObject

Event Enum: RunStreamEventInProgress(イベント情報収集

価値	説明
thread.run.in_progress

---

thread.run.requires_action

ランが requires_action 状態に移行したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runObject	スレッド上の実行実行を表します。	はい
イベント	文字列		はい

データ: runObject

イベント列挙型: RunStreamEventRequiresAction

価値	説明
thread.run.requires_action

---

thread.run.completed

ランが完了したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runObject	スレッド上の実行実行を表します。	はい
イベント	文字列		はい

データ: runObject

イベント列挙:RunStreamEventCompleted(イベント完了)

価値	説明
thread.run.completed

---

thread.run.failed

ランが失敗したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runObject	スレッド上の実行実行を表します。	はい
イベント	文字列		はい

データ: runObject

イベント数:RunStreamEventFailed

価値	説明
thread.run.failed

---

thread.run.cancelling

ランが cancelling 状態に移行したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runObject	スレッド上の実行実行を表します。	はい
イベント	文字列		はい

データ: runObject

イベント列挙:RunStreamEventCancelling

価値	説明
thread.run.cancelling

---

thread.run.cancelled

ランがキャンセルされたときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runObject	スレッド上の実行実行を表します。	はい
イベント	文字列		はい

データ: runObject

イベント列挙:RunStreamEventCancelled

価値	説明
thread.run.cancelled

---

thread.run.expired

ランが終了したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runObject	スレッド上の実行実行を表します。	はい
イベント	文字列		はい

データ: runObject

イベント列挙型: RunStreamEventExpired

価値	説明
thread.run.expired

---

runStepStreamEvent

このコンポーネントは以下のいずれかである:

thread.run.step.created

ランステップが作成されるときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runStepObject	ランの実行におけるステップを表します。	はい
イベント	文字列		はい

データ: runStepObject

イベント数:RunStepStreamEventCreated

価値	説明
thread.run.step.created

---

thread.run.step.in_progress

ランステップが in_progress 状態に移行したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runStepObject	ランの実行におけるステップを表します。	はい
イベント	文字列		はい

データ: runStepObject

Event Enum: RunStepStreamEventInProgress(イベント情報収集

価値	説明
thread.run.step.in_progress

---

thread.run.step.delta

ランステップの一部がストリーミングされているときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runStepDeltaObject	ランステップのデルタ、すなわちストリーミング中のランステップ上のフィールドが変更されたことを表す。	はい
イベント	文字列		はい

データ: runStepDeltaObject

イベント列挙型: RunStepStreamEventDelta

価値	説明
thread.run.step.delta

---

thread.run.step.completed

ランステップが完了したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runStepObject	ランの実行におけるステップを表します。	はい
イベント	文字列		はい

データ: runStepObject

イベント数:RunStepStreamEventCompleted(イベント完了)

価値	説明
thread.run.step.completed

---

thread.run.step.failed

ランステップが失敗したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runStepObject	ランの実行におけるステップを表します。	はい
イベント	文字列		はい

データ: runStepObject

イベント列挙型: RunStepStreamEventFailed

価値	説明
thread.run.step.failed

---

thread.run.step.cancelled

ランステップがキャンセルされたときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	runStepObject	ランの実行におけるステップを表します。	はい
イベント	文字列		はい

データ: runStepObject

イベント数挙:RunStepStreamEventCancelled

価値	説明
thread.run.step.cancelled

---

thread.run.step.expired

ランステップが期限切れになると発生します。

名前	タイプ	説明	必須	デフォルト
データ	runStepObject	ランの実行におけるステップを表します。	はい
イベント	文字列		はい

データ: runStepObject

イベント列挙型: RunStepStreamEventExpired

価値	説明
thread.run.step.expired

---

messageStreamEvent

このコンポーネントは以下のいずれかである:

thread.message.created

メッセージが作成されるときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	messageObject	スレッド内のメッセージを表します。	はい
イベント	文字列		はい

Data: messageObject

イベント数挙:MessageStreamEventCreated

価値	説明
thread.message.created

---

thread.message.in_progress

メッセージが in_progress 状態に移行するときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	messageObject	スレッド内のメッセージを表します。	はい
イベント	文字列		はい

Data: messageObject

イベント列挙:MessageStreamEventInProgress(イベント進行中)

価値	説明
thread.message.in_progress

---

thread.message.delta

メッセージの一部がストリーミングされているときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	messageDeltaObject	メッセージのデルタ、すなわちストリーミング中にメッセージのフィールドが変更されたことを表す。	はい
イベント	文字列		はい

Data: messageDeltaObject

イベント列挙:MessageStreamEventDelta

価値	説明
thread.message.delta

---

thread.message.completed

メッセージが完了したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	messageObject	スレッド内のメッセージを表します。	はい
イベント	文字列		はい

Data: messageObject

イベント列挙:MessageStreamEventCompleted(イベント完了)

価値	説明
thread.message.completed

---

thread.message.incomplete

メッセージが完了する前に終了したときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	messageObject	スレッド内のメッセージを表します。	はい
イベント	文字列		はい

Data: messageObject

イベント列挙:MessageStreamEventIncomplete(イベントストリーム)不完全

価値	説明
thread.message.incomplete

---

Annotation

このコンポーネントは以下のいずれかである:

• FileCitation
• UrlCitation
• FilePath

クリックする対象

クリックアクションです。

名前	タイプ	説明	必須	デフォルト
button	列挙型	クリック時にどのマウスボタンが押されたかを示します。 left、right、wheel、back、またはforwardのいずれかです。 可能な値: left、 right、 wheel、 back、 forward	はい
型	列挙型	イベントの種類を指定します。 クリックアクションの場合、このプロパティは常に clickに設定されています。 可能な値: click	はい
x	整数	クリック音が起きたx座標です。	はい
Y	整数	クリック音が発生したy座標です。	はい

CodeInterpreterFileOutput

コードインタプリタツールの出力はファイルです。

名前	タイプ	説明	必須	デフォルト
ファイル	アレイ		はい
型	列挙型	コードインタプリタのファイル出力タイプ。 いつも files。 可能な値: files	はい

CodeInterpreterTextOutput

コードインタプリタツールの出力はテキストです。

名前	タイプ	説明	必須	デフォルト
ログ	文字列	コードインタプリタツールのログが呼び出します。	はい
型	列挙型	コードインタプリタのテキスト出力の種類。 いつも logs。 可能な値: logs	はい

CodeInterpreterTool

コードを動かすツールです。

名前	タイプ	説明	必須	デフォルト
ファイルID	アレイ	コードを実行するファイルのIDです。	はい
型	列挙型	コードインタプリタツールの種類。 いつも code_interpreter。 可能な値: code_interpreter	はい

CodeInterpreterToolCall

コードを実行するためのツール呼び出しです。

名前	タイプ	説明	必須	デフォルト
コード	文字列	実行すべきコード。	はい
id	文字列	コードインタプリタツール呼び出しのユニークなIDです。	はい
results	アレイ	コードインタプリタツール呼び出しの結果。	はい
状態	列挙型	コードインタプリタツール呼び出しの状態。 可能な値: in_progress、 interpreting、 completed	はい
型	列挙型	コードインタプリタツール呼び出しの種類。 いつも code_interpreter_call。 可能な値: code_interpreter_call	はい

CodeInterpreterToolOutput

このコンポーネントは以下のいずれかである:

• CodeInterpreterTextOutput
• CodeInterpreterFileOutput

ComparisonFilter

定義された比較操作を用いて、指定された属性キーと与えられた値を比較するためのフィルターです。

名前	タイプ	説明	必須	デフォルト
キー	文字列	価値と比較する鍵です。	はい
型	列挙型	比較演算子を指定します: eq、 ne、 gt、 gte、 lt、 lte。 - eq:等しい - ne:等しくありません - gt:より大きい - gte: 大または等しい - lt:より小さい - lte: 以下または等しい 可能な値: eq、 ne、 gt、 gte、 lt、 lte	はい
value	文字列、数値、またはブール値	属性キーと比較する値;文字列型、数値型、またはブール型をサポートしています。	はい

CompoundFilter

複数のフィルターを and または orで組み合わせましょう。

名前	タイプ	説明	必須	デフォルト
フィルター	アレイ	複数のフィルターを組み合わせる。 アイテムは、 ComparisonFilter でも CompoundFilterでもよい。	はい
型	列挙型	作戦の種類: and または or。 可能な値: and、 or	はい

ComputerAction

このコンポーネントは以下のいずれかである:

• Click
• DoubleClick
• Drag
• KeyPress
• Move
• Screenshot
• Scroll
• Type
• 待機

ComputerScreenshotImage

コンピュータ使用ツールで使用されたコンピュータスクリーンショット画像。

名前	タイプ	説明	必須	デフォルト
file_id	文字列	スクリーンショットを含むアップロードファイルの識別子です。	いいえ
image_url	文字列	スクリーンショット画像のURLです。	いいえ
型	列挙型	イベントの種類を指定します。 コンピュータのスクリーンショットの場合、このプロパティは常に computer_screenshotに設定されています。 可能な値: computer_screenshot	はい

ComputerTool

仮想コンピュータを制御するツールです。

名前	タイプ	説明	必須	デフォルト
ディスプレイ高さ	number	コンピューターディスプレイの高さ。	はい
ディスプレイ幅	number	コンピューターディスプレイの幅。	はい
環境	列挙型	制御すべきコンピュータ環境の種類。 可能な値: mac、 windows、 ubuntu、 browser	はい
型	列挙型	コンピュータを使うツールの種類。 いつも computer_use_preview。 可能な値: computer-use-preview	はい

ComputerToolCall

ツールをコンピュータに呼びかけて、ツールを使う。

名前	タイプ	説明	必須	デフォルト
アクション	ComputerAction		はい
call_id	文字列	ツール呼び出しに対して出力を返す際に使われる識別子です。	はい
id	文字列	コンピューター通話のユニークなID。	はい
pending_safety_checks	アレイ	コンピューター通話のための安全確認が控えています。	はい
状態	列挙型	アイテムのステータス。 in_progress、completed、あるいはincompleteのいずれかです。 API経由でアイテムが返送されると入力されます。 可能な値: in_progress、 completed、 incomplete	はい
型	列挙型	コンピューター通話の種類。 いつも computer_call。 可能な値: computer_call	はい

ComputerToolCallOutput

コンピュータツール呼び出しの出力。

名前	タイプ	説明	必須	デフォルト
acknowledged_safety_checks	アレイ	APIが報告した安全チェックは開発者も認めています。	いいえ
call_id	文字列	出力を生み出したコンピュータツール呼び出しのIDです。	はい
id	文字列	コンピュータツールの出力呼び出しのIDです。	いいえ
出力	ComputerScreenshotImage	コンピュータ使用ツールで使用されたコンピュータスクリーンショット画像。	はい
状態	列挙型	メッセージ入力のステータス。 in_progress、completed、あるいはincompleteのいずれかです。 API経由で入力項目が返されると入力されます。 可能な値: in_progress、 completed、 incomplete	いいえ
型	列挙型	コンピュータツールの出力呼び出しの種類。 いつも computer_call_output。 可能な値: computer_call_output	はい

ComputerToolCallOutputResource

名前	タイプ	説明	必須	デフォルト
acknowledged_safety_checks	アレイ	APIが報告した安全チェックは開発者も認めています。	いいえ
call_id	文字列	出力を生み出したコンピュータツール呼び出しのIDです。	はい
id	文字列	コンピュータがツール出力を呼び出す際のユニークなID。	はい
出力	ComputerScreenshotImage	コンピュータ使用ツールで使用されたコンピュータスクリーンショット画像。	はい
状態	列挙型	メッセージ入力のステータス。 in_progress、completed、あるいはincompleteのいずれかです。 API経由で入力項目が返されると入力されます。 可能な値: in_progress、 completed、 incomplete	いいえ
型	列挙型	コンピュータツールの出力呼び出しの種類。 いつも computer_call_output。 可能な値: computer_call_output	はい

ComputerToolCallSafetyCheck

コンピューター通話の安全確認が待っている。

名前	タイプ	説明	必須	デフォルト
コード	文字列	保留中の安全確認の種類。	はい
id	文字列	安全確認のIDです。	はい
メッセージ	文字列	安全チェックが待っていることの詳細です。	はい

Content

マルチモーダルの入力および出力内容。

このコンポーネントは以下のいずれかである:

• InputContent
• OutputContent

Coordinate

x/y座標対、例えば { x: 100, y: 200 }。

名前	タイプ	説明	必須	デフォルト
x	整数	x 座標。	はい
Y	整数	y 座標。	はい

CreateModelResponseProperties

名前	タイプ	説明	必須	デフォルト
メタデータ	Metadata	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これは、オブジェクトに関する追加情報を構造化形式で保存したり、APIやダッシュボードを通じてオブジェクトをクエリしたりするのに役立ちます。 キーは最大64文字の文字列です。 値は最大512文字の文字列です。	いいえ
モデル	文字列	回答を生成するために使われるモデル。	いいえ
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。 一般的にはこれを変更するか、あるいは top_p を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこれを変更するか、あるいは temperature を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
ユーザー	文字列	エンドユーザーを表す一意の識別子で、OpenAIが悪用を監視・検出するのに役立ちます。 .	いいえ

createResponse

名前	タイプ	説明	必須	デフォルト
含める	アレイ	{"$ref": "#/components/schemas/includable/description"}	いいえ
入力	文字列または配列	モデルへのテキスト、画像、またはファイルの入力を用いて応答を生成する。	はい
手順	文字列	モデルのコンテキストの最初の項目としてシステム(または開発者)メッセージを挿入します。 previous_response_idと共に使用した場合、前の応答の指示は次の応答に引き継がれません。 これにより、新しい応答でシステム(または開発者)メッセージを簡単に切り替えることができます。	いいえ
max_output_tokens	整数	応答のために生成できるトークンの数の上限であり、可視出力トークンや推論トークンも含まれます。	いいえ
並列ツール呼び出し	boolean	モデルがツールコールを並列実行できるようにするか。	いいえ	正しい
previous_response_id	文字列	モデルに対する前の応答の一意ID。 これを使って複数ターンにわたる会話を作りましょう。	いいえ
reasoning	Reasoning	推論モデルの設定オプション。	いいえ
保存する	boolean	生成されたモデル応答を保存し、後でAPI経由で取得するかどうか。	いいえ	正しい
ストリーミング	boolean	trueに設定すると、モデル応答データは サーバー送信イベントで生成される際にクライアントにストリーミングされます。	いいえ	いいえ
SMS 送信	オブジェクト	モデルからのテキスト応答の設定オプション。 プレーンテキストでも構造化JSONデータでも構いません。 詳細情報： - テキスト入力および出力 - 構造化出力	いいえ
└─ フォーマット	TextResponseFormatConfiguration	モデルが出力すべきフォーマットを指定するオブジェクト。 { "type": "json_schema" }設定すると構造化出力が可能になり、モデルが提供されたJSONスキーマに合致します。 デフォルトのフォーマットは { "type": "text" } で、追加オプションはありません。 GPT-4o以降のモデルにはおすすめできません: { "type": "json_object" }に設定すると古いJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 json_schemaを使ったモデルでは、この方法をサポートするモデルが推奨されます。	いいえ
tool_choice	ToolChoiceOptions 、 ToolChoiceTypes 、または ToolChoiceFunction	モデルが応答を生成する際に使用するツールを選択する方法について。 モデルが呼び出せるツールを指定するには、 tools パラメータを参照してください。	いいえ
ツール	アレイ	モデルが応答を生成する際に呼び出す可能性のあるツールの配列です。 tool_choiceパラメータを設定することで、どのツールを使うかを指定できます。 モデルに提供できるツールの2つのカテゴリーがあります: - 組み込みツール	いいえ
truncation	列挙型	モデル応答に用いる切断戦略。 - auto: この応答およびそれ以前の応答のコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは 会話の途中で入力項目を落としてコンテキストウィンドウに合わせる応答です。 - disabled (デフォルト):モデルの応答がモデルのコンテキストウィンドウサイズを超える場合、リクエストは400エラーで失敗します。 可能な値: auto、 disabled	いいえ

DoubleClick

ダブルクリックの動作です。

名前	タイプ	説明	必須	デフォルト
型	列挙型	イベントの種類を指定します。 ダブルクリックアクションの場合、このプロパティは常に double_clickに設定されています。 可能な値: double_click	はい
x	整数	ダブルクリックが起きたx座標。	はい
Y	整数	ダブルクリックが起きたy座標です。	はい

ドラッグ

ドラッグアクションだ。

名前	タイプ	説明	必須	デフォルト
パス	アレイ	抗力作用の経路を表す座標の配列です。 座標はオブジェクトの配列として表示されます。例えば[{ x: 100, y: 200 }, { x: 200, y: 300 }]	はい
型	列挙型	イベントの種類を指定します。 ドラッグ作用の場合、この性質は常に dragに設定されます。 可能な値: drag	はい

EasyInputMessage

階層に従う指示を示す役割を持つモデルへのメッセージ入力。 developerまたはsystemの役割で与えられた指示が、userの役割で出される指示よりも優先されます。 assistant役割を持つメッセージは、モデルが過去のやり取りで生成されたものと推定されます。

名前	タイプ	説明	必須	デフォルト
コンテンツ	文字列または InputMessageContentList	モデルに対してテキスト、画像、または音声入力を用いて応答を生成する。 また、過去のアシスタントからの回答を含めることも可能です。	はい
ロール	列挙型	メッセージ入力の役割。 user、assistant、system、あるいはdeveloperのどれかです。 可能な値: user、 assistant、 system、 developer	はい
型	列挙型	メッセージ入力の種類。 いつも message。 可能な値: message	いいえ

FileCitation

ファイルの引用。

名前	タイプ	説明	必須	デフォルト
file_id	文字列	ファイルのIDです。	はい
インデックス	整数	ファイル一覧内のファイルのインデックスです。	はい
型	列挙型	ファイル引用の種類。 いつも file_citation。 可能な値: file_citation	はい

FilePath

ファイルへのパス。

名前	タイプ	説明	必須	デフォルト
file_id	文字列	ファイルのIDです。	はい
インデックス	整数	ファイル一覧内のファイルのインデックスです。	はい
型	列挙型	ファイルパスの種類。 いつも file_path。 可能な値: file_path	はい

FileSearchRanker

ファイル検索に使うランク。 指定がなければ auto ランクを使います。

Property	価値
説明	ファイル検索に使うランク。 指定がなければ auto ランクを使います。
Type	文字列
値	auto default_2024_08_21

FileSearchTool

アップロードされたファイルから関連コンテンツを検索するツールです。

名前	タイプ	説明	必須	デフォルト
フィルター	比較フィルター または 複合フィルター	ファイル属性に基づいて適用するフィルターです。	いいえ
最大結果数	整数	返却すべき最大結果数。 この数字は1から50の間であるべきです。	いいえ
ランキングオプション	オブジェクト	検索のランキングオプション。	いいえ
└─ ランカー	列挙型	ファイル検索に使うランク。 可能な値: auto、 default-2024-11-15	いいえ
└─ スコアのしきい値	number	ファイル検索のスコア閾値は0から1の間の数値です。 1に近い数値は最も関連性の高い結果のみを返そうとしますが、返される結果数は少ない場合もあります。	いいえ	0
型	列挙型	ファイル検索ツールの種類。 いつも file_search。 可能な値: file_search	はい
vector_store_ids	アレイ	検索用のベクターストアのIDです。	はい

FileSearchToolCall

ファイル検索ツールの呼び出し結果。

名前	タイプ	説明	必須	デフォルト
id	文字列	ファイル検索ツールのユニークなIDが呼ばれます。	はい
クエリ	アレイ	ファイル検索に使われたクエリです。	はい
results	アレイ	ファイル検索ツールの結果が呼びかけられます。	いいえ
状態	列挙型	ファイル検索ツールの呼び出しの状態。 in_progress、searching、incomplete、またはfailedのどれか、 可能な値: in_progress、 searching、 completed、 incomplete、 failed	はい
型	列挙型	ファイル検索ツールの呼び出しの種類。 いつも file_search_call。 可能な値: file_search_call	はい

FunctionTool

モデルが呼び出せる関数を自分のコードで定義します。

名前	タイプ	説明	必須	デフォルト
説明	文字列	関数の説明。 モデルが関数を呼び出すかどうかを判断するために使われます。	いいえ
name	文字列	呼び出しする関数の名前。	はい
parameters	オブジェクト	関数のパラメータを記述するJSONスキーマオブジェクト。	はい
厳しい	boolean	厳格なパラメータ検証を強制するかどうか。 デフォルトの true。	はい
型	列挙型	関数ツールの種類。 いつも function。 可能な値: function	はい

FunctionToolCall

関数を実行するためのツールコールです。

名前	タイプ	説明	必須	デフォルト
arguments	文字列	関数に渡す引数のJSON文字列です。	はい
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意ID。	はい
id	文字列	関数ツール呼び出しのユニークなID。	はい
name	文字列	実行する関数の名前。	はい
状態	列挙型	アイテムのステータス。 in_progress、completed、あるいはincompleteのいずれかです。 API経由でアイテムが返送されると入力されます。 可能な値: in_progress、 completed、 incomplete	いいえ
型	列挙型	関数ツール呼び出しの種類。 いつも function_call。 可能な値: function_call	はい

FunctionToolCallOutput

関数ツール呼び出しの出力。

名前	タイプ	説明	必須	デフォルト
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意ID。	はい
id	文字列	関数ツールの一意IDが出力を呼び出します。 API経由でこのアイテムが返されると入力されます。	いいえ
出力	文字列	関数ツール呼び出しの出力のJSON文字列です。	はい
状態	列挙型	アイテムのステータス。 in_progress、completed、あるいはincompleteのいずれかです。 API経由でアイテムが返送されると入力されます。 可能な値: in_progress、 completed、 incomplete	いいえ
型	列挙型	関数ツールの呼び出し出力の種類。 いつも function_call_output。 可能な値: function_call_output	はい

FunctionToolCallOutputResource

名前	タイプ	説明	必須	デフォルト
call_id	文字列	モデルによって生成される関数ツール呼び出しの一意ID。	はい
id	文字列	関数呼び出しツール出力の一意IDです。	はい
出力	文字列	関数ツール呼び出しの出力のJSON文字列です。	はい
状態	列挙型	アイテムのステータス。 in_progress、completed、あるいはincompleteのいずれかです。 API経由でアイテムが返送されると入力されます。 可能な値: in_progress、 completed、 incomplete	いいえ
型	列挙型	関数ツールの呼び出し出力の種類。 いつも function_call_output。 可能な値: function_call_output	はい

includable

モデル応答に含める追加の出力データを指定してください。 現在サポートされている値は以下の通りです:

• file_search_call.resultsファイル検索ツールの呼び出し結果を含めてください。
• message.input_image.image_url: 入力メッセージから画像URLを含めてください。
• computer_call_output.output.image_url: コンピュータ呼び出し出力からの画像URLを含めてください。

Property	価値
説明	モデル応答に含める追加の出力データを指定してください。 現在サポートされている値は以下の通りです: - file_search_call.resultsファイル検索ツールの呼び出し結果を含めてください。 - message.input_image.image_url: 入力メッセージから画像URLを含めてください。 - computer_call_output.output.image_url: コンピュータ呼び出し出力からの画像URLを含めてください。
Type	文字列
値	file_search_call.results message.input_image.image_url computer_call_output.output.image_url

InputAudio

モデルへの音声入力。

名前	タイプ	説明	必須	デフォルト
データ	文字列	Base64エンコードされた音声データ。	はい
format	列挙型	音声データのフォーマット。 現在サポートされているフォーマットは mp3 と wavです。 可能な値: mp3、 wav	はい
型	列挙型	入力項目の種類。 いつも input_audio。 可能な値: input_audio	はい

InputContent

このコンポーネントは以下のいずれかである:

• InputText
• InputImage
• InputFile

InputFile

モデルへのファイル入力。

名前	タイプ	説明	必須	デフォルト
file_data	文字列	モデルに送るファイルの内容。	いいえ
file_id	文字列	モデルに送るファイルのIDです。	いいえ
ファイル名	文字列	モデルに送るファイル名。	いいえ
型	列挙型	入力項目の種類。 いつも input_file。 可能な値: input_file	はい

InputImage

モデルへの画像入力。

名前	タイプ	説明	必須	デフォルト
detail	列挙型	モデルに送る画像のディテールレベル。 high、low、あるいはautoのいずれかです。 デフォルトは autoです。 可能な値: high、 low、 auto	はい
file_id	文字列	モデルに送るファイルのIDです。	いいえ
image_url	文字列	モデルに送る画像のURLです。 データURL内の完全限定URLまたはbase64でエンコードされた画像。	いいえ
型	列挙型	入力項目の種類。 いつも input_image。 可能な値: input_image	はい

InputItem

このコンポーネントは以下のいずれかである:

• EasyInputMessage
• 品目
• ItemReference

入力メッセージ

階層に従う指示を示す役割を持つモデルへのメッセージ入力。 developerまたはsystemの役割で与えられた指示が、userの役割で出される指示よりも優先されます。

名前	タイプ	説明	必須	デフォルト
コンテンツ	InputMessageContentList	モデルへの1つまたは複数の入力項目のリストで、異なる内容を含む types.	はい
ロール	列挙型	メッセージ入力の役割。 user、system、あるいはdeveloperのいずれかです。 可能な値: user、 system、 developer	はい
状態	列挙型	アイテムの状態。 in_progress、completed、あるいはincompleteのいずれかです。 API経由でアイテムが返送されると入力されます。 可能な値: in_progress、 completed、 incomplete	いいえ
型	列挙型	メッセージ入力の種類。 常に messageに設定されています。 可能な値: message	いいえ

InputMessageContentList

モデルへの1つまたは複数の入力項目のリストで、異なるコンテンツタイプを含むものです。

このコンポーネントにはプロパティが定義されていません。

InputMessageResource

名前	タイプ	説明	必須	デフォルト
コンテンツ	InputMessageContentList	モデルへの1つまたは複数の入力項目のリストで、異なる内容を含む types.	はい
id	文字列	メッセージ入力の一意ID。	はい
ロール	列挙型	メッセージ入力の役割。 user、system、あるいはdeveloperのいずれかです。 可能な値: user、 system、 developer	はい
状態	列挙型	アイテムの状態。 in_progress、completed、あるいはincompleteのいずれかです。 API経由でアイテムが返送されると入力されます。 可能な値: in_progress、 completed、 incomplete	いいえ
型	列挙型	メッセージ入力の種類。 常に messageに設定されています。 可能な値: message	いいえ

InputText

モデルへのテキスト入力。

名前	タイプ	説明	必須	デフォルト
SMS 送信	文字列	モデルへのテキスト入力。	はい
型	列挙型	入力項目の種類。 いつも input_text。 可能な値: input_text	はい

品目

回答を生成するために使われるコンテンツ項目。

このコンポーネントは以下のいずれかである:

• InputMessage
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutput
• FunctionToolCall
• FunctionToolCallOutput
• ReasoningItem

ItemReference

参照するアイテムの内部識別子。

名前	タイプ	説明	必須	デフォルト
id	文字列	参照するアイテムのIDです。	はい
型	列挙型	参照すべきアイテムの種類。 いつも item_reference。 可能な値: item_reference	はい

ItemResource

回答を生成するために使われるコンテンツ項目。

このコンポーネントは以下のいずれかである:

• InputMessageResource
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutputResource
• FunctionToolCall
• FunctionToolCallOutputResource

KeyPress

モデルが実行したいキー入力の集合。

名前	タイプ	説明	必須	デフォルト
keys	アレイ	モデルが押してほしいキーの組み合わせ。 これは文字列の配列で、それぞれがキーを表します。	はい
型	列挙型	イベントの種類を指定します。 キープレス操作の場合、このプロパティは常に keypressに設定されています。 可能な値: keypress	はい

メタデータ

オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これは、オブジェクトに関する追加情報を構造化形式で保存したり、APIやダッシュボードを通じてオブジェクトをクエリしたりするのに役立ちます。

キーは最大64文字の文字列です。 値は最大512文字の文字列です。

このコンポーネントにはプロパティが定義されていません。

ModelResponseProperties

名前	タイプ	説明	必須	デフォルト
メタデータ	Metadata	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これは、オブジェクトに関する追加情報を構造化形式で保存したり、APIやダッシュボードを通じてオブジェクトをクエリしたりするのに役立ちます。 キーは最大64文字の文字列です。 値は最大512文字の文字列です。	いいえ
モデル	文字列	回答を生成するために使われるモデル。	いいえ
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。 一般的にはこれを変更するか、あるいは top_p を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこれを変更するか、あるいは temperature を変えることを推奨しますが、両方はおすすめしません。	いいえ	1
ユーザー	文字列	エンドユーザーを表す一意の識別子で、OpenAIが悪用を監視・検出するのに役立ちます。 .	いいえ

移動

マウス移動アクションです。

名前	タイプ	説明	必須	デフォルト
型	列挙型	イベントの種類を指定します。 移動アクションの場合、このプロパティは常に moveに設定されています。 可能な値: move	はい
x	整数	移動するx座標。	はい
Y	整数	移動するY座標です。	はい

OutputAudio

モデルからの音声出力です。

名前	タイプ	説明	必須	デフォルト
データ	文字列	モデルからのBase64エンコード音声データ。	はい
トランスクリプト	文字列	モデルからの音声データの書き起こしです。	はい
型	列挙型	出力される音声の種類。 いつも output_audio。 可能な値: output_audio	はい

OutputContent

このコンポーネントは以下のいずれかである:

• OutputText
• Refusal

OutputItem

名前	タイプ	説明	必須	デフォルト
アクション	ComputerAction		はい
arguments	文字列	関数に渡す引数のJSON文字列です。	はい
call_id	文字列	ツール呼び出しに対して出力を返す際に使われる識別子です。	はい
コンテンツ	アレイ	本文の内容を理由付けています。	はい
id	文字列	論理内容の一意識別子。	はい
name	文字列	実行する関数の名前。	はい
pending_safety_checks	アレイ	コンピューター通話のための安全確認が控えています。	はい
クエリ	アレイ	ファイル検索に使われたクエリです。	はい
results	アレイ	ファイル検索ツールの結果が呼びかけられます。	いいえ
ロール	列挙型	出力メッセージの役割。 いつも assistant。 可能な値: assistant	はい
状態	列挙型	アイテムのステータス。 in_progress、completed、あるいはincompleteのいずれかです。 API経由でアイテムが返送されると入力されます。 可能な値: in_progress、 completed、 incomplete	はい
型	列挙型	対象の種類。 いつも reasoning。 可能な値: reasoning	はい

OutputMessage

モデルからの出力メッセージです。

名前	タイプ	説明	必須	デフォルト
コンテンツ	アレイ	出力メッセージの内容です。	はい
id	文字列	出力メッセージの一意ID。	はい
ロール	列挙型	出力メッセージの役割。 いつも assistant。 可能な値: assistant	はい
状態	列挙型	メッセージ入力のステータス。 in_progress、completed、あるいはincompleteのいずれかです。 API経由で入力項目が返されると入力されます。 可能な値: in_progress、 completed、 incomplete	はい
型	列挙型	出力メッセージの種類。 いつも message。 可能な値: message	はい

OutputText

モデルからのテキスト出力です。

名前	タイプ	説明	必須	デフォルト
注釈	アレイ	テキスト出力の注釈です。	はい
SMS 送信	文字列	モデルからのテキスト出力です。	はい
型	列挙型	出力テキストの種類。 いつも output_text。 可能な値: output_text	はい

RealtimeSessionCreateRequest

リアルタイムのセッションオブジェクト設定。

名前	タイプ	説明	必須	デフォルト
input_audio_format	列挙型	入力音声のフォーマット。 選択肢は pcm16、 g711_ulaw、または g711_alawです。 pcm16の場合、入力音声は16ビットPCM、24kHzのサンプルレート、シングルチャンネル(モノラル)、リトルエンディアンのバイトオーダーでなければなりません。 可能な値: pcm16、 g711_ulaw、 g711_alaw	いいえ
input_audio_noise_reduction	オブジェクト	入力オーディオノイズリダクションの設定。 これを null に設定して電源を切ることができます。 ノイズリダクションフィルターは、VADやモデルに送られる前に入力オーディオバッファに追加された音声をフィルターします。 音声をフィルタリングすることで、VADやターン検出の精度(誤検知の減少)や入力音声の知覚を向上させるモデル性能が向上します。	いいえ
└─ タイプ	列挙型	ノイズリダクションの種類です。 near_field はヘッドホンのような近距離通話用マイク用で、 far_field はノートパソコンや会議室用マイクなどの遠距離マイク用です。 可能な値: near_field、 far_field	いいえ
音声トランスクリプション入力	オブジェクト	入力音声文字起こしの設定はデフォルトでオフにされ、オンになると null に設定できます。 入力音声の文字起こしはモデルのネイティブではありません。モデルは直接音声を消費するためです。 文字起こしは Transcriptionsエンドポイント を非同期で実行し、モデルが正確に聞いた音声ではなく、入力音声内容の誘導として扱うべきです。 クライアントは文字起こしの言語やプロンプトをオプションで設定でき、これらは文字起こしサービスに追加の指針を提供します。	いいえ
└─ 言語	文字列	入力音声の言語。 入力言語を ISO-639-1 (例: en)形式で提供することで、精度と遅延が向上します。	いいえ
└─ モデル	文字列	転写に使うモデルは、現在の選択肢として gpt-4o-transcribe、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 whisper-1です。	いいえ
└─ プロンプト	文字列	モデルのスタイルをガイドしたり、前の音声セグメントを続けるためのオプションテキスト。 whisper-1の場合、プロンプトはキーワードのリストです。 gpt-4o-transcribeモデルの場合、プロンプトは「expect words related to technology」などのフリーテキスト文字列です。	いいえ
手順	文字列	デフォルトのシステム命令(すなわちシステムメッセージ)はモデル呼び出しの前に置かれていました。 このフィールドはクライアントが望ましい回答をモデルに導くことを可能にします。 モデルは回答内容や形式(例:「非常に簡潔にする」「親しみやすい行動をする」「良い反応の例がある」)や、音声行動(例:「話すのが早い」「声に感情を込める」「頻繁に笑う」など)について指導できます。 指示はモデルが必ずしも従うとは限りませんが、望ましい動作についてモデルに指針を提供します。 サーバーはデフォルト命令を設定し、このフィールドが設定されていない場合に使用され、セッション開始時の session.created イベントで表示されます。	いいえ
max_response_output_tokens	整数または文字列	ツール呼び出しを含む単一のアシスタント応答に対する最大出力トークン数。 出力トークン数を制限するために1から4096までの整数を用意するか、あるモデルで利用可能な最大トークン数を inf にします。 デフォルトは infです。	いいえ
modalities		モデルが応答できるモダリティの集合。 音声を無効にするには、["text"]に設定してください。	いいえ
モデル	文字列	このセッションで使用された展開の名前。	いいえ
output_audio_format	列挙型	出力音声のフォーマット。 選択肢は pcm16、 g711_ulaw、または g711_alawです。 pcm16の場合、出力音声は24kHzの周波数でサンプリングされます。 可能な値: pcm16、 g711_ulaw、 g711_alaw	いいえ
温度	number	モデルのサンプリング温度は[0.6, 1.2]に制限されています。 オーディオモデルでは、最高のパフォーマンスのために0.8度の温度が強く推奨されます。	いいえ	0.8
tool_choice	文字列	モデルがどのように道具を選ぶか。 オプションは auto、 none、 required、または関数を指定することができます。	いいえ	自動
ツール	アレイ	モデルが利用可能なツール(機能)。	いいえ
turn_detection	オブジェクト	ターン検出の設定、サーバーVADまたはセマンティックVADの設定。 これを null に設定してオフにすることもでき、その場合はクライアントが手動でモデル応答をトリガーする必要があります。 サーバーVADは、音声の音量に基づいて音声の開始と終了を検出し、ユーザーの音声の終わりに応答することを意味します。 セマンティックVADはより高度で、ターン検出モデル(VADと組み合わせて)を用いて、ユーザーが話し終えたかどうかを意味的に推定し、その確率に基づいて動的にタイムアウトを設定します。 例えば、ユーザーの音声が uhhmで途切れると、モデルはターン終了の確率を低く評価し、ユーザーが話すまで長く待ちます。 これはより自然な会話には役立ちますが、遅延が高くなることがあります。	いいえ
└─ 応答を作成	boolean	VAD停止イベントが発生した際に自動的に応答を生成するかどうか。	いいえ	正しい
└─ 熱心さ	列挙型	semantic_vadモード専用。 モデルの反応への熱意。 low ユーザーが話し続けるまでより長く待ち、 high より早く応答します。 auto はデフォルトであり、 mediumと同等です。 可能な値: low、 medium、 high、 auto	いいえ
└─ 割り込み対応 (interrupt_response)	boolean	VAD開始イベントが発生した際に、進行中の応答を自動的にデフォルト会話(すなわちconversationauto)に出力して中断するかどうか。	いいえ	正しい
└─ prefix_padding_ms（プリフィックス・パディング・ミリ秒）	整数	server_vadモード専用。 VADが音声を検出する前に含める音声量(ミリ秒単位)。 デフォルトは300msです。	いいえ
└─ 無音時間_ミリ秒	整数	server_vadモード専用。 発言停止を検出するための無音の持続時間(ミリ秒単位)。 デフォルトは500msです。 短い値を使えばモデルはより速く反応しますが、ユーザーの短い間入りに飛び込むことがあります。	いいえ
└─ しきい値	number	server_vadモード専用。 VADのアクティベーション閾値(0.0から1.0)はデフォルトで0.5です。 閾値が高いほど、モデルを起動するにはより大きな音が必要になり、騒がしい環境での性能が向上する可能性があります。	いいえ
└─ タイプ	列挙型	旋回検知の種類。 可能な値: server_vad、 semantic_vad	いいえ
音声	VoiceIdsShared		いいえ

RealtimeSessionCreateResponse

新しいリアルタイムセッション構成で、エフェメラルキーを使った。 キーのデフォルトのTTLは1分です。

名前	タイプ	説明	必須	デフォルト
client_secret	オブジェクト	APIから返される一時鍵。	はい
└─ 有効期限_終了	整数	トークンの期限が切れるタイムスタンプ。 現在、すべてのトークンは1分後に期限切れとなります。	いいえ
└─ 値	文字列	クライアント環境でリアルタイムAPIへの接続を認証するために使える一時的な鍵。 これは標準的なAPIトークンではなく、サーバーサイドでのみ使うべきなのでクライアントサイド環境で使うべきです。	いいえ
input_audio_format	文字列	入力音声のフォーマット。 選択肢は pcm16、 g711_ulaw、または g711_alawです。	いいえ
音声トランスクリプション入力	オブジェクト	入力音声文字起こしの設定はデフォルトでオフにされ、オンになると null に設定できます。 入力音声の文字起こしはモデルのネイティブではありません。モデルは直接音声を消費するためです。 転写はWhisper内で非同期的に実行され、モデルが理解する表現ではなく、大まかなガイダンスとして扱うべきです。	いいえ
└─ モデル	文字列	転写に使用するモデルは、現在サポートされている唯一のモデル whisper-1 です。	いいえ
手順	文字列	デフォルトのシステム命令(すなわちシステムメッセージ)はモデル呼び出しの前に置かれていました。 このフィールドはクライアントが望ましい回答をモデルに導くことを可能にします。 モデルは回答内容やフォーマット(例:「非常に簡潔にする」「親しみやすく振る舞う」「良い回答の例がある」)や、音声行動(例:「早く話す」「声に感情を注入する」「頻繁に笑う」)について指導できます。 指示はモデルが必ずしも従うとは限りませんが、望ましい動作についてモデルに指針を提供します。 サーバーはデフォルト命令を設定し、このフィールドが設定されていない場合に使用され、セッション開始時の session.created イベントで表示されます。	いいえ
max_response_output_tokens	整数または文字列	ツール呼び出しを含む単一のアシスタント応答に対する最大出力トークン数。 出力トークン数を制限するために1から4096までの整数を用意するか、あるモデルで利用可能な最大トークン数を inf にします。 デフォルトは infです。	いいえ
modalities		モデルが応答できるモダリティの集合。 音声を無効にするには、["text"]に設定してください。	いいえ
output_audio_format	文字列	出力音声のフォーマット。 選択肢は pcm16、 g711_ulaw、または g711_alawです。	いいえ
温度	number	モデルのサンプリング温度は[0.6, 1.2]に制限されています。 デフォルトは0.8です。	いいえ
tool_choice	文字列	モデルがどのように道具を選ぶか。 オプションは auto、 none、 required、または関数を指定することができます。	いいえ
ツール	アレイ	モデルが利用可能なツール(機能)。	いいえ
turn_detection	オブジェクト	ターン検知の設定。 nullに設定してオフにできます。 サーバーVADは、音声の音量に基づいて音声の開始と終了を検出し、ユーザーの音声の終わりに応答することを意味します。	いいえ
└─ prefix_padding_ms（プリフィックス・パディング・ミリ秒）	整数	VADが音声を検出する前に含める音声量(ミリ秒単位)。 デフォルトは300msです。	いいえ
└─ 無音時間_ミリ秒	整数	発言停止を検出するための無音の持続時間(ミリ秒単位)。 デフォルトは500msです。 短い値を使えばモデルはより速く反応しますが、ユーザーの短い間入りに飛び込むことがあります。	いいえ
└─ しきい値	number	VADのアクティベーション閾値(0.0から1.0)はデフォルトで0.5です。 閾値が高いほど、モデルを起動するにはより大きな音が必要になり、騒がしい環境での性能が向上する可能性があります。	いいえ
└─ タイプ	文字列	ターン検知の種類ですが、現在サポートされているのは server_vad のみです。	いいえ
音声	VoiceIdsShared		いいえ

RealtimeTranscriptionSessionCreateRequest

リアルタイム文字起こしセッションオブジェクトの設定。

名前	タイプ	説明	必須	デフォルト
含める	アレイ	書き起こしに含める項目のセット。 現在利用可能な品は以下の通りです: - item.input_audio_transcription.logprobs	いいえ
input_audio_format	列挙型	入力音声のフォーマット。 選択肢は pcm16、 g711_ulaw、または g711_alawです。 pcm16の場合、入力音声は16ビットPCM、24kHzのサンプルレート、シングルチャンネル(モノラル)、リトルエンディアンのバイトオーダーでなければなりません。 可能な値: pcm16、 g711_ulaw、 g711_alaw	いいえ
input_audio_noise_reduction	オブジェクト	入力オーディオノイズリダクションの設定。 これを null に設定して電源を切ることができます。 ノイズリダクションフィルターは、VADやモデルに送られる前に入力オーディオバッファに追加された音声をフィルターします。 音声をフィルタリングすることで、VADやターン検出の精度(誤検知の減少)や入力音声の知覚を向上させるモデル性能が向上します。	いいえ
└─ タイプ	列挙型	ノイズリダクションの種類です。 near_field はヘッドホンのような近距離通話用マイク用で、 far_field はノートパソコンや会議室用マイクなどの遠距離マイク用です。 可能な値: near_field、 far_field	いいえ
音声トランスクリプション入力	オブジェクト	入力音声文字起こしの設定。 クライアントは文字起こしの言語やプロンプトをオプションで設定でき、これらは文字起こしサービスに追加の指針を提供します。	いいえ
└─ 言語	文字列	入力音声の言語。 入力言語を ISO-639-1 (例: en)形式で提供することで、精度と遅延が向上します。	いいえ
└─ モデル	列挙型	転写に使うモデルは、現在の選択肢として gpt-4o-transcribe、 gpt-4o-transcribe-diarize、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 whisper-1です。 可能な値: gpt-4o-transcribe、 gpt-4o-transcribe-diarize、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 whisper-1	いいえ
└─ プロンプト	文字列	モデルのスタイルをガイドしたり、前の音声セグメントを続けるためのオプションテキスト。 whisper-1の場合、プロンプトはキーワードのリストです。 gpt-4o-transcribeモデルの場合、プロンプトは「expect words related to technology」などのフリーテキスト文字列です。	いいえ
modalities		モデルが応答できるモダリティの集合。 音声を無効にするには、["text"]に設定してください。	いいえ
turn_detection	オブジェクト	ターン検出の設定、サーバーVADまたはセマンティックVADの設定。 これを null に設定してオフにすることもでき、その場合はクライアントが手動でモデル応答をトリガーする必要があります。 サーバーVADは、音声の音量に基づいて音声の開始と終了を検出し、ユーザーの音声の終わりに応答することを意味します。 セマンティックVADはより高度で、ターン検出モデル(VADと組み合わせて)を用いて、ユーザーが話し終えたかどうかを意味的に推定し、その確率に基づいて動的にタイムアウトを設定します。 例えば、ユーザーの音声が uhhmで途切れると、モデルはターン終了の確率を低く評価し、ユーザーが話すまで長く待ちます。 これはより自然な会話には役立ちますが、遅延が高くなることがあります。	いいえ
└─ 応答を作成	boolean	VAD停止イベントが発生した際に自動的に応答を生成するかどうか。 文字起こしセッションは利用できません。	いいえ	正しい
└─ 熱心さ	列挙型	semantic_vadモード専用。 モデルの反応への熱意。 low ユーザーが話し続けるまでより長く待ち、 high より早く応答します。 auto はデフォルトであり、 mediumと同等です。 可能な値: low、 medium、 high、 auto	いいえ
└─ 割り込み対応 (interrupt_response)	boolean	VAD開始イベントが発生した際に、進行中の応答を自動的にデフォルト会話(すなわちconversationauto)に出力して中断するかどうか。 文字起こしセッションは利用できません。	いいえ	正しい
└─ prefix_padding_ms（プリフィックス・パディング・ミリ秒）	整数	server_vadモード専用。 VADが音声を検出する前に含める音声量(ミリ秒単位)。 デフォルトは300msです。	いいえ
└─ 無音時間_ミリ秒	整数	server_vadモード専用。 発言停止を検出するための無音の持続時間(ミリ秒単位)。 デフォルトは500msです。 短い値を使えばモデルはより速く反応しますが、ユーザーの短い間入りに飛び込むことがあります。	いいえ
└─ しきい値	number	server_vadモード専用。 VADのアクティベーション閾値(0.0から1.0)はデフォルトで0.5です。 閾値が高いほど、モデルを起動するにはより大きな音が必要になり、騒がしい環境での性能が向上する可能性があります。	いいえ
└─ タイプ	列挙型	旋回検知の種類。 可能な値: server_vad、 semantic_vad	いいえ

RealtimeTranscriptionSessionCreateResponse

新しいリアルタイム文字起こしセッションの設定です。

REST APIを通じてサーバー上でセッションが作成される場合、セッションオブジェクトには一時的なキーも含まれます。 キーのデフォルトのTTLは1分です。 このプロパティは、WebSocket APIを通じてセッションが更新される際には存在しません。

名前	タイプ	説明	必須	デフォルト
client_secret	オブジェクト	APIから返される一時鍵。 セッションがサーバー上でREST APIで作成された場合にのみ存在します。	はい
└─ 有効期限_終了	整数	トークンの期限が切れるタイムスタンプ。 現在、すべてのトークンは1分後に期限切れとなります。	いいえ
└─ 値	文字列	クライアント環境でリアルタイムAPIへの接続を認証するために使える一時的な鍵。 これは標準的なAPIトークンではなく、サーバーサイドでのみ使うべきなのでクライアントサイド環境で使うべきです。	いいえ
input_audio_format	文字列	入力音声のフォーマット。 選択肢は pcm16、 g711_ulaw、または g711_alawです。	いいえ
音声トランスクリプション入力	オブジェクト	転写モデルの構成。	いいえ
└─ 言語	文字列	入力音声の言語。 入力言語を ISO-639-1 (例: en)形式で提供することで、精度と遅延が向上します。	いいえ
└─ モデル	列挙型	転写に使うモデル。 gpt-4o-transcribe、gpt-4o-mini-transcribe、gpt-4o-mini-transcribe-2025-12-15、またはwhisper-1です。 可能な値: gpt-4o-transcribe、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15、 whisper-1	いいえ
└─ プロンプト	文字列	モデルのスタイルをガイドしたり、前の音声セグメントを続けるためのオプションテキスト。 プロンプトは音声言語に合っているべきです。	いいえ
modalities		モデルが応答できるモダリティの集合。 音声を無効にするには、["text"]に設定してください。	いいえ
turn_detection	オブジェクト	ターン検知の設定。 nullに設定してオフにできます。 サーバーVADは、音声の音量に基づいて音声の開始と終了を検出し、ユーザーの音声の終わりに応答することを意味します。	いいえ
└─ prefix_padding_ms（プリフィックス・パディング・ミリ秒）	整数	VADが音声を検出する前に含める音声量(ミリ秒単位)。 デフォルトは300msです。	いいえ
└─ 無音時間_ミリ秒	整数	発言停止を検出するための無音の持続時間(ミリ秒単位)。 デフォルトは500msです。 短い値を使えばモデルはより速く反応しますが、ユーザーの短い間入りに飛び込むことがあります。	いいえ
└─ しきい値	number	VADのアクティベーション閾値(0.0から1.0)はデフォルトで0.5です。 閾値が高いほど、モデルを起動するにはより大きな音が必要になり、騒がしい環境での性能が向上する可能性があります。	いいえ
└─ タイプ	文字列	ターン検知の種類ですが、現在サポートされているのは server_vad のみです。	いいえ

推論

推論モデルの設定オプション。

名前	タイプ	説明	必須	デフォルト
作業量	ReasoningEffort	推論モデルの推論にかかる労力を制限します。 現在サポートされている値は low、 medium、 highです。 推論の努力を減らすことで、応答の速さや推論に使われるトークンの削減につながる。	はい	中間
概要	列挙型	モデルが行う推論の概要。 これはデバッグやモデルの推論過程の理解に役立ちます。 conciseかdetailedのどちらかです。 可能な値: concise、 detailed	いいえ

ReasoningItem

回答を生成する際に推論モデルが用いる思考の連鎖の記述。

名前	タイプ	説明	必須	デフォルト
コンテンツ	アレイ	本文の内容を理由付けています。	はい
id	文字列	論理内容の一意識別子。	はい
状態	列挙型	アイテムのステータス。 in_progress、completed、あるいはincompleteのいずれかです。 API経由でアイテムが返送されると入力されます。 可能な値: in_progress、 completed、 incomplete	いいえ
型	列挙型	対象の種類。 いつも reasoning。 可能な値: reasoning	はい

Refusal

モデルからの拒否。

名前	タイプ	説明	必須	デフォルト
refusal	文字列	モデルからの拒否の説明。	はい
型	列挙型	拒否の種類。 いつも refusal。 可能な値: refusal	はい

response

名前	タイプ	説明	必須	デフォルト
作成日時	number	このレスポンスが作成された時間のUnixタイムスタンプ(秒単位)です。	はい
エラー	ResponseError	モデルが応答を生成しなかった場合に返されるエラーオブジェクト。	はい
id	文字列	この回答の一意識別子。	はい
incomplete_details	オブジェクト	なぜ回答が不完全であるのかの詳細。	はい
└─ 理由	列挙型	その理由は回答が不完全です。 可能な値: max_output_tokens、 content_filter	いいえ
手順	文字列	モデルのコンテキストの最初の項目としてシステム(または開発者)メッセージを挿入します。 previous_response_idと共に使用した場合、前の応答の指示は次の応答に引き継がれません。 これにより、新しい応答でシステム(または開発者)メッセージを簡単に切り替えることができます。	はい
max_output_tokens	整数	応答のために生成できるトークン数の上限で、可視出力トークンや会話状態も含まれます。	いいえ
メタデータ	Metadata	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これは、オブジェクトに関する追加情報を構造化形式で保存したり、APIやダッシュボードを通じてオブジェクトをクエリしたりするのに役立ちます。 キーは最大64文字の文字列です。 値は最大512文字の文字列です。	はい
モデル	文字列	回答を生成するために使われるモデル。	はい
オブジェクト	列挙型	このリソースのオブジェクトタイプは常に responseに設定されています。 可能な値: response	はい
出力	アレイ	モデルによって生成されたコンテンツの配列です。 - output 配列内の項目の長さと順序はモデルの応答に依存します。 - output 配列の最初の項目にアクセスして、それがモデルによって生成されたコンテンツを含む assistant メッセージだと考えるのではなく、SDKでサポートされている output_text プロパティを使うことを検討するとよいでしょう。	はい
output_text	文字列	SDK専用の利便性プロパティで、output_text配列内のすべてのoutput項目からの集約されたテキスト出力(もし存在する場合)が含まれます。 PythonおよびJavaScriptのSDKでサポートされています。	いいえ
並列ツール呼び出し	boolean	モデルがツールコールを並列実行できるようにするか。	はい	正しい
previous_response_id	文字列	モデルに対する前の応答の一意ID。 これを使って複数ターンにわたる会話を作りましょう。	いいえ
reasoning	Reasoning	推論モデルの設定オプション。	いいえ
状態	列挙型	応答生成の状況。 completed、failed、in_progress、あるいはincompleteのどれかです。 可能な値: completed、 failed、 in_progress、 incomplete	いいえ
温度	number	どのサンプリング温度を使うか、0から2の間で。 0.8のような高い値は出力をよりランダムにし、0.2のように低い値はより集中して決定的になります。 一般的にはこれを変更するか、あるいは top_p を変えることを推奨しますが、両方はおすすめしません。	はい	1
SMS 送信	オブジェクト	モデルからのテキスト応答の設定オプション。 プレーンテキストでも構造化JSONデータでも構いません。 詳細情報： - テキスト入力および出力 - 構造化出力	いいえ
└─ フォーマット	TextResponseFormatConfiguration	モデルが出力すべきフォーマットを指定するオブジェクト。 { "type": "json_schema" }設定すると構造化出力が可能になり、モデルが提供されたJSONスキーマに合致します。 デフォルトのフォーマットは { "type": "text" } で、追加オプションはありません。 GPT-4o以降のモデルにはおすすめできません: { "type": "json_object" }に設定すると古いJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 json_schemaを使ったモデルでは、この方法をサポートするモデルが推奨されます。	いいえ
tool_choice	ToolChoiceOptions 、 ToolChoiceTypes 、または ToolChoiceFunction	モデルが応答を生成する際に使用するツールを選択する方法について。 モデルが呼び出せるツールを指定するには、 tools パラメータを参照してください。	はい
ツール	アレイ	モデルが応答を生成する際に呼び出す可能性のあるツールの配列です。 tool_choiceパラメータを設定することで、どのツールを使うかを指定できます。 モデルに提供できるツールの2つのカテゴリーがあります: - 組み込みツール	はい
top_p	number	温度によるサンプリングの代替として核サンプリングと呼ばれ、モデルは確率質量top_pトークンの結果を考慮します。 つまり0.1とは、確率質量の上位10個を構成するトークンのみ% 考慮されることを意味します。 一般的にはこれを変更するか、あるいは temperature を変えることを推奨しますが、両方はおすすめしません。	はい	1
truncation	列挙型	モデル応答に用いる切断戦略。 - auto: この回答および以前の応答のコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中で入力項目を落として応答を切り詰めてコンテキストウィンドウに合わせます。 - disabled (デフォルト):モデルの応答がモデルのコンテキストウィンドウサイズを超える場合、リクエストは400エラーで失敗します。 可能な値: auto、 disabled	いいえ
使用	ResponseUsage	入力トークン、出力トークン、出力トークンの内訳、使用トークンの総数を含むトークン使用の詳細を表します。	いいえ
ユーザー	文字列	エンドユーザーを表す一意の識別子で、OpenAIが悪用を監視・検出するのに役立ちます。 .	いいえ

ResponseAudioDeltaEvent

部分的な音声応答があるときに発信されます。

名前	タイプ	説明	必須	デフォルト
delta	文字列	Base64でエンコードされた応答オーディオバイトのチャンクです。	はい
型	列挙型	イベントの種類。 いつも response.audio.delta。 可能な値: response.audio.delta	はい

ResponseAudioDoneEvent

音声応答が完了すると発信されます。

名前	タイプ	説明	必須	デフォルト
型	列挙型	イベントの種類。 いつも response.audio.done。 可能な値: response.audio.done	はい

ResponseAudioTranscriptDeltaEvent

音声の一部書き起こしがある場合に発信されます。

名前	タイプ	説明	必須	デフォルト
delta	文字列	音声応答の部分的な書き起こしです。	はい
型	列挙型	イベントの種類。 いつも response.audio.transcript.delta。 可能な値: response.audio.transcript.delta	はい

ResponseAudioTranscriptDoneEvent

完全な音声書き起こしが完成した際に発信されます。

名前	タイプ	説明	必須	デフォルト
型	列挙型	イベントの種類。 いつも response.audio.transcript.done。 可能な値: response.audio.transcript.done	はい

ResponseCodeInterpreterCallCodeDeltaEvent

コードインタプリタによって部分的なコードスニペットが追加されたときに発生します。

名前	タイプ	説明	必須	デフォルト
delta	文字列	コードインタプリタによって追加された部分的なコードスニペット。	はい
出力インデックス	整数	コードインタプリタが呼び出している出力項目のインデックスを進行中です。	はい
型	列挙型	イベントの種類。 いつも response.code_interpreter_call.code.delta。 可能な値: response.code_interpreter_call.code.delta	はい

ResponseCodeInterpreterCallCodeDoneEvent

コードインタプリタによってコードスニペットの出力が最終化されると発信されます。

名前	タイプ	説明	必須	デフォルト
コード	文字列	コードインタプリタによる最終的なコードスニペット。	はい
出力インデックス	整数	コードインタプリタが呼び出している出力項目のインデックスを進行中です。	はい
型	列挙型	イベントの種類。 いつも response.code_interpreter_call.code.done。 可能な値: response.code_interpreter_call.code.done	はい

ResponseCodeInterpreterCallCompletedEvent

コードインタプリタ呼び出しが完了すると発信されます。

名前	タイプ	説明	必須	デフォルト
code_interpreter_call	CodeInterpreterToolCall	コードを実行するためのツール呼び出しです。	はい
出力インデックス	整数	コードインタプリタが呼び出している出力項目のインデックスを進行中です。	はい
型	列挙型	イベントの種類。 いつも response.code_interpreter_call.completed。 可能な値: response.code_interpreter_call.completed	はい

ResponseCodeInterpreterCallInProgressEvent

コードインタプリタ呼び出しが進行中であるときに発行されます。

名前	タイプ	説明	必須	デフォルト
code_interpreter_call	CodeInterpreterToolCall	コードを実行するためのツール呼び出しです。	はい
出力インデックス	整数	コードインタプリタが呼び出している出力項目のインデックスを進行中です。	はい
型	列挙型	イベントの種類。 いつも response.code_interpreter_call.in_progress。 可能な値: response.code_interpreter_call.in_progress	はい

ResponseCodeInterpreterCallInterpretingEvent

コードインタプリタがコードスニペットを積極的に解釈しているときに発生します。

名前	タイプ	説明	必須	デフォルト
code_interpreter_call	CodeInterpreterToolCall	コードを実行するためのツール呼び出しです。	はい
出力インデックス	整数	コードインタプリタが呼び出している出力項目のインデックスを進行中です。	はい
型	列挙型	イベントの種類。 いつも response.code_interpreter_call.interpreting。 可能な値: response.code_interpreter_call.interpreting	はい

ResponseCompletedEvent

モデル応答が完成したときに放出されます。

名前	タイプ	説明	必須	デフォルト
response	response		はい
型	列挙型	イベントの種類。 いつも response.completed。 可能な値: response.completed	はい

ResponseContentPartAddedEvent

新しいコンテンツ部分が追加されたときに発行されます。

名前	タイプ	説明	必須	デフォルト
content_index	整数	追加されたコンテンツ部分の索引。	はい
item_id	文字列	コンテンツ部分が追加された出力項目のIDです。	はい
出力インデックス	整数	コンテンツ部分が追加された出力項目のインデックスです。	はい
パーツ	OutputContent		はい
型	列挙型	イベントの種類。 いつも response.content_part.added。 可能な値: response.content_part.added	はい

ResponseContentPartDoneEvent

コンテンツ部分が完成したときに発出されます。

名前	タイプ	説明	必須	デフォルト
content_index	整数	コンテンツのインデックスが行われています。	はい
item_id	文字列	コンテンツ部分が追加された出力項目のIDです。	はい
出力インデックス	整数	コンテンツ部分が追加された出力項目のインデックスです。	はい
パーツ	OutputContent		はい
型	列挙型	イベントの種類。 いつも response.content_part.done。 可能な値: response.content_part.done	はい

ResponseCreatedEvent

応答が作成されたときに発生するイベントです。

名前	タイプ	説明	必須	デフォルト
response	response		はい
型	列挙型	イベントの種類。 いつも response.created。 可能な値: response.created	はい

ResponseError

モデルが応答を生成しなかった場合に返されるエラーオブジェクト。

名前	タイプ	説明	必須	デフォルト
コード	ResponseErrorCode	レスポンスのエラーコード。	はい
メッセージ	文字列	人間が読みやすい誤りの説明。	はい

ResponseErrorCode

レスポンスのエラーコード。

Property	価値
説明	レスポンスのエラーコード。
Type	文字列
値	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

ResponseErrorEvent

エラーが発生した場合に発行されます。

名前	タイプ	説明	必須	デフォルト
コード	文字列	エラーコード。	はい
メッセージ	文字列	エラーメッセージ。	はい
param	文字列	誤差パラメータです。	はい
型	列挙型	イベントの種類。 いつも error。 可能な値: error	はい

ResponseFailedEvent

応答が失敗したときに発生するイベントです。

名前	タイプ	説明	必須	デフォルト
response	response		はい
型	列挙型	イベントの種類。 いつも response.failed。 可能な値: response.failed	はい

ResponseFileSearchCallCompletedEvent

ファイル検索コールが完了した(結果が見つかりました)時に発行されます。

名前	タイプ	説明	必須	デフォルト
item_id	文字列	ファイル検索コールが開始される出力項目のIDです。	はい
出力インデックス	整数	ファイルサーチが呼び出す出力項目のインデックスが開始されます。	はい
型	列挙型	イベントの種類。 いつも response.file_search_call.completed。 可能な値: response.file_search_call.completed	はい

ResponseFileSearchCallInProgressEvent

ファイル検索コールが開始された際に発行されます。

名前	タイプ	説明	必須	デフォルト
item_id	文字列	ファイル検索コールが開始される出力項目のIDです。	はい
出力インデックス	整数	ファイルサーチが呼び出す出力項目のインデックスが開始されます。	はい
型	列挙型	イベントの種類。 いつも response.file_search_call.in_progress。 可能な値: response.file_search_call.in_progress	はい

ResponseFileSearchCallSearchingEvent

ファイル検索が現在検索中であるときに発行されます。

名前	タイプ	説明	必須	デフォルト
item_id	文字列	ファイル検索コールが開始される出力項目のIDです。	はい
出力インデックス	整数	ファイル検索が呼び出す出力項目のインデックスです。	はい
型	列挙型	イベントの種類。 いつも response.file_search_call.searching。 可能な値: response.file_search_call.searching	はい

ResponseFunctionCallArgumentsDeltaEvent

部分的な関数呼び出し引数デルタが存在するときに発信されます。

名前	タイプ	説明	必須	デフォルト
delta	文字列	関数呼び出しの引数デルタが追加されます。	はい
item_id	文字列	関数呼び出しの引数が加算される出力項目のIDです。	はい
出力インデックス	整数	関数呼び出しの引数が加算される出力項目のインデックスです。	はい
型	列挙型	イベントの種類。 いつも response.function_call_arguments.delta。 可能な値: response.function_call_arguments.delta	はい

ResponseFunctionCallArgumentsDoneEvent

関数呼び出しの引数が確定されたときに発生します。

名前	タイプ	説明	必須	デフォルト
arguments	文字列	関数呼び出しの引数です。	はい
item_id	文字列	品物のIDです。	はい
出力インデックス	整数	出力項目のインデックス。	はい
型	列挙型	可能な値: response.function_call_arguments.done	はい

ResponseInProgressEvent

応答が進行中のときに発信されます。

名前	タイプ	説明	必須	デフォルト
response	response		はい
型	列挙型	イベントの種類。 いつも response.in_progress。 可能な値: response.in_progress	はい

ResponseIncompleteEvent

応答が不完全として終了したときに発信されるイベントです。

名前	タイプ	説明	必須	デフォルト
response	response		はい
型	列挙型	イベントの種類。 いつも response.incomplete。 可能な値: response.incomplete	はい

responseItemList

レスポンス項目のリスト。

名前	タイプ	説明	必須	デフォルト
データ	アレイ	この回答を生成するために使われた項目のリストです。	はい
ファーストID	文字列	リストの最初の項目のIDです。	はい
has_more	boolean	利用可能な商品が他にあるかどうか。	はい
last_id	文字列	リストの最後の項目のIDです。	はい
オブジェクト	列挙型	返されるオブジェクトの種類は listでなければなりません。 可能な値: list	はい

ResponseModalities

モデルに生成してほしい出力タイプ。 ほとんどのモデルはテキスト生成が可能であり、これがデフォルトです:

["text"]

gpt-4o-audio-previewモデルは音声生成にも利用できます。 このモデルにテキストと音声の両方の応答を生成するよう依頼するには、以下を利用できます:

["text", "audio"]

このコンポーネントにはプロパティが定義されていません。

ResponseModalitiesTextOnly

モデルに生成してほしい出力タイプ。 ほとんどのモデルはテキスト生成が可能であり、これがデフォルトです:

["text"]

このAPIはまもなく音声や画像など他の出力モダリティもサポートします。

このコンポーネントにはプロパティが定義されていません。

ResponseOutputItemAddedEvent

新しい出力項目が追加されたときに発行されます。

名前	タイプ	説明	必須	デフォルト
項目	OutputItem		はい
出力インデックス	整数	追加された出力項目のインデックスです。	はい
型	列挙型	イベントの種類。 いつも response.output_item.added。 可能な値: response.output_item.added	はい

ResponseOutputItemDoneEvent

出力項目が完了とマークされたときに発行されます。

名前	タイプ	説明	必須	デフォルト
項目	OutputItem		はい
出力インデックス	整数	完了とマークされた出力項目のインデックス。	はい
型	列挙型	イベントの種類。 いつも response.output_item.done。 可能な値: response.output_item.done	はい

ResponseProperties

名前	タイプ	説明	必須	デフォルト
手順	文字列	モデルのコンテキストの最初の項目としてシステム(または開発者)メッセージを挿入します。 previous_response_idと共に使用した場合、前の応答の指示は次の応答に引き継がれません。 これにより、新しい応答でシステム(または開発者)メッセージを簡単に切り替えることができます。	いいえ
max_output_tokens	整数	応答のために生成できるトークン数の上限で、可視出力トークンや会話状態も含まれます。	いいえ
previous_response_id	文字列	モデルに対する前の応答の一意ID。 これを使って複数ターンにわたる会話を作りましょう。	いいえ
reasoning	Reasoning	推論モデルの設定オプション。	いいえ
SMS 送信	オブジェクト	モデルからのテキスト応答の設定オプション。 プレーンテキストでも構造化JSONデータでも構いません。 詳細情報： - テキスト入力および出力 - 構造化出力	いいえ
└─ フォーマット	TextResponseFormatConfiguration	モデルが出力すべきフォーマットを指定するオブジェクト。 { "type": "json_schema" }設定すると構造化出力が可能になり、モデルが提供されたJSONスキーマに合致します。 デフォルトのフォーマットは { "type": "text" } で、追加オプションはありません。 GPT-4o以降のモデルにはおすすめできません: { "type": "json_object" }に設定すると古いJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 json_schemaを使ったモデルでは、この方法をサポートするモデルが推奨されます。	いいえ
tool_choice	ToolChoiceOptions 、 ToolChoiceTypes 、または ToolChoiceFunction	モデルが応答を生成する際に使用するツールを選択する方法について。 モデルが呼び出せるツールを指定するには、 tools パラメータを参照してください。	いいえ
ツール	アレイ	モデルが応答を生成する際に呼び出す可能性のあるツールの配列です。 tool_choiceパラメータを設定することで、どのツールを使うかを指定できます。 モデルに提供できるツールの2つのカテゴリーがあります: - 組み込みツール	いいえ
truncation	列挙型	モデル応答に用いる切断戦略。 - auto: この回答および以前の応答のコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中で入力項目を落として応答を切り詰めてコンテキストウィンドウに合わせます。 - disabled (デフォルト):モデルの応答がモデルのコンテキストウィンドウサイズを超える場合、リクエストは400エラーで失敗します。 可能な値: auto、 disabled	いいえ

ResponseRefusalDeltaEvent

部分的な拒否のテキストがあるときに発信されます。

名前	タイプ	説明	必須	デフォルト
content_index	整数	拒否テキストが追加される内容部分の索引です。	はい
delta	文字列	追加された拒否のテキスト。	はい
item_id	文字列	拒否テキストが追加される出力項目のIDです。	はい
出力インデックス	整数	拒否テキストが追加される出力項目のインデックスです。	はい
型	列挙型	イベントの種類。 いつも response.refusal.delta。 可能な値: response.refusal.delta	はい

ResponseRefusalDoneEvent

拒否のテキストが確定した際に発信される。

名前	タイプ	説明	必須	デフォルト
content_index	整数	内容の索引は、拒否文が最終決定されている部分です。	はい
item_id	文字列	拒否テキストが最終決定される出力項目のIDです。	はい
出力インデックス	整数	拒否テキストが最終化される出力項目のインデックス。	はい
refusal	文字列	最終決定された拒否のテキスト。	はい
型	列挙型	イベントの種類。 いつも response.refusal.done。 可能な値: response.refusal.done	はい

responseStreamEvent

名前	タイプ	説明	必須	デフォルト
コメント	Annotation		はい
annotation_index	整数	追加された注釈の索引です。	はい
arguments	文字列	関数呼び出しの引数です。	はい
コード	文字列	エラーコード。	はい
code_interpreter_call	CodeInterpreterToolCall	コードを実行するためのツール呼び出しです。	はい
content_index	整数	コンテンツの索引は、テキスト内容が最終的に完成している部分です。	はい
delta	文字列	追加されたテキストのデルタ。	はい
項目	OutputItem	完了とマークされた出力項目。	はい
item_id	文字列	テキスト内容が最終化される出力項目のID。	はい
メッセージ	文字列	エラーメッセージ。	はい
出力インデックス	整数	テキスト内容が最終化される出力項目のインデックス。	はい
param	文字列	誤差パラメータです。	はい
パーツ	OutputContent	内容の部分が終わっている。	はい
refusal	文字列	最終決定された拒否のテキスト。	はい
response	response	不完全な返答。	はい
SMS 送信	文字列	最終的なテキスト内容です。	はい
型	列挙型	イベントの種類。 いつも response.output_text.done。 可能な値: response.output_text.done	はい

ResponseTextAnnotationDeltaEvent

テキスト注釈が追加されたときに発信されます。

名前	タイプ	説明	必須	デフォルト
コメント	Annotation		はい
annotation_index	整数	追加された注釈の索引です。	はい
content_index	整数	テキスト注釈が追加された内容部分の索引です。	はい
item_id	文字列	テキスト注釈が加えられる出力項目のIDです。	はい
出力インデックス	整数	テキスト注釈が追加された出力項目のインデックス。	はい
型	列挙型	イベントの種類。 いつも response.output_text.annotation.added。 可能な値: response.output_text.annotation.added	はい

ResponseTextDeltaEvent

追加のテキストデルタがあると発信されます。

名前	タイプ	説明	必須	デフォルト
content_index	整数	テキストデルタが追加された内容部分のインデックスです。	はい
delta	文字列	追加されたテキストのデルタ。	はい
item_id	文字列	テキストデルタが追加された出力項目のIDです。	はい
出力インデックス	整数	テキストデルタが追加された出力項目のインデックス。	はい
型	列挙型	イベントの種類。 いつも response.output_text.delta。 可能な値: response.output_text.delta	はい

ResponseTextDoneEvent

テキストコンテンツが最終決定されると発信されます。

名前	タイプ	説明	必須	デフォルト
content_index	整数	コンテンツの索引は、テキスト内容が最終的に完成している部分です。	はい
item_id	文字列	テキスト内容が最終化される出力項目のID。	はい
出力インデックス	整数	テキスト内容が最終化される出力項目のインデックス。	はい
SMS 送信	文字列	最終的なテキスト内容です。	はい
型	列挙型	イベントの種類。 いつも response.output_text.done。 可能な値: response.output_text.done	はい

ResponseUsage

入力トークン、出力トークン、出力トークンの内訳、使用トークンの総数を含むトークン使用の詳細を表します。

名前	タイプ	説明	必須	デフォルト
input_tokens	整数	入力トークンの数。	はい
output_tokens	整数	出力トークンの数。	はい
output_tokens_details	オブジェクト	出力トークンの詳細な内訳です。	はい
└─ 推論トークン	整数	推論トークンの数。	いいえ
total_tokens	整数	使用されたトークンの総数。	はい

Screenshot

スクリーンショットアクションです。

名前	タイプ	説明	必須	デフォルト
型	列挙型	イベントの種類を指定します。 スクリーンショットアクションの場合、このプロパティは常に screenshotに設定されています。 可能な値: screenshot	はい

Scroll

スクロールアクションです。

名前	タイプ	説明	必須	デフォルト
scroll_x	整数	横スクロールの距離。	はい
scroll_y	整数	垂直スクロール距離。	はい
型	列挙型	イベントの種類を指定します。 スクロールアクションの場合、この性質は常に scrollに設定されます。 可能な値: scroll	はい
x	整数	スクロールが起きたX座標。	はい
Y	整数	巻物が起こったy座標。	はい

StopConfiguration

APIがこれ以上のトークン生成を停止するシーケンスは最大4つあります。 返されるテキストにはストップシーケンスは含まれません。

このコンポーネントは以下のいずれかである:

TextResponseFormatConfiguration

モデルが出力すべきフォーマットを指定するオブジェクト。

{ "type": "json_schema" }設定すると構造化出力が可能になり、モデルが提供されたJSONスキーマに一致します。

デフォルトのフォーマットは { "type": "text" } で、追加オプションはありません。

GPT-4o以降のモデルにはおすすめできません:

{ "type": "json_object" }に設定すると古いJSONモードが有効になり、モデルが生成するメッセージが有効なJSONであることを保証します。 json_schemaを使ったモデルでは、この方法をサポートするモデルが推奨されます。

このコンポーネントは以下のいずれかである:

• ResponseFormatText
• TextResponseFormatJsonSchema
• ResponseFormatJsonObject

TextResponseFormatJsonSchema

JSONスキーマのレスポンス形式。 構造化されたJSONレスポンスを生成するために使われています。 構造化アウトプットについて詳しく学びましょう。

名前	タイプ	説明	必須	デフォルト
説明	文字列	回答形式の説明であり、モデルがその形式での応答方法を決定するために用いられます。	いいえ
name	文字列	レスポンス形式の名前です。 a-z、A-Z、0-9、またはアンダースコアとダッシュを含む必要があり、最大64までの長さです。	いいえ
スキーマ	ResponseFormatJsonSchemaSchema	応答形式のスキーマは、JSONスキーマオブジェクトとして説明されます。	はい
厳しい	boolean	出力を生成する際に厳格なスキーマ準拠を有効にするかどうか。 trueに設定すると、モデルは常に schema フィールドで定義された正確なスキーマに従います。 strict true時にはJSONスキーマの一部のみがサポートされます。	いいえ	いいえ
型	列挙型	定義される応答形式の種類。 いつも json_schema。 可能な値: json_schema	はい

ツール

このコンポーネントは以下のいずれかである:

• FileSearchTool
• FunctionTool
• ComputerTool

ToolChoiceFunction

このオプションを使ってモデルに特定の関数を強制的に呼び出せます。

名前	タイプ	説明	必須	デフォルト
name	文字列	呼び出しする関数の名前。	はい
型	列挙型	関数呼び出しの場合、型は常に functionです。 可能な値: function	はい

ToolChoiceOptions

モデルが呼び出すツール(もしあれば)を制御します。

none モデルはツールを呼び出さず、代わりにメッセージを生成します。

auto つまり、モデルはメッセージを生成するか、1つ以上のツールを呼び出すかを選べるということです。

required モデルは1つ以上のツールを呼び出しなければならないことを意味します。

Property	価値
説明	モデルが呼び出すツール(もしあれば)を制御します。 none モデルはツールを呼び出さず、代わりにメッセージを生成します。 auto つまり、モデルはメッセージを生成するか、1つ以上のツールを呼び出すかを選べるということです。 required モデルは1つ以上のツールを呼び出しなければならないことを意味します。
Type	文字列
値	none auto required

ToolChoiceTypes

モデルが回答を生成するための組み込みツールを使うべきであることを示します。

名前	タイプ	説明	必須	デフォルト
型	列挙型	モデルが使うべきホスティングツールの種類。 許容される値は以下の通りです: - file_search - computer_use_preview 可能な値: file_search、 computer_use_preview	はい

タイプ

テキストを入力するアクション。

名前	タイプ	説明	必須	デフォルト
SMS 送信	文字列	テキストをタイプする。	はい
型	列挙型	イベントの種類を指定します。 型アクションの場合、このプロパティは常に typeに設定されます。 可能な値: type	はい

UpdateVectorStoreFileAttributesRequest

名前	タイプ	説明	必須	デフォルト
attributes	VectorStoreFileAttributes	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これは、オブジェクトに関する追加情報を構造化形式で保存したり、APIやダッシュボードを通じてオブジェクトをクエリしたりするのに役立ちます。 キーは最大64文字の文字列です。 値は最大512文字の文字列、ブール数、または数字のことです。	はい

UrlCitation

モデル応答を生成するために使われるウェブリソースの引用。

名前	タイプ	説明	必須	デフォルト
end_index	整数	メッセージ内のURL引用の最後の文字の索引です。	はい
start_index	整数	メッセージ内のURL引用の最初の文字の索引です。	はい
title	文字列	ウェブリソースのタイトルです。	はい
型	列挙型	URL引用の種類。 いつも url_citation。 可能な値: url_citation	はい
url	文字列	ウェブリソースのURLです。	はい

VectorStoreFileAttributes

オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これは、オブジェクトに関する追加情報を構造化形式で保存したり、APIやダッシュボードを通じてオブジェクトをクエリしたりするのに役立ちます。 キーは最大64文字の文字列です。 値は最大512文字の文字列、ブール数、または数字のことです。

このコンポーネントにはプロパティが定義されていません。

VectorStoreFileContentResponse

ベクターストアファイルの解析された内容を表します。

名前	タイプ	説明	必須	デフォルト
データ	アレイ	ファイルの内容を解析しました。	はい
has_more	boolean	取得すべきコンテンツページが他にもあるかどうかを示します。	はい
next_page	文字列	次のページ用のトークン(もしあれば)を。	はい
オブジェクト	列挙型	オブジェクトタイプは、常に vector_store.file_content.page 可能な値: vector_store.file_content.page	はい

VectorStoreSearchRequest

名前	タイプ	説明	必須	デフォルト
フィルター	比較フィルター または 複合フィルター	ファイル属性に基づいて適用するフィルターです。	いいえ
最大結果数	整数	返却すべき最大結果数。 この数字は1から50の間であるべきです。	いいえ	10
クエリ	文字列または配列	検索のためのクエリ文字列	はい
ランキングオプション	オブジェクト	検索のランキングオプション。	いいえ
└─ ランカー	列挙型	可能な値: auto、 default-2024-11-15	いいえ
└─ スコアのしきい値	number		いいえ	0
rewrite_query	boolean	ベクトル検索用に自然言語クエリを書き直すかどうか。	いいえ	いいえ

VectorStoreSearchResultContentObject

名前	タイプ	説明	必須	デフォルト
SMS 送信	文字列	検索からテキスト内容が戻ってきました。	はい
型	列挙型	内容の種類。 可能な値: text	はい

VectorStoreSearchResultItem

名前	タイプ	説明	必須	デフォルト
attributes	VectorStoreFileAttributes	オブジェクトに付けることができる16のキー・バリュー・ペアのセット。 これは、オブジェクトに関する追加情報を構造化形式で保存したり、APIやダッシュボードを通じてオブジェクトをクエリしたりするのに役立ちます。 キーは最大64文字の文字列です。 値は最大512文字の文字列、ブール数、または数字のことです。	はい
コンテンツ	アレイ	ファイルからのコンテンツチャンク。	はい
file_id	文字列	ベクターストアファイルのIDです。	はい
ファイル名	文字列	ベクターストアファイルの名前です。	はい
スコア	number	結果の類似度スコア。	はい

VectorStoreSearchResultsPage

名前	タイプ	説明	必須	デフォルト
データ	アレイ	検索結果項目のリスト。	はい
has_more	boolean	他に取るべき結果があるかどうかを示します。	はい
next_page	文字列	次のページ用のトークン(もしあれば)を。	はい
オブジェクト	列挙型	オブジェクトタイプは、常に vector_store.search_results.page 可能な値: vector_store.search_results.page	はい
search_query	アレイ		はい

VoiceIdsShared

このコンポーネントにはプロパティが定義されていません。

Wait

待機アクション。

名前	タイプ	説明	必須	デフォルト
型	列挙型	イベントの種類を指定します。 待機アクションの場合、このプロパティは常に waitに設定されています。 可能な値: wait	はい

ReasoningEffort

推論モデルの推論にかかる労力を制限します。 現在サポートされている値は low、 medium、 highです。 推論の努力を減らすことで、応答の速さや推論に使われるトークンの削減につながる。

Property	価値
説明	推論モデルの推論にかかる労力を制限します。 現在サポートされている値は low、 medium、 highです。 推論の努力を減らすことで、応答の速さや推論に使われるトークンの削減につながる。
Type	文字列
デフォルト	中間
値	low medium high

errorEvent

エラーが発生するときに発生します。 これは内部サーバーのエラーやタイムアウトによって起こることがあります。

名前	タイプ	説明	必須	デフォルト
データ	error		はい
イベント	文字列		はい

event Enum: ErrorEventEnum

価値	説明
エラー

doneEvent

ストリームが終わったときに発生します。

名前	タイプ	説明	必須	デフォルト
データ	文字列		はい
イベント	文字列		はい

event Enum: DoneEventEnum

価値	説明
完了

data Enum: DoneEventDataEnum

価値	説明
[DONE]

次のステップ

モデルやREST APIでのファインチューニングについて学びましょう。 OpenAI をAzureする基になるモデルの詳細について説明します。