@blueking/ai-blueking 0.2.14 → 0.2.15-beta.2

package/README.md

@@ -6,6 +6,43 @@
 npm i @blueking/ai-blueking
 ```
 
+## 通过模板字符串渲染特定 html
+
+#### 渲染知识库列表的模板
+
+可以使用类似如下的模板来渲染匹配的知识库列表
+
+```
+<section class="knowledge-tips">
+  <i class="ai-blueking-icon ai-blueking-angle-up"></i>
+  <span class="knowledge-summary">
+    <i class="ai-blueking-icon ai-blueking-help-document"></i>
+    引用 4 篇资料作为参考
+  </span>
+  <a href="xxx" target="_blank" class="knowledge-link">
+    1. vivo 容器平台如何实现资源超卖方案
+    <i class="ai-blueking-icon ai-blueking-cc-jump-link"></i>
+  </a>
+  <a href="xxx" target="_blank" class="knowledge-link">
+    1. vivo 容器平台如何实现资源超卖方案
+    <i class="ai-blueking-icon ai-blueking-cc-jump-link"></i>
+  </a>
+  <a href="xxx" target="_blank" class="knowledge-link">
+    1. vivo 容器平台如何实现资源超卖方案
+    <i class="ai-blueking-icon ai-blueking-cc-jump-link"></i>
+  </a>
+</section>
+```
+
+#### 渲染带有点击交互的html
+
+可以使用类似如下的模板来渲染可点击交互的 html（具有'ai-clickable'的class），点击以后会触发组件的`ai-click`事件，并把 html 标签的`data-ai`的数据传递出来。这样业务可以进行二次处理。比如说把`data-ai`上的字符串赋值到输入框，可以使用`aiRef.value?.setInputMessage(val)`来设置输入框内容。
+
+```
+<button data-ai="{ type: 'button', data: xxx }" class="ai-clickable">可点击的按钮</button>
+<a data-ai="{ type: 'link', data: 'link url' }" class="ai-clickable" href="void">可点击的链接</a>
+```
+
 ## stream 模式
 
 不同框架，组件引入方式不同，具体可参考下面的的例子。这里使用 vue3 项目为例，来展示 stream 模式交互：
@@ -136,6 +173,7 @@ npm i @blueking/ai-blueking
     :scroll-loading-end="scrollLoadingEnd"
     :size-limit="sizeLimit"
     :start-position="startPosition"
+    @ai-click="handleAIClick"
     @choose-prompt="handleChoosePrompt"
     @clear="handleClear"
     @close="handleClose"
@@ -145,7 +183,7 @@ npm i @blueking/ai-blueking
   />
 </template>
 <script setup lang="ts">
-  import { ref } from 'vue';
+  import { type ComponentInstance, ref } from 'vue';
 
   import AIBlueking, { type IPrompt, type IMessage, RoleType, MessageStatus } from '@blueking/ai-blueking';
 
@@ -226,6 +264,8 @@ npm i @blueking/ai-blueking
   // 向上滚动加载
   const scrollLoading = ref(false);
   const scrollLoadingEnd = ref(false);
+  // 组件实例
+  const aiRef = ref<ComponentInstance<typeof AIBlueking>>();
 
   const handleClear = () => {
     console.log('trigger clear');
@@ -270,6 +310,10 @@ npm i @blueking/ai-blueking
   const handleChoosePrompt = (prompt: IPrompt) => {
     console.log('choose prompt', prompt);
   };
+
+  const handleAIClick = (val: string) => {
+    aiRef.value?.setInputMessage(val);
+  };
 </script>
 ```
 

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

@@ -1,56 +1,52 @@
 import type { IMessage, IPrompt, IPositionLimit, ISize, IStartPosition, IModel } from './types';
-declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<{
+interface IProps {
     messages: IMessage[];
-    prompts?: IPrompt[] | undefined;
-    loading?: boolean | undefined;
-    headBackground?: string | undefined;
-    background?: string | undefined;
-    positionLimit?: IPositionLimit | undefined;
-    sizeLimit?: ISize | undefined;
-    startPosition?: IStartPosition | undefined;
-    userPhoto?: string | undefined;
-    name?: string | undefined;
-    placeholder?: string | undefined;
-    logo?: string | undefined;
-    scrollLoading?: boolean | undefined;
-    scrollLoadingEnd?: boolean | undefined;
-    alert?: string | undefined;
-    models?: IModel[] | undefined;
-    model?: string | undefined;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    close: () => void;
+    prompts?: IPrompt[];
+    loading?: boolean;
+    headBackground?: string;
+    background?: string;
+    positionLimit?: IPositionLimit;
+    sizeLimit?: ISize;
+    startPosition?: IStartPosition;
+    userPhoto?: string;
+    name?: string;
+    placeholder?: string;
+    logo?: string;
+    scrollLoading?: boolean;
+    scrollLoadingEnd?: boolean;
+    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, {
     stop: () => void;
+    close: () => void;
     clear: () => void;
     "scroll-load": () => void;
-    send: (val: string) => void;
+    "ai-click": (val: string) => void;
     "update:model": (val: string) => void;
     "choose-prompt": (prompt: IPrompt) => void;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<{
-    messages: IMessage[];
-    prompts?: IPrompt[] | undefined;
-    loading?: boolean | undefined;
-    headBackground?: string | undefined;
-    background?: string | undefined;
-    positionLimit?: IPositionLimit | undefined;
-    sizeLimit?: ISize | undefined;
-    startPosition?: IStartPosition | undefined;
-    userPhoto?: string | undefined;
-    name?: string | undefined;
-    placeholder?: string | undefined;
-    logo?: string | undefined;
-    scrollLoading?: boolean | undefined;
-    scrollLoadingEnd?: boolean | undefined;
-    alert?: string | undefined;
-    models?: IModel[] | undefined;
-    model?: string | undefined;
-}>>> & {
+    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,39 +1,40 @@
 import type { IMessage, IPrompt } from '../types/index';
-declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<{
+interface IProps {
     messages: IMessage[];
-    prompts?: IPrompt[] | undefined;
-    loading?: boolean | undefined;
-    background?: string | undefined;
-    userPhoto?: string | undefined;
-    placeholder?: string | undefined;
-    scrollLoading?: boolean | undefined;
-    scrollLoadingEnd?: boolean | undefined;
-    alert?: string | undefined;
-}>, {
+    prompts?: IPrompt[];
+    loading?: boolean;
+    background?: string;
+    userPhoto?: string;
+    placeholder?: string;
+    scrollLoading?: boolean;
+    scrollLoadingEnd?: boolean;
+    alert?: string;
+}
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<IProps>, {
     background: string;
     scrollLoadingEnd: boolean;
-}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    send: (userInput: string) => void;
+}>, {
+    setInputMessage: (val: string) => void;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "ai-click": (userInput: string) => void;
+    send: (data: {
+        content: string;
+        cite?: string | undefined;
+    }) => void;
     "choose-prompt": (prompt: IPrompt) => void;
     stop: () => void;
     "scroll-load": () => void;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<{
-    messages: IMessage[];
-    prompts?: IPrompt[] | undefined;
-    loading?: boolean | undefined;
-    background?: string | undefined;
-    userPhoto?: string | undefined;
-    placeholder?: string | undefined;
-    scrollLoading?: boolean | undefined;
-    scrollLoadingEnd?: boolean | undefined;
-    alert?: string | undefined;
-}>, {
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<IProps>, {
     background: string;
     scrollLoadingEnd: boolean;
 }>>> & {
     "onChoose-prompt"?: ((prompt: IPrompt) => any) | undefined;
     onStop?: (() => any) | undefined;
-    onSend?: ((userInput: string) => any) | undefined;
+    onSend?: ((data: {
+        content: string;
+        cite?: string | undefined;
+    }) => any) | undefined;
+    "onAi-click"?: ((userInput: string) => any) | undefined;
     "onScroll-load"?: (() => any) | undefined;
 }, {
     background: string;

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/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/lang/index.d.ts

@@ -23,5 +23,7 @@ export declare const langData: {
     readonly 本周: "this week";
     readonly 上周: "last week";
     readonly 复制成功: "Copy success";
+    readonly 您选择的文本内容: "The text content you selected";
+    readonly 问小鲸: "Ask BK GPT";
 };
-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" | "小鲸" | "向下收缩" | "向上扩展" | "清空聊天记录" | "关闭" | "内容正在执行中，请执行完成后再发送" | "发送" | "您可以键入 “/” 查看更多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;