機能の概要
OpenAI互換のチャット補完インターフェースで、ストリーミング応答と非ストリーミング応答をサポートしています。大規模言語モデルを呼び出して対話やコンテンツ生成などを行うシナリオに適しています。
呼び出しの手順
インターフェース制約
- 呼び出し元はAPIキーを保有している必要があります。詳細については、AI APIキーの管理をご参照ください。
リクエストパス
POST {BASE_URL}/api/v1/chat/completions
リクエストヘッダー
プロパティ |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
リクエストパラメータ
Pathパラメータ
なし
Queryパラメータ
なし
Bodyパラメータ
プロパティ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| model | string | はい | gpt-3.5-turbo | モデル名 |
| messages | array[object] | はい | [{"role": "user", "content": "Hello!"}] | メッセージリスト |
| stream | boolean | いいえ | false | ストリーミング出力を有効にするかどうか |
| max_tokens | integer | いいえ | 2048 | 生成される最大トークン数 |
| max_completion_tokens | integer | いいえ | 512 | 补完部分の最大トークン数 |
| temperature | number | いいえ | 1.0 | サンプリング温度。0から2の範囲 |
| top_p | number | いいえ | 1.0 | コアサンプリングパラメータ |
| user | string | いいえ | user-123 | 最終ユーザーを表す識別子 |
実行結果
パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうか |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | 業務データ |
dataフィールドの説明
名前 |
型 |
説明 |
|---|---|---|
| id | string | 会話補完の一意のID |
| object | string | オブジェクトタイプ。例："chat.completion" |
| created | integer | 作成時刻のタイムスタンプ |
| model | string | 使用されたモデル |
| choices | array[object] | 生成された選択肢リスト |
| usage | object | トークンの使用状況 |
リクエスト例
curl --request POST '{BASE_URL}/api/v1/chat/completions' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"model": "gpt-3.5-turbo",
"messages": [
{"role": "user", "content": "Hello!"}
],
"stream": false,
"max_tokens": 2048,
"temperature": 1.0
}'
レスポンス例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652288,
"model": "gpt-3.5-turbo",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Hello there! How can I assist you today?"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 9,
"completion_tokens": 12,
"total_tokens": 21
}
}
}