フィードバック REST API

この API を使用して、エンドユーザーからCortex Agentに関するフィードバックを収集します。

Cortex Agentに関するフィードバックを収集する

POST /api/v2/databases/{database}/schemas/{schema}/agents/{name}:feedback

Cortex Agentの応答用のフィードバックイベントを作成します。

リクエスト

パスパラメーター

パラメーター

説明

database

(必須)リソースが属するデータベースの識別子。/api/v2/databases GET リクエストを使用して、利用可能なデータベースのリストを取得できます。

schema

(必須)リソースが属するスキーマの識別子。/api/v2/databases/{database}/schemas GET リクエストを使用して、特定のデータベースで利用可能なスキーマのリストを取得できます。

name

(必須)エージェントの識別子。

リクエストヘッダー

ヘッダー

説明

Authorization

(必須)認証トークン詳細については、 認証 をご参照ください。

Content-Type

(必須)application/json

リクエスト本文

リクエスト本文には、エージェント応答に対するフィードバックの詳細が含まれています。

フィールド

説明

request_id

string

フィードバックに関連付けられたリクエスト ID。

positive

boolean

応答が良い(true)か悪い(false)か。

feedback_message

string

詳細なフィードバックメッセージのテキスト。

categories

文字列の配列

フィードバックのカテゴリのリスト。各カテゴリは、フィードバックの特定のカテゴリを表す文字列です。

thread_id

整数

スレッドのID。

リクエスト本文の例

{
  "categories": [
    "Something worked well"
  ],
  "feedback_message": "this is fantastic!",
  "positive": true
}
Copy

応答

正常な応答では、確認メッセージを返します。

応答のヘッダ

ヘッダー

説明

X-Snowflake-Request-ID

API リクエストの一意の ID。

応答本文

{
  "status": "Feedback submitted successfully"
}
Copy