補完の作成

POST

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

プロンプトが与えられると、モデルは 1 つ以上の予測された完了を返し、各位置での代替トークンの確率を返すこともできます。

提供されたプロンプトとパラメータに基づいて補完を作成します。

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.openai.com/v1/completions' \
--header 'Content-Type: application/json' \
--data-raw '{
  "model": "text-davinci-003",
  "prompt": "Say this is a test",
  "max_tokens": 7,
  "temperature": 0,
  "top_p": 1,
  "n": 1,
  "stream": false,
  "logprobs": null,
  "stop": "\n"
}'

Response Example

{
  "id": "cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7",
  "object": "text_completion",
  "created": 1589478378,
  "model": "text-davinci-003",
  "choices": [
    {
      "text": "\n\nThis is indeed a test",
      "index": 0,
      "logprobs": null,
      "finish_reason": "length"
    }
  ],
  "usage": {
    "prompt_tokens": 5,
    "completion_tokens": 7,
    "total_tokens": 12
  }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Authorization

string

optional

Example:

Bearer {{YOUR_API_KEY}}

Body Params application/json

model

string

required

使用するモデルのID。利用可能なすべてのモデルを確認するには、List models APIを使用するか、モデルの概要で説明を参照してください。

prompt

string

required

補完を生成するためのプロンプト（文字列、文字列の配列、トークンの配列、またはトークンの配列としてエンコードされます）。<|endoftext|> はモデルが訓練中に見るドキュメントの区切り文字であるため、プロンプトが指定されていない場合、モデルは新しいドキュメントの開始から生成するかのように動作します。

suffix

string

optional

挿入されたテキストの補完後に続くサフィックス。

max_tokens

integer

optional

補完で生成する最大トークン数。プロンプトのトークン数と max_tokens の合計は、モデルのコンテキスト長を超えることはできません。トークン数をカウントするためのPython コードの例。

temperature

integer

optional

使用するサンプリング温度（0から2の範囲）。0.8のような高い値は出力をよりランダムにし、0.2のような低い値はより焦点を絞り、決定論的になります。通常、これはまたはtop_pのいずれかを変更することをお勧めしますが、両方を変更しないでください。

top_p

integer

optional

温度でサンプリングする代わりに、top_p確率質量を持つトークンの結果をモデルが考慮する「ニュクレウスサンプリング」という方法があります。例えば、0.1はトップ10％の確率質量を構成するトークンのみが考慮されることを意味します。通常、これは temperature またはtop_pを変更することをお勧めしますが、両方を変更しないでください。

integer

optional

各プロンプトに対して生成する補完の数。注意：このパラメータは多くの補完を生成するため、トークンの割り当てをすぐに消費する可能性があります。慎重に使用し、max_tokensおよびstopの設定が適切であることを確認してください。

stream

boolean

optional

部分的な進行状況をストリームで返すかどうか。設定されている場合、トークンは利用可能になるとデータのみのサーバー送信イベントとして送信され、data: [DONE] というメッセージでストリームが終了します。Python コードの例。

logprobs

null

optional

最も可能性の高いトークンに対するログ確率 logprobs を、選択されたトークンとともに含めることができます。例えば、logprobs が 5 の場合、APIは最も可能性の高い5つのトークンのリストを返します。APIは常にサンプリングされたトークンのログ確率を返すため、レスポンスには logprobs+1 の要素が含まれる場合があります。logprobs の最大値は5です。

echo

string

optional

補完に加えて、プロンプトも返す

presence_penalty

number

optional

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

frequency_penalty

number

optional

-2.0から2.0の範囲の数値。正の値は、新しいトークンがこれまでのテキストでの既存の頻度に基づいてペナルティを課し、モデルが同じ行を繰り返す可能性を低減させます。頻度と出現ペナルティに関する詳細情報をご覧ください。

best_of

integer

optional

サーバー側で best_of 補完を生成し、「最良」（トークンごとのログ確率が最も高いもの）を返します。結果はストリームで返すことはできません。n と一緒に使用する場合、best_of は候補補完の数を制御し、n は返す数を指定します。best_of は n より大きくなければなりません。注意：このパラメータは多くの補完を生成するため、トークンの割り当てをすぐに消費する可能性があります。慎重に使用し、max_tokens および stop の設定が適切であることを確認してください。

logit_bias

string

optional

指定されたトークンが補完に現れる可能性を変更します。トークン（GPTトークナイザー内でそのトークンIDで指定された）と関連付けられたバイアス値を -100 から 100 の範囲でマッピングするJSONオブジェクトを受け入れます。このトークナイザーツール（GPT-2およびGPT-3両方に対応）を使用して、テキストをトークンIDに変換できます。数学的には、バイアスはサンプリング前にモデルによって生成されたロジットに加算されます。正確な効果はモデルによって異なりますが、-1 と 1 の間の値は選択の可能性を減少または増加させ、-100 や 100 のような値は関連するトークンを禁止するか、排他的に選択させる結果になります。例えば、{"50256": -100} を渡すことで、<|endoftext|> トークンの生成を防ぐことができます。

stop

string

optional

APIがそれ以上のトークン生成を停止する最大4つのシーケンス。返されたテキストには停止シーケンスは含まれません。

user

string

optional

エンドユーザーを表す一意の識別子で、OpenAIが不正利用を監視し、検出するのに役立ちます。詳細についてはこちらをご覧ください。

Examples

Responses

🟢200Ok

application/json

Body

string

required

object

string

required

created

integer

required

model

string

required

choices

array [object {4}]

required

text

string

optional

index

integer

optional

logprobs

null

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:40

コスト

アシスタントを作成 (v1)