【Python × OpenAI API】主要な引数をまとめてみた｜WordPress連携後のステップアップとして学習

2023年4月1日2025年4月30日

はじめに

Pythonを使ってWordPressの記事投稿ができるようになったので、
次のステップとして「OpenAI API」の使い方、特に主要な引数の意味と役割を整理して勉強しました。

今回は、openai.Completion.create()で使用する代表的な引数を中心に、
私が実際に調べて理解したことをまとめておきます。

OpenAI APIの基本構文（Completion API）

openai.Completion.create(
    engine="text-davinci-002",
    prompt=None,
    temperature=0.5,
    max_tokens=2048,
    top_p=1,
    frequency_penalty=0,
    presence_penalty=0,
    stop=None,
    n=1,
    stream=False,
    logprobs=None,
    echo=False,
    user=None,
    model=None,
    model_owner=None,
    organization=None,
    parameters=None,
    metadata=None,
)

このように、多くのパラメータがありますが、すべてを毎回使う必要はありません。

各引数の意味と役割

引数	説明
`engine`	使用するモデル名（例：`text-davinci-002`）。モデルによって性能や応答が異なります。
`prompt`	モデルに渡す入力テキスト。会話の前提や質問の内容を書きます。
`temperature`	応答の“ランダム性”を調整。0に近いと一貫性重視、1に近いと自由度が高くなります。
`max_tokens`	生成されるトークン（単語・記号など）の最大数を指定します。
`top_p`	確率上位何パーセントからトークンをサンプリングするか（nucleus sampling）。
`frequency_penalty`	同じ語の繰り返しを抑えるためのペナルティ値。
`presence_penalty`	新しい話題や単語を導入させるかどうかの指標。
`stop`	指定した文字列に達したら出力を止めるように制御できます（例：[“\n”]）。
`n`	応答を何個生成するか（通常は1）。
`stream`	出力をリアルタイムでストリーミングするかどうか。
`logprobs`	各トークンの確率情報を取得するための設定（デバッグ用途向け）。
`echo`	プロンプトを応答に含めるかどうか。
`user`, `model`, `organization`	利用者や所属組織の識別。必要に応じて指定。
`parameters`, `metadata`	拡張パラメータやAPIに付随するメタ情報（基本的には使いません）。