Feature/fix streaming mode (#324)

sdks/nodejs-client/README.md

@@ -12,8 +12,12 @@ After installing the SDK, you can use it in your project like this:
 ```js
 import { DifyClient, ChatClient, CompletionClient } from 'dify-client'
 
-const API_KEY = 'your-api-key-here';
+const API_KEY = 'your-api-key-here'
-const user = `random-user-id`;
+const user = `random-user-id`
+const inputs = {
+  name: 'test name a'
+}
+const query = "Please tell me a short story in 10 words or less."
 
 // Create a completion client
 const completionClient = new CompletionClient(API_KEY)
@@ -22,8 +26,15 @@ completionClient.createCompletionMessage(inputs, query, responseMode, user)
 
 // Create a chat client
 const chatClient = new ChatClient(API_KEY)
-// Create a chat message
+// Create a chat message in stream mode
-chatClient.createChatMessage(inputs, query, responseMode, user, conversationId)
+const response = await chatClient.createChatMessage(inputs, query, user, true, null)
+const stream = response.data;
+stream.on('data', data => {
+    console.log(data);
+});
+stream.on('end', () => {
+    console.log("stream done");
+});
 // Fetch conversations
 chatClient.getConversations(user)
 // Fetch conversation messages

sdks/nodejs-client/index.js

@@ -1,140 +1,188 @@
-import axios from 'axios'
+import axios from "axios";
-
+export const BASE_URL = "https://api.dify.ai/v1";
-export const BASE_URL = 'https://api.dify.ai/v1'
 
 export const routes = {
   application: {
-    method: 'GET',
+    method: "GET",
-    url: () => `/parameters`
+    url: () => `/parameters`,
   },
   feedback: {
-    method: 'POST',
+    method: "POST",
-    url: (messageId) => `/messages/${messageId}/feedbacks`,
+    url: (message_id) => `/messages/${message_id}/feedbacks`,
   },
   createCompletionMessage: {
-    method: 'POST',
+    method: "POST",
     url: () => `/completion-messages`,
   },
   createChatMessage: {
-    method: 'POST',
+    method: "POST",
     url: () => `/chat-messages`,
   },
   getConversationMessages: {
-    method: 'GET',
+    method: "GET",
-    url: () => '/messages',
+    url: () => "/messages",
   },
   getConversations: {
-    method: 'GET',
+    method: "GET",
-    url: () => '/conversations',
+    url: () => "/conversations",
   },
   renameConversation: {
-    method: 'PATCH',
+    method: "PATCH",
-    url: (conversationId) => `/conversations/${conversationId}`,
+    url: (conversation_id) => `/conversations/${conversation_id}`,
-  }
+  },
-
+};
-}
 
 export class DifyClient {
   constructor(apiKey, baseUrl = BASE_URL) {
-    this.apiKey = apiKey
+    this.apiKey = apiKey;
-    this.baseUrl = baseUrl
+    this.baseUrl = baseUrl;
   }
 
   updateApiKey(apiKey) {
-    this.apiKey = apiKey
+    this.apiKey = apiKey;
   }
 
-  async sendRequest(method, endpoint, data = null, params = null, stream = false) {
+  async sendRequest(
+    method,
+    endpoint,
+    data = null,
+    params = null,
+    stream = false
+  ) {
     const headers = {
-      'Authorization': `Bearer ${this.apiKey}`,
+      Authorization: `Bearer ${this.apiKey}`,
-      'Content-Type': 'application/json',
+      "Content-Type": "application/json",
-    }
+    };
 
-    const url = `${this.baseUrl}${endpoint}`
+    const url = `${this.baseUrl}${endpoint}`;
-    let response
+    let response;
-    if (!stream) {
+    if (stream) {
       response = await axios({
         method,
         url,
         data,
         params,
         headers,
-        responseType: stream ? 'stream' : 'json',
+        responseType: "stream",
-      })
+      });
     } else {
-      response = await fetch(url, {
+      response = await axios({
-        headers,
         method,
-        body: JSON.stringify(data),
+        url,
-      })
+        data,
+        params,
+        headers,
+        responseType: "json",
+      });
     }
 
-    return response
+    return response;
   }
 
-  messageFeedback(messageId, rating, user) {
+  messageFeedback(message_id, rating, user) {
     const data = {
       rating,
       user,
-    }
+    };
-    return this.sendRequest(routes.feedback.method, routes.feedback.url(messageId), data)
+    return this.sendRequest(
+      routes.feedback.method,
+      routes.feedback.url(message_id),
+      data
+    );
   }
 
   getApplicationParameters(user) {
-    const params = { user }
+    const params = { user };
-    return this.sendRequest(routes.application.method, routes.application.url(), null, params)
+    return this.sendRequest(
+      routes.application.method,
+      routes.application.url(),
+      null,
+      params
+    );
   }
 }
 
 export class CompletionClient extends DifyClient {
-  createCompletionMessage(inputs, query, user, responseMode) {
+  createCompletionMessage(inputs, query, user, stream = false) {
     const data = {
       inputs,
       query,
-      responseMode,
       user,
-    }
+      response_mode: stream ? "streaming" : "blocking",
-    return this.sendRequest(routes.createCompletionMessage.method, routes.createCompletionMessage.url(), data, null, responseMode === 'streaming')
+    };
+    return this.sendRequest(
+      routes.createCompletionMessage.method,
+      routes.createCompletionMessage.url(),
+      data,
+      null,
+      stream
+    );
   }
 }
 
 export class ChatClient extends DifyClient {
-  createChatMessage(inputs, query, user, responseMode = 'blocking', conversationId = null) {
+  createChatMessage(
+    inputs,
+    query,
+    user,
+    stream = false,
+    conversation_id = null
+  ) {
     const data = {
       inputs,
       query,
       user,
-      responseMode,
+      response_mode: stream ? "streaming" : "blocking",
-    }
+    };
-    if (conversationId)
+    if (conversation_id) data.conversation_id = conversation_id;
-      data.conversation_id = conversationId
 
-    return this.sendRequest(routes.createChatMessage.method, routes.createChatMessage.url(), data, null, responseMode === 'streaming')
+    return this.sendRequest(
+      routes.createChatMessage.method,
+      routes.createChatMessage.url(),
+      data,
+      null,
+      stream
+    );
   }
 
-  getConversationMessages(user, conversationId = '', firstId = null, limit = null) {
+  getConversationMessages(
-    const params = { user }
+    user,
+    conversation_id = "",
+    first_id = null,
+    limit = null
+  ) {
+    const params = { user };
 
-    if (conversationId)
+    if (conversation_id) params.conversation_id = conversation_id;
-      params.conversation_id = conversationId
 
-    if (firstId)
+    if (first_id) params.first_id = first_id;
-      params.first_id = firstId
 
-    if (limit)
+    if (limit) params.limit = limit;
-      params.limit = limit
 
-    return this.sendRequest(routes.getConversationMessages.method, routes.getConversationMessages.url(), null, params)
+    return this.sendRequest(
+      routes.getConversationMessages.method,
+      routes.getConversationMessages.url(),
+      null,
+      params
+    );
   }
 
-  getConversations(user, firstId = null, limit = null, pinned = null) {
+  getConversations(user, first_id = null, limit = null, pinned = null) {
-    const params = { user, first_id: firstId, limit, pinned }
+    const params = { user, first_id: first_id, limit, pinned };
-    return this.sendRequest(routes.getConversations.method, routes.getConversations.url(), null, params)
+    return this.sendRequest(
+      routes.getConversations.method,
+      routes.getConversations.url(),
+      null,
+      params
+    );
   }
 
-  renameConversation(conversationId, name, user) {
+  renameConversation(conversation_id, name, user) {
-    const data = { name, user }
+    const data = { name, user };
-    return this.sendRequest(routes.renameConversation.method, routes.renameConversation.url(conversationId), data)
+    return this.sendRequest(
+      routes.renameConversation.method,
+      routes.renameConversation.url(conversation_id),
+      data
+    );
   }
 }
-