@hddjs/hdd-cloud-types 1.0.6 → 1.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/HddCloud/common/index.d.ts +4 -4
  2. package/HddCloud/index.d.ts +59 -59
  3. package/README.md +2 -2
  4. package/hdd-ai-cloud/common/AISceneEnum.d.ts +54 -54
  5. package/hdd-ai-cloud/common/IAliFcContext.d.ts +5 -5
  6. package/hdd-ai-cloud/common/ICallUniCloudParams.js +3 -3
  7. package/hdd-ai-cloud/common/ICallUniCloudParams.ts +20 -20
  8. package/hdd-ai-cloud/common/IChatAiMessageItem.d.ts +23 -23
  9. package/hdd-ai-cloud/common/ICommonError.d.ts +13 -0
  10. package/hdd-ai-cloud/common/ICommonReqRes.d.ts +23 -30
  11. package/hdd-ai-cloud/common/ICommonRequstHead.js +3 -3
  12. package/hdd-ai-cloud/common/ICommonRequstHead.ts +17 -17
  13. package/hdd-ai-cloud/common/IConfigInfo.d.ts +6 -0
  14. package/hdd-ai-cloud/common/ICounselor.d.ts +4 -4
  15. package/hdd-ai-cloud/common/ICounselorType.d.ts +23 -23
  16. package/hdd-ai-cloud/common/IFormatCutOffCollegeData.d.ts +29 -29
  17. package/hdd-ai-cloud/common/IFormatGaokaoBasicInfo.d.ts +67 -0
  18. package/hdd-ai-cloud/common/IFormatProfessional.js +3 -3
  19. package/hdd-ai-cloud/common/IFormatProfessional.ts +29 -29
  20. package/hdd-ai-cloud/common/IGetRecommendSchool.d.ts +77 -73
  21. package/hdd-ai-cloud/common/IInquiryBasicInfo.d.ts +39 -39
  22. package/hdd-ai-cloud/common/IInquirySession.d.ts +25 -25
  23. package/hdd-ai-cloud/common/IPicture.d.ts +13 -13
  24. package/hdd-ai-cloud/common/IReportData.d.ts +136 -0
  25. package/hdd-ai-cloud/common/ISceneAiConfig.d.ts +27 -27
  26. package/hdd-ai-cloud/common/IScoreRank.d.ts +18 -18
  27. package/hdd-ai-cloud/common/ISelectSubject.d.ts +29 -29
  28. package/hdd-ai-cloud/common/ISessionContent.d.ts +31 -27
  29. package/hdd-ai-cloud/common/ISessionRole.d.ts +21 -21
  30. package/hdd-ai-cloud/common/ISseChunk.d.ts +57 -57
  31. package/hdd-ai-cloud/common/ISseData.d.ts +108 -96
  32. package/hdd-ai-cloud/common/IThisContext.d.ts +128 -128
  33. package/hdd-ai-cloud/common/ReportTypeEnum.d.ts +7 -0
  34. package/hdd-ai-cloud/common/SubReportTypeEnum.d.ts +18 -0
  35. package/hdd-ai-cloud/common/index.d.ts +29 -23
  36. package/hdd-ai-cloud/controller/index.d.ts +496 -453
  37. package/hdd-ai-cloud/index.d.ts +3 -3
  38. package/hdd-ai-cloud/service/index.d.ts +36 -36
  39. package/index.d.ts +2 -2
  40. package/npmPublish.md +10 -10
  41. package/package.json +11 -11
