Azure OpenAI Service の REST API プレビューのリファレンス

  • [アーティクル]

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

API の仕様

Azure OpenAI モデルとリソースの管理と対話は、次の 3 つの主要な API サーフェスに分かれています。

  • コントロール プレーン
  • データ プレーン - 作成
  • データ プレーン - 推論

各 API サーフェス/仕様には、異なる Azure OpenAI 機能のセットがカプセル化されています。 各 API には、プレビューと安定した/一般公開 (GA) の API リリースの独自のセットがあります。 現在、プレビュー リリースは毎月のペースで行われる傾向があります。

API 最新のプレビュー リリース 最新の GA リリース 仕様 説明
コントロール プレーン 2024-06-01-preview 2024-10-01 仕様ファイル Azure OpenAI は、他のすべての Azure AI サービスと共通のコントロール プレーンを共有します。 コントロール プレーン API は、Azure OpenAI リソースの作成、モデル デプロイ、その他の上位レベルのリソース管理タスクなどに使用されます。 コントロール プレーンは、Azure Resource Manager、Bicep、Terraform、Azure CLI などの機能で実行可能な内容も制御します。
データ プレーン - 作成 2024-10-01-preview 2024-10-21 仕様ファイル データ プレーン作成 API は、微調整、ファイル アップロード、インジェスト ジョブ、バッチ、および特定のモデル レベルのクエリを制御します
データ プレーン - 推論 2024-10-01-preview 2024-10-21 仕様ファイル データ プレーン推論 API は、データに対する入力候補、チャット入力候補、埋め込み、音声/Whisper、DALL-E、アシスタントなどの機能の推論機能/エンドポイントを提供します。

認証

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

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

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

REST API のバージョン管理

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

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

データ プレーン推論

この記事の残りの部分では、Azure OpenAI データ プレーン推論仕様の最新プレビュー リリース 2024-10-01-preview について説明します。 この記事には、アシスタント、スレッド、ベクター ストアなどの最新のプレビュー機能に関するドキュメントが含まれています。

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

入力候補 - 作成

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

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string 展開された モデルのデプロイ ID。
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
prompt 文字列または配列 文字列、文字列の配列、トークンの配列、またはトークン配列の配列としてエンコードされた、補完を生成するためのプロンプト。

<|endoftext|> はトレーニング中にモデルが認識するドキュメント区切り記号であるため、プロンプトを指定しない場合、モデルは新しいドキュメントの先頭からであるかのように生成します。
 はい
best_of integer サーバー側で best_of 入力候補を生成し、"最適なもの" (トークンあたりの対数確率が最高のもの) を返します。 結果をストリーミングすることはできません。

n とともに使用すると、best_of は入力候補の数を制御し、n は返す数を指定します。best_of は n より大きくする必要があります。

注: このパラメーターにより多くの入力候補が生成されるため、トークン クォータがすぐに消費される可能性があります。 慎重に使用し、max_tokens と stop の設定が合理的であることを確認してください。
 いいえ 1
echo boolean 入力候補に加えてプロンプトをエコーバックします。
 いいえ False
frequency_penalty 数値 -2.0 ～ 2.0 の数。 正の値は、これまでのテキストにおける既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行をそのまま繰り返す可能性を減少させます。
 いいえ 0
logit_bias オブジェクト 指定したトークンが入力候補に表示される可能性を変更します。

トークン (GPT トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする JSON オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。

たとえば、<|endoftext|> トークンが生成されないように、{"50256": -100} を渡すことができます。
 いいえ なし
logprobs integer logprobs の最も可能性の高い出力トークンと、選択したトークンのログ確率を含めます。 たとえば、logprobs が 5 の場合、API は可能性が最も高い 5 個のトークンの一覧を返します。 API は常に、サンプリングされたトークンの logprob を返します。そのため、応答には、最大 logprobs+1 の要素が含まれる可能性があります。

logprobs の最大値は 5 です。
 いいえ なし
max_tokens integer 補完の中で生成できるトークンの最大数。

プロンプトのトークン数と max_tokens の合計は、モデルのコンテキスト長を超えることはできません。
いいえ 16
n integer プロンプトごとに生成する入力候補の数。

注: このパラメーターにより多くの入力候補が生成されるため、トークン クォータがすぐに消費される可能性があります。 慎重に使用し、max_tokens と stop の設定が合理的であることを確認してください。
 いいえ 1
presence_penalty 数値 -2.0 ～ 2.0 の数。 正の値は、新しいトークンがこれまでのテキストに表示されているかどうかに基づいてペナルティを課し、モデルが新しいトピックについて話す可能性を高めます。
 いいえ 0
シード integer 指定されている場合、このシステムは、同じ seed とパラメーターを使用して繰り返された要求に対して同じ結果を返せるように、決定論的にサンプリングを行うように最善を尽くします。

決定性は保証されないため、バックエンドでの変更を監視するには、system_fingerprint 応答パラメーターを参照する必要があります。
 いいえ
stop 文字列または配列 API がそれ以上のトークンの生成を停止する、最大 4 つのシーケンス。 返されるテキストに停止シーケンスは含まれません。
 いいえ
stream boolean 部分的な進行状況をストリーム バックするかどうか。 設定されている場合、トークンは使用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージによって終了します。
 いいえ False
suffix string 挿入されたテキストの入力候補の後に付加されるサフィックス。

このパラメーターは、gpt-3.5-turbo-instruct に対してのみサポートされます。
 いいえ なし
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。

一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。

一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
ユーザー string エンド ユーザーを表す一意の識別子。これは不正使用を監視および検出するのに役立ちます。
 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json createCompletionResponse API からの補完応答を表します。 注: (チャット エンドポイントとは異なり) ストリーム応答オブジェクトと非ストリーム応答オブジェクトはどちらも同じシェイプを共有します。

状態コード: 既定

説明: サービスを利用できません

Content-Type Type 説明
application/json errorResponse

例

例

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-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=2024-10-01-preview

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
input 文字列または配列 埋め込むテキストを入力します。トークンの文字列または配列としてエンコードされます。 1 回の要求で複数の入力を埋め込むには、文字列の配列またはトークン配列の配列を渡します。 入力は、モデルの最大入力トークン数 (text-embedding-ada-002 の場合は 8,192 トークン) を超えてはならず、空の文字列であってはなりません。また、配列は 2,048 次元以下でなければなりません。 はい
ユーザー string エンド ユーザーを表す一意の識別子。乱用の監視と検出に役立ちます。 いいえ
input_type string 使用する埋め込み検索の入力の型 いいえ
encoding_format string 埋め込みを返す形式。 float または base64 を指定できます。 既定値は float です。 いいえ
dimensions integer 結果として出力される埋め込みに必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。 いいえ

応答

名前 種類 内容 必要 Default
オブジェクト string はい
モデル string はい
data 配列 はい
使用量 オブジェクト はい

使用するプロパティ

prompt_tokens

名前 種類 説明 Default
prompt_tokens integer

total_tokens

名前 種類 説明 Default
total_tokens integer

状態コード: 200

説明: OK

Content-Type Type 説明
application/json オブジェクト

例

例

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

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-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.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

チャット入力候補 - 作成

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

チャット メッセージの補完を作成します

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string 展開された モデルのデプロイ ID。
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。

一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。

一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
stream boolean 設定すると、ChatGPT と同様に部分的なメッセージ デルタが送信されます。 トークンは、使用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージによって終了します。
 いいえ False
stop 文字列または配列 API がそれ以上のトークンの生成を停止する、最大 4 つのシーケンス。
 いいえ
max_tokens integer チャット入力候補で生成できるトークンの最大数。

入力トークンと生成されたトークンの合計の長さは、モデルのコンテキスト長によって制限されます。
いいえ
max_completion_tokens integer 可視出力トークンや推論トークンなど、完了するために生成できるトークンの数の上限。 これは、o1 シリーズ モデルでのみサポートされます。 今後の API リリースで、サポートが他のモデルに拡張される予定です。 いいえ
presence_penalty 数値 -2.0 ～ 2.0 の数。 正の値は、新しいトークンがこれまでのテキストに表示されているかどうかに基づいてペナルティを課し、モデルが新しいトピックについて話す可能性を高めます。
 いいえ 0
frequency_penalty 数値 -2.0 ～ 2.0 の数。 正の値は、これまでのテキストにおける既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行をそのまま繰り返す可能性を減少させます。
 いいえ 0
logit_bias オブジェクト 指定したトークンが入力候補に表示される可能性を変更します。

トークン (トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする JSON オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。
 いいえ なし
ユーザー string エンド ユーザーを表す一意の識別子。これは不正使用を監視および検出するのに役立ちます。
 いいえ
messages 配列 これまでの会話を構成するメッセージの一覧。 はい
data_sources 配列 それらを使用する Azure OpenAI チャット拡張機能の構成エントリ。
この追加仕様は、Azure OpenAI とのみ互換性があります。		 いいえ
logprobs boolean 出力トークンのログ確率を返すかどうかを指定します。 true に設定すると、message の content に含まれる各出力トークンのログ確率が返されます。 いいえ False
top_logprobs integer 0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。 このパラメーターを使う場合、logprobs は true に設定する必要があります。 いいえ
n integer 入力メッセージごとに生成するチャット入力候補の選択肢の数。 選択肢全体で生成されたトークンの数に基づいて課金されることに注意してください。 コストを最小限に抑えるために、n を 1 のままにします。 いいえ 1
parallel_tool_calls ParallelToolCalls ツールの使用中に並列関数の呼び出しを有効にするかどうか。 いいえ True
応答形式 ResponseFormatText または ResponseFormatJsonObject または ResponseFormatJsonSchema モデルが出力する必要がある形式を指定するオブジェクト。 GPT-4o、GPT-4o mini、GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_schema", "json_schema": {...} } に設定すると、モデルと提供された JSON スキーマが一致することを保証する構造化出力が有効になります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 いいえ
シード integer この機能はベータ版です。
指定されている場合、このシステムは、同じ seed とパラメーターを使用して繰り返された要求に対して同じ結果を返せるように、決定論的にサンプリングを行うように最善を尽くします。
決定性は保証されないため、バックエンドでの変更を監視するには、system_fingerprint 応答パラメーターを参照する必要があります。
 いいえ
stream_options chatCompletionStreamOptions ストリーミング応答のオプション。 stream: true に設定した場合はこれのみを設定します。
 いいえ なし
tools 配列 モデルによって呼び出されるツールの一覧。 現在のところ、関数のみがツールとしてサポートされています。 これを使用し、モデルによって JSON 入力が生成される関数の一覧を提供します。 最大 128 個の関数がサポートされています。
 いいえ
tool_choice chatCompletionToolChoiceOption モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルでツールが呼び出されず、代わりにメッセージが生成されることを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。 {"type": "function", "function": {"name": "my_function"}} を介して特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。 ツールが存在しない場合は、none が既定値です。 ツールが存在する場合は、auto が既定値です。 いいえ
function_call string または chatCompletionFunctionCallOption tool_choice を優先して非推奨になりました。

モデルによって呼び出される関数を制御します (そのような関数がある場合)。
none は、モデルが関数を呼び出さず、代わりにメッセージを生成することを示します。
auto の場合、メッセージを生成するか、関数を呼び出すか、モデルで選択できます。
{"name": "my_function"} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。

関数が存在しない場合は、none が既定値です。 関数が存在する場合は、auto が既定値です。
 いいえ
functions 配列 非推奨になりました。tools を使用してください。

モデルが JSON 入力を生成する可能性がある関数の一覧。
 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json createChatCompletionResponse または createChatCompletionStreamResponse

状態コード: 既定

説明: サービスを利用できません

Content-Type Type 説明
application/json errorResponse

例

例

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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 データとシステム割り当てマネージド ID に基づいて入力候補を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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=2024-10-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 ベクター データ、前のアシスタント メッセージ、およびユーザー割り当てマネージド ID に基づいて入力候補を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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=2024-10-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 DB に対する入力候補を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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=2024-10-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=2024-10-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=2024-10-01-preview

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string Whisper モデルのデプロイ ID。
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

Content-Type: multipart/form-data

名前 種類 内容 必要 Default
file string 文字起こしするオーディオ ファイル オブジェクト。 はい
プロンプト string モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトはオーディオ言語と一致する必要があります。 いいえ
応答形式 audioResponseFormat 出力の形式を定義します。 いいえ
温度 数値 0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルはログ確率を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。 いいえ 0
言語 string 入力オーディオの言語。 入力言語を ISO-639-1 形式で提供すると、精度と待機時間が向上します。 いいえ
timestamp_granularities[] 配列 この文字起こしに入力するタイムスタンプの詳細度。 タイムスタンプの詳細度を使用するには response_format を verbose_json に設定する必要があります。 オプションの word と segment は一方または両方がサポートされます。 注: セグメント タイムスタンプに追加の待ち時間はありませんが、単語のタイムスタンプを生成すると追加の待ち時間が発生します。 いいえ ['segment']

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json audioResponse または audioVerboseResponse
text/plain string 出力形式で文字起こしされたテキスト (response_format がテキスト、vtt、または srt のいずれかであったとき)。

例

例

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-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=2024-10-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=2024-10-01-preview

入力オーディオを文字起こしし、英語のテキストに翻訳します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string 展開された Whisper モデルのデプロイ ID。
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

Content-Type: multipart/form-data

名前 種類 内容 必要 Default
file string 翻訳するオーディオ ファイル。 はい
プロンプト string モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトは英語にする必要があります。 いいえ
応答形式 audioResponseFormat 出力の形式を定義します。 いいえ
温度 数値 0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルはログ確率を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。 いいえ 0

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json audioResponse または audioVerboseResponse
text/plain string 出力形式で文字起こしされたテキスト (response_format がテキスト、vtt、または srt のいずれかであったとき)。

例

例

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-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=2024-10-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=2024-10-01-preview

入力テキストからオーディオを生成します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string 展開された TTS モデルのデプロイ ID。
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

Content-Type: multipart/form-data

名前 種類 内容 必要 Default
input string オーディオを合成する対象のテキスト。 最大長は 4,096 文字です。 はい
voice enum 音声合成に使用する音声。
使用可能な値: alloy、echo、fable、onyx、nova、shimmer		 はい
応答形式 enum オーディオを合成する形式。
使用可能な値: mp3、opus、aac、flac、wav、pcm		 いいえ
速度 数値 合成されたオーディオの速度。 0.25 から 4.0 の間の値を選択してください。 1.0 は既定値です。 いいえ 1.0

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/octet-stream string

使用例

例

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-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=2024-10-01-preview

特定の DALLE モデル デプロイのテキスト キャプションから画像のバッチを生成します

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
deployment-id path はい string デプロイされた DALLE モデルのデプロイ ID。
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
prompt string 目的のイメージのテキストの説明。 最大長は 4,000 文字です。 はい
n integer 生成するイメージの数。 いいえ 1
size imageSize 生成されたイメージのサイズ。 いいえ 1,024 x 1,024
応答形式 imagesResponseFormat 生成された画像が返される形式です。 いいえ URL
ユーザー string エンド ユーザーを表す一意の識別子。これは不正使用を監視および検出するのに役立ちます。 いいえ
品質 imageQuality 生成されるイメージの品質。 いいえ standard
スタイル imageStyle 生成されたイメージのスタイル。 いいえ vivid

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json generateImagesResponse

状態コード: 既定

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

Content-Type Type 説明
application/json dalleErrorResponse

例

例

プロンプトの指定を受けてイメージを作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-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
          }
        }
      }
    ]
  }
}

リスト - アシスタント

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

アシスタントの一覧を返します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
リミット クエリ いいえ integer
オーダー クエリ いいえ string
after クエリ いいえ string
before クエリ いいえ string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json listAssistantsResponse

例

例

アシスタントの一覧を返します。

GET https://{endpoint}/openai/assistants?api-version=2024-10-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
  }
}

作成 - アシスタント

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

モデルと指示を使ってアシスタントを作成します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
モデル はい
名前 string アシスタントの名前。 最大長は 256 文字です。
 いいえ
description string アシスタントの説明。 最大長は 512 文字です。
 いいえ
instructions string アシスタントが使うシステムの指示。 最大長は 256,000 文字です。
 いいえ
tools 配列 アシスタントで有効になっているツールのリスト。 アシスタントごとに最大 128 個のツールを使用できます。 ツールの種類には、code_interpreter、retrieval、または function があります。
 いいえ []
tool_resources オブジェクト アシスタントのツールによって使用されるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を含むトークンのみが考慮されることを意味します。

一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
応答形式 assistantsApiResponseFormatOption モデルから出力する必要がある形式を指定します。 GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 いいえ

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID の一覧。 このツールには最大 20 個のファイルを関連付けることができます。
 []
名前 種類 説明 Default
vector_store_ids 配列 このアシスタントにアタッチされているベクター ストア。 アシスタントには、最大 1 つのベクター ストアをアタッチできます。
vector_stores 配列 file_ids を使用してベクター ストアを作成し、このアシスタントにアタッチするヘルパー。 アシスタントには、最大 1 つのベクター ストアをアタッチできます。

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json assistantObject モデルを呼び出し、ツールを使用できる assistant を表します。

例

例

モデルと指示を使ってアシスタントを作成します。

POST https://{endpoint}/openai/assistants?api-version=2024-10-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=2024-10-01-preview

アシスタントを取得します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
assistant_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json assistantObject モデルを呼び出し、ツールを使用できる assistant を表します。

例

例

アシスタントを取得します。

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-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=2024-10-01-preview

アシスタントを変更します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
assistant_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
モデル いいえ
name string アシスタントの名前。 最大長は 256 文字です。
 いいえ
description string アシスタントの説明。 最大長は 512 文字です。
 いいえ
instructions string アシスタントが使うシステムの指示。 最大長は 32,768 文字です。
 いいえ
tools 配列 アシスタントで有効になっているツールのリスト。 アシスタントごとに最大 128 個のツールを使用できます。 ツールの種類には、code_interpreter、retrieval、または function があります。
 いいえ []
tool_resources オブジェクト アシスタントのツールによって使用されるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を含むトークンのみが考慮されることを意味します。

一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
応答形式 assistantsApiResponseFormatOption モデルから出力する必要がある形式を指定します。 GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 いいえ

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID をオーバーライドします。 このツールには最大 20 個のファイルを関連付けることができます。
 []

file_search

名前 種類 説明 Default
vector_store_ids 配列 このアシスタントにアタッチされているベクター ストアをオーバーライドします。 アシスタントには、最大 1 つのベクター ストアをアタッチできます。

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json assistantObject モデルを呼び出し、ツールを使用できる assistant を表します。

例

例

アシスタントを変更します。

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-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 https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-01-preview

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
assistant_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json deleteAssistantResponse

例

例

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

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

応答: 状態コード: 200

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

作成 - スレッド

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

スレッドを作成します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
messages 配列 スレッドを開始するメッセージの一覧。 いいえ
tool_resources オブジェクト このスレッドでアシスタントのツールが使用できるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID の一覧。 このツールには最大 20 個のファイルを関連付けることができます。
 []

file_search

名前 種類 説明 Default
vector_store_ids 配列 このスレッドにアタッチされているベクター ストア。 スレッドには、最大 1 つのベクター ストアをアタッチできます。
vector_stores 配列 file_ids を使用してベクター ストアを作成し、このスレッドにアタッチするヘルパー。 スレッドには、最大 1 つのベクター ストアをアタッチできます。

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json threadObject メッセージを含むスレッドを表します。

例

例

スレッドを作成します。

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

応答: 状態コード: 200

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

取得 - スレッド

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

スレッドを取得します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json threadObject メッセージを含むスレッドを表します。

