チャット補完を作成

新しい chat completion を作成する

POST /v1/chat/completions

チャット補完を作成

cURL

curl --request POST \
  --url https://api.example.com/v1/chat/completions/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>",
      "role": "<string>",
      "name": "<string>"
    }
  ],
  "model": "<string>",
  "frequency_penalty": 0,
  "logit_bias": {},
  "logprobs": false,
  "top_logprobs": 0,
  "max_tokens": 123,
  "max_completion_tokens": 123,
  "n": 1,
  "presence_penalty": 0,
  "response_format": {
    "type": "text",
    "json_schema": {
      "name": "<string>",
      "description": "<string>",
      "schema": {},
      "strict": true
    }
  },
  "seed": 0,
  "stop": [],
  "stream": false,
  "stream_options": {
    "include_usage": true,
    "continuous_usage_stats": false
  },
  "temperature": 123,
  "top_p": 123,
  "tools": [
    {
      "function": {
        "name": "<string>",
        "description": "<string>",
        "parameters": {}
      },
      "type": "function"
    }
  ],
  "tool_choice": "none",
  "reasoning_effort": "low",
  "include_reasoning": true,
  "parallel_tool_calls": true,
  "user": "<string>",
  "use_beam_search": false,
  "top_k": 123,
  "min_p": 123,
  "repetition_penalty": 123,
  "length_penalty": 1,
  "stop_token_ids": [],
  "include_stop_str_in_output": false,
  "ignore_eos": false,
  "min_tokens": 0,
  "skip_special_tokens": true,
  "spaces_between_special_tokens": true,
  "truncate_prompt_tokens": 0,
  "prompt_logprobs": 123,
  "allowed_token_ids": [
    123
  ],
  "bad_words": [
    "<string>"
  ],
  "echo": false,
  "add_generation_prompt": true,
  "continue_final_message": false,
  "add_special_tokens": false,
  "documents": [
    {}
  ],
  "chat_template": "<string>",
  "chat_template_kwargs": {},
  "mm_processor_kwargs": {},
  "structured_outputs": {
    "json": "<string>",
    "regex": "<string>",
    "choice": [
      "<string>"
    ],
    "grammar": "<string>",
    "json_object": true,
    "disable_fallback": false,
    "disable_any_whitespace": false,
    "disable_additional_properties": false,
    "whitespace_pattern": "<string>",
    "structural_tag": "<string>",
    "_backend": "<string>",
    "_backend_was_auto": false
  },
  "priority": 0,
  "request_id": "<string>",
  "logits_processors": [
    "<string>"
  ],
  "return_tokens_as_token_ids": true,
  "return_token_ids": true,
  "cache_salt": "<string>",
  "kv_transfer_params": {},
  "vllm_xargs": {}
}
'

200

{
  "model": "<string>",
  "choices": [
    {
      "index": 123,
      "message": {
        "role": "<string>",
        "content": "<string>",
        "refusal": "<string>",
        "annotations": {
          "type": "<string>",
          "url_citation": {
            "end_index": 123,
            "start_index": 123,
            "title": "<string>",
            "url": "<string>"
          }
        },
        "audio": {
          "id": "<string>",
          "data": "<string>",
          "expires_at": 123,
          "transcript": "<string>"
        },
        "function_call": {
          "name": "<string>",
          "arguments": "<string>"
        },
        "tool_calls": [
          {
            "function": {
              "name": "<string>",
              "arguments": "<string>"
            },
            "id": "<string>",
            "type": "function"
          }
        ],
        "reasoning": "<string>",
        "reasoning_content": "<string>"
      },
      "logprobs": {
        "content": [
          {
            "token": "<string>",
            "logprob": -9999,
            "bytes": [
              123
            ],
            "top_logprobs": [
              {
                "token": "<string>",
                "logprob": -9999,
                "bytes": [
                  123
                ]
              }
            ]
          }
        ]
      },
      "finish_reason": "stop",
      "stop_reason": 123,
      "token_ids": [
        123
      ]
    }
  ],
  "usage": {
    "prompt_tokens": 0,
    "total_tokens": 0,
    "completion_tokens": 0,
    "prompt_tokens_details": {
      "cached_tokens": 123
    }
  },
  "id": "<string>",
  "object": "chat.completion",
  "created": 123,
  "service_tier": "auto",
  "system_fingerprint": "<string>",
  "prompt_logprobs": [
    {}
  ],
  "prompt_token_ids": [
    123
  ],
  "kv_transfer_params": {}
}

