Qqtip NPM | npm.io

QQTIP SDK 使用说明文档

介绍

该SDK采用JavaScript编写，需配合AI性能领域助手插件使用

安装

使用 npm 安装

npm i qqtip@lastest --save

使用流程

导入

import { QPAAP } from 'qqtip'

API 参考

QPAAP向平台客户端提供以下接口发送消息至插件

QPAAP 接口	描述	参数	返回值
setPrompt: (data:promptType, cb?:(error: any, isSuccess: Boolean)=>void ) => void	配置插件针对该平台产品的提示词或问题示例提示词	data字段：{ type: string, // 配置的是提示词还是问题示例提示词，可选值：'prompt'、'question' data: Array<{ title: string, // 提示词标题 content: string, // 提示词具体内容 }>}cb：发送完毕的回调函数，没有错误时error为undefined	/
checkQPAAPexist: () => Boolean	检查插件是否存在，开发者可在发送消息前做相关处理	/	插件存在则返回true，否则false
sendToAssistant: (data:dataType, cb?: (error: any, dadaSize: Number)=>void) => void	向插件发送消息（调用该接口时会检测插件是否加载)	data字段： { "data": "...", // string 待传输的数据（必填） "format": "json", // 数据格式枚举类型 json/csv/stack（堆栈文本） "consumer": "input" // 消费在哪里输入框直接查询：input 作为线索：bugfix。（必填） "tags": object, //（非必填）"description": string // （非必填）}cb：发送完毕回调函数，发送成功时dataSize为本次发送的数据大小，error为undefined；发生错误时error不为空，dataSize为0	/

QPAAP向插件端提供以下接口接收消息，平台无需接入

QPAAP 接口	描述	参数
receiveFromPlatform: (cb:(data)=>void) => void	通过回调方式接收消息	回调函数cb:(data)=>voiddata字段：{ index // 当前块号 totalChunks // 总块数 data // 切割后的数据 consumer format tags description};

注意事项

插件页面会在平台网页渲染之后进行注入，QPAAP相关接口需在网页挂载完毕后的生命周期事件使用
相关接口会自动检查插件是否存在，若不存在，则控制台输出警告：” QPAAP warn: AI助手插件未开启“。如果插件不存在并且不希望警告出现，请提前使用接口checkQPAAPexist做相关逻辑处理；如果插件已存在，请尝试延迟调用相关接口。
csv数据格式标准：
- 换列：“,”
- 换行：“ \r\n”
- 例如：'Name,Age,Email\r\nJohn Doe,25,johndoe@example.com\r\nJane Smith,30,janesmith@example.com\r\nTom Johnson,35,tomjohnson@example.com'

示例代码

SDK提供的接口看 API 参考

import { QPAAP } from 'qqtip';
// 可在任意位置调用QPAAP提供的方法

// 例如：配置插件针对该平台的提示词
QPAAP.setPrompt({
    type: 'prompt',
    data: [
        {
          title: "帮助我归因这个性能缺陷并给出解决方案",
          content: "帮助我归因这个性能缺陷并给出解决方案",
        },
        {
          title: "帮助我分析这段数据趋势中的异常并进行归因",
          content: "帮助我分析这段数据趋势中的异常并进行归因",
        }
      ]
})

// 例如：向插件发送一段源数据csv并列为线索
let csvData = 'Name,Age,Email\r\nJohn Doe,25,johndoe@example.com\r\nJane Smith,30,janesmith@example.com\r\nTom Johnson,35,tomjohnson@example.com'
QPAAP.sendToAssistant({
    data: csvData,
    format: 'csv',
    description: 'description',
    consumer: 'bugfix'
},(e,chunks)=>{
    if(!e){
        console.log(`发送了${chunks}数据`)
    }else{
        console.log('发送错误：',e)
    }
})

// 例如：向插件发送一段json图表数据并放入输入框
let jsonData = JSON.stringify({a:1,b:2})
QPAAP.sendToAssistant({
    data: jsonData,
    format: 'csv',
    tags: {},
    description: 'description',
    consumer: 'input'
},(e,chunks)=>{
    if(!e){
        console.log(`发送了${chunks}数据`)
    }else{
        console.log('发送错误：',e)
    }
})

// 例如：配置提示词
QPAAP.setPrompt({
    type: 'prompt', data: [{ 
        title: '帮助我处理这个图表数据', 
        content: '帮助我处理这个图表数据'
    }, { 
        title: '帮助我分析这段数据趋势中的异常并进行归因', 
        content: '帮助我分析这段数据趋势中的异常并进行归因'
    }]
}, (e)=>{
    if(!e){
        console.log(`配置成功`)
    }else{
        console.log('配置错误：',e)
    }
})