チャット補完を作成する
会話を構成するメッセージのリストが与えられると、提供されたモデルは適切なレスポンスを返します。
詳細については、「OpenAI APIリファレンス」内のチャット作成のドキュメントと関連するChat Completions APIガイドを参照してください。
入力
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
|
Model（モデル） |
使用するモデルのID。 Chat APIで機能するモデルの詳細については、「モデルエンドポイント互換性」テーブルを参照してください。 |
ドロップダウン |
TRUE |
|
Message（メッセージ） |
会話を構成するメッセージのリスト。 |
オブジェクトのリスト |
TRUE |
|
Temperature（温度） |
出力で使用するサンプリング温度。 0～2の値を使用できます。デフォルト値は1。 0.8のような高めの値では出力はよりランダムになり、0.2のような低めの値ではよりフォーカスされ、決定論的になります。 一般には、両方ではなく、この入力とTop Pのいずれかを変更することをお勧めします。 |
数値 |
FALSE |
|
Top P |
temperatureによるサンプリングの代替であり、核サンプリングと呼ばれます。 このモデルは、Top Pの確率質量を持つトークンの結果を考慮します。 値0.1は、確立質量の上位10%で構成されるトークンが考慮されることを意味します。デフォルト値は1。 一般には、両方ではなく、この入力と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。 |
テキスト |
|
Object（オブジェクト） |
オブジェクトタイプ。常にchat.completionです。 |
テキスト |
|
Created（作成日時） |
OpenAIがチャット補完を作成したUnixタイムスタンプ。値は秒単位です。 |
数値 |
|
Choices（選択肢） |
チャット補完の選択肢のリスト。
Nが1より大きい場合、結果は複数になる場合があります。 |
オブジェクトのリスト |
|
Usage（使用状況） |
補完リクエストの使用状況統計情報。
|
オブジェクト |
|
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
}
}