承認

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

ボディ

application/json

messages · (ChatCompletionDeveloperMessageParam · object | ChatCompletionSystemMessageParam · object | ChatCompletionUserMessageParam · object | ChatCompletionAssistantMessageParam · object | ChatCompletionToolMessageParam · object | ChatCompletionFunctionMessageParam · object | CustomChatCompletionMessageParam · object | Message · object)[] · 必須

ユーザー から送信されたメッセージに関係なく、モデル が必ず従うべき、開発者が指定する指示です。o1 モデル 以降では、developer メッセージが、従来の system メッセージに置き換わります。

ChatCompletionDeveloperMessageParam

ChatCompletionSystemMessageParam

ChatCompletionUserMessageParam

ChatCompletionAssistantMessageParam

ChatCompletionToolMessageParam

ChatCompletionFunctionMessageParam

CustomChatCompletionMessageParam

Message

表示 子属性

model · string | null

frequency_penalty · number | null · デフォルト: 0

logit_bias · Logit Bias · object

表示 子属性

logprobs · boolean | null · デフォルト: false

top_logprobs · integer | null · デフォルト: 0

max_tokens · integer | null · 非推奨

max_completion_tokens · integer | null

n · integer | null · デフォルト: 1

presence_penalty · number | null · デフォルト: 0

response_format · ResponseFormat · object

ResponseFormat

StructuralTagResponseFormat

LegacyStructuralTagResponseFormat

表示 子属性

seed · integer | null

必須範囲: -9223372036854776000 <= x <= 9223372036854776000

stop · string string[] · デフォルト: []

stream · boolean | null · デフォルト: false

stream_options · StreamOptions · object

表示 子属性

temperature · number | null

top_p · number | null

tools · ChatCompletionToolsParam · object[] | null

表示 子属性

tool_choice · Tool Choice · string Tool Choice · string Tool Choice · string ChatCompletionNamedToolChoiceParam · ChatCompletionNamedToolChoiceParam · object · デフォルト: none

Allowed value: "none"

reasoning_effort · enum<string> | null

利用可能なオプション: low, medium, high

include_reasoning · boolean · デフォルト: true

parallel_tool_calls · boolean | null · デフォルト: true

user · string | null

use_beam_search · boolean · デフォルト: false

top_k · integer | null

min_p · number | null

repetition_penalty · number | null

length_penalty · number · デフォルト: 1

stop_token_ids · integer[] | null

include_stop_str_in_output · boolean · デフォルト: false

ignore_eos · boolean · デフォルト: false

min_tokens · integer · デフォルト: 0

skip_special_tokens · boolean · デフォルト: true

spaces_between_special_tokens · boolean · デフォルト: true

truncate_prompt_tokens · integer | null

必須範囲: x >= -1

prompt_logprobs · integer | null

allowed_token_ids · integer[] | null

bad_words · string[]

echo · boolean · デフォルト: false

true の場合、新しいメッセージが同じロールに属していれば、直前のメッセージに続けて追加されます。

add_generation_prompt · boolean · デフォルト: true

true の場合、生成用のプロンプトがチャットテンプレートに追加されます。これは、モデルの tokenizer 設定の chat template で使用されるパラメーターです。

continue_final_message · boolean · デフォルト: false

これが設定されている場合、チャット内の最後のメッセージが途中で終わるオープンエンドになり、EOS トークンが付与されないようにチャットがフォーマットされます。モデルは新しいメッセージを開始するのではなく、このメッセージを継続します。これにより、モデルの応答の一部をあらかじめ「prefill（プレフィル）」することができます。add_generation_prompt と同時には使用できません。

add_special_tokens · boolean · デフォルト: false

