@blueking/ai-blueking 0.2.15 → 0.3.1

package/README.md

@@ -1,5 +1,77 @@
 # AI 小鲸使用指南
 
+
+## 新特性
+
+- 支持 popup 弹框唤起
+- 支持引用提问功能
+- 支持快捷提问（当前支持翻译、解释功能）
+
+## 0.3.0 重大变更（Breaking Changes）
+
+### 1. 组件显示/隐藏方式变更
+
+- 不再使用 `v-if` 控制组件显示
+- 需要定义一个变量并使用 `v-model:is-show` 绑定到组件
+
+### 2. handleSend 回调参数变更
+
+回调函数现在接收一个对象参数，而不是简单的字符串。参数格式如下：
+
+```typescript
+interface ISendData {
+  content: string;  // 用户输入的内容
+  cite?: string;    // 引用的内容（可选）
+  prompt?: string;  // 使用的 prompt 模板（可选）
+}
+```
+
+## 使用示例
+
+以下展示了如何处理新的 handleSend 回调：
+
+```typescript
+const handleSend = (args: ISendData) => {
+  // 记录当前消息记录
+  const chatHistory = [...messages.value];
+
+  // 添加用户消息
+  messages.value.push({
+    role: 'user',
+    content: args.content,
+    cite: args.cite,
+  });
+
+  // 根据参数构造输入内容
+  const input = args.prompt 
+    ? args.prompt                           // 如果有 prompt，直接使用
+    : args.cite 
+      ? `${args.content}: ${args.cite}`     // 如果有 cite，拼接 content 和 cite
+      : args.content;                       // 否则只使用 content
+
+  // 调用 AI 流式对话
+  // 注：id 是唯一标识当前流，调用 chatHelper.stop 时需要传入
+  chatHelper.stream(
+    {
+      inputs: {
+        input,
+        chat_history: chatHistory,
+      },
+    },
+    1,
+  );
+};
+```
+
+## 注意事项
+
+- 使用 `v-model:is-show` 时需要提前定义对应的响应式变量
+- 处理 handleSend 回调时需要注意新的参数格式
+- 在调用 `chatHelper.stop` 方法时需要传入正确的流 ID
+
+
+
+
 ## 安装
 
 ```bash
@@ -50,6 +122,7 @@ npm i @blueking/ai-blueking
 ```vue
 <template>
   <AIBlueking
+    v-model:is-show="isShow"
     :loading="loading"
     :messages="messages"
     @clear="handleClear"
@@ -63,8 +136,15 @@ npm i @blueking/ai-blueking
   import AIBlueking, { ChatHelper, RoleType, MessageStatus } from '@blueking/ai-blueking';
   import '@blueking/ai-blueking/dist/vue3/style.css';
 
+  interface ISendData {
+    content: string; // 用户输入的内容
+    cite?: string;   // 引用的内容
+    prompt?: string; // 使用的 prompt 模板
+  }
+
   const loading = ref(false);
   const messages = ref([]);
+  const isShow = ref(false);
 
   // 聊天开始
   const handleStart = (id: number | string) => {
@@ -131,19 +211,28 @@ npm i @blueking/ai-blueking
   };
 
   // 发送消息
