@hddjs/hdd-cloud-types 1.0.14-SNAPSHOT.1 → 1.0.15-SNAPSHOT.2

package/hdd-ai-cloud/common/IGetRecommendSchool.d.ts

@@ -17,7 +17,7 @@ export interface IGetRecommendSchool {
   /**
    * 学校名称
    */
-  schoolName?: String;
+  schoolName?: string;
   /**
    * 省份id
    */

package/hdd-ai-cloud/common/IInquirySession.d.ts

@@ -2,6 +2,10 @@
  * 问询会话
  */
 export interface IInquirySession {
+  /**
+   * 会话id/主键id
+   */
+  sessionId?: string;
   /**
    * 用户id
    */
@@ -15,11 +19,15 @@ export interface IInquirySession {
    */
   counselorName?: string;
   /**
-   *  会话标题
+   * 会话标题
    */
   sessionTitle?: string;
   /**
    * 当前步骤
    */
   currentStepId?: string;
+  /**
+   * 创建时间
+   */
+  create_time?: number;
 }

package/hdd-ai-cloud/common/ISessionContent.d.ts

@@ -4,28 +4,538 @@ import { type SessionRoleEnum } from './ISessionRole';
  * 会话内容
  */
 export interface ISessionContent {
-  /**
-   * sessionId
-   */
-  sessionId?: string;
   /**
    * 步骤id
    */
   stepId?: string;
+  /**
+   * 角色
+   */
+  role?: SessionRoleEnum;
+  /**
+   * ai返回的对话内容
+   */
+  assistantMessage?: IAssistantMessage;
+  /**
+   * 用户内容
+   */
+  userMessage?: IUserMessage;
+  /**
+   * system
+   */
+  systemMessage?: ISystemMessage;
+  /**
+   * 工具信息
+   */
+  toolMessage?: IToolMessage;
+}
+
+/**
+ * 系统消息
+ */
+export interface ISystemMessage {
   /**
    * 内容
    */
   content?: string;
+}
+
+/**
+ * 工具消息类型
+ */
+export const enum IToolTypeEnum {
   /**
-   *  原内容类型
+   * 文本消息
    */
-  oriContentType?: string;
+  TextMessage = 'textMessage',
   /**
-   * 角色
+   * 可视化图表消息
    */
-  role?: SessionRoleEnum;
+  VisualChart = 'visualChart',
+  /**
+   * 行为动作消息 如结束对话、展示按钮等行为
+   */
+  BehaviorAction = 'behaviorAction',
+  /**
+   * 收集结构化信息
+   */
+  CollectStructured = 'collectStructured'
+}
+
+/**
+ * ai消息
+ */
+export interface IAssistantMessage {
+  /**
+   * content：正文， reason：思考
+   */
+  type?: 'content' | 'reason';
+  /**
+   * 内容
+   */
+  content?: string;
+  /**
+   * 思考内容
+   */
+  reason?: string;
+}
+
+/**
+ * 用户消息
+ */
+export interface IUserMessage {
+  /**
+   * 内容
+   */
+  content?: string;
   /**
-   * 格式化信息
+   * 格式化信息，json字符串，前端要json parse一下
    */
   formatInfo?: string;
+  /**
+   * 原内容类型，语音、文字、图片
+   */
+  oriContentType?: string;
+}
+
+export interface IToolMessage {
+  /**
+   * 工具消息类型
+   */
+  type?: IToolTypeEnum;
+  /**
+   * 工具消息内容
+   */
+  content?: string;
+  /**
+   * 可视化图表数据
+   */
+  visualChartData?: IVisualChartData;
+  /**
+   * 行为动作
+   */
+  behaviorAction?: {
+    /**
+     * 行为动作
+     */
+    action?: IBehaviorAction;
+    /**
+     * 行为动作描述
+     */
+    actionDescription?: string;
+  };
+  /**
+   * 需要收集结构化信息
+   */
+  needCollectStructuredInfo?: INeedCollectStructuredInfo;
+}
+
+/**
+ * 系统消息
+ */
+export interface ISystemMessage {}
+
+/**
+ * uCharts 图表类型
+ */
+export type UChartsType =
+  | 'line' // 折线图
+  | 'column' // 柱状图
+  | 'bar' // 条形图
+  | 'area' // 区域图
+  | 'pie' // 饼图
+  | 'ring' // 环形图
+  | 'rose' // 玫瑰图
+  | 'radar' // 雷达图
+  | 'arcbar' // 圆弧进度条
+  | 'gauge' // 仪表盘
+  | 'candle' // K线图
+  | 'mix' // 混合图
+  | 'funnel' // 漏斗图
+  | 'map' // 地图
+  | 'word' // 词云图
+  | 'scatter' // 散点图
+  | 'bubble'; // 气泡图
+
+/**
+ * uCharts 图表数据 series 项
+ */
+export interface IUChartsSeries {
+  /**
+   * 系列名称
+   */
+  name?: string;
+  /**
+   * 数据值数组
+   */
+  data?: number[] | number;
+  /**
+   * 系列颜色
+   */
+  color?: string;
+  /**
+   * 图表类型（用于混合图）
+   */
+  type?: UChartsType;
+  /**
+   * 是否在右侧Y轴显示
+   */
+  index?: number;
+  /**
+   * 是否显示数据标签
+   */
+  textShow?: boolean;
+  /**
+   * 数据标签字体大小
+   */
+  textSize?: number;
+  /**
+   * 数据标签颜色
+   */
+  textColor?: string;
+}
+
+/**
+ * uCharts 图表数据
+ */
+export interface IUChartsData {
+  /**
+   * X轴分类标签
+   */
+  categories?: string[];
+  /**
+   * 数据系列
+   */
+  series?: IUChartsSeries[];
+}
+
+/**
+ * uCharts 配置项
+ */
+export interface IUChartsOpts {
+  /**
+   * 画布宽度
+   */
+  width?: number;
+  /**
+   * 画布高度
+   */
+  height?: number;
+  /**
+   * 图表标题
+   */
+  title?: {
+    name?: string;
+    fontSize?: number;
+    color?: string;
+    offsetX?: number;
+    offsetY?: number;
+  };
+  /**
+   * 图表副标题
+   */
+  subtitle?: {
+    name?: string;
+    fontSize?: number;
+    color?: string;
+    offsetX?: number;
+    offsetY?: number;
+  };
+  /**
+   * 颜色数组
+   */
+  color?: string[];
+  /**
+   * 内边距
+   */
+  padding?: [number, number, number, number];
+  /**
+   * 是否开启动画
+   */
+  animation?: boolean;
+  /**
+   * 动画时长(ms)
+   */
+  duration?: number;
+  /**
+   * 是否显示图例
+   */
+  legend?: {
+    show?: boolean;
+    position?: 'top' | 'bottom' | 'left' | 'right';
+    float?: 'left' | 'center' | 'right';
+    fontSize?: number;
+    lineHeight?: number;
+    fontColor?: string;
+    margin?: number;
+    padding?: number;
+    itemGap?: number;
+  };
+  /**
+   * X轴配置
+   */
+  xAxis?: {
+    disabled?: boolean;
+    axisLine?: boolean;
+    axisLineColor?: string;
+    calibration?: boolean;
+    fontColor?: string;
+    fontSize?: number;
+    rotateLabel?: boolean;
+    rotateAngle?: number;
+    labelCount?: number;
+    itemCount?: number;
+    boundaryGap?: 'center' | 'justify';
+    disableGrid?: boolean;
+    gridColor?: string;
+    gridType?: 'solid' | 'dash';
+    dashLength?: number;
+    gridEval?: number;
+    scrollShow?: boolean;
+    scrollAlign?: 'left' | 'right';
+    scrollColor?: string;
+    scrollBackgroundColor?: string;
+    format?: string;
+    min?: number;
+    max?: number;
+  };
+  /**
+   * Y轴配置
+   */
+  yAxis?: {
+    disabled?: boolean;
+    disableGrid?: boolean;
+    splitNumber?: number;
+    gridType?: 'solid' | 'dash';
+    dashLength?: number;
+    gridColor?: string;
+    padding?: number;
+    showTitle?: boolean;
+    data?: {
+      min?: number;
+      max?: number;
+      unit?: string;
+      type?: 'value' | 'category';
+      disabled?: boolean;
+      axisLine?: boolean;
+      axisLineColor?: string;
+      calibration?: boolean;
+      fontColor?: string;
+      fontSize?: number;
+      textAlign?: 'left' | 'center' | 'right';
+      title?: string;
+      titleFontSize?: number;
+      titleOffsetY?: number;
+      titleOffsetX?: number;
+      titleFontColor?: string;
+      format?: (val: number) => string;
+    }[];
+  };
+  /**
+   * 额外配置
+   */
+  extra?: {
+    [key: string]: any;
+    line?: {
+      type?: 'straight' | 'curve' | 'step';
+      width?: number;
+      activeType?: 'hollow' | 'solid';
+      linearType?: 'none' | 'custom';
+      onShadow?: boolean;
+      animation?: 'vertical' | 'horizontal';
+    };
+    column?: {
+      type?: 'group' | 'stack';
+      width?: number;
+      seriesGap?: number;
+      categoryGap?: number;
+      barBorderCircle?: boolean;
+      barBorderRadius?: number[];
+      linearType?: 'none' | 'custom';
+      linearOpacity?: number;
+      customColor?: string[];
+      colorStop?: number;
+      meterBorder?: number;
+      meterFillColor?: string;
+      activeBgColor?: string;
+      activeBgOpacity?: number;
+      meterGap?: number;
+    };
+    pie?: {
+      activeOpacity?: number;
+      activeRadius?: number;
+      offsetAngle?: number;
+      labelWidth?: number;
+      ringWidth?: number;
+      customRadius?: number;
+      border?: boolean;
+      borderWidth?: number;
+      borderColor?: string;
+      linearType?: 'none' | 'custom';
+    };
+    radar?: {
+      gridType?: 'radar' | 'circle';
+      gridColor?: string;
+      gridCount?: number;
+      opacity?: number;
+      max?: number;
+      labelShow?: boolean;
+      border?: boolean;
+      labelColor?: string;
+      labelPointShow?: boolean;
+      labelPointColor?: string;
+    };
+    gauge?: {
+      type?: 'default' | 'progress';
+      width?: number;
+      splitLine?: {
+        fixRadius?: number;
+        splitNumber?: number;
+        width?: number;
+        color?: string;
+        childNumber?: number;
+        childWidth?: number;
+      };
+      pointer?: {
+        width?: number;
+        color?: string;
+      };
+    };
+  };
+  /**
+   * 数据标签配置
+   */
+  dataLabel?: boolean;
+  /**
+   * 数据点标记配置
+   */
+  dataPointShape?: boolean;
+  /**
+   * 数据点标记大小
+   */
+  dataPointShapeType?: 'solid' | 'hollow';
+  /**
+   * 触摸提示配置
+   */
+  enableScroll?: boolean;
+  /**
+   * 触摸提示配置
+   */
+  touchMoveLimit?: number;
+  /**
+   * 提示框配置
+   */
+  tooltip?: {
+    show?: boolean;
+    showBox?: boolean;
+    showArrow?: boolean;
+    showCategory?: boolean;
+    borderWidth?: number;
+    borderColor?: string;
+    borderRadius?: number;
+    boxPadding?: number;
+    bgColor?: string;
+    bgOpacity?: number;
+    fontColor?: string;
+    fontSize?: number;
+    lineHeight?: number;
+    legendShow?: boolean;
+    legendShape?: 'auto' | 'circle' | 'line' | 'rect';
+    splitLine?: boolean;
+    horizen498tal?: boolean;
+    xAxisLabel?: boolean;
+    yAxisLabel?: boolean;
+    labelBgColor?: string;
+    labelBgOpacity?: number;
+    labelFontColor?: string;
+    format?: (item: any, category: string, index: number, opts: IUChartsOpts) => string;
+  };
+}
+
+/**
+ * 可视化图表返回数据
+ */
+export interface IVisualChartData {
+  /**
+   * 图表类型
+   */
+  type?: UChartsType;
+  /**
+   * uCharts 配置项
+   */
+  opts?: IUChartsOpts;
+  /**
+   * uCharts 图表数据
+   */
+  chartData?: IUChartsData;
+}
+
+/**
+ * 行为动作
+ */
+export const enum IBehaviorAction {
+  /**
+   * 结束当前咨询流程,开始生成报告
+   */
+  EndInquiryToGenerateReport = 'endInquiryToGenerateReport'
+}
+
+/**
+ * 需要收集结构化信息
+ */
+export interface INeedCollectStructuredInfo {
+  /**
+   * 表单类型
+   */
+  type?: string;
+  /**
+   * 对用户的语言提示
+   */
+  voiceTip?: string;
+  /**
+   * 表单标题
+   */
+  title?: string;
+  /**
+   * 表单描述
+   */
+  description?: string;
+  /**
+   * 等效的AI内容（当不使用结构化展示时候可以使用等效的AI内容展示给用户 或 用于上下文）
+   */
+  equalAiContent?: string;
+  /**
+   * 需要收集的字段列表
+   */
+  fields: ICollectStructuredInfoField[];
+}
+
+/**
+ * 需要收集的字段列表
+ */
+export interface ICollectStructuredInfoField {
+  /**
+   * 字段名称
+   */
+  name?: string;
+  /**
+   * 字段标签
+   */
+  label?: string;
+  /**
+   * 字段描述
+   */
+  description?: string;
+  /**
+   * 是否必填
+   */
+  required?: boolean;
+  /**
+   * 选项
+   */
+  options?: string[];
+  /**
+   * 占位符
+   */
+  placeholder?: string;
 }

package/hdd-ai-cloud/common/ISseData.d.ts

@@ -1,175 +1,33 @@
-/**
- * 工具消息类型
- */
-export const enum IToolTypeEnum {
-  /**
-   * 文本消息
-   */
-  TextMessage = 'textMessage',
-  /**
-   * 可视化图表消息
-   */
-  VisualChart = 'visualChart',
-  /**
-   * 行为动作消息 如结束对话、展示按钮等行为
-   */
-  BehaviorAction = 'behaviorAction'
-}
-
+import { type ISessionContent } from './ISessionContent';
+import { type ICommonError } from './ICommonError';
 /**
  * sse流式返回片段
  */
-export interface ISseData {
+export interface ISseData extends ISessionContent {
   /**
-   * 流式返回片段的类型
+   * sse类型 默认为messageItem
+   * messageItem: 消息项
+   * errorInfo: 错误信息
    */
-  type: SseDataTypeEnum;
+  sseType?: SseTypeEnum;
   /**
-   * 标识对话步骤id
+   * sse返回的错误信息
    */
-  stepId?: string;
-  /**
-   * ai返回的对话内容
-   */
-  aiMessage?: {
-    content?: string;
-  };
-  /**
-   * ai思考的内容
-   */
-  aiThinking?: {
-    reason?: string;
-  };
-  /**
-   * 需要收集非结构化信息
-   */
-  needCollectstructuredInfo?: INeedCollectStructuredInfo;
-  /**
-   * 错误信息
-   */
-  errorInfo?: {
-    errCode?: string;
-    errMsg?: string;
-  };
-  /**
-   * 工具消息
-   */
-  toolMessage?: {
-    /**
-     * 工具消息类型
-     */
-    toolType?: IToolTypeEnum;
-    /**
-     * 工具消息内容
-     */
-    toolContent?: string;
-    /**
-     * 可视化图表数据
-     */
-    visualChartData?: Record<string, any>;
-    /**
-     * 行为动作
-     */
-    behaviorAction?: {
-      /**
-       * 行为动作
-       */
-      action?: IBehaviorAction;
-      /**
-       * 行为动作描述
-       */
-      actionDescription?: string;
-    };
-  };
+  sseErrorInfo?: ICommonError;
 }
 
 /**
- * 行为动作
+ * sse类型 默认为messageItem
+ * messageItem: 消息项
+ * errorInfo: 错误信息
  */
-export const enum IBehaviorAction {
+export const enum SseTypeEnum {
   /**
-   * 结束当前咨询流程,开始生成报告
+   * 消息项
    */
-  EndInquiryToGenerateReport = 'endInquiryToGenerateReport'
-}
-
-/**
- * sse流式返回片段的类型
- */
-export const enum SseDataTypeEnum {
-  /**
-   * ai返回的对话内容
-   */
-  AIMessage = 'aiMessage',
-  /**
-   * ai思考的内容
-   */
-  AiThinking = 'aiThinking',
-  /**
-   * 需要收集结构化信息
-   */
-  NeedCollectStructuredInfo = 'needCollectStructuredInfo',
+  MessageItem = 'messageItem',
   /**
    * 错误信息
    */
-  ErrorInfo = 'errorInfo',
-  /**
-   * 工具消息
-   */
-  ToolMessage = 'toolMessage'
-}
-
-/**
- * 需要收集结构化信息
- */
-export interface INeedCollectStructuredInfo {
-  /**
-   * 表单类型
-   */
-  type?: string;
-  /**
-   * 对用户的语言提示
-   */
-  voiceTip?: string;
-  /**
-   * 表单标题
-   */
-  title?: string;
-  /**
-   * 表单描述
-   */
-  description?: string;
-  /**
-   * 等效的AI内容（当不使用结构化展示时候可以使用等效的AI内容展示给用户 或 用于上下文）
-   */
-  equalAiContent?: string;
-  /**
-   * 需要收集的字段列表
-   */
-  fields: {
-    /**
-     * 字段名称
-     */
-    name?: string;
-    /**
-     * 字段标签
-     */
-    label?: string;
-    /**
-     * 字段描述
-     */
-    description?: string;
-    /**
-     * 是否必填
-     */
-    required?: boolean;
-    /**
-     * 选项
-     */
-    options?: string[];
-    /**
-     * 占位符
-     */
-    placeholder?: string;
-  }[];
+  ErrorInfo = 'errorInfo'
 }

package/hdd-ai-cloud/controller/getRankInfo.d.ts

@@ -0,0 +1,51 @@
+import { type ICommonReq, type ICommonRes } from '../common';
+
+export interface IGetRankInfoReq extends ICommonReq {
+  /**
+   * 成绩信息
+   */
+  scoreInfo: IScoreInfoItem[];
+}
+
+export interface IScoreInfoItem {
+  /**
+   * 年份
+   */
+  year?: number;
+  /**
+   * 省份id
+   */
+  provinceId: string;
+  /**
+   * 分数
+   */
+  grade: number;
+}
+
+export interface IGetRankInfoRes extends ICommonRes {
+  data?: {
+    /**
+     * 排名信息
+     */
+    rankInfo?: Array<IRankInfoItem | null>;
+  };
+}
+
+export interface IRankInfoItem {
+  /**
+   * 年份
+   */
+  year: number;
+  /**
+   * 省份id
+   */
+  provinceId: string;
+  /**
+   * 分数
+   */
+  grade: number;
+  /**
+   * 排名
+   */
+  rank: number;
+}

package/hdd-ai-cloud/controller/index.d.ts

@@ -387,7 +387,12 @@ export interface IGetInquirySessionListRes extends ICommonRes {
 /**
  * 添加会话内容req
  */
-export interface IAddSessionContentReq extends ICommonReq, ISessionContent {}
+export interface IAddSessionContentReq extends ICommonReq, ISessionContent {
+  /**
+   * 会话id
+   */
+  sessionId?: string;
+}
 
 /**
  * 添加会话内容res

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hddjs/hdd-cloud-types",
-  "version": "1.0.14-SNAPSHOT.1",
+  "version": "1.0.15-SNAPSHOT.2",
   "main": "index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"