@@ -1,27 +1,31 @@
1
- import { type SessionRoleEnum } from './ISessionRole';
2
-
3
- /**
4
- * 会话内容
5
- */
6
- export interface ISessionContent {
7
- /**
8
- * sessionId
9
- */
10
- sessionId?: string;
11
- /**
12
- * 步骤id
13
- */
14
- stepId?: string;
15
- /**
16
- * 内容
17
- */
18
- content?: string;
19
- /**
20
- * 原内容类型
21
- */
22
- oriContentType?: string;
23
- /**
24
- * 角色
25
- */
26
- role?: SessionRoleEnum;
27
- }
1
+ import { type SessionRoleEnum } from './ISessionRole';
2
+
3
+ /**
4
+ * 会话内容
5
+ */
6
+ export interface ISessionContent {
7
+ /**
8
+ * sessionId
9
+ */
10
+ sessionId?: string;
11
+ /**
12
+ * 步骤id
13
+ */
14
+ stepId?: string;
15
+ /**
16
+ * 内容
17
+ */
18
+ content?: string;
19
+ /**
20
+ * 原内容类型
21
+ */
22
+ oriContentType?: string;
23
+ /**
24
+ * 角色
25
+ */
26
+ role?: SessionRoleEnum;
27
+ /**
28
+ * 备注
29
+ */
30
+ formatInfo?: string;
31
+ }
@@ -1,21 +1,21 @@
1
- /**
2
- * 会话角色枚举
3
- */
4
- export const enum SessionRoleEnum {
5
- /**
6
- * 用户
7
- */
8
- USER = 'user',
9
- /**
10
- * ai
11
- */
12
- ASSISTANT = 'assistant',
13
- /**
14
- * 系统
15
- */
16
- SYSTEM = 'system',
17
- /**
18
- * 工具
19
- * */
20
- TOOL = 'tool'
21
- }
1
+ /**
2
+ * 会话角色枚举
3
+ */
4
+ export const enum SessionRoleEnum {
5
+ /**
6
+ * 用户
7
+ */
8
+ USER = 'user',
9
+ /**
10
+ * ai
11
+ */
12
+ ASSISTANT = 'assistant',
13
+ /**
14
+ * 系统
15
+ */
16
+ SYSTEM = 'system',
17
+ /**
18
+ * 工具
19
+ * */
20
+ TOOL = 'tool'
21
+ }
@@ -1,57 +1,57 @@
1
- import { type SessionRoleEnum } from './ISessionRole';
2
- /**
3
- * sse流式返回片段 @deprecated 即将废弃 请整体切换到ISseData
4
- */
5
- export interface ISseChunk {
6
- /**
7
- * sse流式返回片段的类型
8
- */
9
- type: ISseChunkType;
10
- /**
11
- * sse流式返回片段的角色
12
- */
13
- role?: SessionRoleEnum;
14
- /**
15
- * 当type为content时sse流式返回片段的内容
16
- */
17
- content?: string | null;
18
- /**
19
- * 当type为reason时sse流式返回片段的原因
20
- */
21
- reason?: string | null;
22
- /**
23
- * 当type为formatJson时sse流式返回片段的格式化json
24
- * */
25
- formatJson?: {
26
- /**
27
- * 是否开始下一个流程
28
- */
29
- startNextStep?: boolean;
30
- /**
31
- * 可能的答案选项
32
- */
33
- guessAnswerList?: string[];
34
- /**
35
- * 是否是总结
36
- */
37
- isSummary?: boolean;
38
- };
39
- }
40
-
41
- /**
42
- * sse流式返回片段的类型 @deprecated 即将废弃 请整体切换到ISseData
43
- */
44
- export const enum ISseChunkType {
45
- /**
46
- * 内容
47
- */
48
- CONTENT = 'content',
49
- /**
50
- * 原因
51
- */
52
- REASON = 'reason',
53
- /**
54
- * 格式化的json
55
- * */
56
- FORMATJSON = 'formatJson'
57
- }
1
+ import { type SessionRoleEnum } from './ISessionRole';
2
+ /**
3
+ * sse流式返回片段 @deprecated 即将废弃 请整体切换到ISseData
4
+ */
5
+ export interface ISseChunk {
6
+ /**
7
+ * sse流式返回片段的类型
8
+ */
9
+ type: ISseChunkType;
10
+ /**
11
+ * sse流式返回片段的角色
12
+ */
13
+ role?: SessionRoleEnum;
14
+ /**
15
+ * 当type为content时sse流式返回片段的内容
16
+ */
17
+ content?: string | null;
18
+ /**
19
+ * 当type为reason时sse流式返回片段的原因
20
+ */
21
+ reason?: string | null;
22
+ /**
23
+ * 当type为formatJson时sse流式返回片段的格式化json
24
+ * */
25
+ formatJson?: {
26
+ /**
27
+ * 是否开始下一个流程
28
+ */
29
+ startNextStep?: boolean;
30
+ /**
31
+ * 可能的答案选项
32
+ */
33
+ guessAnswerList?: string[];
34
+ /**
35
+ * 是否是总结
36
+ */
37
+ isSummary?: boolean;
38
+ };
39
+ }
40
+
41
+ /**
42
+ * sse流式返回片段的类型 @deprecated 即将废弃 请整体切换到ISseData
43
+ */
44
+ export const enum ISseChunkType {
45
+ /**
46
+ * 内容
47
+ */
48
+ CONTENT = 'content',
49
+ /**
50
+ * 原因
51
+ */
52
+ REASON = 'reason',
53
+ /**
54
+ * 格式化的json
55
+ * */
56
+ FORMATJSON = 'formatJson'
57
+ }
@@ -1,96 +1,108 @@
1
- /**
2
- * sse流式返回片段
3
- */
4
- export interface ISseData {
5
- /**
6
- * 流式返回片段的类型
7
- */
8
- type: SseDataTypeEnum;
9
- /**
10
- * ai返回的对话内容
11
- */
12
- aiMessage?: {
13
- content?: string;
14
- };
15
- /**
16
- * ai思考的内容
17
- */
18
- aiThinking?: {
19
- reason?: string;
20
- };
21
- /**
22
- * 需要收集非结构化信息
23
- */
24
- needCollectstructuredInfo?: {
25
- /**
26
- * 表单类型
27
- */
28
- type?: string;
29
- /**
30
- * 表单标题
31
- */
32
- title?: string;
33
- /**
34
- * 表单描述
35
- */
36
- description?: string;
37
- /**
38
- * 需要收集的字段列表
39
- */
40
- fields: {
41
- /**
42
- * 字段名称
43
- */
44
- name?: string;
45
- /**
46
- * 字段标签
47
- */
48
- label?: string;
49
- /**
50
- * 字段描述
51
- */
52
- description?: string;
53
- /**
54
- * 是否必填
55
- */
56
- required?: boolean;
57
- /**
58
- * 选项
59
- */
60
- options?: string[];
61
- /**
62
- * 占位符
63
- */
64
- placeholder?: string;
65
- }[];
66
- };
67
- /**
68
- * 错误信息
69
- */
70
- errorInfo?: {
71
- errCode?: string;
72
- errMsg?: string;
73
- };
74
- }
75
-
76
- /**
77
- * sse流式返回片段的类型
78
- */
79
- export const enum SseDataTypeEnum {
80
- /**
81
- * ai返回的对话内容
82
- */
83
- AIMessage = 'aiMessage',
84
- /**
85
- * ai思考的内容
86
- */
87
- AiThinking = 'aiThinking',
88
- /**
89
- * 需要收集结构化信息
90
- */
91
- NeedCollectStructuredInfo = 'needCollectStructuredInfo',
92
- /**
93
- * 错误信息
94
- */
95
- ErrorInfo = 'errorInfo'
96
- }
1
+ /**
2
+ * sse流式返回片段
3
+ */
4
+ export interface ISseData {
5
+ /**
6
+ * 流式返回片段的类型
7
+ */
8
+ type: SseDataTypeEnum;
9
+ /**
10
+ * 标识对话步骤id
11
+ */
12
+ stepId?: string;
13
+ /**
14
+ * ai返回的对话内容
15
+ */
16
+ aiMessage?: {
17
+ content?: string;
18
+ };
19
+ /**
20
+ * ai思考的内容
21
+ */
22
+ aiThinking?: {
23
+ reason?: string;
24
+ };
25
+ /**
26
+ * 需要收集非结构化信息
27
+ */
28
+ needCollectstructuredInfo?: {
29
+ /**
30
+ * 表单类型
31
+ */
32
+ type?: string;
33
+ /**
34
+ * 对用户的语言提示
35
+ */
36
+ voiceTip?: string;
37
+ /**
38
+ * 表单标题
39
+ */
40
+ title?: string;
41
+ /**
42
+ * 表单描述
43
+ */
44
+ description?: string;
45
+ /**
46
+ * 等效的AI内容(当不使用结构化展示时候可以使用等效的AI内容展示给用户 或 用于上下文)
47
+ */
48
+ equalAiContent: string;
49
+ /**
50
+ * 需要收集的字段列表
51
+ */
52
+ fields: {
53
+ /**
54
+ * 字段名称
55
+ */
56
+ name?: string;
57
+ /**
58
+ * 字段标签
59
+ */
60
+ label?: string;
61
+ /**
62
+ * 字段描述
63
+ */
64
+ description?: string;
65
+ /**
66
+ * 是否必填
67
+ */
68
+ required?: boolean;
69
+ /**
70
+ * 选项
71
+ */
72
+ options?: string[];
73
+ /**
74
+ * 占位符
75
+ */
76
+ placeholder?: string;
77
+ }[];
78
+ };
79
+ /**
80
+ * 错误信息
81
+ */
82
+ errorInfo?: {
83
+ errCode?: string;
84
+ errMsg?: string;
85
+ };
86
+ }
87
+
88
+ /**
89
+ * sse流式返回片段的类型
90
+ */
91
+ export const enum SseDataTypeEnum {
92
+ /**
93
+ * ai返回的对话内容
94
+ */
95
+ AIMessage = 'aiMessage',
96
+ /**
97
+ * ai思考的内容
98
+ */
99
+ AiThinking = 'aiThinking',
100
+ /**
101
+ * 需要收集结构化信息
102
+ */
103
+ NeedCollectStructuredInfo = 'needCollectStructuredInfo',
104
+ /**
105
+ * 错误信息
106
+ */
107
+ ErrorInfo = 'errorInfo'
108
+ }
@@ -1,128 +1,128 @@
1
- /**
2
- * uniCloud云对象的this上下文
3
- */
4
- export interface IThisContext {
5
- /**
6
- * 函数执行开始的时间戳 毫秒 在_before中赋值
7
- */
8
- funStartTime?: number;
9
- /**
10
- * 函数执行结束的时间戳 毫秒 在_after中赋值
11
- */
12
- funEndTime?: number;
13
- /**
14
- * 函数执行的总时间 毫秒 在_after中赋值funEndTime - funStartTime
15
- */
16
- funRunTime?: number;
17
- /**
18
- * 通过token解析出来的用户信息 _before中赋值 未登录时候赋值为null
19
- */
20
- tokenRes?: ITokenRes | null;
21
- /**
22
- * 获取的云对象信息
23
- */
24
- getCloudInfo?: () => ICloudInfo;
25
- /**
26
- * 获取客户端信息
27
- */
28
- getClientInfo?: () => IClientInfo;
29
- /**
30
- * 获取token
31
- */
32
- getUniIdToken?: () => string;
33
- /**
34
- * 获取调用的云对象方法名
35
- */
36
- getMethodName?: () => string;
37
- /**
38
- * 获取调用云对象时候传入的参数
39
- */
40
- getParams?: () => any;
41
- /**
42
- * 获取请求id
43
- */
44
- getUniCloudRequestId?: () => string;
45
- }
46
-
47
- /**
48
- * this.tokenRes解析出来的用户信息
49
- */
50
- export interface ITokenRes {
51
- /**
52
- * 错误码 0为成功
53
- */
54
- errCode?: number;
55
- /**
56
- * token解析出来的uid
57
- */
58
- uid?: string;
59
- /**
60
- * token解析出来的role角色
61
- */
62
- role?: string[];
63
- /**
64
- * token解析出来的permission权限
65
- */
66
- permission?: string[];
67
- }
68
-
69
- /**
70
- * this.getClientInfo返回的客户端信息
71
- */
72
- export interface IClientInfo {
73
- /**
74
- * 客户端ip
75
- */
76
- clientIP?: string;
77
- /**
78
- * 客户端ua,注意非本地运行环境下客户端getSystemInfoSync也会获取ua参数并上传给云对象,但是云对象会从http请求头里面获取ua而不是clientInfo里面的ua
79
- */
80
- userAgent?: string;
81
- /**
82
- * 调用来源
83
- * client uni-app客户端导入云对象调用
84
- * function 由其他云函数或云对象调用
85
- * http 云对象URL化后通过http访问调用 HBuilderX 3.5.2+
86
- * timing 定时任务调用云对象 HBuilderX 3.5.2+
87
- * server 云函数上传并运行
88
- */
89
- source?: 'client' | 'function' | 'http' | 'timing' | 'server';
90
- /**
91
- * 请求id
92
- */
93
- requestId?: string;
94
- /**
95
- * 场景值 客户端uni.getLaunchOptionsSync返回的scene参数,新增于HBuilderX 3.5.1
96
- */
97
- scene?: string;
98
- }
99
-
100
- /**
101
- * this.getCloudInfo获取的云对象信息
102
- */
103
- export interface ICloudInfo {
104
- /**
105
- * 服务空间供应商,支付宝云为:alipay,阿里云为:aliyun,腾讯云为:tencent
106
- */
107
- provider: 'alipay' | 'aliyun' | 'tencent';
108
- /**
109
- * 服务空间Id
110
- */
111
- spaceId: string;
112
- /**
113
- * 当前获取的服务空间id是否为迁移前的服务空间id
114
- */
115
- useOldSpaceId: boolean;
116
- /**
117
- * 云对象名称
118
- */
119
- functionName: string;
120
- /**
121
- * 云对象此值固定为cloudobject
122
- */
123
- functionType: 'cloudobject';
124
- /**
125
- * 运行环境,取值为local(本地运行)或cloud(云端运行) 新增于HBuilderX 4.25
126
- */
127
- runtimeEnv: 'local' | 'cloud';
128
- }
1
+ /**
2
+ * uniCloud云对象的this上下文
3
+ */
4
+ export interface IThisContext {
5
+ /**
6
+ * 函数执行开始的时间戳 毫秒 在_before中赋值
7
+ */
8
+ funStartTime?: number;
9
+ /**
10
+ * 函数执行结束的时间戳 毫秒 在_after中赋值
11
+ */
12
+ funEndTime?: number;
13
+ /**
14
+ * 函数执行的总时间 毫秒 在_after中赋值funEndTime - funStartTime
15
+ */
16
+ funRunTime?: number;
17
+ /**
18
+ * 通过token解析出来的用户信息 _before中赋值 未登录时候赋值为null
19
+ */
20
+ tokenRes?: ITokenRes | null;
21
+ /**
22
+ * 获取的云对象信息
23
+ */
24
+ getCloudInfo?: () => ICloudInfo;
25
+ /**
26
+ * 获取客户端信息
27
+ */
28
+ getClientInfo?: () => IClientInfo;
29
+ /**
30
+ * 获取token
31
+ */
32
+ getUniIdToken?: () => string;
33
+ /**
34
+ * 获取调用的云对象方法名
35
+ */
36
+ getMethodName?: () => string;
37
+ /**
38
+ * 获取调用云对象时候传入的参数
39
+ */
40
+ getParams?: () => any;
41
+ /**
42
+ * 获取请求id
43
+ */
44
+ getUniCloudRequestId?: () => string;
45
+ }
46
+
47
+ /**
48
+ * this.tokenRes解析出来的用户信息
49
+ */
50
+ export interface ITokenRes {
51
+ /**
52
+ * 错误码 0为成功
53
+ */
54
+ errCode?: number;
55
+ /**
56
+ * token解析出来的uid
57
+ */
58
+ uid?: string;
59
+ /**
60
+ * token解析出来的role角色
61
+ */
62
+ role?: string[];
63
+ /**
64
+ * token解析出来的permission权限
65
+ */
66
+ permission?: string[];
67
+ }
68
+
69
+ /**
70
+ * this.getClientInfo返回的客户端信息
71
+ */
72
+ export interface IClientInfo {
73
+ /**
74
+ * 客户端ip
75
+ */
76
+ clientIP?: string;
77
+ /**
78
+ * 客户端ua,注意非本地运行环境下客户端getSystemInfoSync也会获取ua参数并上传给云对象,但是云对象会从http请求头里面获取ua而不是clientInfo里面的ua
79
+ */
80
+ userAgent?: string;
81
+ /**
82
+ * 调用来源
83
+ * client uni-app客户端导入云对象调用
84
+ * function 由其他云函数或云对象调用
85
+ * http 云对象URL化后通过http访问调用 HBuilderX 3.5.2+
86
+ * timing 定时任务调用云对象 HBuilderX 3.5.2+
87
+ * server 云函数上传并运行
88
+ */
89
+ source?: 'client' | 'function' | 'http' | 'timing' | 'server';
90
+ /**
91
+ * 请求id
92
+ */
93
+ requestId?: string;
94
+ /**
95
+ * 场景值 客户端uni.getLaunchOptionsSync返回的scene参数,新增于HBuilderX 3.5.1
96
+ */
97
+ scene?: string;
98
+ }
99
+
100
+ /**
101
+ * this.getCloudInfo获取的云对象信息
102
+ */
103
+ export interface ICloudInfo {
104
+ /**
105
+ * 服务空间供应商,支付宝云为:alipay,阿里云为:aliyun,腾讯云为:tencent
106
+ */
107
+ provider: 'alipay' | 'aliyun' | 'tencent';
108
+ /**
109
+ * 服务空间Id
110
+ */
111
+ spaceId: string;
112
+ /**
113
+ * 当前获取的服务空间id是否为迁移前的服务空间id
114
+ */
115
+ useOldSpaceId: boolean;
116
+ /**
117
+ * 云对象名称
118
+ */
119
+ functionName: string;
120
+ /**
121
+ * 云对象此值固定为cloudobject
122
+ */
123
+ functionType: 'cloudobject';
124
+ /**
125
+ * 运行环境,取值为local(本地运行)或cloud(云端运行) 新增于HBuilderX 4.25
126
+ */
127
+ runtimeEnv: 'local' | 'cloud';
128
+ }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * 报告类型枚举
3
+ */
4
+ export const enum ReportTypeEnum {
5
+ /** 高考志愿填报报告 */
6
+ GAOKAO = 'gaokao'
7
+ }