Enterprise grade chat completions

エンタープライズグレードの OpenAI chat completions を実行します。 ※このAPIはCraft Typeのアプリでのみ利用可能です。

Required Scope

APIの実行に必要なScopeです。

beta.craft.aimodules.openai.chat.completions

Required Role

管理画面でScopeを追加する際に必要な権限です。

Craft > Craft 設定の編集
Body Params
messages
array of objects
required

Chat completions に渡す一連のメッセージのやり取りを古い順に配列で指定します。

messages*
enum

モデルによって呼び出される関数 (存在する場合) を制御します。 none は、モデルが関数を呼び出さず、代わりにメッセージを生成することを意味します。 auto は、モデルがメッセージを生成するか関数を呼び出すかを選択できることを意味します。 {"name": "my_function"} で特定の関数を指定すると、モデルはその関数を強制的に呼び出します。 関数が存在しない場合のデフォルトは none です。関数が存在する場合、 auto がデフォルトです。

tools
array of objects

モデルが呼び出す可能性のあるツールのリスト。現在、ツールとしては関数のみがサポートされています。これを使用して、モデルが JSON 入力を生成する可能性のある関数のリストを提供します。

tools
string
enum
required

Chat completions に利用するモデル.

Allowed:
number
0 to 2

応答のばらつきを表すパラメーター。0に近いほど応答の内容は固定されます。通常、 temperaturetop_p はどちらか一方を指定します。

number
0 to 1

応答のばらつきを表すパラメーター。0に近いほど応答の内容は固定されます。通常、 temperaturetop_p はどちらか一方を指定します。

number
-2 to 2

応答に含まれるトークンの重複を抑制します。正の値を指定すると、トークン生成時に同一トークンの使用が抑制されます。

number
-2 to 2

応答に含まれるトークンの重複を抑制します。正の値を指定すると、トークン生成時に同一トークンの使用が抑制されます。 presence_penalty との違いは、presence_penalty は「トークンがこれまでの応答に現れたかどうか」に基づく重複抑制であるのに対して、 frequency_penalty は「これまでの応答に含まれる同一トークンの数」に基づく重複抑制である点です。

number

応答に利用できるトークン数。

string

応答の生成を終了する文字列。応答に stop で指定した文字列が現れた場合に生成を終了し、その直前までの応答を返します。

Headers
string

今後利用する可能性のある予約語です。現在は設定不要です。

string

認証情報を含むトークンです。"Authorization" ヘッダーに Bearer <token> の形式で設定してください。

string

リクエストのコンテンツタイプを指定します。通常は application/json を使用してください。

Response

Language
Credentials
Bearer
URL
Response
Choose an example:
application/json