@akropolys/kiku (英语)
聊天、搜索、语音和图片输入 Kiku 将访问者连接到您在 Akropolys 中配置的内容和 API 动作 。 对于React和Next.js,使用下面的React包. 对于其他网站,使用CDN嵌入;在喜欢脚本集成时,它也在React中工作.
Java 脚本嵌入
将 Kiku 添加到任何已发布的 CDN 脚本网站上 :
<script
src="https://cdn.akropolys.cloud/kiku/2.2.44/kiku.js"
data-site-id="YOUR_SITE_ID"
data-api-token="YOUR_PUBLIC_BROWSER_TOKEN"
data-label="Ask Kiku"
data-vision="true"
defer
></script>
嵌入式包括自己的回放运行时间,样式,和起放. 您的网站不需要 React 安装或提供者, 包括当它使用 React 或 Next.js 时. 见 嵌入式导线 用于配置、摄入和自宿.
安装
推荐 React 和 Next.js 应用程序 :
npm install @akropolys/[email protected] @akropolys/[email protected]
这个包集成需要回放和回放DOM 17或更后.
反应和下一个.js
'use client';
import { AkropolysProvider } from '@akropolys/sdk';
import { KikuButton } from '@akropolys/kiku';
import '@akropolys/kiku/styles.css';
export default function WebsiteAssistant() {
return (
<AkropolysProvider
siteId={process.env.NEXT_PUBLIC_AKROPOLYS_SITE_ID!}
apiUrl={process.env.NEXT_PUBLIC_AKROPOLYS_API_URL!}
apiToken={process.env.NEXT_PUBLIC_AKROPOLYS_API_TOKEN!}
>
<KikuButton label="Ask us" enableVoice enableVision />
</AkropolysProvider>
);
}
在您的应用程序或布局中挂载组件一次 。 在 Next.js App 路由器中,导入您根版式中的样式表, 如果这是您的项目保存全局 CSS 的地方 .
使用您的网站的公共浏览器符号 。 在您的服务器上保留私钥和服务器证书 。 为您在 Shell 的网站启用相应的语音和视觉特性 .
来宾能做的
- 询问您的内容并比较表格中的记录 .
- 使用现场声音说话,或在谈话中包括相片.
- 开源记录并保存后期的项目 .
- 长压或右键点击消息访问其动作.
- 使用翻译控件,从右到左的布局,以及聊天主题.
构成部分
| 构成部分 | 目的 |
|---|---|
KikuButton | 一个打开聊天窗口的发射装置. |
SearchBar | 有流出结果的内置搜索. |
两个部件都使用 AkropolysProvider 从 @akropolys/sdk。 。 。 .
自定义发射器
<KikuButton
label="Ask about this property"
title="Your assistant"
placeholder="What would you like to know?"
chips={['Show available properties', 'Compare my options']}
theme="dark"
enableVoice
enableVision
/>
theme 接受 light, (中文(简体) ), dark,或一个 AkropolysTheme 对象从 @akropolys/sdk启用 onSelectSource 处理选择源记录的访客.
内容和行动
给每个目录记录一个稳定的顶层 id中的网页链接 fields.url 是可选的; Kiku 可以在没有记录的情况下显示和保存记录。 见 SDK 摄取指南。 。 。 .
在 Shell 中配置动作端点、 方法和请求字段 。 部件在聊天和语音中从访客浏览器中调用您的 API 。 Cookie认证自动工作. 对于办事员、 Auth0 或 Supabase 无记名 API, 添加一个选项, 例如 actionAuth: { provider: "supabase", client: supabase } 改为 Kiku.mount(...),或使用 actionAuth 在您现有的反应提供者上安装道具 。 已存在的 Auth 客户端处理符号更新; Kiku 在内部添加信头 。 CDN嵌入版不需要应用程序包装. 您的 API 验证权限并进行操作 。 见 站点动作指南。 。 。 .
链接
许可证
麻省理工学院 阿克罗波利斯