エージェントレスポンスの評価
エージェントレスポンスの評価
ユーザーがエージェントのレスポンスに対してフィードバックを送信できる機能です。
これにより、エージェント開発者はレスポンスの品質を改善できます。
リクエストメソッド
POST
リクエストURL
https://api-${endpoint}.gptbots.ai/v1/message/feedback
リクエスト認証
認証方法の説明についてはAPI Overviewをご参照ください。
リクエスト
リクエスト例
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/message/feedback' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"answer_id": "123456789",
"feedback": "POSITIVE"
}'
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/message/feedback' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"answer_id": "123456789",
"feedback": "POSITIVE"
}'
このコードブロックをポップアップで表示
リクエストヘッダー
| フィールド | タイプ | 説明 |
|---|---|---|
| Authorization | Bearer ${API Key} | 認証には Authorization: Bearer ${API Key} を使用してください。トークンはAPIキーページから取得できます。 |
| Content-Type | application/json | データの形式は application/json を設定してください。 |
リクエストボディ
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
| answer_id | string | 必須 | エージェントのレスポンスに対するメッセージIDです。 |
| feedback | string | 必須 | エージェントのレスポンスに対するフィードバックの種類。 - POSITIVE: ポジティブ(良い、いいね、承認) - NEGATIVE: ネガティブ(悪い、よくない、非承認) - CANCELED: フィードバックの取り消し |
レスポンス
レスポンス例
{
"affectCount": 0
}
{
"affectCount": 0
}
このコードブロックをポップアップで表示
成功時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| affectCount | Long | 処理されたフィードバックの数。成功時には1が表示されます。 |
エラー時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| code | Int | エラーコード |
| message | String | エラーの詳細情報 |
エラーコード
| コード | メッセージ |
|---|---|
| 40000 | 無効なパラメータ |
| 40127 | 開発者認証に失敗しました |
| 20059 | エージェントが削除されています |
