@hddjs/hdd-cloud-types 1.0.1

package/HddCloud/common/index.d.ts

@@ -0,0 +1,4 @@
+export interface IOpenAiMessage {
+  content?: string;
+  role?: 'user' | 'assistant' | 'system' | 'tool';
+}

package/HddCloud/index.d.ts

@@ -0,0 +1,59 @@
+export * from './common';
+export interface HddCloud {}
+/**
+ * 符合openai格式的大模型调用入参
+ * @tutorial https://help.aliyun.com/zh/model-studio/developer-reference/use-qwen-by-calling-api?spm=a2c4g.11186623.help-menu-2400256.d_3_3_0.1ff14823Prcy7Z&scm=20140722.H_2712576._.OR_help-T_cn~zh-V_1
+ */
+export interface IChatOpenAiParams {
+  /**
+   * 调用配置信息 如apikey url等
+   */
+  hddOptions: {
+    /**
+     * 模型地址
+     */
+    baseUrl: string;
+    /**
+     * 调用大模型的apiKey
+     */
+    apiKey: string;
+  };
+  /**
+   * 调用的模型
+   */
+  model?: 'qwq-plus' | 'qwen-max' | 'deepseek-r1' | 'deepseek-v3';
+  /**
+   * 对话消息
+   */
+  messages?: IOpenAiMessage[];
+  /**
+   * 是否开启流式传输
+   */
+  stream?: boolean;
+  /**
+   * 是否包含使用情况 流式传输时候生效
+   */
+  stream_options?: {
+    include_usage?: boolean;
+  };
+  /**
+   * 返回的格式 默认text
+   */
+  response_format?: {
+    type: 'text' | 'json_object';
+  };
+  /**
+   * 最大生成token数
+   */
+  max_tokens?: number;
+}
+
+/**
+ * 符合openai规范的 大模型调用的流式chunk消息体
+ */
+export interface IChatOpenAiChunk {}
+
+/**
+ * 符合openai格式的大模型调用出参
+ */
+export interface IChatOpenAiRes extends AsyncIterable<IChatOpenAiChunk> {}

package/README.md

@@ -0,0 +1,3 @@
+### 项目定位
+各云函数、工具集类型
+npm包名 @hddjs/hdd-cloud-types

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

@@ -0,0 +1,21 @@
+/**
+ * AI场景枚举
+ */
+export const enum AISceneEnum {
+  /**
+   * 高考志愿填报
+   */
+  GAOKAO = 'gaokao',
+  /**
+   * 高考志愿填报 基本情况问答
+   */
+  GAOKAO_BASE_ASK = 'gaokao_base_ask',
+  /**
+   * 高考志愿填报 可能的答案
+   */
+  GAOKAO_MAYBE_ANSWER = 'gaokao_maybe_answer',
+  /**
+   * 学习助手
+   */
+  Study_Helper = 'study_helper'
+}

package/hdd-ai-cloud/common/IAliFcContext.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/hdd-ai-cloud/common/IAliFcContext.ts

@@ -0,0 +1,5 @@
+/**
+ * Aliyun FC context
+ * @tutorial https://help.aliyun.com/zh/functioncompute/context?spm=a2c4g.11186623.help-menu-2508973.d_2_2_3_1.4fe7626axuNlJW
+ */
+export interface IAliFcContext {}

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

