@frigade/ assist- api

Frigade Assistance API:向自己的AI代理添加产品答案并进行现场直播,页面上的指导.

安装

npm install @frigade/assist-api

要求数 react 财务报告和审定财务报表 react-dom 18-19作为同龄人依赖关系.

使用量

import * as FrigadeAssistAPI from '@frigade/assist-api';

FrigadeAssistAPI.init({
  apiKey: 'YOUR_FRIGADE_PUBLIC_API_KEY',
  apiUrl: 'https://api.frigade.ai',
  userId: 'user-123',
});

在浏览器里,在你的应用负载之后,给它打电话一次。 然后从你的代理人那里发射一个向导:

const result = await FrigadeAssistAPI.query({
  intent: 'Invite a teammate',
});

或者通过一个 Vercel AI SDK 工具直通(返回) null 如果工具电话不是Frigade的:

const result = await FrigadeAssistAPI.handleToolCall(toolCall);

result.status 这是其中之一 started, (中文(简体) ), answer, (中文(简体) ), needs_clarification, (中文(简体) ), cancelled, (中文(简体) ), unavailable,或 error. 此前发出的呼吁 init 页:1 unavailable 有理无据 not-initialized; 打电话时 init 仍在装入等待.

解除运行指南 :

FrigadeAssistAPI.close();

A 类 query() 还在飞行中 cancelled,如同用户关闭向导卡时那样。 在此之前 init,或者没有向导运行, close() 什么也没做.

活动

const unsubscribe = FrigadeAssistAPI.on('complete', () => {
  console.log('Guide completed');
});

unsubscribe();

处理器可在 init。 。 。 . off(event, handler) 也删除处理器。 见 EventType 类型.

选项

见 FrigadeAssistAPIConfig 类型.

许可证

见 自由主义。 。 。 .