Merge pull request #1733 from 0xi4o/feature/chat-message-feedback

Feature: Chat message feedback

Author: 0xi4o

packages/server/src/Interface.ts

@@ -6,6 +6,11 @@ export enum chatType {
     INTERNAL = 'INTERNAL',
     EXTERNAL = 'EXTERNAL'
 }
+
+export enum ChatMessageRatingType {
+    THUMBS_UP = 'THUMBS_UP',
+    THUMBS_DOWN = 'THUMBS_DOWN'
+}
 /**
  * Databases
  */
@@ -39,6 +44,16 @@ export interface IChatMessage {
     createdDate: Date
 }
 
+export interface IChatMessageFeedback {
+    id: string
+    content?: string
+    chatflowid: string
+    chatId: string
+    messageId: string
+    rating: ChatMessageRatingType
+    createdDate: Date
+}
+
 export interface ITool {
     id: string
     name: string

packages/server/src/database/entities/ChatMessageFeedback.ts

@@ -0,0 +1,30 @@
+/* eslint-disable */
+import { Entity, Column, CreateDateColumn, PrimaryGeneratedColumn, Index, Unique } from 'typeorm'
+import { IChatMessageFeedback, ChatMessageRatingType } from '../../Interface'
+
+@Entity()
+@Unique(['messageId'])
+export class ChatMessageFeedback implements IChatMessageFeedback {
+    @PrimaryGeneratedColumn('uuid')
+    id: string
+
+    @Index()
+    @Column()
+    chatflowid: string
+
+    @Index()
+    @Column()
+    chatId: string
+
+    @Column()
+    messageId: string
+
+    @Column({ nullable: true })
+    rating: ChatMessageRatingType
+
+    @Column({ nullable: true, type: 'text' })
+    content?: string
+
+    @CreateDateColumn()
+    createdDate: Date
+}

packages/server/src/database/entities/index.ts

@@ -1,5 +1,6 @@
 import { ChatFlow } from './ChatFlow'
 import { ChatMessage } from './ChatMessage'
+import { ChatMessageFeedback } from './ChatMessageFeedback'
 import { Credential } from './Credential'
 import { Tool } from './Tool'
 import { Assistant } from './Assistant'
@@ -8,6 +9,7 @@ import { Variable } from './Variable'
 export const entities = {
     ChatFlow,
     ChatMessage,
+    ChatMessageFeedback,
     Credential,
     Tool,
     Assistant,

packages/server/src/database/migrations/mysql/1707213626553-AddFeedback.ts

@@ -0,0 +1,22 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class AddFeedback1707213626553 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(
+            `CREATE TABLE IF NOT EXISTS \`chat_message_feedback\` (
+                \`id\` varchar(36) NOT NULL,
+                \`chatflowid\` varchar(255) NOT NULL,
+                \`content\` text,
+                \`chatId\` varchar(255) NOT NULL,
+                \`messageId\` varchar(255) NOT NULL,
+                \`rating\` varchar(255) NOT NULL,
+                \`createdDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
+                PRIMARY KEY (\`id\`)
+              ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;`
+        )
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`DROP TABLE chat_message_feedback`)
+    }
+}

packages/server/src/database/migrations/mysql/index.ts

@@ -13,6 +13,7 @@ import { AddFileAnnotationsToChatMessage1700271021237 } from './1700271021237-Ad
 import { AddFileUploadsToChatMessage1701788586491 } from './1701788586491-AddFileUploadsToChatMessage'
 import { AddVariableEntity1699325775451 } from './1702200925471-AddVariableEntity'
 import { AddSpeechToText1706364937060 } from './1706364937060-AddSpeechToText'
