@lobehub/chat/src/database/_deprecated/schemas/message.ts

Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.

/* eslint-disable sort-keys-fix/sort-keys-fix  */
import { z } from 'zod';

const TranslateSchema = z.object({
  from: z.string().optional(),
  to: z.string(),
  content: z.string().optional(),
});

const PluginSchema = z.object({
  identifier: z.string(),
  arguments: z.string(),
  apiName: z.string(),
  type: z.enum(['default', 'markdown', 'standalone', 'builtin', 'mcp']).default('default'),
});

const ToolCallSchema = PluginSchema.extend({
  id: z.string(),
});

export const DB_MessageSchema = z.object({
  role: z.enum(['user', 'system', 'assistant', 'tool']),
  content: z.string(),
  files: z.array(z.string()).optional(),
  favorite: z.number().int().min(0).max(1).optional(),
  error: z.any().optional(),

  tools: z.array(ToolCallSchema).optional(),
  tool_call_id: z.string().optional(),

  plugin: PluginSchema.optional(),
  pluginState: z.any().optional(),
  pluginError: z.any().optional(),

  fromModel: z.string().optional(),
  fromProvider: z.string().optional(),
  translate: TranslateSchema.optional().or(z.literal(false)).or(z.null()),
  tts: z.any().optional(),

  traceId: z.string().optional(),
  observationId: z.string().optional(),

  // foreign keys
  parentId: z.string().optional(),
  quotaId: z.string().optional(),
  sessionId: z.string(),
  topicId: z.string().nullable().optional(),
});

export type DB_Message = z.infer<typeof DB_MessageSchema>;