@@ -0,0 +1,23 @@
+import { type SessionRoleEnum } from './SessionRoleEnum';
+export interface IChatAiMessageItem {
+  /**
+   * 会话角色 前端禁止传入系统消息 服务端需要过滤前端传入的系统消息
+   */
+  role: SessionRoleEnum;
+  /**
+   * 消息内容
+   */
+  content: string;
+  /**
+   * 发送者昵称
+   */
+  nickName?: string;
+  /**
+   * 发送时间戳
+   */
+  timeStamp?: number;
+  /**
+   * 发送时间字符串展示 YYYY-MM-DD HH:mm:ss / HH:mm:ss
+   */
+  timeStr?: string;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * 通用res返回参数
+ */
+export interface ICommonRes {
+  /**
+   * 错误码 0:成功
+   */
+  errCode?: string;
+  /**
+   * 错误信息
+   */
+  errMsg?: string;
+  /**
+   * 运行时间 ms
+   */
+  funRunTime?: number;
+  /**
+   * 开始时间时间戳
+   */
+  funStartTime?: number;
+  /**
+   * 结束时间时间戳
+   */
+  funEndTime?: number;
+}
+
+/**
+ * 通用请求参数
+ */
+export interface ICommonReq {}

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

@@ -0,0 +1,4 @@
+/**
+ * 咨询师
+ */
+export interface ICounselor {}

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

@@ -0,0 +1,27 @@
+import { type AISceneEnum } from './AISceneEnum';
+/**
+ * AI场景hdd-ai-config配置
+ */
+export interface ISceneAiConfig {
+  /**
+   * apiKey
+   */
+  apiKey?: string;
+  /**
+   * baseURL
+   */
+  baseURL?: string;
+  /**
+   * 提问场景
+   */
+  scene?: AISceneEnum;
+  /**
+   * 场景描述
+   */
+  desc?: string;
+  /**
+   * 该场景需要调用的模型
+   * @enum 'qwen-max' | 'deepseek-r1' | 'qwen-plus'
+   */
+  model?: string;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * 会话内容
+ */
+export interface ISessionContent {
+  /**
+   * 消息内容id
+   */
+  _id?: string;
+}

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

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

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

@@ -0,0 +1,53 @@
+import { type SessionRoleEnum } from './ISessionRole';
+/**
+ * sse流式返回片段
+ */
+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[];
+  };
+}
+
+/**
+ * sse流式返回片段的类型
+ */
+export const enum ISseChunkType {
+  /**
+   * 内容
+   */
+  CONTENT = 'content',
+  /**
+   * 原因
+   */
+  REASON = 'reason',
+  /**
+   * 格式化的json
+   * */
+  FORMATJSON = 'formatJson'
+}

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

