機能の概要
OpenAI Responses互換エントリポイントです。現在は非ストリーミング呼び出しのみをサポートしています。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPI Keyを保有している必要があります。詳細については、AI API Keyの管理を参照してください。
リクエストパス
POST {BASE_URL}/api/v1/responses
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
リクエストパラメータ
Pathパラメータ
なし
Queryパラメータ
なし
Bodyパラメータ
パラメータ名 |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| model | string | はい | gpt-3.5-turbo | モデル名 |
| input | unknown | はい | ユーザー入力内容 | 入力内容 |
| instructions | string | はい | あなたはアシスタントです。 | システム指示 |
| stream | boolean | はい | false | ストリーミング出力を有効にするかどうか。現在はfalseのみサポートしています。 |
| max_output_tokens | integer | いいえ | 1000 | 最大出力トークン数 |
| temperature | number | いいえ | 0.7 | サンプリング温度 |
| top_p | number | いいえ | 1.0 | 核（nucleus）サンプリングのパラメータ |
| user | string | いいえ | user-123 | ユーザーID |
実行結果
戻り値パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうか |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | ビジネスデータを返します。 |
dataフィールドの説明
名前 |
型 |
説明 |
|---|---|---|
| response | unknown | モデルが生成した応答内容 |
リクエスト例
curl --request POST '{BASE_URL}/api/v1/responses' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"model": "gpt-3.5-turbo",
"input": "こんにちは",
"instructions": "あなたはアシスタントです。",
"stream": false,
"max_output_tokens": 1000,
"temperature": 0.7,
"top_p": 1.0,
"user": "user-123"
}'
戻り値の例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"response": "こんにちは！何かお手伝いできることはありますか？"
}
}