チャット補完を作成する

会話を構成するメッセージのリストが与えられると、提供されたモデルは適切なレスポンスを返します。

詳細については、「OpenAI APIリファレンス」内のチャット作成のドキュメントと関連するChat Completions APIガイドを参照してください。

入力

フィールド	定義	タイプ	必須
モデル（Model）	使用するモデルのID。 Chat APIで機能するモデルの詳細については、「モデルエンドポイント互換性」テーブルを参照してください。	ドロップダウン	正
メッセージ（Messages）	会話を構成するメッセージのリスト。	オブジェクトのリスト	正
温度（Temperature）	出力で使用するサンプリング温度。 `0` ～ `2`の値を使用できます。デフォルトは`1`です。 `0.8`のような高めの値では出力はよりランダムになり、`0.2`のような低めの値ではよりフォーカスされ、決定論的になります。一般には、Oktaは両方ではなく、この入力とTop Pのいずれかを変更することをお勧めします。	数値	FALSE
Top P	temperatureによるサンプリングの代替であり、核サンプリングと呼ばれます。このモデルは、Top Pの確率質量を持つトークンの結果を考慮します。値`0.1`は、確立質量の上位10%で構成されるトークンが考慮されることを意味します。デフォルトは`1`です。一般には、Oktaは両方ではなく、この入力と温度（Temperature）のいずれかを変更することをお勧めします。	数値	FALSE
N	入力メッセージごとに生成されるチャット補完の選択肢の数。デフォルトは`1`です。	数値	FALSE
停止（Stop）	それ以上のトークンの生成を停止するようにAPIに伝える最大で4つのテキストシーケンスを指定できます。「stopシーケンスの使用方法」を参照してください。返されるチャット補完には`stop`シーケンスは含まれません。	テキスト	FALSE
最大トークン（Max Tokens）	チャット補完に生成するトークンの最大数。「トークナイザー」を参照してください。	数値	FALSE
存在ペナルティ（Presence Penalty）	`-2.0`～`2.0`の数値。正の値では、テキスト内で既出かどうかに基づいて新規トークンがペナライズされるため、モデルが新しいトピックについて話す可能性が高くなります。	数値	FALSE
頻度ペナルティ（Frequency Penalty）	`-2.0`～`2.0`の数値。正の値では、テキスト内で既出かどうかに基づいて新規トークンがペナライズされるため、モデルが同じ行を繰り返す可能性が低くなります。	数値	FALSE
ユーザー（User）	エンドユーザーを表す一意のID。 OpenAIは、このIDを使って不正使用を監視、検出できます。「安全性のベストプラクティス」を参照してください。	テキスト	FALSE

出力

フィールド	定義	タイプ
モデル（Model）	チャット補完で使用されるモデル。	テキスト
ID (ID)	チャット補完チャンクの一意のID。	テキスト
Object（オブジェクト）	オブジェクトタイプ。常に`chat.completion`です。	テキスト
作成日時（Created）	OpenAIがチャット補完を作成したUnixタイムスタンプ。値は秒単位です。	数値
選択肢（Choices）	チャット補完の選択肢のリスト。 `index`：選択肢リスト内の選択肢のインデックス。 `message`：モデルが生成するチャット補完メッセージ。 `role`：メッセージの作成者のロール。 `content`：メッセージのコンテンツ。 `finish reason`（終了理由）：モデルがトークンの生成を停止した理由。これらのフィールドの完全な説明については、「chat completion API」を参照してください。 N が`1`より大きい場合、結果は複数になる場合があります。	オブジェクトのリスト
使用状況（Usage）	補完リクエストの使用状況統計情報。 `prompt tokens`（プロンプトトークン）：プロンプト内のトークンの数。 `completion tokens`（補完トークン）：生成された補完内のトークンの数。 `total tokens`（合計トークン）：リクエストで使用されるトークンの総数。上記2つの値の合計です。	オブジェクト
Raw Output (未加工出力）	チャットから返される未加工の出力。	オブジェクト

例

次に、カードが返す未加工出力（Raw Output）結果の例を示します。

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "gpt-3.5-turbo-0613",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "\n\nHello there, how may I assist you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}