@@ -0,0 +1,128 @@
+/**
+ * uniCloud云对象的this上下文
+ */
+export interface IThisContext {
+  /**
+   * 函数执行开始的时间戳 毫秒 在_before中赋值
+   */
+  funStartTime?: number;
+  /**
+   * 函数执行结束的时间戳 毫秒 在_after中赋值
+   */
+  funEndTime?: number;
+  /**
+   * 函数执行的总时间 毫秒 在_after中赋值funEndTime - funStartTime
+   */
+  funRunTime?: number;
+  /**
+   * 通过token解析出来的用户信息 _before中赋值 未登录时候赋值为null
+   */
+  tokenRes?: ITokenRes | null;
+  /**
+   * 获取的云对象信息
+   */
+  getCloudInfo?: () => ICloudInfo;
+  /**
+   * 获取客户端信息
+   */
+  getClientInfo?: () => IClientInfo;
+  /**
+   * 获取token
+   */
+  getUniIdToken?: () => string;
+  /**
+   * 获取调用的云对象方法名
+   */
+  getMethodName?: () => string;
+  /**
+   * 获取调用云对象时候传入的参数
+   */
+  getParams?: () => any;
+  /**
+   * 获取请求id
+   */
+  getUniCloudRequestId?: () => string;
+}
+
+/**
+ * this.tokenRes解析出来的用户信息
+ */
+export interface ITokenRes {
+  /**
+   * 错误码 0为成功
+   */
+  errCode?: number;
+  /**
+   * token解析出来的uid
+   */
+  uid?: string;
+  /**
+   * token解析出来的role角色
+   */
+  role?: string[];
+  /**
+   * token解析出来的permission权限
+   */
+  permission?: string[];
+}
+
+/**
+ * this.getClientInfo返回的客户端信息
+ */
+export interface IClientInfo {
+  /**
+   * 客户端ip
+   */
+  clientIP?: string;
+  /**
+   * 客户端ua，注意非本地运行环境下客户端getSystemInfoSync也会获取ua参数并上传给云对象，但是云对象会从http请求头里面获取ua而不是clientInfo里面的ua
+   */
+  userAgent?: string;
+  /**
+   * 调用来源
+   * client	uni-app客户端导入云对象调用
+   * function	由其他云函数或云对象调用
+   * http	云对象URL化后通过http访问调用 HBuilderX 3.5.2+
+   * timing	定时任务调用云对象 HBuilderX 3.5.2+
+   * server	云函数上传并运行
+   */
+  source?: 'client' | 'function' | 'http' | 'timing' | 'server';
+  /**
+   * 请求id
+   */
+  requestId?: string;
+  /**
+   * 场景值 客户端uni.getLaunchOptionsSync返回的scene参数，新增于HBuilderX 3.5.1
+   */
+  scene?: string;
+}
+
+/**
+ * this.getCloudInfo获取的云对象信息
+ */
+export interface ICloudInfo {
+  /**
+   * 服务空间供应商，支付宝云为：alipay，阿里云为：aliyun，腾讯云为：tencent
+   */
+  provider: 'alipay' | 'aliyun' | 'tencent';
+  /**
+   * 服务空间Id
+   */
+  spaceId: string;
+  /**
+   * 当前获取的服务空间id是否为迁移前的服务空间id
+   */
+  useOldSpaceId: boolean;
+  /**
+   * 云对象名称
+   */
+  functionName: string;
+  /**
+   * 云对象此值固定为cloudobject
+   */
+  functionType: 'cloudobject';
+  /**
+   * 运行环境，取值为local(本地运行)或cloud(云端运行) 新增于HBuilderX 4.25
+   */
+  runtimeEnv: 'local' | 'cloud';
+}

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

@@ -0,0 +1,9 @@
+export * from './ICommonReqRes';
+export * from './ISessionRole';
+export * from './ISessionContent';
+export * from './ICounselor';
+export * from './IChatAiMessageItem';
+export * from './AISceneEnum';
+export * from './ISceneAiConfig';
+export * from './IAliFcContext';
+export * from './ISseChunk';

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

@@ -0,0 +1,131 @@
+import { type IChatAiMessageItem } from './common/IChatAiMessageItem';
+import { type ICommonReq, type AISceneEnum } from './common';
+
+export * from './common';
+/**
+ *  千问AI聊天api 请求参数
+ */
+export interface IChatQwenReq extends ICommonReq {
+  /**
+   * 历史对话消息
+   */
+  messages: IChatAiMessageItem[];
+  /**
+   * 是否开启流式传输
+   */
+  stream: boolean;
+  /**
+   * 提问场景
+   */
+  scene?: AISceneEnum;
+  /**
+   * 通道id(如果开启流式传输stream为true则必传)
+   */
+  channel?: string;
+  /**
+   * 是否开发模式 仅调式使用 默认false 前端禁止使用
+   */
+  devMode?: boolean;
+}
+
+/**
+ * 千问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[];
+}

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from './hdd-ai-cloud';
+export * from './HddCloud';

package/npmPublish.md

@@ -0,0 +1,11 @@
+### 发布前切换到官方的站点
+npm config set registry https://registry.npmjs.org/
+### 执行登录
+npm login
+### 发公有包
+npm publish --access=public 
+```
+--access=public必须要加上，不然发布的是私有包，而NPM上要发布私有包是要收费的，如果第一步init时没有加上--scope=hddjs，那么这里可以不加上这个后缀，因为不带作用域的包发布时，默认是公有的
+```
+### 发布完包之后切会淘宝源
+npm config set registry https://registry.npmmirror.com

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@hddjs/hdd-cloud-types",
+  "version": "1.0.1",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "LZC",
+  "license": "ISC",
+  "types": "./index.d.ts",
+  "description": ""
+}