例

例

スレッドを取得します。

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

応答: 状態コード: 200

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

変更 - スレッド

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

スレッドを変更します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
tool_resources オブジェクト このスレッドでアシスタントのツールが使用できるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID の一覧。 このツールには最大 20 個のファイルを関連付けることができます。
 []

file_search

名前 種類 説明 Default
vector_store_ids 配列 このスレッドにアタッチされているベクター ストア。 スレッドには、最大 1 つのベクター ストアをアタッチできます。

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json threadObject メッセージを含むスレッドを表します。

例

例

スレッドを変更します。

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-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=2024-10-01-preview

スレッドを削除します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json deleteThreadResponse

例

例

スレッドを削除します。

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

応答: 状態コード: 200

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

リスト - メッセージ

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

指定されたスレッドのメッセージのリストを返します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
リミット クエリ いいえ integer
オーダー クエリ いいえ string
after クエリ いいえ string
before クエリ いいえ string
run_id クエリ いいえ string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json listMessagesResponse

例

例

メッセージを一覧表示する

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-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
  }
}

作成 - メッセージ

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

メッセージを作成します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
role string メッセージを作成しているエンティティのロール。 使用できる値は、以下のとおりです。
- user: メッセージは実際のユーザーが送信したものであることを示します。ユーザーが作成したメッセージを表すために、ほとんどの場合に使用する必要があります。
- assistant: メッセージはアシスタントが生成したものであることを示します。 この値を使用して、アシスタントからのメッセージを会話に挿入します。
 はい
コンテンツ string メッセージのコンテンツ。 はい
添付ファイル 配列 メッセージに添付されているファイルと、追加先にする必要があるツールの一覧。 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json messageObject スレッド内のメッセージを表します。

例

例

メッセージを作成します。

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-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=2024-10-01-preview

メッセージを取得します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
message_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json messageObject スレッド内のメッセージを表します。

例

例

メッセージを取得します。

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-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": {}
  }
}

変更 - メッセージ

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

メッセージを変更します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
message_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json messageObject スレッド内のメッセージを表します。

例

例

メッセージを変更します。

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-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"
    }
  }
}

作成 - スレッドと実行

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

スレッドを作成し、1 つの要求で実行します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
assistant_id string この実行を実行するために使われるアシスタントの ID。 はい
スレッド createThreadRequest いいえ
モデル string この実行を実行するために使われるモデルのデプロイ名。 ここで値を指定すると、アシスタントに関連付けられたモデルがオーバーライドされます。 指定しない場合は、アシスタントに関連付けられたモデルが使われます。 いいえ
instructions string アシスタントの既定のシステム メッセージをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 いいえ
tools 配列 アシスタントがこの実行に使用できるツールをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 いいえ
tool_resources オブジェクト アシスタントのツールによって使用されるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を含むトークンのみが考慮されることを意味します。

一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
stream boolean true の場合は、サーバー送信イベントとして実行中に発生したイベントのストリームを返します。実行が終了状態になると、data: [DONE] メッセージが表示されて終了します。
 いいえ
stream_options chatCompletionStreamOptions ストリーミング応答のオプション。 stream: true に設定した場合はこれのみを設定します。
 いいえ なし
max_prompt_tokens integer 実行の過程で使用される可能性があるプロンプト トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数のプロンプト トークンのみを使用しようとします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。
 いいえ
max_completion_tokens integer 実行の過程で使用される可能性がある入力候補トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数の入力候補トークンのみを使用しようとします。 実行が指定された入力候補トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。
 いいえ
truncation_strategy truncationObject 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 いいえ
tool_choice assistantsApiToolChoiceOption モデルによって呼び出されるツールを制御します (ある場合)。
none は、モデルでツールが呼び出されず、代わりにメッセージが生成されることを意味します。
auto は既定値であり、モデルがメッセージの生成またはツールの呼び出しを選択できることを意味します。
{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。
 いいえ
parallel_tool_calls ParallelToolCalls ツールの使用中に並列関数の呼び出しを有効にするかどうか。 いいえ True
応答形式 assistantsApiResponseFormatOption モデルから出力する必要がある形式を指定します。 GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 いいえ

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID の一覧。 このツールには最大 20 個のファイルを関連付けることができます。
 []

file_search

名前 種類 説明 Default
vector_store_ids 配列 このアシスタントにアタッチされているベクター ストアの ID。 アシスタントには、最大 1 つのベクター ストアをアタッチできます。

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json runObject スレッド上で実行される実行を表します。

例

例

スレッドを作成し、1 つの要求で実行します。

POST https://{endpoint}/openai/threads/runs?api-version=2024-10-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=2024-10-01-preview

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
リミット クエリ いいえ integer
オーダー クエリ いいえ string
after クエリ いいえ string
before クエリ いいえ string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json listRunsResponse

例

例

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

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-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=2024-10-01-preview

実行を作成します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
assistant_id string この実行を実行するために使われるアシスタントの ID。 はい
モデル string この実行を行うために使われるモデルの ID。 ここで値を指定すると、アシスタントに関連付けられたモデルがオーバーライドされます。 指定しない場合は、アシスタントに関連付けられたモデルが使われます。 いいえ
instructions string アシスタントの既定のシステム メッセージをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 いいえ
additional_instructions string 実行の手順の最後に追加の手順を追加します。 これは、他の手順をオーバーライドすることなく、実行ごとに動作を変更する場合に役立ちます。 いいえ
additional_messages 配列 実行を作成する前に、スレッドにメッセージを追加します。 いいえ
tools 配列 アシスタントがこの実行に使用できるツールをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を含むトークンのみが考慮されることを意味します。

一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
stream boolean true の場合は、サーバー送信イベントとして実行中に発生したイベントのストリームを返します。実行が終了状態になると、data: [DONE] メッセージが表示されて終了します。
 いいえ
max_prompt_tokens integer 実行の過程で使用される可能性があるプロンプト トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数のプロンプト トークンのみを使用しようとします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。
 いいえ
max_completion_tokens integer 実行の過程で使用される可能性がある入力候補トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数の入力候補トークンのみを使用しようとします。 実行が指定された入力候補トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。
 いいえ
truncation_strategy truncationObject 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 いいえ
tool_choice assistantsApiToolChoiceOption モデルによって呼び出されるツールを制御します (ある場合)。
none は、モデルでツールが呼び出されず、代わりにメッセージが生成されることを意味します。
auto は既定値であり、モデルがメッセージの生成またはツールの呼び出しを選択できることを意味します。
{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。
 いいえ
parallel_tool_calls ParallelToolCalls ツールの使用中に並列関数の呼び出しを有効にするかどうか。 いいえ True
応答形式 assistantsApiResponseFormatOption モデルから出力する必要がある形式を指定します。 GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json runObject スレッド上で実行される実行を表します。

例

例

実行を作成します。

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-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=2024-10-01-preview

実行を取得します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
run_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json runObject スレッド上で実行される実行を表します。

例

例

実行を取得します。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-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=2024-10-01-preview

実行を変更します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
run_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json runObject スレッド上で実行される実行を表します。

例

例

実行を変更します。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-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=2024-10-01-preview

実行に status: "requires_action" があり、required_action.type が submit_tool_outputs のとき、すべてが完了したら、このエンドポイントを使用して、ツール呼び出しからの出力を送信できます。 すべての出力は 1 つの要求で送信する必要があります。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
run_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
tool_outputs 配列 出力が送信されるツールのリスト。 はい
stream boolean true の場合は、サーバー送信イベントとして実行中に発生したイベントのストリームを返します。実行が終了状態になると、data: [DONE] メッセージが表示されて終了します。
 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json runObject スレッド上で実行される実行を表します。

例

例

実行に status: "requires_action" があり、required_action.type が submit_tool_outputs のとき、すべてが完了したら、このエンドポイントを使用して、ツール呼び出しからの出力を送信できます。 すべての出力は 1 つの要求で送信する必要があります。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-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=2024-10-01-preview

in_progress の実行を取り消します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
run_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json runObject スレッド上で実行される実行を表します。

例

例

in_progress の実行を取り消します。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-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=2024-10-01-preview

実行に属する実行ステップの一覧を返します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
run_id path はい string
リミット クエリ いいえ integer
オーダー クエリ いいえ string
after クエリ いいえ string
before クエリ いいえ string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json listRunStepsResponse

例

例

実行に属する実行ステップの一覧を返します。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-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=2024-10-01-preview

実行ステップを取得します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
thread_id path はい string
run_id path はい string
step_id path はい string
api-version クエリ はい string API バージョン

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json runStepObject 実行の実行中のステップを表します。

例

例

実行ステップを取得します。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-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=2024-10-01-preview

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
リミット クエリ いいえ integer
オーダー クエリ いいえ string
after クエリ いいえ string
before クエリ いいえ string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json listVectorStoresResponse

例

例

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

GET https://{endpoint}/openai/vector_stores?api-version=2024-10-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
  }
}

作成 - ベクター ストア

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

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
file_ids 配列 ベクター ストアが使う必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。 いいえ
name string ベクター ストアの名前。 いいえ
expires_after vectorStoreExpirationAfter ベクター ストアの有効期限ポリシー。 いいえ
chunking_strategy autoChunkingStrategyRequestParam または staticChunkingStrategyRequestParam ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。 file_ids が空でない場合のみ適用されます。 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json vectorStoreObject ベクター ストアは、file_search ツールで使用できる処理済みファイルのコレクションです。

例

例

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

POST https://{endpoint}/openai/vector_stores?api-version=2024-10-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=2024-10-01-preview

ベクター ストアを取得します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
vector_store_id path はい string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json vectorStoreObject ベクター ストアは、file_search ツールで使用できる処理済みファイルのコレクションです。

例

例

ベクター ストアを取得します。

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

応答: 状態コード: 200

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

変更 - ベクター ストア

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

ベクター ストアを変更します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
vector_store_id path はい string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
name string ベクター ストアの名前。 いいえ
expires_after vectorStoreExpirationAfter ベクター ストアの有効期限ポリシー。 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json vectorStoreObject ベクター ストアは、file_search ツールで使用できる処理済みファイルのコレクションです。

例

例

ベクター ストアを変更します。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-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=2024-10-01-preview

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
vector_store_id path はい string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json deleteVectorStoreResponse

例

例

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

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-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=2024-10-01-preview

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
vector_store_id path はい string
リミット クエリ いいえ integer
オーダー クエリ いいえ string
after クエリ いいえ string
before クエリ いいえ string
フィルター クエリ いいえ string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json listVectorStoreFilesResponse

例

例

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-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
  }
}

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

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

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
vector_store_id path はい string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
file_id string ベクター ストアが使う必要があるファイル ID。 ファイルにアクセスできる file_search などのツールに便利です。 はい
chunking_strategy chunkingStrategyRequestParam ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json vectorStoreFileObject ベクター ストアにアタッチされているファイルの一覧。

例

例

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-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 https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
vector_store_id path はい string
file_id path はい string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json vectorStoreFileObject ベクター ストアにアタッチされているファイルの一覧。

例

例

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-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=2024-10-01-preview

ベクター ストア ファイルを削除します。 これにより、ベクター ストアからファイルが削除されますが、ファイル自体は削除されません。 ファイルを削除するには、ファイルの削除エンドポイントを使用します。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
vector_store_id path はい string
file_id path はい string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json deleteVectorStoreFileResponse

例

例

ベクター ストア ファイルを削除します。 これにより、ベクター ストアからファイルが削除されますが、ファイル自体は削除されません。 ファイルを削除するには、ファイルの削除エンドポイントを使用します。

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

応答: 状態コード: 200

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

作成 - ベクター ストア ファイルのバッチ

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

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
vector_store_id path はい string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

要求本文

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

名前 種類 内容 必要 Default
file_ids 配列 ベクター ストアが使う必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。 はい
chunking_strategy chunkingStrategyRequestParam ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。 いいえ

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json vectorStoreFileBatchObject ベクター ストアにアタッチされているファイルのバッチ。

例

例

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-10-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 https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-01-preview

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
vector_store_id path はい string
batch_id path はい string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json vectorStoreFileBatchObject ベクター ストアにアタッチされているファイルのバッチ。

例

例

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-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=2024-10-01-preview

ベクター ストア ファイルのバッチを取り消します。 これは、このバッチ内のファイルの処理をできるだけ早く取り消そうとします。

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
vector_store_id path はい string
batch_id path はい string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json vectorStoreFileBatchObject ベクター ストアにアタッチされているファイルのバッチ。

例

例

ベクター ストア ファイルのバッチを取り消します。 これは、このバッチ内のファイルの処理をできるだけ早く取り消そうとします。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-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=2024-10-01-preview

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

URI パラメーター

名前 / 必須 タイプ 説明
endpoint path はい string
URL		 サポートされる Azure OpenAI エンドポイント (プロトコルとホスト名。例: https://aoairesource.openai.azure.com。"aoairesource" は Azure OpenAI リソース名に置き換えてください)。 https://{your-resource-name}.openai.azure.com
vector_store_id path はい string
batch_id path はい string
リミット クエリ いいえ integer
オーダー クエリ いいえ string
after クエリ いいえ string
before クエリ いいえ string
フィルター クエリ いいえ string
api-version クエリ はい string

要求ヘッダー

名前 Required タイプ 説明
api-key True string ここには Azure OpenAI API キーを指定します

応答

状態コード: 200

説明: OK

Content-Type Type 説明
application/json listVectorStoreFilesResponse

例

例

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-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
  }
}

コンポーネント

errorResponse

名前 種類 内容 必要 Default
error error いいえ

errorBase

名前 種類 内容 必要 Default
code string いいえ
message string いいえ

エラー

名前 種類 内容 必要 Default
param string いいえ
type string いいえ
inner_error innerError 追加の詳細を含む内部エラー。 いいえ

innerError

追加の詳細を含む内部エラー。

名前 種類 内容 必要 Default
code innerErrorCode 内部エラー オブジェクトのエラー コード。 いいえ
content_filter_results contentFilterPromptResults コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。 いいえ

innerErrorCode

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

説明: 内部エラー オブジェクトのエラー コード。

型: string

既定:

列挙型名: InnerErrorCode

列挙値:

Value 説明
ResponsibleAIPolicyViolation プロンプトが、コンテンツ フィルター規則の 1 つ以上に違反しました。

dalleErrorResponse

名前 種類 内容 必要 Default
エラー dalleError いいえ

dalleError

名前 種類 内容 必要 Default
param string いいえ
type string いいえ
inner_error dalleInnerError 追加の詳細を含む内部エラー。 いいえ

dalleInnerError

追加の詳細を含む内部エラー。

名前 種類 内容 必要 Default
code innerErrorCode 内部エラー オブジェクトのエラー コード。 いいえ
content_filter_results dalleFilterResults コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。 いいえ
revised_prompt string イメージの生成に使用されたプロンプト (プロンプトにリビジョンがある場合)。 いいえ

contentFilterCompletionTextSpan

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

名前 種類 内容 必要 Default
completion_start_offset integer このスパンの開始である UTF32 コード ポイントのオフセット。 はい
completion_end_offset integer このスパンから除外される最初の UTF32 コード ポイントのオフセット。 このフィールドは、空のスパンの場合は常に completion_start_offset と等しくなります。 このフィールドは、空ではないスパンの場合は常に completion_start_offset より大きくなります。 はい

contentFilterResultBase

名前 種類 内容 必要 Default
filtered boolean はい

contentFilterSeverityResult

名前 種類 内容 必要 Default
filtered boolean はい
severity string いいえ

contentFilterDetectedResult

名前 種類 内容 必要 Default
filtered boolean はい
detected boolean いいえ

contentFilterDetectedWithCitationResult

名前 種類 内容 必要 Default
citation object いいえ

citation のプロパティ

URL

件名 種類 説明 Default
URL string

ライセンス

名前 種類 説明 Default
ライセンス string

contentFilterDetectedWithCompletionTextSpansResult

名前 種類 内容 必要 Default
詳細 配列 いいえ

contentFilterIdResult

名前 種類 内容 必要 Default
filtered boolean はい
id string いいえ

contentFilterResultsBase

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

名前 種類 内容 必要 Default
sexual contentFilterSeverityResult いいえ
violence contentFilterSeverityResult いいえ
hate contentFilterSeverityResult いいえ
self_harm contentFilterSeverityResult いいえ
profanity contentFilterDetectedResult いいえ
custom_blocklists contentFilterDetailedResults フィルター処理されたセグメントのコンテンツ フィルター ID の詳細を含むコンテンツ フィルター結果。 いいえ
エラー errorBase いいえ

contentFilterPromptResults

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。

名前 種類 内容 必要 Default
sexual contentFilterSeverityResult いいえ
violence contentFilterSeverityResult いいえ
hate contentFilterSeverityResult いいえ
self_harm contentFilterSeverityResult いいえ
profanity contentFilterDetectedResult いいえ
custom_blocklists contentFilterDetailedResults フィルター処理されたセグメントのコンテンツ フィルター ID の詳細を含むコンテンツ フィルター結果。 いいえ
エラー errorBase いいえ
脱獄 contentFilterDetectedResult いいえ
indirect_attack contentFilterDetectedResult いいえ

contentFilterChoiceResults

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 サード パーティのテキストと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。

名前 種類 内容 必要 Default
sexual contentFilterSeverityResult いいえ
violence contentFilterSeverityResult いいえ
hate contentFilterSeverityResult いいえ
self_harm contentFilterSeverityResult いいえ
profanity contentFilterDetectedResult いいえ
custom_blocklists contentFilterDetailedResults フィルター処理されたセグメントのコンテンツ フィルター ID の詳細を含むコンテンツ フィルター結果。 いいえ
エラー errorBase いいえ
protected_material_text contentFilterDetectedResult いいえ
protected_material_code contentFilterDetectedWithCitationResult いいえ
ungrounded_material contentFilterDetectedWithCompletionTextSpansResult いいえ

contentFilterDetailedResults

フィルター処理されたセグメントのコンテンツ フィルター ID の詳細を含むコンテンツ フィルター結果。

名前 種類 内容 必要 Default
filtered boolean はい
詳細 配列 いいえ

promptFilterResult

要求内の 1 つのプロンプトのコンテンツ フィルター処理結果。

名前 種類 内容 必要 Default
prompt_index integer いいえ
content_filter_results contentFilterPromptResults コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。 いいえ

promptFilterResults

要求内の 0 個以上のプロンプトのコンテンツ フィルター処理結果。 ストリーミング要求の場合、プロンプトが異なると、結果は異なるタイミングや異なる順序で届く可能性があります。

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

dalleContentFilterResults

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

名前 種類 内容 必要 Default
sexual contentFilterSeverityResult いいえ
violence contentFilterSeverityResult いいえ
hate contentFilterSeverityResult いいえ
self_harm contentFilterSeverityResult いいえ

dalleFilterResults

コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。

名前 種類 内容 必要 Default
sexual contentFilterSeverityResult いいえ
violence contentFilterSeverityResult いいえ
hate contentFilterSeverityResult いいえ
self_harm contentFilterSeverityResult いいえ
profanity contentFilterDetectedResult いいえ
脱獄 contentFilterDetectedResult いいえ
custom_blocklists contentFilterDetailedResults フィルター処理されたセグメントのコンテンツ フィルター ID の詳細を含むコンテンツ フィルター結果。 いいえ

chatCompletionsRequestCommon

