doomiaichat 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { EventEmitter } from "events";
 import { AxiosRequestConfig } from "axios";
-export default class AIChat extends EventEmitter {
+export declare class AIChat extends EventEmitter {
     private readonly chatRobot;
     private readonly chatModel;
     private readonly maxtoken;
@@ -11,10 +11,53 @@ export default class AIChat extends EventEmitter {
      * @param apiKey 调用OpenAI 的key
      * @param apiOption
      */
-    constructor(apiKey: string, apiOption?: any);
+    constructor(apiKey: string, apiOption?: CallChatApiOption);
     /**
      * 向OpenAI发送一个聊天请求
      * @param {*} chatText
      */
-    chatRequest(chatText: string | any, axiosOption: AxiosRequestConfig): Promise<any>;
+    chatRequest(chatText: string | Array<any>, callChatOption: CallChatApiOption, axiosOption: AxiosRequestConfig): Promise<ChatReponse>;
+    /**
+     * 判断一句话的表达情绪
+     * @param {*} s1
+     * @param {*} axiosOption
+     */
+    getScentenceEmotional(s1: string, axiosOption?: any): Promise<ChatReponse>;
+    /**
+     * 获取两句话的相似度取值
+     * @param {*} s1
+     * @param {*} s2
+     */
+    getScentenseSimilarity(s1: string, s2: string, axiosOption?: any): Promise<ChatReponse>;
+}
+/**
+ * Api封装后的返回结果
+ */
+export interface ChatReponse {
+    /**
+     * return the result of api called
+     * @type {boolean}
+     */
+    'successed': boolean;
+    /**
+     * The error info
+     * @type {any}
+     * @memberof ChatReponse
+     */
+    'error'?: any;
+    /**
+     * The name of the user in a multi-user chat
+     * @type {Array<any>}
+     * @memberof ChatReponse
+     */
+    'message'?: Array<any>;
+}
+/**
+ * 调用OpenAI Api的参数约定
+ */
+export interface CallChatApiOption {
+    model?: string;
+    maxtoken?: number;
+    temperature?: number;
+    replyCounts?: number;
 }

package/dist/index.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { Configuration, OpenAIApi } from "openai";
 import { EventEmitter } from "events";
-export default class AIChat extends EventEmitter {
+export class AIChat extends EventEmitter {
     /**
      *
      * @param apiKey 调用OpenAI 的key
@@ -26,19 +26,21 @@ export default class AIChat extends EventEmitter {
      * 向OpenAI发送一个聊天请求
      * @param {*} chatText
      */
-    chatRequest(chatText, axiosOption) {
+    chatRequest(chatText, callChatOption, axiosOption) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!chatText)
-                return { successed: false, errcode: 2, errmsg: '缺失聊天的内容' };
+                return { successed: false, error: { errcode: 2, errmsg: '缺失聊天的内容' } };
             if (!this.chatRobot)
-                return { successed: false, errcode: 1, errmsg: '聊天机器人无效' };
+                return { successed: false, error: { errcode: 1, errmsg: '聊天机器人无效' } };
+            let message = typeof (chatText) == 'string' ?
+                [{ role: 'system', content: chatText + '' }] : chatText;
             try {
                 const response = yield this.chatRobot.createChatCompletion({
-                    model: this.chatModel,
-                    messages: chatText,
-                    temperature: this.temperature,
-                    max_tokens: this.maxtoken
-                    // n: this.replyCounts
+                    model: callChatOption.model || this.chatModel,
+                    messages: message,
+                    temperature: (callChatOption === null || callChatOption === void 0 ? void 0 : callChatOption.temperature) || this.temperature,
+                    max_tokens: (callChatOption === null || callChatOption === void 0 ? void 0 : callChatOption.maxtoken) || this.maxtoken,
+                    n: callChatOption.replyCounts || 1
                 }, axiosOption);
                 return { successed: true, message: response.data.choices };
             }
@@ -47,4 +49,38 @@ export default class AIChat extends EventEmitter {
             }
         });
     }
+    /**
+     * 判断一句话的表达情绪
+     * @param {*} s1
+     * @param {*} axiosOption
+     */
+    getScentenceEmotional(s1, axiosOption = { timeout: 30000 }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!s1)
+                return { successed: false, error: { errcode: 2, errmsg: '缺失参数' } };
+            const emotion = ['愤怒', '威胁', '讽刺', '愧疚', '兴奋', '友好', '消极', '生气', '正常'];
+            const messages = [
+                { role: 'user', content: s1 },
+                { role: 'user', content: `请分析上述内容的语言情绪,请从"${emotion.join(',')}"这些情绪中对应一个输出` },
+            ];
+            return this.chatRequest(messages, {}, axiosOption);
+        });
+    }
+    /**
+     * 获取两句话的相似度取值
+     * @param {*} s1
+     * @param {*} s2
+     */
+    getScentenseSimilarity(s1, s2, axiosOption = { timeout: 30000 }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!s1 || !s2)
+                return { successed: false, error: { errcode: 2, errmsg: '缺失参数' } };
+            const messages = [
+                { role: 'user', content: s1 },
+                { role: 'user', content: s2 },
+                { role: 'user', content: '请从语义上对比以上两句话的相似度,请仅输出0至100之间的整数对比结果即可' },
+            ];
+            return this.chatRequest(messages, { maxtoken: 32 }, axiosOption);
+        });
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doomiaichat",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Doomisoft OpenAI",
   "main": "dist/index.js",
   "scripts": {

package/src/index.ts

@@ -1,7 +1,7 @@
-import { Configuration, OpenAIApi, CreateChatCompletionResponse } from "openai"
+import { Configuration, OpenAIApi, CreateChatCompletionResponse, ChatCompletionRequestMessage } from "openai"
 import { EventEmitter } from "events";
 import { AxiosRequestConfig, AxiosResponse } from "axios";
-export default class AIChat extends EventEmitter {
+export class AIChat extends EventEmitter {
     private readonly chatRobot: OpenAIApi;
     private readonly chatModel: string;
     private readonly maxtoken: number;
@@ -11,7 +11,7 @@ export default class AIChat extends EventEmitter {
      * @param apiKey 调用OpenAI 的key
      * @param apiOption 
      */
-    constructor(apiKey: string, apiOption: any = {}) {
+    constructor(apiKey: string, apiOption: CallChatApiOption = {}) {
         super();
         this.chatRobot = new OpenAIApi(new Configuration({ apiKey }))
         this.chatModel = apiOption.model || 'gpt-3.5-turbo';
@@ -23,22 +23,88 @@ export default class AIChat extends EventEmitter {
      * 向OpenAI发送一个聊天请求
      * @param {*} chatText 
      */
-    public async chatRequest(chatText: string | any, axiosOption: AxiosRequestConfig):Promise<any> {
-        if (!chatText) return { successed: false, errcode: 2, errmsg: '缺失聊天的内容' }
-        if (!this.chatRobot) return { successed: false, errcode: 1, errmsg: '聊天机器人无效' }
-        try{
+    public async chatRequest(chatText: string | Array<any>, callChatOption: CallChatApiOption, axiosOption: AxiosRequestConfig): Promise<ChatReponse> {
+        if (!chatText) return {successed:false, error:{ errcode: 2, errmsg: '缺失聊天的内容' }};
+            if(!this.chatRobot) return {successed: false, error: { errcode: 1, errmsg: '聊天机器人无效' }};
+
+        let message: Array<ChatCompletionRequestMessage> = typeof(chatText)=='string'?
+            [{ role: 'system', content: chatText + '' }] : chatText;
+        try {
             const response: AxiosResponse<CreateChatCompletionResponse, any>
                 = await this.chatRobot.createChatCompletion({
-                    model: this.chatModel,
-                    messages: chatText,
-                    temperature: this.temperature,
-                    max_tokens: this.maxtoken
-                    // n: this.replyCounts
+                    model: callChatOption.model ||  this.chatModel,
+                    messages: message,
+                    temperature: callChatOption?.temperature || this.temperature,
+                    max_tokens: callChatOption?.maxtoken || this.maxtoken,
+                    n: callChatOption.replyCounts || 1
                 }, axiosOption);
-            return { successed: true, message: response.data.choices }
-        }catch(error){
-            return { successed: false,error }
+            return {successed:true,message: response.data.choices};
+        } catch (error) {
+            return { successed: false, error }; 
         }
-       
+
+    }
+
+
+    /**
+     * 判断一句话的表达情绪
+     * @param {*} s1 
+     * @param {*} axiosOption 
+     */
+    async getScentenceEmotional(s1:string, axiosOption: any = { timeout: 30000 }):Promise<ChatReponse> {
+        if (!s1) return { successed: false, error:{errcode: 2, errmsg: '缺失参数'} }
+        const emotion = ['愤怒', '威胁', '讽刺', '愧疚', '兴奋', '友好',  '消极', '生气', '正常'];
+        const messages = [
+            { role: 'user', content: s1 },
+            { role: 'user', content: `请分析上述内容的语言情绪,请从"${emotion.join(',')}"这些情绪中对应一个输出` },
+        ]
+        return this.chatRequest(messages,{}, axiosOption);
     }
+
+    /**
+     * 获取两句话的相似度取值
+     * @param {*} s1 
+     * @param {*} s2 
+     */
+    async getScentenseSimilarity(s1: string, s2: string, axiosOption:any = { timeout: 30000 }):Promise<ChatReponse> {
+        if (!s1 || !s2) return { successed: false, error: { errcode: 2, errmsg: '缺失参数' } }
+        const messages = [
+            { role: 'user', content: s1 },
+            { role: 'user', content: s2 },
+            { role: 'user', content: '请从语义上对比以上两句话的相似度,请仅输出0至100之间的整数对比结果即可' },
+        ]
+        return this.chatRequest(messages, {maxtoken:32}, axiosOption);
+    }
+}
+
+/**
+ * Api封装后的返回结果
+ */
+export interface ChatReponse {
+    /**
+     * return the result of api called
+     * @type {boolean}
+     */
+    'successed': boolean
+    /**
+     * The error info 
+     * @type {any}
+     * @memberof ChatReponse
+     */
+    'error'?: any;
+    /**
+     * The name of the user in a multi-user chat
+     * @type {Array<any>}
+     * @memberof ChatReponse
+     */
+    'message'?: Array<any>;
 }
+/**
+ * 调用OpenAI Api的参数约定
+ */
+export interface CallChatApiOption{
+    model?:string,      ///模型名称
+    maxtoken?:number;    ///返回的最大token
+    temperature?:number;
+    replyCounts?:number;  ///返回多少答案
+}