+import { AddFeedback1707213626553 } from './1707213626553-AddFeedback'
 
 export const mysqlMigrations = [
     Init1693840429259,
@@ -29,5 +30,6 @@ export const mysqlMigrations = [
     AddFileAnnotationsToChatMessage1700271021237,
     AddFileUploadsToChatMessage1701788586491,
     AddVariableEntity1699325775451,
-    AddSpeechToText1706364937060
+    AddSpeechToText1706364937060,
+    AddFeedback1707213626553
 ]

packages/server/src/database/migrations/postgres/1707213601923-AddFeedback.ts

@@ -0,0 +1,22 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class AddFeedback1707213601923 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(
+            `CREATE TABLE IF NOT EXISTS chat_message_feedback (
+                id uuid NOT NULL DEFAULT uuid_generate_v4(),
+                "chatflowid" varchar NOT NULL,
+                "content" text,
+                "chatId" varchar NOT NULL,
+                "messageId" varchar NOT NULL,
+                "rating" varchar NOT NULL,
+                "createdDate" timestamp NOT NULL DEFAULT now(),
+                CONSTRAINT "PK_98419043dd704f54-9830ab78f8" PRIMARY KEY (id)
+            );`
+        )
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`DROP TABLE chat_message_feedback`)
+    }
+}

packages/server/src/database/migrations/postgres/index.ts

@@ -13,6 +13,7 @@ import { AddFileAnnotationsToChatMessage1700271021237 } from './1700271021237-Ad
 import { AddFileUploadsToChatMessage1701788586491 } from './1701788586491-AddFileUploadsToChatMessage'
 import { AddVariableEntity1699325775451 } from './1702200925471-AddVariableEntity'
 import { AddSpeechToText1706364937060 } from './1706364937060-AddSpeechToText'
+import { AddFeedback1707213601923 } from './1707213601923-AddFeedback'
 
 export const postgresMigrations = [
     Init1693891895163,
@@ -29,5 +30,6 @@ export const postgresMigrations = [
     AddFileAnnotationsToChatMessage1700271021237,
     AddFileUploadsToChatMessage1701788586491,
     AddVariableEntity1699325775451,
-    AddSpeechToText1706364937060
+    AddSpeechToText1706364937060,
+    AddFeedback1707213601923
 ]

packages/server/src/database/migrations/sqlite/1707213619308-AddFeedback.ts

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from 'typeorm'
+
+export class AddFeedback1707213619308 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(
+            `CREATE TABLE IF NOT EXISTS "chat_message_feedback" ("id" varchar PRIMARY KEY NOT NULL, "chatflowid" varchar NOT NULL, "chatId" varchar NOT NULL, "messageId" varchar NOT NULL, "rating" varchar NOT NULL, "content" text, "createdDate" datetime NOT NULL DEFAULT (datetime('now')));`
+        )
+        await queryRunner.query(`CREATE INDEX IF NOT EXISTS "IDX_e574527322272fd838f4f0f3d3" ON "chat_message_feedback" ("chatflowid") ;`)
+        await queryRunner.query(`CREATE INDEX IF NOT EXISTS "IDX_e574527322272fd838f4f0f3d3" ON "chat_message_feedback" ("chatId") ;`)
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`DROP TABLE IF EXISTS "chat_message_feedback";`)
+    }
+}

packages/server/src/database/migrations/sqlite/index.ts

@@ -13,6 +13,7 @@ import { AddFileAnnotationsToChatMessage1700271021237 } from './1700271021237-Ad
 import { AddFileUploadsToChatMessage1701788586491 } from './1701788586491-AddFileUploadsToChatMessage'
 import { AddVariableEntity1699325775451 } from './1702200925471-AddVariableEntity'
 import { AddSpeechToText1706364937060 } from './1706364937060-AddSpeechToText'
+import { AddFeedback1707213619308 } from './1707213619308-AddFeedback'
 
 export const sqliteMigrations = [
     Init1693835579790,
@@ -29,5 +30,6 @@ export const sqliteMigrations = [
     AddFileAnnotationsToChatMessage1700271021237,
     AddFileUploadsToChatMessage1701788586491,
     AddVariableEntity1699325775451,
-    AddSpeechToText1706364937060
+    AddSpeechToText1706364937060,
+    AddFeedback1707213619308
 ]