{"id":17288409,"url":"https://github.com/theajack/spark-node","last_synced_at":"2025-04-14T11:24:07.538Z","repository":{"id":174453167,"uuid":"652208190","full_name":"theajack/spark-node","owner":"theajack","description":"讯飞星火认知大模型 Nodejs SDK","archived":false,"fork":false,"pushed_at":"2023-12-15T01:04:59.000Z","size":81,"stargazers_count":20,"open_issues_count":0,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-18T13:24:48.866Z","etag":null,"topics":["nodejs","spark","xun-fei"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theajack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-11T12:42:23.000Z","updated_at":"2024-04-01T08:35:50.000Z","dependencies_parsed_at":"2023-12-14T15:49:53.994Z","dependency_job_id":"99e9fcaf-b3df-474c-85a2-5fa6b92273ee","html_url":"https://github.com/theajack/spark-node","commit_stats":null,"previous_names":["theajack/spark-node"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theajack%2Fspark-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theajack%2Fspark-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theajack%2Fspark-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theajack%2Fspark-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theajack","download_url":"https://codeload.github.com/theajack/spark-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248869664,"owners_count":21174913,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodejs","spark","xun-fei"],"created_at":"2024-10-15T10:27:39.002Z","updated_at":"2025-04-14T11:24:07.505Z","avatar_url":"https://github.com/theajack.png","language":"TypeScript","readme":"\u003c!--\n * @Author: chenzhongsheng\n * @Date: 2023-02-13 17:02:26\n * @Description: Coding something\n--\u003e\n# [Spark-Nodejs](https://github.com/theajack/spark-node)\n\n[讯飞星火认知大模型](https://xinghuo.xfyun.cn/) Nodejs SDK \u0026 Web使用\n\n## install \n\n```\nnpm i spark-nodejs\n```\n\n## 使用\n\n```js\nconst spark = new Spark({\n    // 自行填入相关参数\n    secret: 'xxx',\n    key: 'xxx',\n    appid: 'xxx',\n});\nconst answer = await spark.chat('你好');\n```\n\n## 构造参数\n\n```ts\nexport interface ISparkOptions {\n    secret: string; // 从平台获取\n    key: string; // 从平台获取\n    version?: // 非必须 星火大模型版本号 默认为1，支持1,2,3\n    appid?: string; // 应用appid，从开放平台控制台创建的应用中获取\n    uid?: string; // 每个用户的id，用于区分不同用户\n    temperature?: number; // 取值为[0,1],默认为0.5\t核采样阈值。用于决定结果随机性，取值越高随机性越强即相同的问题得到的不同答案的可能性越高\n    maxTokens?: number; // 取值为[1,4096]，默认为2048\t模型回答的tokens的最大长度\n    topK?: number; // 取值为[1，6],默认为4\t从k个候选中随机选择⼀个（⾮等概率）\n    chatId?: string; // 需要保障用户下的唯一性\t用于关联用户会话\n    useHistory?: boolean; // 是否需要使用历史对话记录，对token消耗会很快 default: false\n    versionStr?: // 非必须 API接口的version字段，默认为'', 表示采用version指代的版本号，该字段为了扩展性考虑，可以传入 vx.x 表示任意版本\n}\n```\n\n## API\n\n### generateUrl\n\n生成websocket请求 url，可以下发给前端发起ws请求\n\n```js\nconst url = spark.generateUrl();\n```\n\n### chat\n\n直接使用node发起对话\n\n```js\nconst url = spark.chat({\n    content: '你好',\n    // onData 表示分段拿到返回结果\n    onData({content, start, end, seq}){\n      // content 表示分段的内容 \n      // start 表示是否是第一段\n      // end 表示是否是最后一段\n      // seq 表示序号\n      console(content, start, end, seq);\n    },\n    onEnd({content, token, questionTokens}){\n      // content 表示完整的返回\n      // token 表示返回回答的token数\n      // questionTokens 表示发起对话的token数\n      console(content, start, end, seq);\n    }\n});\n```\n\n或者使用 chat的Promise返回\n\n```js\nconst answer = await spark.chat('你好');\n```\n\n函数声明\n\n```ts\nfunction chat (options: IQuestionOptions): Promise\u003cstring\u003e;\n\ninterface IQuestionOptions {\n    content: string;\n    onData?(options: {content: string; start: boolean; end: boolean, seq: number}): void;\n    onEnd?(options: {content: string, tokens: number, questionTokens: number}): void;\n}\n```\n\n## Web 端使用\n\nspark-node中将消息部分单独打包到 socket 模块，可以在web环境中使用。使用场景为服务端生成url下发，web端调用socket模块发起聊天\n\n```js\nimport { SparkChat } from \"spark-nodejs/chat\";\nconst spark = new SparkChat({url: 'xxx'});\nspark.chat({content: 'xxx'}); // chat 参数与上文中的chat参数一致\n```\n\n构造参数：\n\n构造参数如下，除了多了 url 与 urlGetter 参数外，其他与上文一致，url与urlGetter填入一个即可\n\n当填入url时，一次请求结束之后需要手动重新获取url设置\n\n当填入urlGetter时，会自动获取url，推荐使用urlGetter\n\n```ts\nexport interface ISparkSocketOptions {\n    url?: string; // 指定url\n    urlGetter?: ()=\u003ePromise\u003cstring\u003e; // 自动获取url的函数，一般封装获取url的请求\n    appid?: string;\n    uid?: string;\n    temperature?: number; // 取值为[0,1],默认为0.5\t核采样阈值。用于决定结果随机性，取值越高随机性越强即相同的问题得到的不同答案的可能性越高\n    maxTokens?: number; // 取值为[1,4096]，默认为2048\t模型回答的tokens的最大长度\n    topK?: number; // 取值为[1，6],默认为4\t从k个候选中随机选择⼀个（⾮等概率）\n    chatId?: string; // 需要保障用户下的唯一性\t用于关联用户会话\n    useHistory?: boolean; // default: false\n}\n```\n\n### cdn使用\n\n```html\n\u003cscript src='https://cdn.jsdelivr.net/npm/spark-nodejs'\u003e\u003c/script\u003e\n\u003cscript\u003e\nconst spark = new SparkChat({url: 'xxx'});\n\u003c/script\u003e\n```\n\n## 关于 useHistory\n\n开启了 useHistory 之后，Spark-Node 内部会缓存之前的对话上下文，然后在 chat 时一起发送给服务端，所以token消耗会很快，请按需要决定是否开启。\n\nhistroyToken的最大限制是8192，超过这个限制时Spark-Node会自动清除最早的记录，知道tokens小于8192。","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheajack%2Fspark-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheajack%2Fspark-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheajack%2Fspark-node/lists"}