メッセージフィードバックを送信

対象アプリ：Chatflow、チャットボット、Agent、テキストジェネレーター。

メッセージに like または dislike の評価と、任意のコメントを記録します。rating に null を送信すると、そのメッセージの既存のフィードバックを取り消します。

POST /messages/{message_id}/feedbacks

メッセージフィードバックを送信

cURL

curl --request POST \
  --url https://{api_base_url}/messages/{message_id}/feedbacks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rating": "like",
  "user": "abc-123",
  "content": "This answer was very helpful!"
}
'

import requests

url = "https://{api_base_url}/messages/{message_id}/feedbacks"

payload = {
    "rating": "like",
    "user": "abc-123",
    "content": "This answer was very helpful!"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({rating: 'like', user: 'abc-123', content: 'This answer was very helpful!'})
};

fetch('https://{api_base_url}/messages/{message_id}/feedbacks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/messages/{message_id}/feedbacks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'rating' => 'like',
    'user' => 'abc-123',
    'content' => 'This answer was very helpful!'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/messages/{message_id}/feedbacks"

	payload := strings.NewReader("{\n  \"rating\": \"like\",\n  \"user\": \"abc-123\",\n  \"content\": \"This answer was very helpful!\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{api_base_url}/messages/{message_id}/feedbacks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rating\": \"like\",\n  \"user\": \"abc-123\",\n  \"content\": \"This answer was very helpful!\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/messages/{message_id}/feedbacks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rating\": \"like\",\n  \"user\": \"abc-123\",\n  \"content\": \"This answer was very helpful!\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "result": "success"
}

{
  "status": 400,
  "code": "invalid_param",
  "message": "Arg user must be provided."
}

{
  "status": 404,
  "code": "not_found",
  "message": "Message Not Exists."
}

Authorizations

Authorization · string · header · required

すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。

Path Parameters

message_id · string<uuid> · required

フィードバックを送信するメッセージの ID です。メッセージ ID は 会話履歴メッセージ一覧を取得 から取得します。

Body

application/json

メッセージフィードバックを送信するためのリクエストボディ。

user · string · required

エンドユーザーの識別子。アプリ側で定義し、アプリ内で一意にします。フィードバックはそのエンドユーザーにスコープされるため、メッセージを受け取った user と一致する必要があります。エンドユーザーの識別 を参照してください。

rating · enum<string> | null

フィードバック評価。以前送信したフィードバックを取り消すには null に設定します。

Available options: like, dislike, null

content · string

追加の詳細を提供する任意のテキストフィードバック。

Response

200

application/json

操作が成功しました。

result · string

操作結果。常に success です。