名前 種類 内容 必要 Default
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。		 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。
一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。		 いいえ 1
stream boolean 設定すると、ChatGPT と同様に部分的なメッセージ デルタが送信されます。 トークンは、使用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージによって終了します。 いいえ False
stop 文字列または配列 API が以降のトークンの生成を停止する最大 4 つのシーケンス。 いいえ
max_tokens integer 生成された回答に許可されるトークンの最大数。 既定では、モデルが返すことができるトークンの数は (4096 - プロンプト トークン) になります。 これには o1 シリーズ モデルとの互換性はありません。 いいえ 4096
max_completion_tokens integer 可視出力トークンや推論トークンなど、完了するために生成できるトークンの数の上限。 これは、o1 シリーズ モデルでのみサポートされます。 今後の API リリースで、サポートが他のモデルに拡張される予定です。 いいえ
presence_penalty 数値 -2.0 ～ 2.0 の数。 正の値は、新しいトークンがこれまでのテキストに表示されているかどうかに基づいてペナルティを課し、モデルが新しいトピックについて話す可能性を高めます。 いいえ 0
frequency_penalty 数値 -2.0 ～ 2.0 の数。 正の値は、これまでのテキストにおける既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行をそのまま繰り返す可能性を減少させます。 いいえ 0
logit_bias オブジェクト 指定したトークンが入力候補に表示される可能性を変更します。 トークン (トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする json オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。 いいえ
ユーザー string エンド ユーザーを表す一意の識別子。これは、Azure OpenAI が不正使用を監視および検出するのに役立ちます。 いいえ

createCompletionRequest

名前 種類 内容 必要 Default
prompt 文字列または配列 文字列、文字列の配列、トークンの配列、またはトークン配列の配列としてエンコードされた、補完を生成するためのプロンプト。

<|endoftext|> はトレーニング中にモデルが認識するドキュメント区切り記号であるため、プロンプトを指定しない場合、モデルは新しいドキュメントの先頭からであるかのように生成します。
 はい
best_of integer サーバー側で best_of 入力候補を生成し、"最適なもの" (トークンあたりの対数確率が最高のもの) を返します。 結果をストリーミングすることはできません。

n とともに使用すると、best_of は入力候補の数を制御し、n は返す数を指定します。best_of は n より大きくする必要があります。

注: このパラメーターにより多くの入力候補が生成されるため、トークン クォータがすぐに消費される可能性があります。 慎重に使用し、max_tokens と stop の設定が合理的であることを確認してください。
 いいえ 1
echo boolean 入力候補に加えてプロンプトをエコーバックします。
 いいえ False
frequency_penalty 数値 -2.0 ～ 2.0 の数。 正の値は、これまでのテキストにおける既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行をそのまま繰り返す可能性を減少させます。
 いいえ 0
logit_bias オブジェクト 指定したトークンが入力候補に表示される可能性を変更します。

トークン (GPT トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする JSON オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。

たとえば、<|endoftext|> トークンが生成されないように、{"50256": -100} を渡すことができます。
 いいえ なし
logprobs integer logprobs の最も可能性の高い出力トークンと、選択したトークンのログ確率を含めます。 たとえば、logprobs が 5 の場合、API は可能性が最も高い 5 個のトークンの一覧を返します。 API は常に、サンプリングされたトークンの logprob を返します。そのため、応答には、最大 logprobs+1 の要素が含まれる可能性があります。

logprobs の最大値は 5 です。
 いいえ なし
max_tokens integer 補完の中で生成できるトークンの最大数。

プロンプトのトークン数と max_tokens の合計は、モデルのコンテキスト長を超えることはできません。
いいえ 16
n integer プロンプトごとに生成する入力候補の数。

注: このパラメーターにより多くの入力候補が生成されるため、トークン クォータがすぐに消費される可能性があります。 慎重に使用し、max_tokens と stop の設定が合理的であることを確認してください。
 いいえ 1
presence_penalty 数値 -2.0 ～ 2.0 の数。 正の値は、新しいトークンがこれまでのテキストに表示されているかどうかに基づいてペナルティを課し、モデルが新しいトピックについて話す可能性を高めます。
 いいえ 0
シード integer 指定されている場合、このシステムは、同じ seed とパラメーターを使用して繰り返された要求に対して同じ結果を返せるように、決定論的にサンプリングを行うように最善を尽くします。

決定性は保証されないため、バックエンドでの変更を監視するには、system_fingerprint 応答パラメーターを参照する必要があります。
 いいえ
stop 文字列または配列 API が以降のトークンの生成を停止する最大 4 つのシーケンス。 返されるテキストに停止シーケンスは含まれません。
 いいえ
stream boolean 部分的な進行状況をストリーム バックするかどうか。 設定されている場合、トークンは使用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージによって終了します。
いいえ False
suffix string 挿入されたテキストの入力候補の後に付加されるサフィックス。

このパラメーターは、gpt-3.5-turbo-instruct に対してのみサポートされます。
 いいえ なし
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。

一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。

一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
ユーザー string エンド ユーザーを表す一意の識別子。これは不正使用を監視および検出するのに役立ちます。
 いいえ

createCompletionResponse

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

名前 種類 内容 必要 Default
ID string チャット入力候補の一意識別子。 はい
選択肢(複数) 配列 入力プロンプト用にモデルが生成した入力候補の一覧。 はい
作成済 integer 入力候補が作成されたときの Unix タイムスタンプ (秒単位)。 はい
モデル string 補完に使用されるモデル。 はい
prompt_filter_results promptFilterResults 要求内の 0 個以上のプロンプトのコンテンツ フィルター処理結果。 ストリーミング要求の場合、プロンプトが異なると、結果は異なるタイミングや異なる順序で届く可能性があります。 いいえ
system_fingerprint string このフィンガープリントは、モデルが実行されるバックエンド構成を表します。

seed 要求パラメーターと組み合わせて使うと、決定性に影響を与える可能性のあるバックエンドの変更がいつ行われたかを把握できます。
 いいえ
オブジェクト enum オブジェクトの種類であり、これは常に "text_completion" になります
使用できる値: text_completion		 はい
使用量 completionUsage 入力候補要求の使用状況の統計情報。 いいえ

createChatCompletionRequest

名前 種類 内容 必要 Default
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。

一般に、これと top_p の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10％ の確率質量を構成するトークンのみが考慮されることを意味します。

一般に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
stream boolean 設定すると、ChatGPT と同様に部分的なメッセージ デルタが送信されます。 トークンは、使用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームは data: [DONE] メッセージによって終了します。
 いいえ False
stop 文字列または配列 API が以降のトークンの生成を停止する最大 4 つのシーケンス。
 いいえ
max_tokens integer チャット入力候補で生成できるトークンの最大数。

入力トークンと生成されたトークンの合計の長さは、モデルのコンテキスト長によって制限されます。
いいえ
max_completion_tokens integer 可視出力トークンや推論トークンなど、完了するために生成できるトークンの数の上限。 これは、o1 シリーズ モデルでのみサポートされます。 今後の API リリースで、サポートが他のモデルに拡張される予定です。 いいえ
presence_penalty 数値 -2.0 ～ 2.0 の数。 正の値は、新しいトークンがこれまでのテキストに表示されているかどうかに基づいてペナルティを課し、モデルが新しいトピックについて話す可能性を高めます。
 いいえ 0
frequency_penalty 数値 -2.0 ～ 2.0 の数。 正の値は、これまでのテキストにおける既存の頻度に基づいて新しいトークンにペナルティを与え、モデルが同じ行をそのまま繰り返す可能性を減少させます。
 いいえ 0
logit_bias オブジェクト 指定したトークンが入力候補に表示される可能性を変更します。

トークン (トークナイザーのトークン ID で指定) を関連付けられたバイアス値 (-100 から 100) にマップする JSON オブジェクトを受け入れます。 数学的には、サンプリングの前にモデルによって生成されたロジットにバイアスが追加されます。 正確な効果はモデルごとに異なりますが、-1 から 1 の値では選択の可能性が低下または増加し、-100 や 100 などの値では、関連するトークンの禁止または排他的な選択になります。
 いいえ なし
ユーザー string エンド ユーザーを表す一意の識別子。これは不正使用を監視および検出するのに役立ちます。
 いいえ
messages 配列 これまでの会話を構成するメッセージの一覧。 はい
data_sources 配列 それらを使用する Azure OpenAI チャット拡張機能の構成エントリ。
この追加仕様は、Azure OpenAI とのみ互換性があります。		 いいえ
logprobs boolean 出力トークンのログ確率を返すかどうかを指定します。 true に設定すると、message の content に含まれる各出力トークンのログ確率が返されます。 いいえ False
top_logprobs integer 0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。 このパラメーターを使う場合、logprobs は true に設定する必要があります。 いいえ
n integer 入力メッセージごとに生成するチャット入力候補の選択肢の数。 選択肢全体で生成されたトークンの数に基づいて課金されることに注意してください。 コストを最小限に抑えるために、n を 1 のままにします。 いいえ 1
parallel_tool_calls ParallelToolCalls ツールの使用中に並列関数の呼び出しを有効にするかどうか。 いいえ True
応答形式 ResponseFormatText または ResponseFormatJsonObject または ResponseFormatJsonSchema モデルが出力する必要がある形式を指定するオブジェクト。 GPT-4o、GPT-4o mini、GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_schema", "json_schema": {...} } に設定すると、モデルと提供された JSON スキーマが一致することを保証する構造化出力が有効になります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 いいえ
シード integer この機能はベータ版です。
指定されている場合、このシステムは、同じ seed とパラメーターを使用して繰り返された要求に対して同じ結果を返せるように、決定論的にサンプリングを行うように最善を尽くします。
決定性は保証されないため、バックエンドでの変更を監視するには、system_fingerprint 応答パラメーターを参照する必要があります。
 いいえ
stream_options chatCompletionStreamOptions ストリーミング応答のオプション。 stream: true に設定した場合はこれのみを設定します。
 いいえ なし
tools 配列 モデルによって呼び出されるツールの一覧。 現在のところ、関数のみがツールとしてサポートされています。 これを使用し、モデルによって JSON 入力が生成される関数の一覧を提供します。 最大 128 個の関数がサポートされています。
 いいえ
tool_choice chatCompletionToolChoiceOption モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルでツールが呼び出されず、代わりにメッセージが生成されることを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。 {"type": "function", "function": {"name": "my_function"}} を介して特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。 ツールが存在しない場合は、none が既定値です。 ツールが存在する場合は、auto が既定値です。 いいえ
function_call string または chatCompletionFunctionCallOption tool_choice を優先して非推奨になりました。

モデルによって呼び出される関数を制御します (そのような関数がある場合)。
none は、モデルが関数を呼び出さず、代わりにメッセージを生成することを示します。
auto の場合、メッセージを生成するか、関数を呼び出すか、モデルで選択できます。
{"name": "my_function"} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。

関数が存在しない場合は、none が既定値です。 関数が存在する場合は、auto が既定値です。
 いいえ
functions 配列 非推奨になりました。tools を使用してください。

モデルが JSON 入力を生成する可能性がある関数の一覧。
 いいえ

chatCompletionFunctions

名前 種類 内容 必要 Default
description string モデルが関数をいつどのように呼び出すかを選ぶために使われる、関数の動作の説明。 いいえ
name string 呼び出される関数の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。 はい
parameters FunctionParameters 関数が受け取るパラメーター。JSON スキーマ オブジェクトとして記述されます。 例については guide](/azure/ai-services/openai/how-to/function-calling) を、形式に関するドキュメントについては JSON スキーマのリファレンスを参照してください。

parameters を省略すると、空のパラメーター リストを持つ関数が定義されます。		 いいえ

chatCompletionFunctionCallOption

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

名前 種類 内容 必要 Default
name string 呼び出す関数の名前。 はい

chatCompletionFunctionParameters

関数が受け取るパラメーター。JSON スキーマ オブジェクトとして記述されます。 例については guide/ を、形式に関するドキュメントについては JSON スキーマのリファレンスを参照してください。

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

chatCompletionRequestMessage

このコンポーネントには、次のいずれかを指定できます。

chatCompletionRequestSystemMessage

名前 種類 内容 必要 Default
content 文字列または配列 システム メッセージのコンテンツ。 はい
role enum メッセージ作成者のロール。この場合 system。
使用できる値: system		 はい
名前 string 参加者の名前 (省略可能)。 同じロールの参加者を区別するためのモデル情報を指定します。 いいえ

chatCompletionRequestUserMessage

名前 種類 内容 必要 Default
content 文字列または配列 ユーザー メッセージのコンテンツ。
 はい
role enum メッセージ作成者のロール。この場合 user。
使用できる値: user		 はい
名前 string 参加者の名前 (省略可能)。 同じロールの参加者を区別するためのモデル情報を指定します。 いいえ

chatCompletionRequestAssistantMessage

名前 種類 内容 必要 Default
content 文字列または配列 アシスタント メッセージのコンテンツ。 tool_calls または function_call が指定されていない限り、必須です。
 いいえ
refusal string アシスタントによる拒否メッセージ。 いいえ
role enum メッセージ作成者のロール。この場合 assistant。
使用できる値: assistant		 はい
名前 string 参加者の名前 (省略可能)。 同じロールの参加者を区別するためのモデル情報を指定します。 いいえ
tool_calls chatCompletionMessageToolCalls 関数呼び出しなど、モデルによって生成されるツール呼び出し。 いいえ
function_call オブジェクト 非推奨となり、tool_calls に置き換えられました。 モデルによって生成された、呼び出される関数の名前と引数。 いいえ

function_call のプロパティ

arguments

名前 種類 説明 Default
引数 string モデルによって JSON 形式で生成された、関数を呼び出すための引数。 モデルは常に有効な JSON を生成するとは限らず、関数スキーマで定義されていないパラメーターを生成する可能性があることに注意してください。 関数を呼び出す前に、コード内の引数を検証します。

name

名前 種類 説明 Default
name string 呼び出す関数の名前。

chatCompletionRequestToolMessage

名前 種類 内容 必要 Default
role enum メッセージ作成者のロール。この場合 tool。
使用できる値: tool		 はい
content 文字列または配列 ツール メッセージのコンテンツ。 はい
tool_call_id string このメッセージが応答しているツール呼び出し。 はい

chatCompletionRequestFunctionMessage

名前 種類 内容 必要 Default
role enum メッセージ作成者のロール。この場合 function。
使用可能な値: function		 はい
コンテンツ string 関数メッセージのコンテンツ。 はい
名前 string 呼び出す関数の名前。 はい

chatCompletionRequestSystemMessageContentPart

このコンポーネントには、次のいずれかを指定できます。

chatCompletionRequestUserMessageContentPart

このコンポーネントには、次のいずれかを指定できます。

chatCompletionRequestAssistantMessageContentPart

このコンポーネントには、次のいずれかを指定できます。

chatCompletionRequestToolMessageContentPart

このコンポーネントには、次のいずれかを指定できます。

chatCompletionRequestMessageContentPartText

名前 種類 内容 必要 Default
type enum コンテンツ パーツの種類。
使用できる値: text		 はい
text string テキスト コンテンツ。 はい

chatCompletionRequestMessageContentPartImage

名前 種類 内容 必要 Default
type enum コンテンツ パーツの種類。
使用できる値: image_url		 はい
image_url オブジェクト はい

image_url のプロパティ

URL

件名 種類 説明 Default
URL string 画像の URL または base64 でエンコードされた画像データのいずれか。

詳細

名前 種類 説明 Default
詳細 string 画像の詳細レベルを指定します。 詳細については、Vision ガイドをご覧ください。 auto

chatCompletionRequestMessageContentPartRefusal

名前 種類 内容 必要 Default
type enum コンテンツ パーツの種類。
使用できる値: refusal		 はい
refusal string モデルによって生成された拒否メッセージ。 はい

azureChatExtensionConfiguration

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

名前 種類 内容 必要 Default
type azureChatExtensionType 1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張する
ために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。
この構成の使用は、Azure OpenAI とのみ互換性があります。		 はい

azureChatExtensionType

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

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

型: string

既定:

列挙型名: AzureChatExtensionType

列挙値:

Value 説明
azure_search Azure OpenAI チャット拡張機能としての Azure Search の使用を表します。
azure_cosmos_db Azure OpenAI チャット拡張機能としての Azure Cosmos DB の使用を表します。
elasticsearch Azure OpenAI チャット拡張機能としての Elasticsearch® インデックスの使用を表します。
mongo_db Azure OpenAI チャット拡張機能としての Mongo DB の使用を表します。
pinecone Azure OpenAI チャット拡張機能としての Pinecone インデックスの使用を表します。

azureSearchChatExtensionConfiguration

Azure OpenAI チャット拡張機能として使用するときの Azure Search の構成可能なオプションの特定の表現。

名前 種類 内容 必要 Default
type azureChatExtensionType 1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張する
ために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。
この構成の使用は、Azure OpenAI とのみ互換性があります。		 はい
parameters azureSearchChatExtensionParameters Azure OpenAI チャット拡張機能として使用するときの Azure Search のパラメーター。 いいえ

azureSearchChatExtensionParameters

Azure OpenAI チャット拡張機能として使用するときの Azure Search のパラメーター。

名前 種類 内容 必要 Default
認証 onYourDataApiKeyAuthenticationOptions または onYourDataSystemAssignedManagedIdentityAuthenticationOptions または onYourDataUserAssignedManagedIdentityAuthenticationOptions または onYourDataAccessTokenAuthenticationOptions はい
top_n_documents integer 構成されたクエリの特徴量に対して構成されている上位のドキュメントの数。 いいえ
max_search_queries integer 1 つのユーザー メッセージごとに検索プロバイダーに送信する必要がある、書き換えられたクエリの最大数。 指定しないと、送信するクエリの数は自動的に決定されます。 いいえ
allow_partial_result boolean true を指定した場合、部分的な検索結果の使用が許可され、すべてのクエリが失敗した場合、要求は失敗します。 指定しない場合、または false として指定した場合、検索クエリが失敗すると要求は失敗します。 いいえ False
in_scope boolean クエリをインデックス付きデータの使用に制限するかどうか。 いいえ
strictness integer 検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど、精度は高くなりますが、回答の再現率は低くなります。 いいえ
endpoint string 使用する Azure Search リソースの絶対エンドポイント パス。 はい
index_name string 参照先の Azure Search リソースで使用できるインデックスの名前。 はい
fields_mapping azureSearchIndexFieldMappingOptions 構成済みの Azure Search リソースを使用する場合のフィールドの処理方法を制御する省略可能な設定。 いいえ
query_type azureSearchQueryType Azure OpenAI チャット拡張機能として使用するときに実行する必要がある Azure Search 取得クエリの種類。 いいえ
semantic_configuration string クエリの追加のセマンティック構成。 いいえ
filter string 検索フィルター。 いいえ
embedding_dependency onYourDataEndpointVectorizationSource または onYourDataDeploymentNameVectorizationSource または onYourDataIntegratedVectorizationSource いいえ
include_contexts 配列 出力コンテキストに含まれるプロパティ。 指定しない場合、既定値の citations と intent が使用されます。 いいえ

azureSearchIndexFieldMappingOptions

構成済みの Azure Search リソースを使用する場合のフィールドの処理方法を制御する省略可能な設定。

名前 種類 内容 必要 Default
title_field string タイトルとして使用するインデックス フィールドの名前。 いいえ
url_field string URL として使用するインデックス フィールドの名前。 いいえ
filepath_field string ファイルパスとして使用するインデックス フィールドの名前。 いいえ
content_fields 配列 コンテンツとして扱う必要があるインデックス フィールドの名前。 いいえ
content_fields_separator string コンテンツ フィールドで使用する区切り記号パターン。 いいえ
vector_fields 配列 ベクトル データを表すフィールドの名前。 いいえ
image_vector_fields 配列 画像のベクター データを表すフィールドの名前。 いいえ

azureSearchQueryType

Azure OpenAI チャット拡張機能として使用するときに実行する必要がある Azure Search 取得クエリの種類。

説明: Azure OpenAI チャット拡張機能として使用するときに実行する必要がある Azure Search 取得クエリの種類。

型: string

既定:

列挙型名: AzureSearchQueryType

列挙値:

Value 説明
simple 既定の単純なクエリ パーサーを表します。
"セマンティック" 高度なセマンティック モデリングのセマンティック クエリ パーサーを表します。
vector 計算されたデータに対するベクトル検索を表します。
vector_simple_hybrid 単純なクエリ戦略とベクター データの組み合わせを表します。
vector_semantic_hybrid セマンティック検索とベクター データ クエリの組み合わせを表します。

azureCosmosDBChatExtensionConfiguration

Azure OpenAI チャット拡張機能として使用するときの Azure Cosmos DB の構成可能なオプションの特定の表現。

名前 種類 内容 必要 Default
type azureChatExtensionType 1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張する
ために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。
この構成の使用は、Azure OpenAI とのみ互換性があります。		 はい
parameters azureCosmosDBChatExtensionParameters MongoDB 仮想コアに Azure Cosmos DB を使用するときに Azure OpenAI On Your Data チャット拡張機能の構成に
使用するパラメーター。		 いいえ

azureCosmosDBChatExtensionParameters

Azure Cosmos DB for MongoDB 仮想コアを使用するときに Azure OpenAI On Your Data チャット拡張機能の構成に使用するパラメーター。

名前 種類 内容 必要 Default
認証 onYourDataConnectionStringAuthenticationOptions 接続文字列を使用する場合の Azure OpenAI On Your Data の認証オプション。 はい
top_n_documents integer 構成されたクエリの特徴量に対して構成されている上位のドキュメントの数。 いいえ
max_search_queries integer 1 つのユーザー メッセージごとに検索プロバイダーに送信する必要がある、書き換えられたクエリの最大数。 指定しないと、送信するクエリの数は自動的に決定されます。 いいえ
allow_partial_result boolean true を指定した場合、部分的な検索結果の使用が許可され、すべてのクエリが失敗した場合、要求は失敗します。 指定しない場合、または false として指定した場合、検索クエリが失敗すると要求は失敗します。 いいえ False
in_scope boolean クエリをインデックス付きデータの使用に制限するかどうか。 いいえ
strictness integer 検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど、精度は高くなりますが、回答の再現率は低くなります。 いいえ
database_name string Azure Cosmos DB で使用する MongoDB 仮想コア データベースの名前。 はい
container_name string Azure Cosmos DB リソース コンテナーの名前。 はい
index_name string Azure Cosmos DB で使用する MongoDB 仮想コア インデックスの名前。 はい
fields_mapping azureCosmosDBFieldMappingOptions 構成済みの Azure Cosmos DB リソースを使用するときのフィールドの処理方法を制御するオプションの設定。 はい
embedding_dependency onYourDataEndpointVectorizationSource または onYourDataDeploymentNameVectorizationSource はい
include_contexts 配列 出力コンテキストに含まれるプロパティ。 指定しない場合、既定値の citations と intent が使用されます。 いいえ

azureCosmosDBFieldMappingOptions

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

名前 種類 内容 必要 Default
title_field string タイトルとして使用するインデックス フィールドの名前。 いいえ
url_field string URL として使用するインデックス フィールドの名前。 いいえ
filepath_field string ファイルパスとして使用するインデックス フィールドの名前。 いいえ
content_fields 配列 コンテンツとして扱う必要があるインデックス フィールドの名前。 はい
content_fields_separator string コンテンツ フィールドで使用する区切り記号パターン。 いいえ
vector_fields 配列 ベクトル データを表すフィールドの名前。 はい

elasticsearchChatExtensionConfiguration

Azure OpenAI チャット拡張機能として使用するときの Elasticsearch の構成可能なオプションの特定の表現。

名前 種類 内容 必要 Default
type azureChatExtensionType 1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張する
ために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。
この構成の使用は、Azure OpenAI とのみ互換性があります。		 はい
parameters elasticsearchChatExtensionParameters Azure OpenAI チャット拡張機能として Elasticsearch® を構成するときに使用するパラメーター。 いいえ

elasticsearchChatExtensionParameters

Azure OpenAI チャット拡張機能として Elasticsearch® を構成するときに使用するパラメーター。

名前 種類 内容 必要 Default
認証 onYourDataKeyAndKeyIdAuthenticationOptions または onYourDataEncodedApiKeyAuthenticationOptions はい
top_n_documents integer 構成されたクエリの特徴量に対して構成されている上位のドキュメントの数。 いいえ
max_search_queries integer 書き換えられたクエリの最大数は、1 つのユーザー メッセージに対する検索プロバイダーに送信する必要があります。 指定しないと、送信するクエリの数は自動的に決定されます。 いいえ
allow_partial_result boolean true を指定した場合、部分的な検索結果の使用が許可され、すべてのクエリが失敗した場合、要求は失敗します。 指定しない場合、または false として指定した場合、検索クエリが失敗すると要求は失敗します。 いいえ False
in_scope boolean クエリをインデックス付きデータの使用に制限するかどうか。 いいえ
strictness integer 検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど、精度は高くなりますが、回答の再現率は低くなります。 いいえ
endpoint string Elasticsearch® のエンドポイント。 はい
index_name string Elasticsearch® のインデックス名。 はい
fields_mapping elasticsearchIndexFieldMappingOptions 構成済みの Elasticsearch® リソースを使用するときのフィールドの処理方法を制御するオプションの設定。 いいえ
query_type elasticsearchQueryType Azure OpenAI チャット拡張機能として使用するときに実行する必要がある Elasticsearch® 取得クエリの種類。 いいえ
embedding_dependency onYourDataEndpointVectorizationSource または onYourDataDeploymentNameVectorizationSource または onYourDataModelIdVectorizationSource いいえ
include_contexts 配列 出力コンテキストに含まれるプロパティ。 指定しない場合、既定値の citations と intent が使用されます。 いいえ

elasticsearchIndexFieldMappingOptions

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

名前 種類 内容 必要 Default
title_field string タイトルとして使用するインデックス フィールドの名前。 いいえ
url_field string URL として使用するインデックス フィールドの名前。 いいえ
filepath_field string ファイルパスとして使用するインデックス フィールドの名前。 いいえ
content_fields 配列 コンテンツとして扱う必要があるインデックス フィールドの名前。 いいえ
content_fields_separator string コンテンツ フィールドで使用する区切り記号パターン。 いいえ
vector_fields 配列 ベクトル データを表すフィールドの名前。 いいえ

elasticsearchQueryType

Azure OpenAI チャット拡張機能として使用するときに実行する必要がある Elasticsearch® 取得クエリの種類。

説明: Azure OpenAI チャット拡張機能として使用するときに実行する必要がある Elasticsearch® 取得クエリの種類。

型: string

既定:

列挙型名: ElasticsearchQueryType

列挙値:

Value 説明
simple 既定の単純なクエリ パーサーを表します。
vector 計算されたデータに対するベクトル検索を表します。

mongoDBChatExtensionConfiguration

Azure OpenAI チャット拡張機能として使用するときの Mongo DB の構成可能なオプションの特定の表現。

名前 種類 内容 必要 Default
type azureChatExtensionType 1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張する
ために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。
この構成の使用は、Azure OpenAI とのみ互換性があります。		 はい
parameters mongoDBChatExtensionParameters Mongo DB を使用している場合、Azure OpenAI On Your Data チャット拡張機能を構成するときに使用するパラメーター。 いいえ

mongoDBChatExtensionParameters

Mongo DB を使用している場合、Azure OpenAI On Your Data チャット拡張機能を構成するときに使用するパラメーター。

名前 種類 内容 必要 Default
認証 onYourDataUsernameAndPasswordAuthenticationOptions ユーザー名とパスワードを使用する場合の Azure OpenAI On Your Data の認証オプション。 はい
top_n_documents integer 構成されたクエリの特徴量に対して構成されている上位のドキュメントの数。 いいえ
max_search_queries integer 書き換えられたクエリの最大数は、1 つのユーザー メッセージに対する検索プロバイダーに送信する必要があります。 指定しないと、送信するクエリの数は自動的に決定されます。 いいえ
allow_partial_result boolean true を指定した場合、部分的な検索結果の使用が許可され、すべてのクエリが失敗した場合、要求は失敗します。 指定しない場合、または false として指定した場合、検索クエリが失敗すると要求は失敗します。 いいえ False
in_scope boolean クエリをインデックス付きデータの使用に制限するかどうか。 いいえ
strictness integer 検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど、精度は高くなりますが、回答の再現率は低くなります。 いいえ
endpoint string Mongo DB クラスター エンドポイントの名前。 はい
database_name string Mongo DB データベースの名前。 はい
collection_name string Mongo DB コレクションの名前。 はい
app_name string Mongo DB アプリケーションの名前。 はい
index_name string Mongo DB インデックスの名前。 はい
fields_mapping mongoDBFieldMappingOptions 構成済みの Mongo DB リソースを使用するときのフィールドの処理方法を制御するオプションの設定。 はい
embedding_dependency onYourDataEndpointVectorizationSource または onYourDataDeploymentNameVectorizationSource はい
include_contexts 配列 出力コンテキストに含まれるプロパティ。 指定しない場合、既定値の citations と intent が使用されます。 いいえ

mongoDBFieldMappingOptions

構成済みの Mongo DB リソースを使用するときのフィールドの処理方法を制御するオプションの設定。

名前 種類 内容 必要 Default
title_field string タイトルとして使用するインデックス フィールドの名前。 いいえ
url_field string URL として使用するインデックス フィールドの名前。 いいえ
filepath_field string ファイルパスとして使用するインデックス フィールドの名前。 いいえ
content_fields 配列 コンテンツとして扱う必要があるインデックス フィールドの名前。 はい
content_fields_separator string コンテンツ フィールドで使用する区切り記号パターン。 いいえ
vector_fields 配列 ベクトル データを表すフィールドの名前。 はい

pineconeChatExtensionConfiguration

Azure OpenAI チャット拡張機能として使用するときの Pinecone の構成可能なオプションの特定の表現。

名前 種類 内容 必要 Default
type azureChatExtensionType 1 つの Azure OpenAI チャット拡張機能の構成データの表現。 これは、応答動作を拡張する
ために Azure OpenAI チャット拡張機能を使用する必要があるチャット入力候補要求によって使用されます。
この構成の使用は、Azure OpenAI とのみ互換性があります。		 はい
parameters pineconeChatExtensionParameters Azure OpenAI Pinecone チャット拡張機能を構成するためのパラメーター。 いいえ

pineconeChatExtensionParameters

Azure OpenAI Pinecone チャット拡張機能を構成するためのパラメーター。

名前 種類 内容 必要 Default
認証 onYourDataApiKeyAuthenticationOptions API キーを使用する場合の Azure OpenAI On Your Data の認証オプション。 はい
top_n_documents integer 構成されたクエリの特徴量に対して構成されている上位のドキュメントの数。 いいえ
max_search_queries integer 書き換えられたクエリの最大数は、1 つのユーザー メッセージに対する検索プロバイダーに送信する必要があります。 指定しないと、送信するクエリの数は自動的に決定されます。 いいえ
allow_partial_result boolean true を指定した場合、部分的な検索結果の使用が許可され、すべてのクエリが失敗した場合、要求は失敗します。 指定しない場合、または false として指定した場合、検索クエリが失敗すると要求は失敗します。 いいえ False
in_scope boolean クエリをインデックス付きデータの使用に制限するかどうか。 いいえ
strictness integer 検索の関連性フィルター処理の構成された厳密度。 厳密度が高いほど、精度は高くなりますが、回答の再現率は低くなります。 いいえ
環境 string Pinecone の環境名。 はい
index_name string Pinecone データベース インデックスの名前。 はい
fields_mapping pineconeFieldMappingOptions 構成済みの Pinecone リソースを使用するときのフィールドの処理方法を制御するオプションの設定。 はい
embedding_dependency onYourDataDeploymentNameVectorizationSource 同じ Azure OpenAI リソース内の内部埋め込みモデル デプロイ名に基づくベクトル検索を適用するときに
Azure OpenAI On Your Data で 使用されるベクター化ソースの詳細。		 はい
include_contexts 配列 出力コンテキストに含まれるプロパティ。 指定しない場合、既定値の citations と intent が使用されます。 いいえ

pineconeFieldMappingOptions

構成済みの Pinecone リソースを使用するときのフィールドの処理方法を制御するオプションの設定。

名前 種類 内容 必要 Default
title_field string タイトルとして使用するインデックス フィールドの名前。 いいえ
url_field string URL として使用するインデックス フィールドの名前。 いいえ
filepath_field string ファイルパスとして使用するインデックス フィールドの名前。 いいえ
content_fields 配列 コンテンツとして扱う必要があるインデックス フィールドの名前。 はい
content_fields_separator string コンテンツ フィールドで使用する区切り記号パターン。 いいえ

onYourDataAuthenticationOptions

Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい

onYourDataContextProperty

コンテキスト プロパティ。

説明: コンテキスト プロパティ。

型: string

既定:

列挙型名: OnYourDataContextProperty

列挙値:

Value 説明
citations citations プロパティ。
意図 intent プロパティ。
all_retrieved_documents all_retrieved_documents プロパティ。

onYourDataAuthenticationType

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

説明: Azure OpenAI On Your Data でサポートされる認証タイプ。

型: string

既定:

列挙型名: OnYourDataAuthenticationType

列挙値:

Value 説明
api_key API キーによる認証。
connection_string 接続文字列による認証。
key_and_key_id キーとキー ID のペアによる認証。
encoded_api_key エンコードされた API キーによる認証。
access_token アクセス トークンによる認証。
system_assigned_managed_identity システム割り当てマネージド ID による認証。
user_assigned_managed_identity ユーザー割り当てマネージド ID による認証。
username_and_password ユーザー名とパスワードによる認証。

onYourDataApiKeyAuthenticationOptions

API キーを使用する場合の Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい
key string 認証に使用する API キー。 いいえ

onYourDataConnectionStringAuthenticationOptions

接続文字列を使用する場合の Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい
connection_string string 認証に使用する接続文字列。 いいえ

onYourDataKeyAndKeyIdAuthenticationOptions

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

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい
key string 認証に使用する Elasticsearch キー。 いいえ
key_id string 認証に使用する Elasticsearch キー ID。 いいえ

onYourDataEncodedApiKeyAuthenticationOptions

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

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい
encoded_api_key string 認証に使用する Elasticsearch でエンコードされた API キー。 いいえ

onYourDataAccessTokenAuthenticationOptions

アクセス トークンを使用する場合の Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい
access_token string 認証に使用するアクセス トークン。 いいえ

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

システム割り当てマネージド ID を使用する場合の Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい

onYourDataUserAssignedManagedIdentityAuthenticationOptions

ユーザー割り当てマネージド ID を使用する場合の Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい
managed_identity_resource_id string 認証に使用するユーザー割り当てマネージド ID のリソース ID。 いいえ

onYourDataUsernameAndPasswordAuthenticationOptions

ユーザー名とパスワードを使用する場合の Azure OpenAI On Your Data の認証オプション。

名前 種類 内容 必要 Default
type onYourDataAuthenticationType Azure OpenAI On Your Data でサポートされる認証タイプ。 はい
username string 認証で使用するユーザー名。 いいえ
password string パスワード。 認証に使用。 いいえ

onYourDataVectorizationSource

ベクトル検索を使用した Azure OpenAI On Your Data のベクター化ソースの抽象表現。

名前 種類 内容 必要 Default
type onYourDataVectorizationSourceType ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できる
ソースを表します。		 はい

onYourDataVectorizationSourceType

ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できるソースを表します。

説明: ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できる
ソースを表します。

型: string

既定:

列挙型名: OnYourDataVectorizationSourceType

列挙値:

Value 説明
endpoint Azure OpenAI 埋め込みモデルに対するパブリック サービス呼び出しによって実行されるベクター化を表します。
deployment_name 使用する Ada モデル デプロイ名を表します。 このモデル デプロイは、同じ Azure OpenAI リソース内に存在する必要がありますが、
On Your Data は、パブリック呼び出しではなく内部呼び出し経由でこのモデルデプロイを使用します。これにより、プライベート ネットワークで
ベクトル検索が有効になります。
integrated 検索リソース内で定義されている統合ベクトライザーを表します。
model_id 検索サービスで定義されている特定の埋め込みモデル ID を表します。
現在、Elasticsearch® でのみサポートされています。

onYourDataEndpointVectorizationSource

埋め込みのために Azure OpenAI エンドポイント呼び出しに基づくベクトル検索を適用するときに Azure OpenAI On Your Data で使用されるベクター化ソースの詳細。

名前 種類 内容 必要 Default
type onYourDataVectorizationSourceType ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できる
ソースを表します。		 はい
endpoint string 埋め込みの取得元となるリソース エンドポイント URL を指定します。 https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings という形式にする必要があります。 api-version クエリ パラメーターは許可されていません。 いいえ
認証 onYourDataApiKeyAuthenticationOptions または onYourDataAccessTokenAuthenticationOptions いいえ
dimensions integer 埋め込みに必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。 いいえ

onYourDataDeploymentNameVectorizationSource

同じ Azure OpenAI リソース内の内部埋め込みモデル デプロイ名に基づくベクトル検索を適用するときに Azure OpenAI On Your Data で使用されるベクター化ソースの詳細。

名前 種類 内容 必要 Default
type onYourDataVectorizationSourceType ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できる
ソースを表します。		 はい
deployment_name string ベクター化に使用するモデル デプロイの名前を指定します。 このモデル デプロイは同じ Azure OpenAI リソース内に存在する必要がありますが、On Your Data は、パブリック呼び出しではなく内部呼び出し経由でこのモデルデプロイを使用します。これにより、プライベート ネットワークでベクトル検索が有効になります。 いいえ
dimensions integer 埋め込みに必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。 いいえ

onYourDataIntegratedVectorizationSource

検索リソース内で定義されている統合ベクトライザーを表します。

名前 種類 内容 必要 Default
type onYourDataVectorizationSourceType ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できる
ソースを表します。		 はい

onYourDataModelIdVectorizationSource

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

名前 種類 内容 必要 Default
type onYourDataVectorizationSourceType ベクトル検索で使用するデータのベクター化を構成するために Azure OpenAI On Your Data が使用できる
ソースを表します。		 はい
model_id string ベクター化に使用するモデル ID を指定します。 このモデル ID は検索サービスに定義する必要があります。 いいえ

azureChatExtensionsMessageContext

対応するチャット入力候補応答の生成に Azure OpenAI チャット拡張機能が関係しているときに使用できる追加のコンテキスト情報の表現。 このコンテキスト情報は、一致する拡張機能を使うように構成されている Azure OpenAI 要求を使用するときにのみ、値が設定されます。

名前 種類 内容 必要 Default
citations 配列 応答でアシスタント メッセージを生成するために使用されるデータ ソースの取得結果。 いいえ
意図 string チャット履歴から検出されたインテント。コンテキストを引き継ぐ次のターンに渡すために使用されます。 いいえ
all_retrieved_documents 配列 すべての取得したドキュメント。 いいえ

citation

チャット補完応答メッセージの引用情報。

名前 種類 内容 必要 Default
content string 引用の内容。 はい
タイトル string 引用のタイトル。 いいえ
URL string 引用の URL。 いいえ
filepath string 引用のファイル パス。 いいえ
chunk_id string 引用のチャンク ID。 いいえ
rerank_score 数値 取得したドキュメントの再ランク付けスコア。 いいえ

retrievedDocument

取得したドキュメント。

名前 種類 内容 必要 Default
content string 引用の内容。 はい
タイトル string 引用のタイトル。 いいえ
URL string 引用の URL。 いいえ
filepath string 引用のファイル パス。 いいえ
chunk_id string 引用のチャンク ID。 いいえ
rerank_score 数値 取得したドキュメントの再ランク付けスコア。 いいえ
search_queries 配列 ドキュメント取得に使用した検索クエリ。 いいえ
data_source_index integer データ ソースのインデックス。 いいえ
original_search_score 数値 取得したドキュメントの元の検索スコア。 いいえ
filter_reason filterReason 取得したドキュメントのフィルター処理の理由。 いいえ

filterReason

取得したドキュメントのフィルター処理の理由。

説明: 取得したドキュメントのフィルター処理の理由。

型: string

既定:

列挙型名: FilterReason

列挙値:

Value 説明
score ドキュメントは、strictness 構成によって定義された元の検索スコアのしきい値でフィルター処理されます。
rerank ドキュメントは、元の検索スコアのしきい値でフィルター処理されず、再ランク付けスコアと top_n_documents 構成でフィルター処理されます。

chatCompletionMessageToolCall

名前 種類 内容 必要 Default
ID string ツール呼び出しの ID。 はい
type toolCallType ツール呼び出しの種類。この場合 function。 はい
関数 オブジェクト モデルが呼び出した関数。 はい

function のプロパティ

name

名前 種類 説明 Default
name string 呼び出す関数の名前。

arguments

名前 種類 説明 Default
引数 string モデルによって JSON 形式で生成された、関数を呼び出すための引数。 モデルは常に有効な JSON を生成するとは限らず、関数スキーマで定義されていないパラメーターを作成する可能性があることに注意してください。 関数を呼び出す前に、コード内の引数を検証します。

toolCallType

ツール呼び出しの種類。この場合 function。

説明: ツール呼び出しの種類。この場合 function。

型: string

既定:

列挙型名: ToolCallType

列挙値:

Value 説明
関数 ツール呼び出しの種類は function です。

chatCompletionRequestMessageTool

名前 種類 内容 必要 Default
tool_call_id string このメッセージが応答しているツール呼び出し。 いいえ
content string メッセージの内容。 いいえ

chatCompletionRequestMessageFunction

名前 種類 内容 必要 Default
role enum メッセージ作成者のロール。この場合 function。
使用可能な値: function		 いいえ
name string メッセージの内容。 いいえ
content string メッセージの内容。 いいえ

createChatCompletionResponse

指定された入力に基づいて、モデルによって返されるチャット入力候補応答を表します。

名前 種類 内容 必要 Default
ID string チャット入力候補の一意識別子。 はい
prompt_filter_results promptFilterResults 要求内の 0 個以上のプロンプトのコンテンツ フィルター処理結果。 ストリーミング要求の場合、プロンプトが異なると、結果は異なるタイミングや異なる順序で届く可能性があります。 いいえ
選択肢(複数) 配列 チャット入力候補の選択肢の一覧。 n が 1 より大きい場合は複数の値を指定できます。 はい
作成済 integer チャット入力候補が作成されたときの Unix タイムスタンプ (秒単位)。 はい
モデル string チャット入力候補に使われるモデル。 はい
system_fingerprint string このフィンガープリントは、モデルが実行されるバックエンド構成を表します。

seed 要求パラメーターと組み合わせて使うと、決定性に影響を与える可能性のあるバックエンドの変更がいつ行われたかを把握できます。
 いいえ
オブジェクト enum オブジェクトの種類。これは常に chat.completion です。
使用できる値: chat.completion		 はい
使用量 completionUsage 入力候補要求の使用状況の統計情報。 いいえ

createChatCompletionStreamResponse

指定された入力に基づいて、モデルによって返されるチャット入力候補応答のストリーミングされたチャンクを表します。

名前 種類 内容 必要 Default
ID string チャット入力候補の一意識別子。 各チャンクの ID は同じです。 はい
選択肢(複数) 配列 チャット入力候補の選択肢の一覧。 n が 1 より大きい場合は、複数の要素を含めることができます。
 はい
作成済 integer チャット入力候補が作成されたときの Unix タイムスタンプ (秒単位)。 各チャンクのタイムスタンプは同じです。 はい
モデル string 入力候補を生成するモデル。 はい
system_fingerprint string このフィンガープリントは、モデルが実行されるバックエンド構成を表します。
seed 要求パラメーターと組み合わせて使うと、決定性に影響を与える可能性のあるバックエンドの変更がいつ行われたかを把握できます。
 いいえ
オブジェクト enum オブジェクトの種類。これは常に chat.completion.chunk です。
使用できる値: chat.completion.chunk		 はい

chatCompletionStreamResponseDelta

ストリーミングされたモデル応答によって生成されるチャット入力候補デルタ。

名前 種類 内容 必要 Default
content string チャンク メッセージのコンテンツ。 いいえ
function_call オブジェクト 非推奨となり、tool_calls に置き換えられました。 モデルによって生成された、呼び出される関数の名前と引数。 いいえ
tool_calls 配列 いいえ
role enum このメッセージの作成者の役割。
使用できる値: system、user、assistant、tool		 いいえ
refusal string モデルによって生成された拒否メッセージ。 いいえ

function_call のプロパティ

arguments

名前 種類 説明 Default
引数 string モデルによって JSON 形式で生成された、関数を呼び出すための引数。 モデルは常に有効な JSON を生成するとは限らず、関数スキーマで定義されていないパラメーターを作成する可能性があることに注意してください。 関数を呼び出す前に、コード内の引数を検証します。

name

名前 種類 説明 Default
name string 呼び出す関数の名前。

chatCompletionMessageToolCallChunk

名前 種類 内容 必要 Default
インデックス integer はい
id string ツール呼び出しの ID。 いいえ
type enum ツールの型。 現在、function のみがサポートされています。
使用可能な値: function		 いいえ
関数 object いいえ

function のプロパティ

name

名前 種類 説明 Default
name string 呼び出す関数の名前。

arguments

名前 種類 説明 Default
引数 string モデルによって JSON 形式で生成された、関数を呼び出すための引数。 モデルは常に有効な JSON を生成するとは限らず、関数スキーマで定義されていないパラメーターを作成する可能性があることに注意してください。 関数を呼び出す前に、コード内の引数を検証します。

chatCompletionStreamOptions

ストリーミング応答のオプション。 stream: true に設定した場合はこれのみを設定します。

名前 種類 内容 必要 Default
include_usage boolean 設定されている場合は、data: [DONE] メッセージの前に追加のチャンクがストリームされます。 このチャンクの usage フィールドは要求全体のトークンの使用状況に関する統計情報を示し、choices フィールドは常に空の配列になります。 他のすべてのチャンクにも usage フィールドが含まれますが、null 値です。
 いいえ

chatCompletionChoiceLogProbs

選択肢のログ確率情報。

名前 種類 内容 必要 Default
content 配列 ログ確率情報を含むメッセージ コンテンツ トークンの一覧。 はい
refusal 配列 ログ確率情報を含むメッセージ拒否トークンの一覧。 いいえ

chatCompletionTokenLogprob

名前 種類 内容 必要 Default
token string トークンです。 はい
logprob 数値 このトークンのログ確率。 はい
バイト 配列 トークンの UTF-8 バイト表現を表す整数の一覧。 文字が複数のトークンによって表され、そのバイト表現を組み合わせて正しいテキスト表現を生成する必要がある場合に便利です。 トークンのバイト表現がない場合は、null を指定できます。 はい
top_logprobs 配列 このトークン位置にある、最も可能性の高いトークンとそのログ確率の一覧。 まれに、要求したよりも少ない数の top_logprobs が返される場合があります。 はい

chatCompletionResponseMessage

モデルによって生成されたチャット入力候補メッセージ。

名前 種類 内容 必要 Default
role chatCompletionResponseMessageRole 応答メッセージの作成者のロール。 はい
refusal string モデルによって生成された拒否メッセージ。 はい
コンテンツ string メッセージの内容。 はい
tool_calls 配列 関数呼び出しなど、モデルによって生成されるツール呼び出し。 いいえ
function_call chatCompletionFunctionCall 非推奨となり、tool_calls に置き換えられました。 モデルによって生成された、呼び出される関数の名前と引数。 いいえ
context azureChatExtensionsMessageContext 対応するチャット入力候補応答の生成に Azure OpenAI チャット拡張機能が関係しているときに
使用できる追加のコンテキスト情報の表現。 このコンテキスト情報は、一致する拡張機能を使うように
構成されている Azure OpenAI 要求を使用するときにのみ、値が設定されます。		 いいえ

chatCompletionResponseMessageRole

応答メッセージの作成者のロール。

説明: 応答メッセージの作成者のロール。

型: string

既定:

列挙値:

  • assistant

chatCompletionToolChoiceOption

モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルでツールが呼び出されず、代わりにメッセージが生成されることを意味します。 auto は、モデルがメッセージを生成するか、1 つ以上のツールを呼び出すかを選択できることを意味します。 required は、モデルが 1 つ以上のツールを呼び出す必要があることを意味します。 {"type": "function", "function": {"name": "my_function"}} を介して特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。 ツールが存在しない場合は、none が既定値です。 ツールが存在する場合は、auto が既定値です。

このコンポーネントには、次のいずれかを指定できます。

chatCompletionNamedToolChoice

モデルで使用する必要があるツールを指定します。 モデルで特定の関数を強制的に呼び出すために使用します。

名前 種類 内容 必要 Default
type enum ツールの型。 現在、function のみがサポートされています。
使用可能な値: function		 はい
関数 オブジェクト はい

function のプロパティ

name

名前 種類 説明 Default
name string 呼び出す関数の名前。

ParallelToolCalls

ツールの使用中に並列関数の呼び出しを有効にするかどうか。

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

chatCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

非推奨となり、tool_calls に置き換えられました。 モデルによって生成された、呼び出される関数の名前と引数。

名前 種類 内容 必要 Default
name string 呼び出す関数の名前。 はい
引数 string モデルによって JSON 形式で生成された、関数を呼び出すための引数。 モデルは常に有効な JSON を生成するとは限らず、関数スキーマで定義されていないパラメーターを作成する可能性があることに注意してください。 関数を呼び出す前に、コード内の引数を検証します。 はい

completionUsage

入力候補要求の使用状況の統計情報。

名前 種類 内容 必要 Default
prompt_tokens integer プロンプト内のトークンの数。 はい
completion_tokens integer 生成された入力候補内のトークンの数。 はい
total_tokens integer 要求内で使われたトークンの合計数 (プロンプトと入力候補の和)。 はい
prompt_tokens_details オブジェクト プロンプト トークンの詳細。 いいえ
completion_tokens_details オブジェクト 完了に使用されたトークンの内訳。 いいえ

prompt_tokens_details のプロパティ

cached_tokens

名前 種類 説明 Default
cached_tokens integer キャッシュされたプロンプト トークンの数。

completion_tokens_details のプロパティ

reasoning_tokens

名前 種類 説明 Default
reasoning_tokens integer 推論のためにモデルによって生成されたトークン。

chatCompletionTool

名前 種類 内容 必要 Default
type enum ツールの型。 現在、function のみがサポートされています。
使用可能な値: function		 はい
関数 FunctionObject はい

FunctionParameters

関数が受け取るパラメーター。JSON スキーマ オブジェクトとして記述されます。 例についてはこちらのガイドを参照してください。形式に関するドキュメントについては JSON スキーマのリファレンスを参照してください。

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

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

FunctionObject

名前 種類 内容 必要 Default
description string モデルが関数をいつどのように呼び出すかを選ぶために使われる、関数の動作の説明。 いいえ
name string 呼び出される関数の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。 はい
parameters FunctionParameters 関数が受け取るパラメーター。JSON スキーマ オブジェクトとして記述されます。 例についてはこちらのガイドを参照してください。形式に関するドキュメントについては JSON スキーマのリファレンスを参照してください。

parameters を省略すると、空のパラメーター リストを持つ関数が定義されます。		 いいえ
厳密 boolean 関数呼び出しの生成時に厳格なスキーマの準拠を有効にするかどうか。 true に設定すると、モデルは parameters フィールドで定義されている正確なスキーマに従います。 strict が true の場合、JSON スキーマのサブセットのみがサポートされます。 いいえ False

ResponseFormatText

名前 種類 内容 必要 Default
type enum 定義されている応答形式の種類: text
使用できる値: text		 はい

ResponseFormatJsonObject

名前 種類 内容 必要 Default
type enum 定義されている応答形式の種類: json_object
使用できる値: json_object		 はい

ResponseFormatJsonSchemaSchema

JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。

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

ResponseFormatJsonSchema

名前 種類 内容 必要 Default
type enum 定義されている応答形式の種類: json_schema
使用できる値: json_schema		 はい
json_schema オブジェクト はい

json_schema のプロパティ

description

件名 種類 説明 Default
description string 応答形式の目的の説明。その形式で応答する方法を決定するためにモデルによって使用されます。

name

名前 種類 説明 Default
name string 応答形式の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。

schema

名前 種類 説明 Default
schema ResponseFormatJsonSchemaSchema JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。

厳密

名前 種類 説明 Default
厳密 boolean 出力の生成時に厳格なスキーマの準拠を有効にするかどうか。 true に設定すると、モデルは schema フィールドで定義されている正確なスキーマに常に従います。 strict が true の場合、JSON スキーマのサブセットのみがサポートされます。 False

chatCompletionChoiceCommon

名前 種類 内容 必要 Default
インデックス integer いいえ
finish_reason string いいえ

createTranslationRequest

翻訳要求。

名前 種類 内容 必要 Default
file string 翻訳するオーディオ ファイル。 はい
プロンプト string モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトは英語にする必要があります。 いいえ
応答形式 audioResponseFormat 出力の形式を定義します。 いいえ
温度 数値 0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルはログ確率を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。 いいえ 0

audioResponse

response_format が json のときの翻訳または文字起こしの応答

名前 種類 内容 必要 Default
text string 翻訳または文字起こしされたテキスト。 はい

audioVerboseResponse

response_format が verbose_json のときの翻訳または文字起こしの応答

名前 種類 内容 必要 Default
text string 翻訳または文字起こしされたテキスト。 はい
タスク string オーディオ タスクの種類。 いいえ
言語 string 言語。 いいえ
duration 数値 期間. いいえ
セグメント 配列 いいえ
単語 配列 いいえ

audioResponseFormat

出力の形式を定義します。

説明: 出力の形式を定義します。

型: string

既定:

列挙値:

  • json
  • text
  • srt
  • verbose_json
  • vtt

createTranscriptionRequest

文字起こし要求。

名前 種類 内容 必要 Default
file string 文字起こしするオーディオ ファイル オブジェクト。 はい
プロンプト string モデルのスタイルをガイドしたり、前のオーディオ セグメントを続行したりするための省略可能なテキスト。 プロンプトはオーディオ言語と一致する必要があります。 いいえ
応答形式 audioResponseFormat 出力の形式を定義します。 いいえ
温度 数値 0 から 1 の間のサンプリング温度。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。 0 に設定すると、モデルはログ確率を使用して、特定のしきい値に達するまで温度を自動的に上昇させます。 いいえ 0
言語 string 入力オーディオの言語。 入力言語を ISO-639-1 形式で提供すると、精度と待機時間が向上します。 いいえ
timestamp_granularities[] 配列 この文字起こしに入力するタイムスタンプの詳細度。 タイムスタンプの詳細度を使用するには response_format を verbose_json に設定する必要があります。 オプションの word と segment は一方または両方がサポートされます。 注: セグメント タイムスタンプに追加の待ち時間はありませんが、単語のタイムスタンプを生成すると追加の待ち時間が発生します。 いいえ ['segment']

audioSegment

文字起こしまたは翻訳セグメント。

名前 種類 内容 必要 Default
ID integer セグメント識別子。 いいえ
seek 数値 セグメントのオフセット。 いいえ
start 数値 セグメントの開始オフセット。 いいえ
end 数値 セグメントの終了オフセット。 いいえ
text string セグメントのテキスト。 いいえ
トークン 配列 テキストのトークン。 いいえ
温度 数値 温度。 いいえ
avg_logprob 数値 平均ログ確率。 いいえ
compression_ratio 数値 圧縮率。 いいえ
no_speech_prob 数値 "音声なし" の確率。 いいえ

audioWord

文字起こしまたは翻訳語。

名前 種類 内容 必要 Default
word string Word いいえ
start 数値 語の開始オフセット。 いいえ
end 数値 語の終了オフセット。 いいえ

createSpeechRequest

音声要求。

名前 種類 内容 必要 Default
input string オーディオを合成する対象のテキスト。 最大長は 4096 文字です。 はい
voice enum 音声合成に使用する音声。
使用可能な値: alloy、echo、fable、onyx、nova、shimmer		 はい
応答形式 enum オーディオを合成する形式。
使用可能な値: mp3、opus、aac、flac、wav、pcm		 いいえ
速度 数値 合成されたオーディオの速度。 0.25 から 4.0 の間の値を選択してください。 1.0 は既定値です。 いいえ 1.0

imageQuality

生成されるイメージの品質。

説明: 生成される画像の品質。

型: string

既定値: standard

列挙型名: Quality

列挙値:

Value 説明
standard 標準品質の場合、標準品質の画像が作成されます。
hd HD 品質の場合、よりきめ細かく、全体の一貫性が高い画像が作成されます。

imagesResponseFormat

生成された画像が返される形式です。

説明: 生成された画像が返される形式です。

型: string

既定値: URL

列挙型名: ImagesResponseFormat

列挙値:

Value 説明
URL 生成された画像をダウンロードするための一時的なアクセスを提供する URL。
b64_json 生成された画像は base64 でエンコードされた文字列として返されます。

imageSize

生成されたイメージのサイズ。

説明: 生成される画像のサイズ。

型: string

既定値: 1024x1024

列挙型名: Size

列挙値:

Value 説明
256 x 256 生成される画像の目的のサイズは 256x256 ピクセルです。 dall-e-2 でのみサポートされます。
512 x 512 生成される画像の目的のサイズは 512x512 ピクセルです。 dall-e-2 でのみサポートされます。
1792x1024 生成される画像の目的のサイズは 1792x1024 ピクセルです。 dall-e-3 でのみサポートされます。
1024x1792 生成される画像の目的のサイズは 1024x1792 ピクセルです。 dall-e-3 でのみサポートされます。
1,024 x 1,024 生成される画像の目的のサイズは 1024x1024 ピクセルです。

imageStyle

生成されたイメージのスタイル。

説明: 生成される画像のスタイル。

型: string

既定値: vivid

列挙型名: Style

列挙値:

Value 説明
vivid vivid の場合、超現実的で劇的な画像が作成されます。
natural natural の場合、より自然で、あまり超現実的ではない画像が作成されます。

imageGenerationsRequest

名前 種類 内容 必要 Default
prompt string 目的のイメージのテキストの説明。 最大長は 4000 文字です。 はい
n integer 生成するイメージの数。 いいえ 1
size imageSize 生成されたイメージのサイズ。 いいえ 1,024 x 1,024
応答形式 imagesResponseFormat 生成された画像が返される形式です。 いいえ URL
ユーザー string エンド ユーザーを表す一意の識別子。これは不正使用を監視および検出するのに役立ちます。 いいえ
品質 imageQuality 生成されるイメージの品質。 いいえ standard
スタイル imageStyle 生成されたイメージのスタイル。 いいえ vivid

generateImagesResponse

名前 種類 内容 必要 Default
作成済 integer 操作が作成されたときの UNIX タイムスタンプ。 はい
data 配列 操作が成功した場合の結果データ はい

imageResult

成功した場合は画像の URL またはエンコードされた画像、それ以外の場合はエラー。

名前 種類 内容 必要 Default
URL string 画像の URL。 いいえ
b64_json string base64 でエンコードされた画像 いいえ
content_filter_results dalleContentFilterResults コンテンツ フィルタリングの結果に関する情報。 いいえ
revised_prompt string イメージの生成に使用されたプロンプト (プロンプトにリビジョンがある場合)。 いいえ
prompt_filter_results dalleFilterResults コンテンツ フィルタリング カテゴリ (hate、sexual、violence、self_harm) に関する情報、それが検出されたかどうか、および重大度レベル (有害なコンテンツの強さとリスク レベルを決定する very_low、low、medium、high-scale) とそれがフィルター処理されたかどうか。 脱獄コンテンツと不適切な表現に関する情報、それが検出されたかどうか、およびそれがフィルター処理されたかどうか。 また、顧客のブロックリストに関する情報、それがフィルター処理されたかどうかとその ID。 いいえ

line

隣接するコンテンツ要素のシーケンス (単語や選択記号など) で構成されるコンテンツ行オブジェクトです。

名前 種類 内容 必要 Default
text string はい
スパン 配列 検出されたオブジェクトとその境界ボックス情報を表すスパンの配列。 はい

スパン

検出されたオブジェクトとその境界ボックス情報を表すスパン オブジェクト。

名前 種類 内容 必要 Default
text string 検出されたオブジェクトを表すスパンのテキスト コンテンツ。 はい
オフセット integer テキスト内でスパンが開始する文字オフセット。 このオフセットはスパンの最初の文字の位置として定義され、テキストの先頭から Unicode コードポイントとしてカウントされます。 はい
length integer Unicode コードポイントで測定されたスパンの長さ (文字単位)。 はい
多角形 配列 検出されたオブジェクトを囲む多角形の点を表すオブジェクトの配列。 はい

runCompletionUsage

実行に関連する使用状況の統計。 この値は実行が終了状態でない場合 (つまり in_progress、queued など) は null になります。

名前 種類 内容 必要 Default
completion_tokens integer 実行の過程で使用される入力候補トークンの数。 はい
prompt_tokens integer 実行の過程で使用されるプロンプト トークンの数。 はい
total_tokens integer 使われたトークンの合計数 (プロンプトと入力候補の和)。 はい

runStepCompletionUsage

実行ステップに関連する使用状況の統計。 この値は、実行ステップの状態が in_progress の間は null になります。

名前 種類 内容 必要 Default
completion_tokens integer 実行ステップの過程で使用される入力候補トークンの数。 はい
prompt_tokens integer 実行ステップの過程で使用されるプロンプト トークンの数。 はい
total_tokens integer 使われたトークンの合計数 (プロンプトと入力候補の和)。 はい

assistantsApiResponseFormatOption

モデルから出力する必要がある形式を指定します。 GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。

このコンポーネントには、次のいずれかを指定できます。

assistantsApiResponseFormat

モデルの予想される出力を記述するオブジェクト。 json_object の場合、種類 tools の function のみを実行に渡すことができます。 text 場合、モデルはテキストまたは必要な任意の値を返すことができます。

名前 種類 内容 必要 Default
type string text または json_object のいずれかである必要があります。 いいえ text

type の列挙型: AssistantsApiResponseFormat

Value 説明
text
json_object

assistantObject

モデルを呼び出し、ツールを使用できる assistant を表します。

名前 種類 内容 必要 Default
ID string API エンドポイントで参照できる識別子。 はい
オブジェクト string オブジェクトの種類。これは常に assistant です。 はい
created_at integer アシスタントが作成されたときの Unix タイムスタンプ (秒単位)。 はい
名前 string アシスタントの名前。 最大長は 256 文字です。
 はい
説明 string アシスタントの説明。 最大長は 512 文字です。
 はい
モデル string 使用するモデルの ID。 モデルの一覧表示 API を使用して、使用可能なすべてのモデルを表示できます。
 はい
instructions string アシスタントが使うシステムの指示。 最大長は 256,000 文字です。
 はい
tools 配列 アシスタントで有効になっているツールのリスト。 アシスタントごとに最大 128 個のツールを使用できます。 ツールの種類には、code_interpreter、file_search、または function があります。
 はい []
tool_resources オブジェクト アシスタントのツールによって使用されるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 はい
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を含むトークンのみが考慮されることを意味します。

一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
応答形式 assistantsApiResponseFormatOption モデルから出力する必要がある形式を指定します。 GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 いいえ

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID の一覧。 このツールには最大 20 個のファイルを関連付けることができます。
 []

file_search

名前 種類 説明 Default
vector_store_ids 配列 このアシスタントにアタッチされているベクター ストアの ID。 アシスタントには、最大 1 つのベクター ストアをアタッチできます。

object の列挙型: AssistantObjectType

Value 説明
assistant オブジェクトの種類。これは常に assistant です

createAssistantRequest

名前 種類 内容 必要 Default
モデル はい
名前 string アシスタントの名前。 最大長は 256 文字です。
 いいえ
description string アシスタントの説明。 最大長は 512 文字です。
 いいえ
instructions string アシスタントが使うシステムの指示。 最大長は 256,000 文字です。
 いいえ
tools 配列 アシスタントで有効になっているツールのリスト。 アシスタントごとに最大 128 個のツールを使用できます。 ツールの種類には、code_interpreter、retrieval、または function があります。
 いいえ []
tool_resources オブジェクト アシスタントのツールによって使用されるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を含むトークンのみが考慮されることを意味します。

一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
応答形式 assistantsApiResponseFormatOption モデルから出力する必要がある形式を指定します。 GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 いいえ

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID の一覧。 このツールには最大 20 個のファイルを関連付けることができます。
 []

file_search

名前 種類 説明 Default
vector_store_ids 配列 このアシスタントにアタッチされているベクター ストア。 アシスタントには、最大 1 つのベクター ストアをアタッチできます。
vector_stores 配列 file_ids を使用してベクター ストアを作成し、このアシスタントにアタッチするヘルパー。 アシスタントには、最大 1 つのベクター ストアをアタッチできます。

modifyAssistantRequest

名前 種類 内容 必要 Default
モデル いいえ
name string アシスタントの名前。 最大長は 256 文字です。
 いいえ
description string アシスタントの説明。 最大長は 512 文字です。
 いいえ
instructions string アシスタントが使うシステムの指示。 最大長は 32,768 文字です。
 いいえ
tools 配列 アシスタントで有効になっているツールのリスト。 アシスタントごとに最大 128 個のツールを使用できます。 ツールの種類には、code_interpreter、retrieval、または function があります。
 いいえ []
tool_resources オブジェクト アシスタントのツールによって使用されるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を含むトークンのみが考慮されることを意味します。

一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
応答形式 assistantsApiResponseFormatOption モデルから出力する必要がある形式を指定します。 GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 いいえ

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID をオーバーライドします。 このツールには最大 20 個のファイルを関連付けることができます。
 []

file_search

名前 種類 説明 Default
vector_store_ids 配列 このアシスタントにアタッチされているベクター ストアをオーバーライドします。 アシスタントには、最大 1 つのベクター ストアをアタッチできます。

deleteAssistantResponse

名前 種類 内容 必要 Default
ID string はい
deleted boolean はい
オブジェクト string はい

object の列挙型: DeleteAssistantResponseState

Value 説明
assistant.deleted

listAssistantsResponse

名前 種類 内容 必要 Default
オブジェクト string はい
data 配列 はい
first_id string はい
last_id string はい
has_more boolean はい

assistantToolsCode

名前 種類 内容 必要 Default
type string 定義されるツールの種類: code_interpreter はい

type の列挙型: assistantToolsCodeType

Value 説明
code_interpreter

assistantToolsFileSearch

名前 種類 内容 必要 Default
type string 定義されるツールの種類: file_search はい
file_search オブジェクト ファイル検索ツールのオーバーライド。 いいえ

max_num_results

名前 種類 説明 Default
max_num_results integer ファイル検索ツールが出力する結果の最大数。 既定値は、gpt-4* モデルでは 20、gpt-3.5-turbo では 5 です。 この数値は 1 から 50 までの数にする必要があります (1 と 50 も含まれます)。

ファイル検索ツールの出力が、max_num_results 個の結果よりも少ない場合があることに注意してください。

type の列挙型: assistantToolsFileSearchType

Value 説明
file_search

assistantToolsFileSearchTypeOnly

名前 種類 内容 必要 Default
type string 定義されるツールの種類: file_search はい

type の列挙型: assistantToolsFileSearchType

Value 説明
file_search

assistantToolsFunction

名前 種類 内容 必要 Default
type string 定義されるツールの種類: function はい
関数 オブジェクト 関数の定義。 はい

function のプロパティ

description

件名 種類 説明 Default
description string モデルが関数をいつどのように呼び出すかを選ぶために使われる、関数の動作の説明。

name

名前 種類 説明 Default
name string 呼び出される関数の名前。 a-z、A-Z、0-9 を使用するか、アンダースコアとダッシュを含める必要があります。最大長は 64 です。

parameters

件名 種類 説明 Default
parameters chatCompletionFunctionParameters 関数が受け取るパラメーター。JSON スキーマ オブジェクトとして記述されます。 例についてはこちらのガイドを参照してください。形式に関するドキュメントについては JSON スキーマのリファレンスを参照してください。

type の列挙型: assistantToolsFunction

Value 説明
関数

truncationObject

実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。

名前 種類 内容 必要 Default
type string スレッドに使用する切り捨て戦略。 既定値は、auto です。 last_messages に設定すると、スレッドはスレッド内の n 個までの最新のメッセージを残して切り捨てられます。 auto に設定すると、スレッドの途中にあるメッセージが、モデルのコンテキスト長 max_prompt_tokens に合わせて削除されます。 はい
last_messages integer 実行のコンテキストを構築するときのスレッドからの最新のメッセージの数。 いいえ

type の列挙型: TruncationType

Value 説明
auto
last_messages

assistantsApiToolChoiceOption

モデルによって呼び出されるツールを制御します (ある場合)。 none は、モデルでツールが呼び出されず、代わりにメッセージが生成されることを意味します。 auto は既定値であり、モデルがメッセージの生成またはツールの呼び出しを選択できることを意味します。 {"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。

このコンポーネントには、次のいずれかを指定できます。

assistantsNamedToolChoice

モデルで使用する必要があるツールを指定します。 モデルで特定のツールを強制的に呼び出すために使用します。

名前 種類 内容 必要 Default
type string ツールの型。 種類が function の場合は、関数名を設定する必要があります はい
関数 object いいえ

function のプロパティ

name

名前 種類 説明 Default
name string 呼び出す関数の名前。

type の列挙型: AssistantsNamedToolChoiceType

Value 説明
関数
code_interpreter
file_search

runObject

スレッド上で実行される実行を表します。

名前 種類 内容 必要 Default
ID string API エンドポイントで参照できる識別子。 はい
オブジェクト string オブジェクトの種類。これは常に thread.run です。 はい
created_at integer 実行が作成されたときの Unix タイムスタンプ (秒単位)。 はい
thread_id string この実行の一部として実行されたスレッドの ID。 はい
assistant_id string この実行が実行される際に使われるアシスタントの ID。 はい
状態 string 実行の状態。queued、in_progress、requires_action、cancelling、cancelled、failed、completed、または expired のいずれか。 はい
required_action オブジェクト 実行を続行するために必要なアクションの詳細。 アクションが必要ない場合は null になります。 はい
last_error オブジェクト この実行に関連付けられた最後のエラー。 エラーがない場合は null になります。 はい
expires_at integer 実行が期限切れになるときの Unix タイムスタンプ (秒単位)。 はい
started_at integer 実行が開始されたときの Unix タイムスタンプ (秒単位)。 はい
cancelled_at integer 実行が取り消されたときの Unix タイムスタンプ (秒単位)。 はい
failed_at integer 実行が失敗したときの Unix タイムスタンプ (秒単位)。 はい
completed_at integer 実行が完了したときの Unix タイムスタンプ (秒単位)。 はい
incomplete_details オブジェクト 実行が不完全である理由の詳細。 実行が不完全でない場合は null になります。 はい
モデル string アシスタントがこの実行に使ったモデル。 はい
instructions string アシスタントがこの実行に使った手順。 はい
tools 配列 アシスタントがこの実行に使ったツールのリスト。 はい []
metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 はい
使用量 runCompletionUsage 実行に関連する使用状況の統計。 この値は実行が終了状態でない場合 (つまり in_progress、queued など) は null になります。 はい
温度 数値 この実行に使用されるサンプリング温度。 設定しない場合、既定値は 1 です。 いいえ
top_p 数値 この実行に使用される核サンプリング値。 設定しない場合、既定値は 1 です。 いいえ
max_prompt_tokens integer 実行の過程で使用されるように指定されたプロンプト トークンの最大数。
 はい
max_completion_tokens integer 実行の過程で使用されるように指定された入力候補トークンの最大数。
 はい
truncation_strategy truncationObject 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 はい
tool_choice assistantsApiToolChoiceOption モデルによって呼び出されるツールを制御します (ある場合)。
none は、モデルでツールが呼び出されず、代わりにメッセージが生成されることを意味します。
auto は既定値であり、モデルがメッセージの生成またはツールの呼び出しを選択できることを意味します。
{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。
 はい
parallel_tool_calls ParallelToolCalls ツールの使用中に並列関数の呼び出しを有効にするかどうか。 いいえ True
応答形式 assistantsApiResponseFormatOption モデルから出力する必要がある形式を指定します。 GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 はい

required_action のプロパティ

type

名前 種類 説明 Default
type string 現時点では、これは常に submit_tool_outputs です。

submit_tool_outputs

名前 種類 説明 Default
tool_calls 配列 関連するツール呼び出しの一覧。

last_error のプロパティ

code

名前 種類 説明 Default
code string server_error、rate_limit_exceeded のいずれか。

メッセージ

名前 種類 説明 Default
message string 人が判読できるエラーの説明。

incomplete_details のプロパティ

reason

名前 種類 説明 Default
reason string 実行が不完全である理由。 これは、実行の過程で達した特定のトークン制限を指します。

object の列挙型: runObjectType

Value 説明
thread.run 実行オブジェクトの種類。常に thread.run です

status の列挙型: RunObjectStatus

Value 説明
キュー登録済み キューに登録済みの状態
in_progress 進行中の状態
requires_action アクションが必要な状態
cancelling キャンセル中の状態
キャンセル済み キャンセル済みの状態
失敗 失敗した状態
completed 完了した状態
期限切れ 期限切れの状態

createRunRequest

名前 種類 内容 必要 Default
assistant_id string この実行を実行するために使われるアシスタントの ID。 はい
モデル string この実行を実行するために使われるモデルのデプロイ ID。 ここで値を指定すると、アシスタントに関連付けられたモデルがオーバーライドされます。 指定しない場合は、アシスタントに関連付けられたモデルが使われます。 いいえ
instructions string アシスタントの既定のシステム メッセージをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 いいえ
additional_instructions string 実行の手順の最後に追加の手順を追加します。 これは、他の手順をオーバーライドすることなく、実行ごとに動作を変更する場合に役立ちます。 いいえ
additional_messages 配列 実行を作成する前に、スレッドにメッセージを追加します。 いいえ
tools 配列 アシスタントがこの実行に使用できるツールをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を含むトークンのみが考慮されることを意味します。

一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
stream boolean true の場合は、サーバー送信イベントとして実行中に発生したイベントのストリームを返します。実行が終了状態になると、data: [DONE] メッセージが表示されて終了します。
 いいえ
max_prompt_tokens integer 実行の過程で使用される可能性があるプロンプト トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数のプロンプト トークンのみを使用しようとします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。
 いいえ
max_completion_tokens integer 実行の過程で使用される可能性がある入力候補トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数の入力候補トークンのみを使用しようとします。 実行が指定された入力候補トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。
 いいえ
truncation_strategy truncationObject 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 いいえ
tool_choice assistantsApiToolChoiceOption モデルによって呼び出されるツールを制御します (ある場合)。
none は、モデルでツールが呼び出されず、代わりにメッセージが生成されることを意味します。
auto は既定値であり、モデルがメッセージの生成またはツールの呼び出しを選択できることを意味します。
{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。
 いいえ
parallel_tool_calls ParallelToolCalls ツールの使用中に並列関数の呼び出しを有効にするかどうか。 いいえ True
応答形式 assistantsApiResponseFormatOption モデルから出力する必要がある形式を指定します。 GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 いいえ

listRunsResponse

名前 種類 内容 必要 Default
オブジェクト string はい
data 配列 はい
first_id string はい
last_id string はい
has_more boolean はい

modifyRunRequest

名前 種類 内容 必要 Default
metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

submitToolOutputsRunRequest

名前 種類 内容 必要 Default
tool_outputs 配列 出力が送信されるツールのリスト。 はい
stream boolean true の場合は、サーバー送信イベントとして実行中に発生したイベントのストリームを返します。実行が終了状態になると、data: [DONE] メッセージが表示されて終了します。
 いいえ

runToolCallObject

ツール呼び出しオブジェクト

名前 種類 内容 必要 Default
ID string ツール呼び出しの ID。 この ID は、ツールの出力を実行に送信するエンドポイントを使用してツールの出力を送信するときに参照する必要があります。 はい
type string 出力が必要なツール呼び出しの種類。 現時点では、これは常に function です。 はい
関数 オブジェクト 関数の定義。 はい

function のプロパティ

name

名前 種類 説明 Default
name string 関数の名前です。

arguments

名前 種類 説明 Default
引数 string モデルが関数に渡すことを予期する引数。

type の列挙型: RunToolCallObjectType

Value 説明
関数

createThreadAndRunRequest

名前 種類 内容 必要 Default
assistant_id string この実行を実行するために使われるアシスタントの ID。 はい
スレッド createThreadRequest いいえ
モデル string この実行を実行するために使われるモデルのデプロイ名。 ここで値を指定すると、アシスタントに関連付けられたモデルがオーバーライドされます。 指定しない場合は、アシスタントに関連付けられたモデルが使われます。 いいえ
instructions string アシスタントの既定のシステム メッセージをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 いいえ
tools 配列 アシスタントがこの実行に使用できるツールをオーバーライドします。 これは、実行ごとに動作を変更する場合に役立ちます。 いいえ
tool_resources オブジェクト アシスタントのツールによって使用されるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ
温度 数値 使用するサンプリング温度 (0 から 2)。 0.8 のような大きい値にすると、出力はよりランダムになり、0.2 のような小さい値にすると、出力はより集中的および決定論的になります。
 いいえ 1
top_p 数値 温度によるサンプリングに代わる核サンプリングと呼ばれるもので、モデルは top_p の確率質量を持つトークンの結果を考慮します。 したがって、0.1 は、上位 10% の確率質量を含むトークンのみが考慮されることを意味します。

一般的に、これと temperature の両方ではなく、いずれかを変更することをお勧めします。
 いいえ 1
stream boolean true の場合は、サーバー送信イベントとして実行中に発生したイベントのストリームを返します。実行が終了状態になると、data: [DONE] メッセージが表示されて終了します。
 いいえ
stream_options chatCompletionStreamOptions ストリーミング応答のオプション。 stream: true に設定した場合はこれのみを設定します。
 いいえ なし
max_prompt_tokens integer 実行の過程で使用される可能性があるプロンプト トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数のプロンプト トークンのみを使用しようとします。 実行が指定されたプロンプト トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。
 いいえ
max_completion_tokens integer 実行の過程で使用される可能性がある入力候補トークンの最大数。 実行はベスト エフォート型で、実行の複数のターンにわたって、指定された数の入力候補トークンのみを使用しようとします。 実行が指定された入力候補トークンの数を超えると、実行は状態 incomplete で終了します。 詳細については、incomplete_details を参照してください。
 いいえ
truncation_strategy truncationObject 実行前にスレッドを切り捨てる方法を制御します。 これを使用して、実行の初期コンテキスト ウィンドウを制御します。 いいえ
tool_choice assistantsApiToolChoiceOption モデルによって呼び出されるツールを制御します (ある場合)。
none は、モデルでツールが呼び出されず、代わりにメッセージが生成されることを意味します。
auto は既定値であり、モデルがメッセージの生成またはツールの呼び出しを選択できることを意味します。
{"type": "file_search"} や {"type": "function", "function": {"name": "my_function"}} などの特定のツールを指定すると、モデルでそのツールの呼び出しが強制されます。
 いいえ
parallel_tool_calls ParallelToolCalls ツールの使用中に並列関数の呼び出しを有効にするかどうか。 いいえ True
応答形式 assistantsApiResponseFormatOption モデルから出力する必要がある形式を指定します。 GPT-4 Turbo、および gpt-3.5-turbo-1106 以降のすべての GPT-3.5 Turbo モデルと互換性があります。

{ "type": "json_object" } に設定すると、JSON モードが有効になります。これにより、モデルが生成するメッセージが有効な JSON であることが保証されます。

重要: JSON モードを使うときは、システムまたはユーザー メッセージ経由で、JSON を生成するようにユーザー自身がモデルに指示することも必要です。 これがないと、トークンの上限に達するまで、モデルはいつまでも空白のストリームを生成する可能性があります。その結果、実行時間が長く、一見 "止まっている" ように見える要求が発生します。 また、finish_reason="length" の場合、メッセージの内容が部分的に切り取られる可能性があります。これは、世代が max_tokens を超えたか、会話がコンテキストの最大長を超えたことを示します。
 いいえ

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID の一覧。 このツールには最大 20 個のファイルを関連付けることができます。
 []

file_search

名前 種類 説明 Default
vector_store_ids 配列 このアシスタントにアタッチされているベクター ストアの ID。 アシスタントには、最大 1 つのベクター ストアをアタッチできます。

threadObject

メッセージを含むスレッドを表します。

名前 種類 内容 必要 Default
ID string API エンドポイントで参照できる識別子。 はい
オブジェクト string オブジェクトの種類。これは常に thread です。 はい
created_at integer スレッドが作成されたときの Unix タイムスタンプ (秒単位)。 はい
tool_resources オブジェクト このスレッドでアシスタントのツールが使用できるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 はい
metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 はい

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID の一覧。 このツールには最大 20 個のファイルを関連付けることができます。
 []

file_search

名前 種類 説明 Default
vector_store_ids 配列 このスレッドにアタッチされているベクター ストア。 スレッドには、最大 1 つのベクター ストアをアタッチできます。

object の列挙型: ThreadObjectType

Value 説明
スレッド スレッド オブジェクトの型。常に thread です

createThreadRequest

名前 種類 内容 必要 Default
messages 配列 スレッドを開始するメッセージの一覧。 いいえ
tool_resources オブジェクト このスレッドでアシスタントのツールが使用できるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID の一覧。 このツールには最大 20 個のファイルを関連付けることができます。
 []

file_search

名前 種類 説明 Default
vector_store_ids 配列 このスレッドにアタッチされているベクター ストア。 スレッドには、最大 1 つのベクター ストアをアタッチできます。
vector_stores 配列 file_ids を使用してベクター ストアを作成し、このスレッドにアタッチするヘルパー。 スレッドには、最大 1 つのベクター ストアをアタッチできます。

modifyThreadRequest

名前 種類 内容 必要 Default
tool_resources オブジェクト このスレッドでアシスタントのツールが使用できるリソースのセット。 リソースは、ツールの種類に固有です。 たとえば、code_interpreter ツールにはファイル ID の一覧が必要ですが、file_search ツールにはベクター ストア ID の一覧が必要です。
 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

tool_resources のプロパティ

code_interpreter

名前 種類 説明 Default
file_ids 配列 code_interpreter ツールで使用できるファイル ID の一覧。 このツールには最大 20 個のファイルを関連付けることができます。
 []

file_search

名前 種類 説明 Default
vector_store_ids 配列 このスレッドにアタッチされているベクター ストア。 スレッドには、最大 1 つのベクター ストアをアタッチできます。

deleteThreadResponse

名前 種類 内容 必要 Default
ID string はい
deleted boolean はい
オブジェクト string はい

object の列挙型: DeleteThreadResponseObjectState

Value 説明
thread.deleted スレッド削除応答オブジェクトの状態。thread.deleted です

listThreadsResponse

名前 種類 内容 必要 Default
オブジェクト string はい
data 配列 はい
first_id string はい
last_id string はい
has_more boolean はい

messageObject

スレッド内のメッセージを表します。

名前 種類 内容 必要 Default
ID string API エンドポイントで参照できる識別子。 はい
オブジェクト string オブジェクトの種類。これは常に thread.message です。 はい
created_at integer メッセージが作成されたときの Unix タイムスタンプ (秒単位)。 はい
thread_id string このメッセージが属しているスレッド ID。 はい
状態 string メッセージの状態。in_progress、incomplete、または completed のいずれかを指定できます。 はい
incomplete_details オブジェクト 不完全なメッセージについては、メッセージが不完全である理由について詳しく説明します。 はい
completed_at integer メッセージが完了したときの Unix タイムスタンプ (秒単位)。 はい
incomplete_at integer メッセージに不完全のマークが付けられたときの Unix タイムスタンプ (秒単位)。 はい
role string メッセージを生成したエンティティ。 user、assistant のいずれか。 はい
content 配列 テキストや画像の配列内のメッセージの内容。 はい
assistant_id string 該当する場合は、このメッセージを作成したアシスタントの ID。 はい
run_id string 該当する場合は、このメッセージの作成に関連付けられた実行の ID。 はい
添付ファイル 配列 メッセージに添付されているファイルと、追加されたツールの一覧。 はい
metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 はい

incomplete_details のプロパティ

reason

名前 種類 説明 Default
reason string メッセージが不完全である理由。

object の列挙型: MessageObjectType

Value 説明
thread.message メッセージ オブジェクトの種類。これは thread.message です

status の列挙型: MessageObjectStatus

Value 説明
in_progress
incomplete
completed

role の列挙型: MessageObjectRole

Value 説明
ユーザー
assistant

messageDeltaObject

メッセージの差分、つまりストリーミング中に変更されたメッセージのフィールドを表します。

名前 種類 内容 必要 Default
ID string メッセージの識別子。API エンドポイントで参照できます。 はい
オブジェクト string オブジェクトの種類。これは常に thread.message.delta です。 はい
delta オブジェクト メッセージ上で変更されたフィールドを含む差分。 はい

delta のプロパティ

role

名前 種類 説明 Default
role string メッセージを生成したエンティティ。 user、assistant のいずれか。

content

名前 種類 説明 Default
content 配列 テキストや画像の配列内のメッセージの内容。

object の列挙型: MessageDeltaObjectType

Value 説明
thread.message.delta

createMessageRequest

名前 種類 内容 必要 Default
role string メッセージを作成しているエンティティのロール。 使用できる値は、以下のとおりです。
- user: メッセージは実際のユーザーが送信したものであることを示します。ユーザーが作成したメッセージを表すために、ほとんどの場合に使用する必要があります。
- assistant: メッセージはアシスタントが生成したものであることを示します。 この値を使用して、アシスタントからのメッセージを会話に挿入します。
 はい
コンテンツ string メッセージのコンテンツ。 はい
添付ファイル 配列 メッセージに添付されているファイルと、追加先にする必要があるツールの一覧。 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

role の列挙型: CreateMessageRequestRole

Value 説明
ユーザー
assistant

modifyMessageRequest

名前 種類 内容 必要 Default
metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

deleteMessageResponse

名前 種類 内容 必要 Default
ID string はい
deleted boolean はい
オブジェクト string はい

object の列挙型: DeleteMessageResponseObject

Value 説明
thread.message.deleted 削除メッセージ応答オブジェクトの状態

listMessagesResponse

名前 種類 内容 必要 Default
オブジェクト string はい
data 配列 はい
first_id string はい
last_id string はい
has_more boolean はい

messageContentImageFileObject

メッセージのコンテンツ内の画像ファイルを参照します。

名前 種類 内容 必要 Default
type string 常に image_file。 はい
image_file オブジェクト はい

image_file のプロパティ

file_id

名前 種類 説明 Default
file_id string メッセージ コンテンツ内の画像のファイル ID。

type の列挙型: MessageContentImageFileObjectType

Value 説明
image_file メッセージ コンテンツの画像ファイルの種類

messageContentTextObject

メッセージの一部であるテキスト コンテンツ。

名前 種類 内容 必要 Default
type string 常に text。 はい
text オブジェクト はい

text のプロパティ

値

名前 種類 説明 Default
値 string テキストを構成するデータ。

annotations

名前 種類 説明 Default
注釈 配列

type の列挙型: messageContentTextObjectType

Value 説明
text メッセージ コンテンツのテキスト オブジェクトの種類

messageContentTextAnnotationsFileCitationObject

アシスタントまたはメッセージに関連付けられている特定のファイルからの特定の引用を指すメッセージ内の引用。 アシスタントが "取得" ツールを使用してファイルを検索するときに生成されます。

名前 種類 内容 必要 Default
type string 常に file_citation。 はい
text string 置き換える必要があるメッセージ コンテンツ内のテキスト。 はい
file_citation オブジェクト はい
start_index integer はい
end_index integer はい

file_citation のプロパティ

file_id

名前 種類 説明 Default
file_id string 引用元の特定のファイルの ID。

type の列挙型: FileCitationObjectType

Value 説明
file_citation ファイル引用オブジェクトの種類

messageContentTextAnnotationsFilePathObject

アシスタントが code_interpreter ツールを使用してファイルを生成したときに生成されたファイルの URL。

名前 種類 内容 必要 Default
type string 常に file_path。 はい
text string 置き換える必要があるメッセージ コンテンツ内のテキスト。 はい
file_path オブジェクト はい
start_index integer はい
end_index integer はい

file_path のプロパティ

file_id

名前 種類 説明 Default
file_id string 生成されたファイルの ID。

type の列挙型: FilePathObjectType

Value 説明
file_path ファイル パス オブジェクトの種類

messageDeltaContentImageFileObject

メッセージのコンテンツ内の画像ファイルを参照します。

名前 種類 内容 必要 Default
インデックス integer メッセージ内のコンテンツ パーツのインデックス。 はい
type string 常に image_file。 はい
image_file object いいえ

image_file のプロパティ

file_id

名前 種類 説明 Default
file_id string メッセージ コンテンツ内の画像のファイル ID。

type の列挙型: MessageDeltaContentImageFileObjectType

Value 説明
image_file

messageDeltaContentTextObject

メッセージの一部であるテキスト コンテンツ。

名前 種類 内容 必要 Default
インデックス integer メッセージ内のコンテンツ パーツのインデックス。 はい
type string 常に text。 はい
text object いいえ

text のプロパティ

値

名前 種類 説明 Default
値 string テキストを構成するデータ。

annotations

名前 種類 説明 Default
注釈 配列

type の列挙型: MessageDeltaContentTextObjectType

Value 説明
text

messageDeltaContentTextAnnotationsFileCitationObject

アシスタントまたはメッセージに関連付けられている特定のファイルからの特定の引用を指すメッセージ内の引用。 アシスタントが "file_search" ツールを使用してファイルを検索するときに生成されます。

名前 種類 内容 必要 Default
インデックス integer テキスト コンテンツ パーツ内の注釈のインデックス。 はい
type string 常に file_citation。 はい
text string 置き換える必要があるメッセージ コンテンツ内のテキスト。 いいえ
file_citation object いいえ
start_index integer いいえ
end_index integer いいえ

file_citation のプロパティ

file_id

名前 種類 説明 Default
file_id string 引用元の特定のファイルの ID。

quote

名前 種類 説明 Default
quote string ファイル内の特定の引用。

type の列挙型: MessageDeltaContentTextAnnotationsFileCitationObjectType

Value 説明
file_citation

messageDeltaContentTextAnnotationsFilePathObject

アシスタントが code_interpreter ツールを使用してファイルを生成したときに生成されたファイルの URL。

名前 種類 内容 必要 Default
インデックス integer テキスト コンテンツ パーツ内の注釈のインデックス。 はい
type string 常に file_path。 はい
text string 置き換える必要があるメッセージ コンテンツ内のテキスト。 いいえ
file_path object いいえ
start_index integer いいえ
end_index integer いいえ

file_path のプロパティ

file_id

名前 種類 説明 Default
file_id string 生成されたファイルの ID。

type の列挙型: MessageDeltaContentTextAnnotationsFilePathObjectType

Value 説明
file_path

runStepObject

実行の実行中のステップを表します。

名前 種類 内容 必要 Default
ID string 実行ステップの識別子。API エンドポイントで参照できます。 はい
オブジェクト string オブジェクトの種類。これは常に assistant.run.step です。 はい
created_at integer 実行ステップが作成されたときの Unix タイムスタンプ (秒単位)。 はい
assistant_id string 実行ステップに関連付けられたアシスタントの ID。 はい
thread_id string 実行されたスレッドの ID。 はい
run_id string この実行ステップが含まれる実行の ID。 はい
type string 実行ステップの種類。message_creation または tool_calls を指定できます。 はい
状態 string 実行の状態。in_progress、cancelled、failed、completed、または expired を指定できます。 はい
step_details runStepDetailsMessageCreationObject または runStepDetailsToolCallsObject 実行ステップの詳細。 はい
last_error オブジェクト この実行ステップに関連付けられた最後のエラー。 エラーがない場合は null になります。 はい
expired_at integer 実行ステップが期限切れになるときの Unix タイムスタンプ (秒単位)。 親実行の有効期限が切れている場合、ステップは期限切れと見なされます。 はい
cancelled_at integer 実行ステップが取り消されたときの Unix タイムスタンプ (秒単位)。 はい
failed_at integer 実行ステップが失敗したときの Unix タイムスタンプ (秒単位)。 はい
completed_at integer 実行ステップが完了したときの Unix タイムスタンプ (秒単位)。 はい
metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 はい

last_error のプロパティ

code

名前 種類 説明 Default
code string server_error、rate_limit_exceeded のいずれか。

メッセージ

名前 種類 説明 Default
message string 人が判読できるエラーの説明。

object の列挙型: RunStepObjectType

Value 説明
assistant.run.step オブジェクトの種類。これは常に assistant.run.step です

type の列挙型: RunStepObjectType

Value 説明
message_creation メッセージ作成の実行ステップ
tool_calls ツール呼び出しの実行ステップ

status の列挙型: RunStepObjectStatus

Value 説明
in_progress 進行中の実行状態
キャンセル済み キャンセル済みの実行状態
失敗 キャンセル済みの実行状態
completed キャンセル済みの実行状態
期限切れ キャンセル済みの実行状態

runStepDeltaObject

実行ステップの差分、つまりストリーミング中に変更された実行ステップのフィールドを表します。

名前 種類 内容 必要 Default
ID string 実行ステップの識別子。API エンドポイントで参照できます。 はい
オブジェクト string オブジェクトの種類。これは常に thread.run.step.delta です。 はい
delta オブジェクト 実行ステップで変更されたフィールドを含む差分。 はい

delta のプロパティ

step_details

名前 種類 説明 Default
step_details runStepDeltaStepDetailsMessageCreationObject または runStepDeltaStepDetailsToolCallsObject 実行ステップの詳細。

object の列挙型: RunStepDeltaObjectType

Value 説明
thread.run.step.delta

listRunStepsResponse

名前 種類 内容 必要 Default
オブジェクト string はい
data 配列 はい
first_id string はい
last_id string はい
has_more boolean はい

runStepDetailsMessageCreationObject

実行ステップによるメッセージ作成の詳細。

名前 種類 内容 必要 Default
type string 常に message_creation。 はい
message_creation オブジェクト はい

message_creation のプロパティ

message_id

名前 種類 説明 Default
message_id string この実行ステップで作成されたメッセージの ID。

type の列挙型: RunStepDetailsMessageCreationObjectType

Value 説明
message_creation

runStepDeltaStepDetailsMessageCreationObject

実行ステップによるメッセージ作成の詳細。

名前 種類 内容 必要 Default
type string 常に message_creation。 はい
message_creation object いいえ

message_creation のプロパティ

message_id

名前 種類 説明 Default
message_id string この実行ステップで作成されたメッセージの ID。

type の列挙型: RunStepDeltaStepDetailsMessageCreationObjectType

Value 説明
message_creation

runStepDetailsToolCallsObject

ツール呼び出しの詳細。

名前 種類 内容 必要 Default
type string 常に tool_calls。 はい
tool_calls 配列 実行ステップが関係していたツール呼び出しの配列。 これらは、code_interpreter、retrieval、または function の 3 種類のツールのいずれかに関連付けることができます。
 はい

type の列挙型: RunStepDetailsToolCallsObjectType

Value 説明
tool_calls

runStepDeltaStepDetailsToolCallsObject

ツール呼び出しの詳細。

名前 種類 内容 必要 Default
type string 常に tool_calls。 はい
tool_calls 配列 実行ステップが関係していたツール呼び出しの配列。 これらは、code_interpreter、file_search、または function の 3 種類のツールのいずれかに関連付けることができます。
 いいえ

type の列挙型: RunStepDeltaStepDetailsToolCallsObjectType

Value 説明
tool_calls

runStepDetailsToolCallsCodeObject

実行ステップが関係していたコード インタープリター ツール呼び出しの詳細。

名前 種類 内容 必要 Default
ID string ツール呼び出しの ID。 はい
type string ツール呼び出しの種類。 これは、この種類のツール呼び出しに対して常に code_interpreter になります。 はい
code_interpreter オブジェクト コード インタープリター ツール呼び出しの定義。 はい

code_interpreter のプロパティ

input

名前 種類 説明 Default
input string コード インタープリター ツール呼び出しへの入力。

outputs

名前 種類 説明 Default
outputs 配列 コード インタープリター ツール呼び出しからの出力。 コード インタープリターは、テキスト (logs) や画像 (image) などの 1 つ以上の項目を出力できます。 これらはそれぞれ、異なるオブジェクトの種類で表されます。

type の列挙型: RunStepDetailsToolCallsCodeObjectType

Value 説明
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

実行ステップが関係していたコード インタープリター ツール呼び出しの詳細。

名前 種類 内容 必要 Default
インデックス integer ツール呼び出し配列内のツール呼び出しのインデックス。 はい
id string ツール呼び出しの ID。 いいえ
type string ツール呼び出しの種類。 これは、この種類のツール呼び出しに対して常に code_interpreter になります。 はい
code_interpreter オブジェクト コード インタープリター ツール呼び出しの定義。 いいえ

code_interpreter のプロパティ

input

名前 種類 説明 Default
input string コード インタープリター ツール呼び出しへの入力。

outputs

名前 種類 説明 Default
outputs 配列 コード インタープリター ツール呼び出しからの出力。 コード インタープリターは、テキスト (logs) や画像 (image) などの 1 つ以上の項目を出力できます。 これらはそれぞれ、異なるオブジェクトの種類で表されます。

type の列挙型: RunStepDeltaStepDetailsToolCallsCodeObjectType

Value 説明
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

実行ステップの一環としてのコード インタープリター ツール呼び出しからのテキスト出力。

名前 種類 内容 必要 Default
type string 常に logs。 はい
logs string コード インタープリター ツール呼び出しからのテキスト出力。 はい

type の列挙型: RunStepDetailsToolCallsCodeOutputLogsObjectType

Value 説明
logs

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

実行ステップの一環としてのコード インタープリター ツール呼び出しからのテキスト出力。

名前 種類 内容 必要 Default
インデックス integer 出力配列内の出力のインデックス。 はい
type string 常に logs。 はい
logs string コード インタープリター ツール呼び出しからのテキスト出力。 いいえ

type の列挙型: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

Value 説明
logs

runStepDetailsToolCallsCodeOutputImageObject

名前 種類 内容 必要 Default
type string 常に image。 はい
image オブジェクト はい

image のプロパティ

file_id

名前 種類 説明 Default
file_id string 画像のファイル ID。

type の列挙型: RunStepDetailsToolCallsCodeOutputImageObjectType

Value 説明
image

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

名前 種類 内容 必要 Default
インデックス integer 出力配列内の出力のインデックス。 はい
type string 常に image。 はい
image object いいえ

image のプロパティ

file_id

名前 種類 説明 Default
file_id string 画像のファイル ID。

type の列挙型: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Value 説明
image

runStepDetailsToolCallsFileSearchObject

名前 種類 内容 必要 Default
ID string ツール呼び出しオブジェクトの ID。 はい
type string ツール呼び出しの種類。 これは、この種類のツール呼び出しに対して常に file_search になります。 はい
file_search オブジェクト 現時点では、これは常に空のオブジェクトになります。 はい

type の列挙型: RunStepDetailsToolCallsFileSearchObjectType

Value 説明
file_search

runStepDeltaStepDetailsToolCallsFileSearchObject

名前 種類 内容 必要 Default
インデックス integer ツール呼び出し配列内のツール呼び出しのインデックス。 はい
id string ツール呼び出しオブジェクトの ID。 いいえ
type string ツール呼び出しの種類。 これは、この種類のツール呼び出しに対して常に retrieval になります。 はい
file_search オブジェクト 現時点では、これは常に空のオブジェクトになります。 はい

type の列挙型: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Value 説明
file_search

runStepDetailsToolCallsFunctionObject

名前 種類 内容 必要 Default
ID string ツール呼び出しオブジェクトの ID。 はい
type string ツール呼び出しの種類。 これは、この種類のツール呼び出しに対して常に function になります。 はい
関数 オブジェクト 呼び出された関数の定義。 はい

function のプロパティ

name

名前 種類 説明 Default
name string 関数の名前です。

arguments

名前 種類 説明 Default
引数 string 関数に渡される引数。

output

名前 種類 説明 Default
output string 関数の出力。 出力がまだ送信済みではない場合、これは null になります。

type の列挙型: RunStepDetailsToolCallsFunctionObjectType

Value 説明
関数

runStepDeltaStepDetailsToolCallsFunctionObject

名前 種類 内容 必要 Default
インデックス integer ツール呼び出し配列内のツール呼び出しのインデックス。 はい
id string ツール呼び出しオブジェクトの ID。 いいえ
type string ツール呼び出しの種類。 これは、この種類のツール呼び出しに対して常に function になります。 はい
関数 オブジェクト 呼び出された関数の定義。 いいえ

function のプロパティ

name

名前 種類 説明 Default
name string 関数の名前です。

arguments

名前 種類 説明 Default
引数 string 関数に渡される引数。

output

名前 種類 説明 Default
output string 関数の出力。 出力がまだ送信済みではない場合、これは null になります。

type の列挙型: RunStepDetailsToolCallsFunctionObjectType

Value 説明
関数

vectorStoreExpirationAfter

ベクター ストアの有効期限ポリシー。

名前 種類 内容 必要 Default
アンカー string これを超えると有効期限ポリシーが適用されるアンカー タイムスタンプ。 サポートされるアンカー: last_active_at。 はい
days integer ベクター ストアの有効期限が切れるアンカー時点以降の日数。 はい

anchor の列挙型: VectorStoreExpirationAfterAnchor

Value 説明
last_active_at これを超えると有効期限ポリシーが適用されるアンカー タイムスタンプ。

vectorStoreObject

ベクター ストアは、file_search ツールで使用できる処理済みファイルのコレクションです。

名前 種類 内容 必要 Default
ID string API エンドポイントで参照できる識別子。 はい
オブジェクト enum オブジェクトの種類。これは常に vector_store です。
使用可能な値: vector_store		 はい
created_at integer ベクター ストアが作成されたときの Unix タイムスタンプ (秒単位)。 はい
名前 string ベクター ストアの名前。 はい
usage_bytes integer ベクター ストア内のファイルによって使用されるバイトの合計数。 はい
file_counts オブジェクト はい
状態 string ベクター ストアの状態。expired、in_progress、または completed のいずれかを指定できます。 completed の状態は、ベクター ストアは使用する準備ができていることを示します。 はい
expires_after vectorStoreExpirationAfter ベクター ストアの有効期限ポリシー。 いいえ
expires_at integer ベクター ストアの有効期限が切れる Unix タイムスタンプ (秒単位)。 いいえ
last_active_at integer ベクター ストアが最後にアクティブだったときの Unix タイムスタンプ (秒単位)。 はい
metadata オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 はい

file_counts のプロパティ

in_progress

名前 種類 説明 Default
in_progress integer 現在処理中のファイルの数。

completed

名前 種類 説明 Default
completed integer 正常に処理されたファイルの数。

失敗

名前 種類 説明 Default
失敗 integer 処理に失敗したファイルの数。

キャンセル済み

名前 種類 説明 Default
キャンセル済み integer 取り消されたファイルの数。

total

名前 種類 説明 Default
total integer ファイルの合計数。

status の列挙型: VectorStoreObjectStatus

Value 説明
期限切れ
in_progress
completed

createVectorStoreRequest

名前 種類 内容 必要 Default
file_ids 配列 ベクター ストアが使う必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。 いいえ
name string ベクター ストアの名前。 いいえ
expires_after vectorStoreExpirationAfter ベクター ストアの有効期限ポリシー。 いいえ
chunking_strategy autoChunkingStrategyRequestParam または staticChunkingStrategyRequestParam ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。 file_ids が空でない場合のみ適用されます。 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

updateVectorStoreRequest

名前 種類 内容 必要 Default
name string ベクター ストアの名前。 いいえ
expires_after vectorStoreExpirationAfter ベクター ストアの有効期限ポリシー。 いいえ
メタデータ オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。 これは、オブジェクトに関する追加情報を構造化された形式で格納する場合に役立ちます。 キーの最大長は 64 文字、値の最大長は 512 文字です。
 いいえ

listVectorStoresResponse

名前 種類 内容 必要 Default
オブジェクト string はい
data 配列 はい
first_id string はい
last_id string はい
has_more boolean はい

deleteVectorStoreResponse

名前 種類 内容 必要 Default
ID string はい
deleted boolean はい
オブジェクト string はい

object の列挙型: DeleteVectorStoreResponseObject

Value 説明
vector_store.deleted 削除ベクター ストア応答オブジェクトの状態

vectorStoreFileObject

ベクター ストアにアタッチされているファイルの一覧。

名前 種類 内容 必要 Default
ID string API エンドポイントで参照できる識別子。 はい
オブジェクト string オブジェクトの種類。これは常に vector_store.file です。 はい
usage_bytes integer ベクター ストアの使用量の合計 (バイト単位)。 これは元のファイル サイズとは異なる場合があることに注意してください。 はい
created_at integer ベクター ストア ファイルが作成されたときの Unix タイムスタンプ (秒単位)。 はい
vector_store_id string ファイルがアタッチされているベクター ストアの ID。 はい
状態 string ベクター ストア ファイルの状態。in_progress、completed、cancelled、または failed のいずれかを指定できます。 completed の状態は、ベクター ストア ファイルは使用する準備ができていることを示します。 はい
last_error オブジェクト このベクター ストア ファイルに関連付けられている最後のエラー。 エラーがない場合は null になります。 はい
chunking_strategy autoChunkingStrategyRequestParam または staticChunkingStrategyRequestParam ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。 file_ids が空でない場合のみ適用されます。 いいえ

last_error のプロパティ

code

名前 種類 説明 Default
code string server_error、rate_limit_exceeded のいずれか。

メッセージ

名前 種類 説明 Default
message string 人が判読できるエラーの説明。

object の列挙型: VectorStoreFileObjectType

Value 説明
vector_store.file

status の列挙型: VectorStoreFileObjectStatus

Value 説明
in_progress
completed
キャンセル済み
失敗

otherChunkingStrategyResponseParam

これは、チャンキング戦略が不明な場合に返されます。 通常、これは、chunking_strategy の概念が API で導入される前にファイルのインデックスが作成されたためです。

名前 種類 内容 必要 Default
type string 常に other。 はい

type の列挙型: OtherChunkingStrategyResponseParamType

Value 説明
other

staticChunkingStrategyResponseParam

名前 種類 内容 必要 Default
type string 常に static。 はい
static staticChunkingStrategy はい

type の列挙型: StaticChunkingStrategyResponseParamType

Value 説明
static

staticChunkingStrategy

名前 種類 内容 必要 Default
max_chunk_size_tokens integer 各チャンク内のトークンの最大数。 既定値は 800 です。 最小値は 100 で、最大値は 4096 です。 はい
chunk_overlap_tokens integer チャンク間で重複するトークンの数。 既定値は 400 です。

重複は、max_chunk_size_tokens の半分を超えてはならないことに注意してください。
 はい

autoChunkingStrategyRequestParam

既定の戦略。 この戦略では現在、800 の max_chunk_size_tokens と 400 の chunk_overlap_tokens を使用しています。

名前 種類 内容 必要 Default
type enum 常に auto です。
使用できる値: auto		 はい

staticChunkingStrategyRequestParam

名前 種類 内容 必要 Default
type enum 常に static です。
使用できる値: static		 はい
static staticChunkingStrategy はい

chunkingStrategyRequestParam

ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。

このコンポーネントには、次のいずれかを指定できます。

createVectorStoreFileRequest

名前 種類 内容 必要 Default
file_id string ベクター ストアが使う必要があるファイル ID。 ファイルにアクセスできる file_search などのツールに便利です。 はい
chunking_strategy chunkingStrategyRequestParam ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。 いいえ

listVectorStoreFilesResponse

名前 種類 内容 必要 Default
オブジェクト string はい
data 配列 はい
first_id string はい
last_id string はい
has_more boolean はい

deleteVectorStoreFileResponse

名前 種類 内容 必要 Default
ID string はい
deleted boolean はい
オブジェクト string はい

object の列挙型: DeleteVectorStoreFileResponseObject

Value 説明
vector_store.file.deleted

vectorStoreFileBatchObject

ベクター ストアにアタッチされているファイルのバッチ。

名前 種類 内容 必要 Default
ID string API エンドポイントで参照できる識別子。 はい
オブジェクト string オブジェクトの種類。これは常に vector_store.file_batch です。 はい
created_at integer ベクター ストア ファイルのバッチが作成されたときの Unix タイムスタンプ (秒単位)。 はい
vector_store_id string ファイルがアタッチされているベクター ストアの ID。 はい
状態 string ベクター ストア ファイルのバッチの状態。in_progress、completed、cancelled、または failed のいずれかを指定できます。 はい
file_counts オブジェクト はい

file_counts のプロパティ

in_progress

名前 種類 説明 Default
in_progress integer 現在処理中のファイルの数。

completed

名前 種類 説明 Default
completed integer 処理されたファイルの数。

失敗

名前 種類 説明 Default
失敗 integer 処理に失敗したファイルの数。

キャンセル済み

名前 種類 説明 Default
キャンセル済み integer 取り消されたファイルの数。

total

名前 種類 説明 Default
total integer ファイルの合計数。

object の列挙型: VectorStoreFileBatchObjectType

Value 説明
vector_store.files_batch

status の列挙型: VectorStoreFileBatchObjectStatus

Value 説明
in_progress
completed
キャンセル済み
失敗

createVectorStoreFileBatchRequest

名前 種類 内容 必要 Default
file_ids 配列 ベクター ストアが使う必要があるファイル ID の一覧。 ファイルにアクセスできる file_search などのツールに便利です。 はい
chunking_strategy chunkingStrategyRequestParam ファイルをチャンクするために使用されるチャンキング戦略。 設定されていない場合は、auto 戦略を使用します。 いいえ

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

このコンポーネントには、次のいずれかを指定できます。

thread.created

新しいスレッドが作成されると発生します。

名前 種類 内容 必要 Default
event string はい
data threadObject メッセージを含むスレッドを表します。 はい

Data: threadObject

Event の列挙型: ThreadStreamEventEnum

Value 説明
thread.created スレッドがイベントを作成しました

runStreamEvent

このコンポーネントには、次のいずれかを指定できます。

thread.run.created

新しい実行が作成されると発生します。

名前 種類 内容 必要 Default
event string はい
data runObject スレッド上で実行される実行を表します。 はい

Data: runObject

Event の列挙型: RunStreamEventCreated

Value 説明
thread.run.created

thread.run.queued

実行が queued 状態に移行すると発生します。

名前 種類 内容 必要 Default
event string はい
data runObject スレッド上で実行される実行を表します。 はい

Data: runObject

Event の列挙型: RunStreamEventQueued

Value 説明
thread.run.queued

thread.run.in_progress

実行が in_progress 状態に移行するときに発生します。

名前 種類 内容 必要 Default
event string はい
data runObject スレッド上で実行される実行を表します。 はい

Data: runObject

Event の列挙型: RunStreamEventInProgress

Value 説明
thread.run.in_progress

thread.run.requires_action

実行が requires_action 状態に移行すると発生します。

名前 種類 内容 必要 Default
event string はい
data runObject スレッド上で実行される実行を表します。 はい

Data: runObject

Event の列挙型: RunStreamEventRequiresAction

Value 説明
thread.run.requires_action

thread.run.completed

実行が完了すると発生します。

名前 種類 内容 必要 Default
event string はい
data runObject スレッド上で実行される実行を表します。 はい

Data: runObject

Event の列挙型: RunStreamEventCompleted

Value 説明
thread.run.completed

thread.run.failed

実行が失敗すると発生します。

名前 種類 内容 必要 Default
event string はい
data runObject スレッド上で実行される実行を表します。 はい

Data: runObject

Event の列挙型: RunStreamEventFailed

Value 説明
thread.run.failed

thread.run.cancelling

実行が cancelling 状態に移行すると発生します。

名前 種類 内容 必要 Default
event string はい
data runObject スレッド上で実行される実行を表します。 はい

Data: runObject

Event の列挙型: RunStreamEventCancelling

Value 説明
thread.run.cancelling

thread.run.cancelled

実行が取り消されると発生します。

名前 種類 内容 必要 Default
event string はい
data runObject スレッド上で実行される実行を表します。 はい

Data: runObject

Event の列挙型: RunStreamEventCancelled

Value 説明
thread.run.cancelled

thread.run.expired

実行の有効期限が切れると発生します。

名前 種類 内容 必要 Default
event string はい
data runObject スレッド上で実行される実行を表します。 はい

Data: runObject

Event の列挙型: RunStreamEventExpired

Value 説明
thread.run.expired

runStepStreamEvent

このコンポーネントには、次のいずれかを指定できます。

thread.run.step.created

実行ステップが作成されると発生します。

名前 種類 内容 必要 Default
event string はい
data runStepObject 実行の実行中のステップを表します。
 はい

Data: runStepObject

Event の列挙型: RunStepStreamEventCreated

Value 説明
thread.run.step.created

thread.run.step.in_progress

実行ステップが in_progress 状態に移行すると発生します。

名前 種類 内容 必要 Default
event string はい
data runStepObject 実行の実行中のステップを表します。
 はい

Data: runStepObject

Event の列挙型: RunStepStreamEventInProgress

Value 説明
thread.run.step.in_progress

thread.run.step.delta

実行ステップの一部がストリーミングされているときに発生します。

名前 種類 内容 必要 Default
event string はい
data runStepDeltaObject 実行ステップの差分、つまりストリーミング中に変更された実行ステップのフィールドを表します。
 はい

Data: runStepDeltaObject

Event の列挙型: RunStepStreamEventDelta

Value 説明
thread.run.step.delta

thread.run.step.completed

実行ステップが完了すると発生します。

名前 種類 内容 必要 Default
event string はい
data runStepObject 実行の実行中のステップを表します。
 はい

Data: runStepObject

Event の列挙型: RunStepStreamEventCompleted

Value 説明
thread.run.step.completed

thread.run.step.failed

実行ステップが失敗すると発生します。

名前 種類 内容 必要 Default
event string はい
data runStepObject 実行の実行中のステップを表します。
 はい

Data: runStepObject

Event の列挙型: RunStepStreamEventFailed

Value 説明
thread.run.step.failed

thread.run.step.cancelled

実行ステップが取り消されると発生します。

名前 種類 内容 必要 Default
event string はい
data runStepObject 実行の実行中のステップを表します。
 はい

Data: runStepObject

Event の列挙型: RunStepStreamEventCancelled

Value 説明
thread.run.step.cancelled

thread.run.step.expired

実行ステップの有効期限が切れると発生します。

名前 種類 内容 必要 Default
event string はい
data runStepObject 実行の実行中のステップを表します。
 はい

Data: runStepObject

Event の列挙型: RunStepStreamEventExpired

Value 説明
thread.run.step.expired

messageStreamEvent

このコンポーネントには、次のいずれかを指定できます。

thread.message.created

メッセージが作成されると発生します。

名前 種類 内容 必要 Default
event string はい
data messageObject スレッド内のメッセージを表します。 はい

Data: messageObject

Event の列挙型: MessageStreamEventCreated

Value 説明
thread.message.created

thread.message.in_progress

メッセージが in_progress 状態に移行するときに発生します。

名前 種類 内容 必要 Default
event string はい
data messageObject スレッド内のメッセージを表します。 はい

Data: messageObject

Event の列挙型: MessageStreamEventInProgress

Value 説明
thread.message.in_progress

thread.message.delta

メッセージが部分的にストリーミングされているときに発生します。

名前 種類 内容 必要 Default
event string はい
data messageDeltaObject メッセージの差分、つまりストリーミング中に変更されたメッセージのフィールドを表します。
 はい

Data: messageDeltaObject

Event の列挙型: MessageStreamEventDelta

Value 説明
thread.message.delta

thread.message.completed

メッセージが完了すると発生します。

名前 種類 内容 必要 Default
event string はい
data messageObject スレッド内のメッセージを表します。 はい

Data: messageObject

Event の列挙型: MessageStreamEventCompleted

Value 説明
thread.message.completed

thread.message.incomplete

メッセージが完成前に終了すると発生します。

名前 種類 内容 必要 Default
event string はい
data messageObject スレッド内のメッセージを表します。 はい

Data: messageObject

Event の列挙型: MessageStreamEventIncomplete

Value 説明
thread.message.incomplete

errorEvent

エラーが発生すると発生します。 これは、内部サーバー エラーまたはタイムアウトが原因で発生することがあります。

名前 種類 内容 必要 Default
event string はい
data error はい

event の列挙型: ErrorEventEnum

Value 説明
エラー

doneEvent

ストリーミングが終了すると発生します。

名前 種類 内容 必要 Default
event string はい
データ string はい

event の列挙型: DoneEventEnum

Value 説明
完了

data の列挙型: DoneEventDataEnum

Value 説明
[DONE]

次のステップ

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