本文へスキップ
Markdown で表示

Completions

プロンプトに続くテキストを生成します。リクエストとレスポンスは OpenAI Completions 形式に従います。ゲートウェイは chat リクエストと同じ方法で計測し、ボディをモデルサーバーに転送します。会話やツール呼び出しには Chat completions を使用してください。

POST/completions
URL
https://api.bricksum.com/v1/completions

認証

ゲートウェイが処理するエンドポイントの認証方法はすべて同じで、 API リファレンス ページで説明しています。

リクエストボディ

対応状況

対応
ゲートウェイが処理するか、公開済みの実測で動作を確認した項目です。
転送のみ
モデルサーバーに転送されます。Kiln は動作を検証していません。
無視
200 で受け付けられますが、適用されません。レスポンスのその他の部分は通常どおりです。
非対応
エラーで拒否されるか、説明に記載したモデルでは動作しません。

共通パラメータ

以下のパラメータの定義は API リファレンス ページに一度だけ記載しています。ここには、このエンドポイントで異なる点だけを記載します。

  • modelstring必須対応

    共通の定義と同じです。

    完全な定義を見る

  • max_tokensinteger転送のみ

    モデルサーバーに転送されます。Kiln は動作を検証していません。

    完全な定義を見る

  • streamboolean対応

    ゲートウェイは文字列 "true" と数値 1 も true として読み取り、転送前にこのフィールドを boolean に書き換えます。usage チャンクを受け取るには、以下の stream_options を使用してください。

    デフォルト
    false

    完全な定義を見る

このエンドポイント固有のパラメータ

  • promptstring | array必須対応

    続きを生成するテキストです。ゲートウェイは値を変更せずに転送し、検証は行いません。

  • stream_optionsobject対応

    ストリーミングレスポンスのオプションです。stream: true と一緒に送る場合にのみ使用してください。

    usage オプション
    • include_usageboolean対応

      true の場合、ストリームの最後に、choices が空で usage オブジェクトにトークン数と cost を含むチャンクが 1 つ追加されます。ゲートウェイはトークン計測のためにすべてのストリーミングリクエストでこの値を設定し、指定がなかった場合は usage チャンクを取り除きます。

      デフォルト
      false
  • temperaturenumber転送のみ

    モデルサーバーに転送されます。Kiln は動作を検証していません。

    範囲
    0–2
  • top_pnumber転送のみ

    モデルサーバーに転送されます。Kiln は動作を検証していません。

    範囲
    0–1
  • ninteger転送のみ

    モデルサーバーに転送されます。Kiln は動作を検証していません。

  • seedinteger転送のみ

    モデルサーバーに転送されます。Kiln は動作を検証していません。

  • stopstring | array転送のみ

    モデルサーバーに転送されます。Kiln は動作を検証していません。

  • presence_penaltynumber転送のみ

    モデルサーバーに転送されます。Kiln は動作を検証していません。

    範囲
    -2–2
  • frequency_penaltynumber転送のみ

    モデルサーバーに転送されます。Kiln は動作を検証していません。

    範囲
    -2–2
  • logprobsinteger転送のみ

    モデルサーバーに転送されます。Kiln は動作を検証していません。

  • echoboolean転送のみ

    モデルサーバーに転送されます。Kiln は動作を検証していません。

  • ignore_eosboolean転送のみ

    モデルサーバーに転送されます。Kiln は動作を検証していません。gpt-oss モデルに対する 400(unsupported_parameter)のチェックは /chat/completions にのみ適用されます。

ここに記載のない OpenAI Completions パラメータも、同じようにモデルサーバーに転送されます。Kiln は動作を検証していません。

レスポンスボディ

フィールド型説明
idstringcompletion の ID です。
objectstring"text_completion" です。
choices[].textstring生成されたテキストです。
choices[].finish_reasonstring"stop" または "length"(max_tokens による打ち切り)です。
usage.prompt_tokensinteger入力トークン数です。
usage.completion_tokensinteger出力トークン数です。reasoning トークンを含みます。
usage.total_tokensinteger入力と出力のトークン数の合計です。
usage.prompt_tokens_details.cached_tokensintegerプレフィックスキャッシュから処理された入力トークン数です。モデルサーバーが報告した場合にのみ含まれます。
usage.costnumberこのリクエストでクレジットから差し引かれる金額(USD)です。ゲートウェイが追加します。
X-Neocloud-Generation-Idheaderこのリクエストの usage イベント ID を含むレスポンスヘッダーです。ログと一緒に保存してください。

ストリームチャンク

stream: true の場合、各 data: 行に以下のフィールドを持つチャンクが 1 つずつ入ります。keepalive コメント、data: [DONE]、切断時の動作は ストリーミング ページで説明しています。

フィールド型説明
choices[].textstringこのチャンクで新しく生成されたテキストです。
choices[].finish_reasonstring | null最後の content チャンクまでは null で、最後のチャンクに終了理由が入ります。
usageobjectstream_options.include_usage が true の場合にのみ、最後のチャンクに含まれます。このチャンクの choices 配列は空です。
usage.costnumberこのリクエストでクレジットから差し引かれる金額(USD)です。ゲートウェイが usage チャンクに追加します。

エラー

メッセージの文言ではなく、HTTP ステータスと error.code で分岐してください。error.code の欄が空の場合、ボディに code はありません。すべてのステータスコードは エラー ページにあります。

ステータス · error.code原因対処
400モデルサーバーがリクエストを拒否しました。不正な JSON、無効なパラメータ、モデルページに記載のモデル別コンテキスト長を超えるコンテキストが原因です。リクエスト内容を修正してください。そのまま再試行しないでください。
404model_not_foundモデル ID がカタログにありません。GET /models で ID を確認してください。
429rate_limit_exceeded組織ですでに 8 件のリクエストが処理中です。レート制限ヘッダーは付きません。指数バックオフで再試行してください。
502モデルバックエンドがエラーを返したか、到達できませんでした。ボディはプレーンテキストです。指数バックオフで再試行してください。
503サービスがメンテナンス中か、利用可能なモデルバックエンドがありません。メンテナンス中は Retry-After の日時まで待ってください。それ以外は指数バックオフで再試行してください。

401、402、403、429 は、リクエストがこのエンドポイントに届く前にゲートウェイが返します。これらは API リファレンス ページに一度だけ記載しています。

制限

コンテキスト長、リクエストボディのサイズ、タイムアウト、組織ごとのレート制限もここに適用され、 API リファレンス ページに一度だけ記載しています。

429 のヘッダーと再試行の方法は レート制限 ページにあります。