-  const handleSend = (message: string) => {
+  const handleSend = (args: ISendData) => {
     // 记录当前消息记录
     const chatHistory = [...messages.value];
     // 添加一条消息
     messages.value.push({
       role: 'user',
-      content: message,
+      content: args.content,
+      cite: args.cite,
     });
+
+    // 根据参数构造输入内容
+    const input = args.prompt
+      ? args.prompt // 如果有 prompt，直接使用
+      : args.cite
+        ? `${args.content}: ${args.cite}` // 如果有 cite，拼接 content 和 cite
+        : args.content; // 否则只使用 content
+
     // ai 消息，id是唯一标识当前流，调用 chatHelper.stop 的时候需要传入
     chatHelper.stream(
       {
         inputs: {
-          input: message,
+          input,
           chat_history: chatHistory,
         },
       },
@@ -273,6 +362,10 @@ npm i @blueking/ai-blueking
 
   const handleSend = (val: string) => {
     console.log('trigger send', val);
+      // args 包含:
+      // - content: 用户输入的内容
+      // - cite: 引用的内容(可选)
+      // - prompt: 使用的 prompt 模板(可选)
   };
 
   const handleStop = () => {

package/dist/ai-blueking.vue.d.ts

@@ -17,27 +17,36 @@ interface IProps {
     alert?: string;
     models?: IModel[];
     model?: string;
+    isShow?: boolean;
 }
 declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<IProps>, {
     setInputMessage: (val: string) => void;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    close: () => void;
     stop: () => void;
+    close: () => void;
     clear: () => void;
     "scroll-load": () => void;
     "ai-click": (val: string) => void;
-    send: (val: string) => void;
     "update:model": (val: string) => void;
     "choose-prompt": (prompt: IPrompt) => void;
+    send: (data: {
+        content: string;
+        cite?: string | undefined;
+    }) => void;
+    "update:isShow": (val: boolean) => void;
 }, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<IProps>>> & {
+    onClose?: (() => any) | undefined;
     "onChoose-prompt"?: ((prompt: IPrompt) => any) | undefined;
     onClear?: (() => any) | undefined;
     onStop?: (() => any) | undefined;
-    onSend?: ((val: string) => any) | undefined;
+    onSend?: ((data: {
+        content: string;
+        cite?: string | undefined;
+    }) => any) | undefined;
     "onAi-click"?: ((val: string) => any) | undefined;
     "onScroll-load"?: (() => any) | undefined;
-    onClose?: (() => any) | undefined;
     "onUpdate:model"?: ((val: string) => any) | undefined;
+    "onUpdate:isShow"?: ((val: boolean) => any) | undefined;
 }, {}, {}>;
 export default _default;
 

package/dist/components/ai-avatar.vue.d.ts

@@ -0,0 +1,28 @@
+interface Props {
+    size?: number;
+}
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
+    size: number;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
+    size: number;
+}>>>, {
+    size: number;
+}, {}>;
+export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/ai-cite.vue.d.ts

@@ -0,0 +1,21 @@
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<{
+    text: string;
+    showCloseIcon?: boolean | undefined;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    close: () => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<{
+    text: string;
+    showCloseIcon?: boolean | undefined;
+}>>> & {
+    onClose?: (() => any) | undefined;
+}, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/render-content.vue.d.ts

@@ -1,4 +1,4 @@
-import type { IMessage, IPrompt } from '../types/index';
+import type { IMessage, IPrompt, ISendData } from '../types/index';
 interface IProps {
     messages: IMessage[];
     prompts?: IPrompt[];
@@ -17,7 +17,7 @@ declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_T
     setInputMessage: (val: string) => void;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "ai-click": (userInput: string) => void;
-    send: (userInput: string) => void;
+    send: (data: ISendData) => void;
     "choose-prompt": (prompt: IPrompt) => void;
     stop: () => void;
     "scroll-load": () => void;
@@ -27,7 +27,7 @@ declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_T
 }>>> & {
     "onChoose-prompt"?: ((prompt: IPrompt) => any) | undefined;
     onStop?: (() => any) | undefined;
-    onSend?: ((userInput: string) => any) | undefined;
+    onSend?: ((data: ISendData) => any) | undefined;
     "onAi-click"?: ((userInput: string) => any) | undefined;
     "onScroll-load"?: (() => any) | undefined;
 }, {

package/dist/components/render-modal.vue.d.ts

@@ -60,8 +60,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
     };
     logo: string;
 }>>> & {
-    onClear?: (() => any) | undefined;
     onClose?: (() => any) | undefined;
+    onClear?: (() => any) | undefined;
     "onChoose-model"?: ((val: string) => any) | undefined;
 }, {
     headBackground: string;

package/dist/components/render-popup.vue.d.ts

@@ -0,0 +1,6 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    click: (...args: any[]) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>> & {
+    onClick?: ((...args: any[]) => any) | undefined;
+}, {}, {}>;
+export default _default;

package/dist/components/render-shortcuts.vue.d.ts

@@ -0,0 +1,19 @@
+import type { IShortCut } from '../types/index';
+interface IProps {
+    shortcuts: IShortCut[];
+}
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<IProps>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    select: (shortcut: IShortCut) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<IProps>>> & {
+    onSelect?: ((shortcut: IShortCut) => any) | undefined;
+}, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/composables/use-bk-ai.d.ts

@@ -0,0 +1,22 @@
+import { RoleType, MessageStatus } from '../types/enum';
+interface UseBkAiOptions {
+    useStream?: boolean;
+    apiUrl?: string;
+}
+export declare function useBkAi(options?: UseBkAiOptions): {
+    loading: import("vue").Ref<boolean>;
+    messages: import("vue").Ref<{
+        status?: MessageStatus | undefined;
+        time?: string | number | undefined;
+        cite?: string | undefined;
+        role: RoleType;
+        content: string;
+    }[]>;
+    isShow: import("vue").Ref<boolean>;
+    handleShowAi: () => void;
+    handleClose: () => void;
+    handleClear: () => void;
+    handleSend: (args: any) => void;
+    handleStop: () => void;
+};
+export {};

package/dist/composables/use-scroll-show.d.ts

@@ -0,0 +1,4 @@
+export declare function useScrollShow(): {
+    isShow: import("vue").Ref<boolean>;
+    scrollToBottom: () => void;
+};

package/dist/composables/use-select-pop.d.ts

@@ -0,0 +1,12 @@
+export declare function useSelect(): {
+    isIconVisible: import("vue").Ref<boolean>;
+    iconPosition: import("vue").Ref<{
+        top: string;
+        left: string;
+    }>;
+    selectedText: import("vue").Ref<string>;
+    hideIcon: () => void;
+    clearSelection: () => void;
+    setSelection: (text: string) => void;
+    lockSelectedText: import("vue").Ref<boolean>;
+};

package/dist/config/index.d.ts

@@ -0,0 +1 @@
+export * from './shortcuts';

package/dist/config/shortcuts.d.ts

@@ -0,0 +1,2 @@
+import { IShortCut } from '../types';
+export declare const DEFAULT_SHORTCUTS: IShortCut[];

package/dist/lang/index.d.ts

@@ -23,5 +23,8 @@ export declare const langData: {
     readonly 本周: "this week";
     readonly 上周: "last week";
     readonly 复制成功: "Copy success";
+    readonly 您选择的文本内容: "The text content you selected";
+    readonly 问小鲸: "Ask BK GPT";
+    readonly 想对选中的文本做什么: "What do you want to do with the selected text?";
 };
-export declare const t: (key: keyof typeof langData) => "BK GPT" | "shrink down" | "expand upward" | "Empty chat records" | "close" | "The content is being executed, please send it after the execution is completed." | "Send" | "You can type \"/\" to see more Prompts" | "Please input" | "Latest" | "Stop" | "Scroll up to load more records" | " sunday" | " monday" | " tuesday" | " wednesday" | " thursday" | " friday" | " saturday" | "yesterday" | "this week" | "last week" | "Copy success" | "小鲸" | "向下收缩" | "向上扩展" | "清空聊天记录" | "关闭" | "内容正在执行中，请执行完成后再发送" | "发送" | "您可以键入 “/” 查看更多Prompt" | "请输入" | "返回最新" | "终止生成" | "向上滚动加载更多记录" | "日" | "一" | "二" | "三" | "四" | "五" | "六" | "昨天" | "本周" | "上周" | "复制成功";
+export declare const t: (key: keyof typeof langData) => "close" | "BK GPT" | "shrink down" | "expand upward" | "Empty chat records" | "The content is being executed, please send it after the execution is completed." | "Send" | "You can type \"/\" to see more Prompts" | "Please input" | "Latest" | "Stop" | "Scroll up to load more records" | " sunday" | " monday" | " tuesday" | " wednesday" | " thursday" | " friday" | " saturday" | "yesterday" | "this week" | "last week" | "Copy success" | "The text content you selected" | "Ask BK GPT" | "What do you want to do with the selected text?" | "小鲸" | "向下收缩" | "向上扩展" | "清空聊天记录" | "关闭" | "内容正在执行中，请执行完成后再发送" | "发送" | "您可以键入 “/” 查看更多Prompt" | "请输入" | "返回最新" | "终止生成" | "向上滚动加载更多记录" | "日" | "一" | "二" | "三" | "四" | "五" | "六" | "昨天" | "本周" | "上周" | "复制成功" | "您选择的文本内容" | "问小鲸" | "想对选中的文本做什么";

package/dist/types/enum.d.ts

@@ -4,6 +4,7 @@ export declare enum AgentMessageType {
 }
 export declare enum RoleType {
     Assistant = "assistant",
+    Cite = "cite",
     System = "system",
     User = "user"
 }

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ import { RoleType, MessageStatus } from './enum';
 export interface IMessage extends IChatHistory {
     status?: MessageStatus;
     time?: number | string;
+    cite?: string;
 }
 export interface IPrompt {
     id: number | string;
@@ -31,3 +32,12 @@ export interface IModel {
     id: string;
     name: string;
 }
+export interface IShortCut {
+    label: string;
+    prompt: string;
+}
+export interface ISendData {
+    content: string;
+    cite?: string;
+    prompt?: string;
+}