エージェントレスポンスの評価
エージェントレスポンスの評価
エージェントが生成したコンテンツの品質を、開発者や運用担当者が確認・評価できるようにサポートし、レスポンス内容の妥当性を把握・改善に役立てることができます。
リクエストメソッド
POST
エンドポイント
https://api-${endpoint}.gptbots.ai/v1/message/quality
認証
認証方法の説明についてはAPI Overviewをご参照ください。
リクエスト
リクエスト例
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/message/quality' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"answer_id": "123456789",
"quality": "FULLY_RESOLVED"
}'
curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/message/quality' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
"answer_id": "123456789",
"quality": "FULLY_RESOLVED"
}'
このコードブロックをポップアップで表示
リクエストヘッダー
| フィールド | タイプ | 説明 |
|---|---|---|
| Authorization | Bearer ${API Key} | 認証には Authorization: Bearer ${API Key} を使用してください。トークンはAPIキーページから取得できます。 |
| Content-Type | application/json | データの形式は application/json を設定してください。 |
リクエストボディ
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
| answer_id | String | 必須 | エージェントの返信ID。 |
| quality | String | 必須 | エージェントのレスポンスに対する品質評価。指定可能な値： - NONE: フィードバックなし - UNRESOLVED: 未解決 - PARTIALLY_RESOLVED: 部分的に解決 - FULLY_RESOLVED: 完全に解決 |
レスポンス
レスポンス例
{
"affectCount": 1
}
{
"affectCount": 1
}
このコードブロックをポップアップで表示
成功時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| affectCount | Long | このインスタンスにおける評価の成功回数です。1 の場合は成功を意味します。 |
エラー時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| code | Int | エラーコード |
| message | String | エラー詳細内容 |
エラーコード
| コード | メッセージ |
|---|---|
| 40000 | 無効なパラメータ |
| 40127 | 開発者認証に失敗しました |
| 20059 | エージェントが削除されました |