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

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

@@ -1,31 +1,518 @@
-import { type SessionRoleEnum } from './ISessionRole';
-
-/**
- * 会话内容
- */
-export interface ISessionContent {
-  /**
-   * sessionId
-   */
-  sessionId?: string;
-  /**
-   * 步骤id
-   */
-  stepId?: string;
-  /**
-   * 内容
-   */
-  content?: string;
-  /**
-   *  原内容类型
-   */
-  oriContentType?: string;
-  /**
-   * 角色
-   */
-  role?: SessionRoleEnum;
-  /**
-   * 备注
-   */
-  formatInfo?: string;
-}
+import { type SessionRoleEnum } from './ISessionRole';
+
+/**
+ * 会话内容
+ */
+export interface ISessionContent {
+  /**
+   * 步骤id
+   */
+  stepId?: string;
+  /**
+   * 角色
+   */
+  role?: SessionRoleEnum;
+  /**
+   * ai返回的对话内容
+   */
+  assistantMessage?: IAssistantMessage;
+  /**
+   * 用户内容
+   */
+  userMessage?: IUserMessage;
+  /**
+   * system
+   */
+  systemMessage?: ISystemMessage;
+  /**
+   * 工具信息
+   */
+  toolMessage?: IToolMessage;
+}
+
+/**
+ * 工具消息类型
+ */
+export const enum IToolTypeEnum {
+  /**
+   * 文本消息
+   */
+  TextMessage = 'textMessage',
+  /**
+   * 可视化图表消息
+   */
+  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;
+}
+
+/**
+ * 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[] | { value: number; name?: string }[];
+  /**
+   * 系列颜色
+   */
+  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;
+  };
+  /**
+   * 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;
+      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: {
+    /**
+     * 字段名称
+     */
+    name?: string;
+    /**
+     * 字段标签
+     */
+    label?: string;
+    /**
+     * 字段描述
+     */
+    description?: string;
+    /**
+     * 是否必填
+     */
+    required?: boolean;
+    /**
+     * 选项
+     */
+    options?: string[];
+    /**
+     * 占位符
+     */
+    placeholder?: string;
+  }[];
+}

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

@@ -1,21 +1,21 @@
-/**
- * 会话角色枚举
- */
-export const enum SessionRoleEnum {
-  /**
-   * 用户
-   */
-  USER = 'user',
-  /**
-   * ai
-   */
-  ASSISTANT = 'assistant',
-  /**
-   * 系统
-   */
-  SYSTEM = 'system',
-  /**
-   * 工具
-   * */
-  TOOL = 'tool'
-}
+/**
+ * 会话角色枚举
+ */
+export const enum SessionRoleEnum {
+  /**
+   * 用户
+   */
+  USER = 'user',
+  /**
+   * ai
+   */
+  ASSISTANT = 'assistant',
+  /**
+   * 系统
+   */
+  SYSTEM = 'system',
+  /**
+   * 工具
+   * */
+  TOOL = 'tool'
+}

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

@@ -1,57 +1,57 @@
-import { type SessionRoleEnum } from './ISessionRole';
-/**
- * sse流式返回片段  @deprecated 即将废弃 请整体切换到ISseData
- */
-export interface ISseChunk {
-  /**
-   * sse流式返回片段的类型
-   */
-  type: ISseChunkType;
-  /**
-   * sse流式返回片段的角色
-   */
-  role?: SessionRoleEnum;
-  /**
-   * 当type为content时sse流式返回片段的内容
-   */
-  content?: string | null;
-  /**
-   * 当type为reason时sse流式返回片段的原因
-   */
-  reason?: string | null;
-  /**
-   * 当type为formatJson时sse流式返回片段的格式化json
-   * */
-  formatJson?: {
-    /**
-     * 是否开始下一个流程
-     */
-    startNextStep?: boolean;
-    /**
-     * 可能的答案选项
-     */
-    guessAnswerList?: string[];
-    /**
-     * 是否是总结
-     */
-    isSummary?: boolean;
-  };
-}
-
-/**
- * sse流式返回片段的类型  @deprecated 即将废弃 请整体切换到ISseData
- */
-export const enum ISseChunkType {
-  /**
-   * 内容
-   */
-  CONTENT = 'content',
-  /**
-   * 原因
-   */
-  REASON = 'reason',
-  /**
-   * 格式化的json
-   * */
-  FORMATJSON = 'formatJson'
-}
+import { type SessionRoleEnum } from './ISessionRole';
+/**
+ * sse流式返回片段  @deprecated 即将废弃 请整体切换到ISseData
+ */
+export interface ISseChunk {
+  /**
+   * sse流式返回片段的类型
+   */
+  type: ISseChunkType;
+  /**
+   * sse流式返回片段的角色
+   */
+  role?: SessionRoleEnum;
+  /**
+   * 当type为content时sse流式返回片段的内容
+   */
+  content?: string | null;
+  /**
+   * 当type为reason时sse流式返回片段的原因
+   */
+  reason?: string | null;
+  /**
+   * 当type为formatJson时sse流式返回片段的格式化json
+   * */
+  formatJson?: {
+    /**
+     * 是否开始下一个流程
+     */
+    startNextStep?: boolean;
+    /**
+     * 可能的答案选项
+     */
+    guessAnswerList?: string[];
+    /**
+     * 是否是总结
+     */
+    isSummary?: boolean;
+  };
+}
+
+/**
+ * sse流式返回片段的类型  @deprecated 即将废弃 请整体切换到ISseData
+ */
+export const enum ISseChunkType {
+  /**
+   * 内容
+   */
+  CONTENT = 'content',
+  /**
+   * 原因
+   */
+  REASON = 'reason',
+  /**
+   * 格式化的json
+   * */
+  FORMATJSON = 'formatJson'
+}