@frigade/ 协助员
Frigade Assistant:一个在网络应用中解答用户问题的出品助理.
安装
npm install @frigade/assistant
要求数 react 财务报告和审定财务报表 react-dom 18-19作为同龄人依赖关系.
使用量
import * as FrigadeAssistant from '@frigade/assistant';
FrigadeAssistant.init({
apiKey: 'YOUR_FRIGADE_PUBLIC_API_KEY',
apiUrl: 'https://api.frigade.ai',
userId: 'user-123',
});
在浏览器里,在你的应用负载之后,给它打电话一次.
控件
FrigadeAssistant.show(); // open the assistant, ready for a question
FrigadeAssistant.hide(); // take it off the page; it keeps running
FrigadeAssistant.close(); // end the conversation, back to the collapsed button
FrigadeAssistant.ask({ question: 'What can you do?' });
FrigadeAssistant.getMode(); // 'pre-init', 'hidden', 'collapsed', 'input', ...
在助手挂起之前拨打的电话, 一旦挂起就排队运行 . getMode() 返回时 'pre-init' 直到那时.
活动
const unsubscribe = FrigadeAssistant.on('ask', ({ query }) => {
console.log('User asked', query);
});
unsubscribe();
处理器可在 init。 。 。 . off(event, handler) 也删除处理器。 见 EventType 类型.
选项
| 选项 | 类型 | 说明 |
|---|---|---|
apiKey | string | 要求. 你的Frigade公共API密钥. |
apiUrl | string | 要求. Frigade API URL (英语). |
userId | string | 签名用户的ID. |
userProperties | Record<string, unknown> | 用户的额外属性 . |
assistantId | string | 范围要求具体助理. |
locale | string | 强制UI语言(例如. 'es-MX'。默认浏览器. |
defaultVisible | boolean | 助理是否在负载中可见 。 默认为 true。 。 。 . |
见 FrigadeAssistantConfig 类型.
许可证
见 自由主义。 。 。 .