チャット補完の作成

POST

https://api.openai.com/v1/chat/completions

指定されたチャット会話に対するモデル応答を作成します。

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.openai.com/v1/chat/completions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
  "model": "gpt-3.5-turbo",
  "messages": [{"role": "user", "content": "Hello!"}]
}'

Response Example

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "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
  }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Content-Type

string

required

Example:

application/json

string

required

Example:

application/json

Authorization

string

optional

Example:

Bearer {{YOUR_API_KEY}}

Body Params application/json

model

string

required

使用するモデルのID。 Chat API で動作するモデルの詳細については、モデルエンドポイントの互換性表を参照してください。

messages

array [object {2}]

required

これまでの会話を構成するメッセージのリスト。 Python コードの例。.

role

string

optional

メッセージ作成者の役割。system、user、assistant、またはfunctionのいずれか。

content

string

optional

メッセージの内容。 content、関数呼び出しを伴うアシスタントメッセージを除くすべてのメッセージに必要です。

temperature

integer

optional

使用するサンプリング温度 (0 ～ 2)。0.8 などの高い値では出力がよりランダムになり、0.2 などの低い値ではより集中的で確定的になります。通常、これまたはtop_p変更することをお勧めしますが、両方を変更することは推奨しません。

top_p

integer

optional

核サンプリングと呼ばれる、温度によるサンプリングの代替方法。モデルは、top_p 確率質量を使用してトークンの結果を考慮します。したがって、0.1 は、上位 10% の確率質量を構成するトークンのみが考慮されることを意味します。通常、これまたはtemperature変更することをお勧めしますが、両方を変更することは推奨しません。

integer

optional

各入力メッセージに対して生成するチャット完了の選択肢の数。

stream

boolean

optional

設定すると、ChatGPT と同様に、部分的なメッセージデルタが送信されます。トークンは、利用可能になるとデータのみのサーバー送信イベントとして送信され、ストリームはdata: [DONE]メッセージによって終了します。 Python コードの例。.

stop

string

optional

API がさらなるトークンの生成を停止する最大 4 つのシーケンス。

max_tokens

integer

optional

チャット完了で生成するトークンの最大数。入力トークンと生成されたトークンの合計の長さは、モデルのコンテキストの長さによって制限されます。トークンをカウントするためのPython コードの例。

presence_penalty

number

optional

-2.0 から 2.0 までの数値。正の値を指定すると、これまでにテキストに出現したかどうかに基づいて新しいトークンにペナルティが課され、モデルが新しいトピックについて話す可能性が高まります。頻度とプレゼンスのペナルティの詳細については、こちらをご覧ください。

frequency_penalty

number

optional

-2.0 から 2.0 までの数値。正の値を指定すると、これまでのテキスト内の既存の頻度に基づいて新しいトークンにペナルティが課され、モデルが同じ行をそのまま繰り返す可能性が低くなります。頻度とプレゼンスのペナルティの詳細については、こちらをご覧ください。

logit_bias

null

optional

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

user

string

optional

エンドユーザーを表す一意の識別子。OpenAI による不正行為の監視と検出に役立ちます。もっと詳しく知る。.

Examples

Responses

🟢200OK

application/json

Body

string

required

object

string

required

created

integer

required

choices

array [object {3}]

required

index

integer

optional

message

object

optional

finish_reason

string

optional

usage

object

required

prompt_tokens

integer

required

completion_tokens

integer

required

total_tokens

integer

required

Modified at 2024-12-04 10:03:25

翻訳を作成

埋め込みの作成