true の場合、チャットテンプレートによって追加される内容に加え、特別なトークン（例: BOS）がプロンプトに追加されます。ほとんどのモデルでは、チャットテンプレートが特別なトークンの追加を処理するため、この設定は false（デフォルト）のままにしておく必要があります。

documents · Documents · object[] | null

RAG（retrieval-augmented generation）を実行する際に、モデル から参照可能なドキュメントを表す dict のリストです。テンプレートが RAG をサポートしていない場合、この引数は効果はありません。各ドキュメントは "title" と "text" キーを含む dict とすることを推奨します。

表示 子属性

chat_template · string | null

この変換に使用する Jinja テンプレートです。transformers v4.44 以降ではデフォルトのチャットテンプレートは使用できないため、tokenizer がチャットテンプレートを定義していない場合は、チャットテンプレートを必ず指定する必要があります。

chat_template_kwargs · Chat Template Kwargs · object

テンプレートレンダラーに渡される追加のキーワード引数です。チャットテンプレートから参照可能になります。

mm_processor_kwargs · Mm Processor Kwargs · object

HF プロセッサーに渡す追加のキーワード引数（kwargs）です。

structured_outputs · StructuredOutputsParams · object

構造化出力用の追加のキーワード引数（kwargs）です。

表示 子属性

priority · integer · デフォルト: 0

リクエストの優先度です（値が小さいほど早く処理されます。デフォルト: 0）。優先度が 0 以外の場合、指定した モデル が優先度付きスケジューリングを使用していなければエラーになります。

request_id · string

このリクエストに関連付けられた request_id です。呼び出し元で設定しなかった場合は random_uuid が自動生成されます。この ID は推論処理全体を通して使用され、レスポンスにも含まれます。

logits_processors · (string | LogitsProcessorConstructor · object)[] | null

サンプリング時に適用する logits processor の修飾名、またはそのコンストラクターを表すオブジェクトのリストです。コンストラクターは JSON オブジェクトで、必須フィールドとしてプロセッサークラス／ファクトリの修飾名を指定する 'qualname' を持ち、さらに位置引数を含む 'args' フィールドおよびキーワード引数を含む 'kwargs' フィールドを任意で持ちます。例: {'qualname': 'my_module.MyLogitsProcessor', 'args': [1, 2], 'kwargs': {'param': 'value'}}。

return_tokens_as_token_ids · boolean | null

'logprobs' と一緒に指定した場合、トークンは 'token_id:{token_id}' という形式の文字列として表現されます。この形式により、JSON にエンコードできないトークンを識別できるようになります。

return_token_ids · boolean | null

指定した場合、生成されたテキストに加えてトークン ID が結果に含まれます。ストリーミングモードでは、prompt_token_ids は最初のチャンクにのみ含まれ、token_ids には各チャンクの差分トークンのみが含まれます。これはデバッグする際や、生成テキストを入力トークンにマッピングし直す必要がある場合に便利です。

cache_salt · string | null

指定した場合、マルチユーザー環境で攻撃者にプロンプトを推測されないように、指定した文字列でプレフィックスキャッシュにソルトを付与します。ソルトはランダムで、第三者がアクセスできないよう保護され、かつ予測不可能な十分な長さである必要があります（例：256 ビットに相当する、43 文字の base64 エンコード文字列）。

kv_transfer_params · Kv Transfer Params · object

分離型サービング用に使用される KVTransfer パラメーター。

vllm_xargs · Vllm Xargs · object

カスタム拡張機能で使用される、値として文字列または数値（のリスト）を取る追加のリクエストパラメーター。

表示 子属性

レスポンス

200

application/json

成功時のレスポンス

model · string · 必須

choices · ChatCompletionResponseChoice · object[] · 必須

表示 子属性

usage · UsageInfo · object · 必須

表示 子属性

id · string

object · string · デフォルト: chat.completion

Allowed value: "chat.completion"

created · integer

service_tier · enum<string> | null

利用可能なオプション: auto, default, flex, scale, priority

system_fingerprint · string | null

prompt_logprobs · (object | null)[] | null

表示 子属性

prompt_token_ids · integer[] | null

kv_transfer_params · Kv Transfer Params · object

KVTransfer パラメーター。