用途:为 Domo 应用平台中的 AI 调用提供 toolkit 优先的规范,指导使用 AIClient 完成文本生成、text_to_sql 与响应解析。
主要能力与关键规则:
- 安装:yarn add @domoinc/toolkit;从该包导入 AIClient。
- AIClient 方法为静态方法,不要实例化后调用。正确:await AIClient.text_to_sql('...');错误:const ai = new AIClient(); await ai.text_to_sql('...')。
- 方法名使用 snake_case,如 generate_text、text_to_sql、text_to_beastmode。
- text_to_sql 的第二个参数必须是 DataSourceSchema 数组(可传多个 schema 以支持多表及 join 感知的 SQL),不能传单个对象。
- 文本生成示例:AIClient.generate_text('Explain this sales trend in simple terms', { template: 'You are a business analyst. ${input}' }, { tone: 'professional' }, undefined, { temperature: 0.7 })。
- 响应可能存在 data、body、output、choices 等不同结构,建议防御式解析并做字符串校验;若取不到有效输出则抛出错误。
- text_to_sql 适合临时 SQL;/sql/v1 不会自动应用仪表板/页面筛选器。若需筛选感知,应使用 Query API(/data/v1,通过 @domoinc/query)执行。
限制与补充:签名说明为近似值,应以已安装 toolkit 的类型定义为准;官方未提供更多收费、平台或效果信息。