@hddjs/hdd-cloud-types 1.0.6 → 1.0.10

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

@@ -1,453 +1,496 @@
-import { type IChatAiMessageItem } from '../common/IChatAiMessageItem';
-import {
-  type ICommonReq,
-  type AISceneEnum,
-  type ICommonRes,
-  type ISelectSubject,
-  type IInquiryBasicInfo,
-  type IInquirySession,
-  type ISessionContent,
-  type IGetRecommendSchool,
-  type IScoreRank,
-  type IReportResult
-} from '../common';
-import { type ICounselorType } from '../common/ICounselorType';
-
-/**
- *  千问AI聊天api 请求参数
- */
-export interface IChatQwenReq extends ICommonReq {
-  /**
-   * 历史对话消息
-   */
-  messages: IChatAiMessageItem[];
-  /**
-   * 是否开启流式传输
-   */
-  stream: boolean;
-  /**
-   * 提问场景
-   */
-  scene?: AISceneEnum;
-  /**
-   * 通道id(如果开启流式传输stream为true则必传)
-   */
-  channel?: string;
-  /**
-   * 是否开发模式 仅调式使用 默认false 前端禁止使用
-   */
-  devMode?: boolean;
-  /**
-   *会话id 如有则表示是已经创建的聊天 没有则表示是新聊天
-   */
-  sessionId?: string;
-  /**
-   *会话步骤id
-   */
-  stepId?: string;
-}
-
-/**
- * 千问AI聊天api 返回参数
- */
-export interface IChatQwenRes extends ICommonReq {
-  /**
-   * ai回复消息(完成拼接之后的消息)
-   */
-  message: string;
-  /**
-   * llm运行总时间 单位ms
-   */
-  llmRunTime: number;
-}
-
-/**
- * AI聊天api 单次流式传输返回参数
- */
-export interface IChatAIStreamRes {
-  /**
-   * 当前返回的消息
-   */
-  chunkMessage: string;
-  /**
-   * 深度思考的原因 仅deepseek模型返回
-   */
-  chunkReasonMessage?: string;
-  /**
-   * 索引(从0开始) 本次流式消息是整体流式消息的第几个
-   */
-  index: number;
-}
-
-/**
- *  DeepSeek AI聊天api 请求参数
- */
-export interface IChatDeepSeekReq extends ICommonReq {
-  /**
-   * 历史对话消息
-   */
-  messages: IChatAiMessageItem[];
-  /**
-   * 是否开启流式传输
-   */
-  stream: boolean;
-  /**
-   * 通道id(如果开启流式传输stream为true则必传)
-   */
-  channel?: string;
-  /**
-   * 提问场景
-   */
-  scene?: AISceneEnum;
-  /**
-   * 是否开发模式 仅调式使用 默认false 前端禁止使用
-   */
-  devMode?: boolean;
-}
-
-/**
- * DeepSeek AI聊天api 返回参数
- */
-export interface IChatDeepSeekRes extends ICommonReq {
-  /**
-   * ai回复消息(完成拼接之后的消息)
-   */
-  message: string;
-  /**
-   * deepseek深度思考给出的原因
-   */
-  reasonMessage: string;
-  /**
-   * llm运行总时间 单位ms
-   */
-  llmRunTime: number;
-}
-
-export interface IGuessAnswerListReq extends ICommonReq {
-  /**
-   * 问题内容
-   */
-  content: string;
-  /**
-   * 临时消息id
-   */
-  tempMsgId: string;
-  /**
-   * 场景
-   */
-  scene?: AISceneEnum;
-}
-
-export interface IGuessAnswerListRes extends ICommonRes {
-  /**
-   * 关联的问题id
-   */
-  relatedTempMsgId?: string;
-  /**
-   * 可能的答案选项
-   */
-  choices?: string[];
-}
-
-/**
- * 生成报告的req
- */
-export interface IGenerateReportReq extends ICommonReq {
-  /**
-   * 会话id
-   */
-  sessionId?: string;
-  /**
-   * 报告id
-   */
-  reportId?: string;
-  /**
-   * 报告类型，例如：专业、性格
-   */
-  reportType?: string;
-  /**
-   * 咨询类型
-   */
-  counselorId?: string;
-  /**
-   * 报告所需数据
-   */
-  params?: any;
-}
-
-/**
- * 生成报告的res
- */
-export interface IGenerateReportRes extends ICommonRes {}
-
-/**
- * 获取咨询师类型的响应
- */
-export interface IGetCounselorTypeRes extends ICommonRes {
-  data?: ICounselorType[] | null;
-}
-
-/**
- * 智能体的req
- */
-export interface IAgentReq extends ICommonReq {
-  /**
-   * 智能体类型 necc为高考智能体
-   */
-  type: 'ncee';
-  /**
-   * 节点名称 恢复对话时候前端透传需要回到的节点名称
-   */
-  gotoNodeName?: string;
-  /**
-   * 会话id
-   */
-  sessionId?: string;
-  /**
-   * 用户输入信息
-   */
-  content?: string;
-  /**
-   * 是否是恢复上次的会话 'F' | 'T'
-   */
-  isResume?: 'F' | 'T';
-  /**
-   * 是否展示图表数据 'F' | 'T'
-   */
-  showGraph?: 'F' | 'T';
-  gaokaoData: {
-    /**
-     * 高考排名
-     */
-    rank?: string;
-    /**
-     * 高考主要选课
-     */
-    mainSubject?: string;
-  };
-}
-
-/**
- * 智能体res
- */
-export interface IAgentRes extends ICommonRes {
-  data?: {
-    /**
-     * 图结构showGraph为'T'时返回
-     */
-    base64Image?: string;
-    /**
-     * 智能体回复的消息
-     */
-    message: string[];
-  };
-}
-
-export interface ISttOneMinuteRes extends ICommonRes {
-  data?: {
-    /**
-     * 翻译结果
-     */
-    transResult?: string;
-  };
-}
-
-/**
- * 获取group info的req
- */
-export interface IGetGroupInfoReq extends ICommonReq, ISelectSubject {}
-
-/**
- * 获取group info的res
- */
-export interface IGetGroupInfoRes extends ICommonRes {
-  data?: {
-    /**
-     * 组别id
-     */
-    groupId?: number;
-    /**
-     * 描述
-     */
-    desc?: string;
-  };
-}
-
-/**
- * 添加基础信息req
- */
-export interface IAddInquiryBasicInfoReq extends ICommonReq, IInquiryBasicInfo {}
-
-/**
- * 添加基础信息res
- */
-export interface IAddInquiryBasicInfoRes extends ICommonRes {
-  data?: {
-    /**
-     * 基础信息id
-     */
-    basicId?: string;
-  };
-}
-
-/**
- * 获取基础信息req
- */
-export interface IGetInquiryBasicInfoReq extends ICommonRes {
-  sessionId?: string;
-}
-
-/**
- * 添加基础信息res
- */
-export interface IGetInquiryBasicInfoRes extends ICommonRes {
-  data?: {
-    /**
-     * 基础信息
-     */
-    basicInfo?: IInquiryBasicInfo;
-  };
-}
-
-/**
- * 添加问询会话req
- */
-export interface IAddInquirySessionReq extends ICommonReq, IInquirySession {}
-
-/**
- * 添加问询会话res
- */
-export interface IAddInquirySessionRes extends ICommonRes {
-  data?: {
-    /**
-     * 问询会话id
-     */
-    sessionId?: string;
-  };
-}
-
-/**
- * 获取问询会话req
- */
-export interface IGetInquirySessionListReq extends ICommonRes {
-  /**
-   * 咨询师id
-   */
-  counselorId?: string;
-}
-
-/**
- * 添加问询会话res
- */
-export interface IGetInquirySessionListRes extends ICommonRes {
-  data?: {
-    /**
-     * 问询会话列表
-     */
-    sessionInfos?: IInquirySession[];
-  };
-}
-
-/**
- * 添加会话内容req
- */
-export interface IAddSessionContentReq extends ICommonReq, ISessionContent {}
-
-/**
- * 添加会话内容res
- */
-export interface IAddSessionContentRes extends ICommonRes {
-  data?: {
-    /**
-     * 会话内容id
-     */
-    contentId?: string;
-  };
-}
-
-/**
- * 获取会话内容req
- */
-export interface IGetSessionContentReq extends ICommonRes {
-  /**
-   * 会话id
-   */
-  sessionId?: string;
-  /**
-   * 步骤id
-   */
-  stepId?: string;
-}
-
-/**
- * 添加会话内容res
- */
-export interface IGetSessionContentRes extends ICommonRes {
-  data?: {
-    /**
-     * 会话内容列表
-     */
-    contents?: ISessionContent[];
-  };
-}
-
-/**
- * 获取推荐学校req
- */
-export interface IGetRecommendSchoolReq extends ICommonRes {
-  /**
-   * 会话id
-   */
-  sessionId?: string;
-}
-
-/**
- * 获取推荐学校res
- */
-export interface IGetRecommendSchoolRes extends ICommonRes {
-  data?: {
-    /**
-     * 推荐学校列表
-     */
-    schoolInfos?: IGetRecommendSchool[];
-  };
-}
-
-/**
- * 一分一档req
- */
-export interface IGetGradeInfoReq extends ICommonRes {
-  /**
-   * 会话id
-   */
-  sessionId?: string;
-}
-
-/**
- * 一分一档res
- */
-export interface IGetGradeInfoRes extends ICommonRes {
-  data?: {
-    /**
-     * 一分一档
-     */
-    gradeInfo?: IScoreRank;
-  };
-}
-
-/**
- * 生成报告信息req
- */
-export interface IGenerateReportInfoReq extends ICommonRes {
-  /**
-   * 会话id
-   */
-  sessionId?: string;
-}
-
-/**
- * 生成报告信息res
- */
-export interface IGenerateReportInfoRes extends ICommonRes {
-  data?: IReportResult;
-}
+import { type IChatAiMessageItem } from '../common/IChatAiMessageItem';
+import {
+  type ICommonReq,
+  type AISceneEnum,
+  type ICommonRes,
+  type ISelectSubject,
+  type IInquiryBasicInfo,
+  type IInquirySession,
+  type ISessionContent,
+  type IGetRecommendSchool,
+  type IScoreRank,
+  type IReportResult,
+  type ReportTypeEnum,
+  type SubReportTypeEnum,
+  type IFormatGaokaoBasicInfo,
+  type IConfigInfo
+} from '../common';
+import { type ICounselorType } from '../common/ICounselorType';
+import { type IGaokaoVolunteerRecommendationReport } from '../common/IReportData';
+import { type IGaokaoInterestReport } from '../common/IReportData';
+import { type IGaokaoMajorMatchingReport } from '../common/IReportData';
+import { type IGaokaoFutureDevelopmentReport } from '../common/IReportData';
+
+/**
+ *  千问AI聊天api 请求参数
+ */
+export interface IChatQwenReq extends ICommonReq {
+  /**
+   * 历史对话消息
+   */
+  messages: IChatAiMessageItem[];
+  /**
+   * 是否开启流式传输
+   */
+  stream: boolean;
+  /**
+   * 提问场景
+   */
+  scene?: AISceneEnum;
+  /**
+   * 通道id(如果开启流式传输stream为true则必传)
+   */
+  channel?: string;
+  /**
+   * 是否开发模式 仅调式使用 默认false 前端禁止使用
+   */
+  devMode?: boolean;
+  /**
+   *会话id 如有则表示是已经创建的聊天 没有则表示是新聊天
+   */
+  sessionId?: string;
+  /**
+   *会话步骤id
+   */
+  stepId?: string;
+}
+
+/**
+ * 千问AI聊天api 返回参数
+ */
+export interface IChatQwenRes extends ICommonReq {
+  /**
+   * ai回复消息(完成拼接之后的消息)
+   */
+  message: string;
+  /**
+   * llm运行总时间 单位ms
+   */
+  llmRunTime: number;
+}
+
+/**
+ * AI聊天api 单次流式传输返回参数
+ */
+export interface IChatAIStreamRes {
+  /**
+   * 当前返回的消息
+   */
+  chunkMessage: string;
+  /**
+   * 深度思考的原因 仅deepseek模型返回
+   */
+  chunkReasonMessage?: string;
+  /**
+   * 索引(从0开始) 本次流式消息是整体流式消息的第几个
+   */
+  index: number;
+}
+
+/**
+ *  DeepSeek AI聊天api 请求参数
+ */
+export interface IChatDeepSeekReq extends ICommonReq {
+  /**
+   * 历史对话消息
+   */
+  messages: IChatAiMessageItem[];
+  /**
+   * 是否开启流式传输
+   */
+  stream: boolean;
+  /**
+   * 通道id(如果开启流式传输stream为true则必传)
+   */
+  channel?: string;
+  /**
+   * 提问场景
+   */
+  scene?: AISceneEnum;
+  /**
+   * 是否开发模式 仅调式使用 默认false 前端禁止使用
+   */
+  devMode?: boolean;
+}
+
+/**
+ * DeepSeek AI聊天api 返回参数
+ */
+export interface IChatDeepSeekRes extends ICommonReq {
+  /**
+   * ai回复消息(完成拼接之后的消息)
+   */
+  message: string;
+  /**
+   * deepseek深度思考给出的原因
+   */
+  reasonMessage: string;
+  /**
+   * llm运行总时间 单位ms
+   */
+  llmRunTime: number;
+}
+
+export interface IGuessAnswerListReq extends ICommonReq {
+  /**
+   * 问题内容
+   */
+  content: string;
+  /**
+   * 临时消息id
+   */
+  tempMsgId: string;
+  /**
+   * 场景
+   */
+  scene?: AISceneEnum;
+}
+
+export interface IGuessAnswerListRes extends ICommonRes {
+  /**
+   * 关联的问题id
+   */
+  relatedTempMsgId?: string;
+  /**
+   * 可能的答案选项
+   */
+  choices?: string[];
+}
+
+/**
+ * 生成报告的res
+ */
+export interface IAiGenerateReportRes extends ICommonRes {
+  /**
+   * 成功数量
+   */
+  successCount?: number;
+  /**
+   * 失败数量
+   */
+  failedCount?: number;
+  /**
+   * 错误信息
+   */
+  errors?: string[];
+  /**
+   * 报告数据
+   */
+  reportData?: {
+    /**
+     * 高考志愿推荐:院校排序等推荐
+     */
+    'gaokao-volunteer-recommendation': IGaokaoVolunteerRecommendationReport;
+    /**
+     * 高考志愿兴趣分析:霍兰德职业兴趣测评报告
+     */
+    'gaokao-interest': IGaokaoInterestReport;
+    /**
+     * 高考志愿专业匹配分析:专业推荐报告(专业匹配分析\排序)
+     */
+    'gaokao-major-matching': IGaokaoMajorMatchingReport;
+    /**
+     * 高考志愿未来发展:未来发展建议
+     */
+    'gaokao-future-development': IGaokaoFutureDevelopmentReport;
+  };
+}
+
+/**
+ * 生成报告的req
+ */
+export interface IAiGenerateReportReq extends ICommonReq {
+  /**
+   * 报告id
+   */
+  reportId?: string;
+  /**
+   * 报告类型
+   */
+  reportType?: ReportTypeEnum;
+  /**
+   * 报告类型列表
+   */
+  subReportTypeList?: SubReportTypeEnum[];
+}
+
+/**
+ * 获取咨询师类型的响应
+ */
+export interface IGetCounselorTypeRes extends ICommonRes {
+  data?: ICounselorType[] | null;
+}
+
+/**
+ * 智能体的req
+ */
+export interface IAgentReq extends ICommonReq {
+  /**
+   * 智能体类型 necc为高考智能体, gaokao为高考智能体, report为报告智能体
+   */
+  type: 'ncee' | 'gaokao' | 'report';
+  /**
+   * 节点名称 恢复对话时候前端透传需要回到的节点名称
+   */
+  gotoNodeName?: string;
+  /**
+   * 会话id
+   */
+  sessionId?: string;
+  /**
+   * 用户输入信息
+   */
+  content?: string;
+  /**
+   * 步骤id
+   */
+  stepId?: string;
+  /**
+   * 是否是恢复上次的会话 'F' | 'T'
+   */
+  isResume?: 'F' | 'T';
+  /**
+   * 是否展示图表数据 'F' | 'T'
+   */
+  showGraph?: 'F' | 'T';
+  /**
+   * 表单类型
+   */
+  formType?: 'gaokaoBasicInfo';
+  /**
+   * 格式化的表单数据 包括高考数据和报告数据
+   */
+  formattedFormData?: IFormatGaokaoBasicInfo;
+}
+
+/**
+ * 智能体res
+ */
+export interface IAgentRes extends ICommonRes {
+  data?: {
+    /**
+     * 图结构showGraph为'T'时返回
+     */
+    base64Image?: string;
+    /**
+     * 智能体回复的消息
+     */
+    message: string[];
+  };
+}
+
+export interface ISttOneMinuteRes extends ICommonRes {
+  data?: {
+    /**
+     * 翻译结果
+     */
+    transResult?: string;
+  };
+}
+
+/**
+ * 获取group info的req
+ */
+export interface IGetGroupInfoReq extends ICommonReq, ISelectSubject {}
+
+/**
+ * 获取group info的res
+ */
+export interface IGetGroupInfoRes extends ICommonRes {
+  data?: {
+    /**
+     * 组别id
+     */
+    groupId?: number;
+    /**
+     * 描述
+     */
+    desc?: string;
+  };
+}
+
+/**
+ * 添加基础信息req
+ */
+export interface IAddInquiryBasicInfoReq extends ICommonReq, IInquiryBasicInfo {}
+
+/**
+ * 添加基础信息res
+ */
+export interface IAddInquiryBasicInfoRes extends ICommonRes {
+  data?: {
+    /**
+     * 基础信息id
+     */
+    basicId?: string;
+  };
+}
+
+/**
+ * 获取基础信息req
+ */
+export interface IGetInquiryBasicInfoReq extends ICommonRes {
+  sessionId?: string;
+}
+
+/**
+ * 添加基础信息res
+ */
+export interface IGetInquiryBasicInfoRes extends ICommonRes {
+  data?: {
+    /**
+     * 基础信息
+     */
+    basicInfo?: IInquiryBasicInfo;
+  };
+}
+
+/**
+ * 添加问询会话req
+ */
+export interface IAddInquirySessionReq extends ICommonReq, IInquirySession {}
+
+/**
+ * 添加问询会话res
+ */
+export interface IAddInquirySessionRes extends ICommonRes {
+  data?: {
+    /**
+     * 问询会话id
+     */
+    sessionId?: string;
+  };
+}
+
+/**
+ * 获取问询会话req
+ */
+export interface IGetInquirySessionListReq extends ICommonRes {
+  /**
+   * 咨询师id
+   */
+  counselorId?: string;
+}
+
+/**
+ * 添加问询会话res
+ */
+export interface IGetInquirySessionListRes extends ICommonRes {
+  data?: {
+    /**
+     * 问询会话列表
+     */
+    sessionInfos?: IInquirySession[];
+  };
+}
+
+/**
+ * 添加会话内容req
+ */
+export interface IAddSessionContentReq extends ICommonReq, ISessionContent {}
+
+/**
+ * 添加会话内容res
+ */
+export interface IAddSessionContentRes extends ICommonRes {
+  data?: {
+    /**
+     * 会话内容id
+     */
+    contentId?: string;
+  };
+}
+
+/**
+ * 获取会话内容req
+ */
+export interface IGetSessionContentReq extends ICommonRes {
+  /**
+   * 会话id
+   */
+  sessionId?: string;
+  /**
+   * 步骤id
+   */
+  stepId?: string;
+}
+
+/**
+ * 添加会话内容res
+ */
+export interface IGetSessionContentRes extends ICommonRes {
+  data?: {
+    /**
+     * 会话内容列表
+     */
+    contents?: ISessionContent[];
+  };
+}
+
+/**
+ * 获取推荐学校req
+ */
+export interface IGetRecommendSchoolReq extends ICommonRes {
+  /**
+   * 会话id
+   */
+  sessionId?: string;
+}
+
+/**
+ * 获取推荐学校res
+ */
+export interface IGetRecommendSchoolRes extends ICommonRes {
+  data?: {
+    /**
+     * 推荐学校列表
+     */
+    schoolInfos?: IGetRecommendSchool[];
+  };
+}
+
+/**
+ * 一分一档req
+ */
+export interface IGetGradeInfoReq extends ICommonRes {
+  /**
+   * 会话id
+   */
+  sessionId?: string;
+}
+
+/**
+ * 一分一档res
+ */
+export interface IGetGradeInfoRes extends ICommonRes {
+  data?: {
+    /**
+     * 一分一档
+     */
+    gradeInfo?: IScoreRank;
+  };
+}
+
+/**
+ * 生成报告信息req
+ */
+export interface IGenerateReportInfoReq extends ICommonRes {
+  /**
+   * 会话id
+   */
+  sessionId?: string;
+}
+
+/**
+ * 生成报告信息res
+ */
+export interface IGenerateReportInfoRes extends ICommonRes {
+  data?: IReportResult;
+}
+
+/**
+ * 获取token
+ */
+export interface IGetConfigInfoRes extends ICommonRes {
+  data?: IConfigInfo;
+}