Add a new LLM: 'Moonshot'

Author: blmdxiao

README.md

@@ -18,6 +18,7 @@ Quickly launch an intelligent customer service system with Flask, LLM, RAG, incl
     - [Using OpenAI as the LLM base](#using-openai-as-the-llm-base)
     - [Using ZhipuAI as the LLM base](#using-zhipuai-as-the-llm-base)
     - [Using DeepSeek as the LLM base](#using-deepseek-as-the-llm-base)
+    - [Using Moonshot as the LLM base](#using-moonshot-as-the-llm-base)
     - [Using local LLMs](#using-local-llms)
   - [Step 3: Deploy RAG-GPT](#step-3-deploy-rag-gpt)
     - [Deploy RAG-GPT using Docker](#deploy-rag-gpt-using-docker)
@@ -168,6 +169,45 @@ LLAMA_CLOUD_API_KEY="xxxx"
 - Adjust **`URL_PREFIX`** to match your website's domain. This is mainly for generating accessible URL links for uploaded local files. Such as `http://127.0.0.1:7000/web/download_dir/2024_05_20/d3a01d6a-90cd-4c2a-b926-9cda12466caf/openssl-cookbook.pdf`.
 - For more information about the meanings and usages of constants, you can check under the `server/constant` directory.
 
+
+#### Using Moonshot as the LLM base
+
+If you cannot use OpenAI's API services, consider using Moonshot as an alternative.
+
+> [!NOTE]
+> Moonshot does not provide an `Embedding API`, so here we use ZhipuAI's `Embedding API`.
+
+
+```shell
+cp env_of_moonshot .env
+```
+
+The variables in .env
+
+```shell
+LLM_NAME="Moonshot"
+ZHIPUAI_API_KEY="xxxx"
+MOONSHOT_API_KEY="xxxx"
+MOONSHOT_MODEL_NAME="moonshot-v1-8k"
+MIN_RELEVANCE_SCORE=0.4
+BOT_TOPIC="xxxx"
+URL_PREFIX="http://127.0.0.1:7000/"
+USE_PREPROCESS_QUERY=1
+USE_RERANKING=1
+USE_DEBUG=0
+USE_LLAMA_PARSE=0
+LLAMA_CLOUD_API_KEY="xxxx"
+```
+
+- Don't modify **`LLM_NAME`**
+- Modify the **`ZHIPUAI_API_KEY`** with your own key. Please log in to the [ZhipuAI website](https://open.bigmodel.cn/usercenter/apikeys) to view your API Key.
+- Modify the **`MOONSHOT_API_KEY`** with your own key. Please log in to the [Moonshot website](https://platform.moonshot.cn/console/api-keys) to view your API Key.
+- Update the **`MOONSHOT_MODEL_NAME `** setting if you want to use other models of Moonshot.
+- Change **`BOT_TOPIC`** to reflect your Bot's name. This is very important, as it will be used in `Prompt Construction`. Please try to use a concise and clear word, such as `OpenIM`, `LangChain`.
+- Adjust **`URL_PREFIX`** to match your website's domain. This is mainly for generating accessible URL links for uploaded local files. Such as `http://127.0.0.1:7000/web/download_dir/2024_05_20/d3a01d6a-90cd-4c2a-b926-9cda12466caf/openssl-cookbook.pdf`.
+- For more information about the meanings and usages of constants, you can check under the `server/constant` directory.
+
+
 #### Using local LLMs
 
 If your knowledge base involves **sensitive information** and you prefer not to use cloud-based LLMs, consider using `Ollama` to deploy large models locally.

env_of_moonshot

@@ -0,0 +1,12 @@
+LLM_NAME="Moonshot"
+ZHIPUAI_API_KEY="xxxx"
+MOONSHOT_API_KEY="xxxx"
+MOONSHOT_MODEL_NAME="moonshot-v1-8k"
+MIN_RELEVANCE_SCORE=0.4
+BOT_TOPIC="xxxx"
+URL_PREFIX="http://127.0.0.1:7000/"
+USE_PREPROCESS_QUERY=1
+USE_RERANKING=1
+USE_DEBUG=0
+USE_LLAMA_PARSE=0
+LLAMA_CLOUD_API_KEY="xxxx"

server/app/account.py

@@ -7,8 +7,9 @@
 from server.app.utils.token_helper import TokenHelper
 from server.logger.logger_config import my_logger as logger
 
-
-account_bp = Blueprint('account_config', __name__, url_prefix='/open_kf_api/account')
+account_bp = Blueprint('account_config',
+                       __name__,
+                       url_prefix='/open_kf_api/account')
 
 
 @account_bp.route('/login', methods=['POST'])
@@ -18,36 +19,65 @@ def login():
     password = data.get('password')
 
     if not account_name or not password:
-        return {'retcode': -20000, 'message': 'Account name and password are required', 'data': {}}
+        return {
+            'retcode': -20000,
+            'message': 'Account name and password are required',
+            'data': {}
+        }
 
     conn = None
     try:
         conn = get_db_connection()
         cur = conn.cursor()
 
         # Check if the account exists and verify the password
-        cur.execute('SELECT id, password_hash FROM t_account_tab WHERE account_name = ?', (account_name,))
+        cur.execute(
+            'SELECT id, password_hash FROM t_account_tab WHERE account_name = ?',
+            (account_name, ))
         account = cur.fetchone()
 
         if account and check_password_hash(account['password_hash'], password):
             # Generate token with account_name in the payload
             token = TokenHelper.generate_token(account_name)
             logger.info(f"Generate token: '{token}'")
-            
+
             # Set is_login to 1 and update mtime to the current Unix timestamp
             try:
                 with diskcache_lock.lock():
-                    cur.execute('UPDATE t_account_tab SET is_login = 1, mtime = ? WHERE account_name = ?', (int(time.time()), account_name,))
+                    cur.execute(
+                        'UPDATE t_account_tab SET is_login = 1, mtime = ? WHERE account_name = ?',
+                        (
+                            int(time.time()),
+                            account_name,
+                        ))
                     conn.commit()
             except Exception as e:
                 logger.error(f"Process discache_lock exception: {e}")
-                return {'retcode': -30000, 'message': f'An error occurred: {e}', 'data': {}}
-
-            return {'retcode': 0, 'message': 'Login successful', 'data': {'token': token}}
+                return {
+                    'retcode': -30000,
+                    'message': f'An error occurred: {e}',
+                    'data': {}
+                }
+
+            return {
+                'retcode': 0,
+                'message': 'Login successful',
+                'data': {
+                    'token': token
+                }
+            }
         else:
-            return {'retcode': -20001, 'message': 'Invalid credentials', 'data': {}}
+            return {
+                'retcode': -20001,
+                'message': 'Invalid credentials',
+                'data': {}
+            }
     except Exception as e:
-        return {'retcode': -30000, 'message': f'An error occurred during login, exception: {e}', 'data': {}}
+        return {
+            'retcode': -30000,
+            'message': f'An error occurred during login, exception: {e}',
+            'data': {}
+        }
     finally:
         if conn:
             conn.close()
@@ -62,11 +92,18 @@ def update_password():
     new_password = data.get('new_password')
 
     if None in (account_name, current_password, new_password):
-        return {'retcode': -20000, 'message': 'Account name, current password, and new password are required', 'data': {}}
+        return {
+            'retcode': -20000,
+            'message':
+            'Account name, current password, and new password are required',
+            'data': {}
+        }
 
     token_user_id = request.user_payload['user_id']
     if token_user_id != account_name:
-        logger.error(f"account_name:'{account_name}' does not match with token_user_id: '{token_user_id}'")
+        logger.error(
+            f"account_name:'{account_name}' does not match with token_user_id: '{token_user_id}'"
+        )
         return {'retcode': -20001, 'message': 'Token is invalid!', 'data': {}}
 
     conn = None
@@ -75,26 +112,55 @@ def update_password():
         cur = conn.cursor()
 
         # Check if the account exists and verify the current password
-        cur.execute('SELECT id, password_hash FROM t_account_tab WHERE account_name = ?', (account_name,))
+        cur.execute(
+            'SELECT id, password_hash FROM t_account_tab WHERE account_name = ?',
+            (account_name, ))
         account = cur.fetchone()
 
-        if not account or not check_password_hash(account['password_hash'], current_password):
-            logger.error(f"Invalid account_name: '{account_name}' or current_password: '{current_password}'")
-            return {'retcode': -20001, 'message': 'Invalid account name or password', 'data': {}}
+        if not account or not check_password_hash(account['password_hash'],
+                                                  current_password):
+            logger.error(
+                f"Invalid account_name: '{account_name}' or current_password: '{current_password}'"
+            )
+            return {
+                'retcode': -20001,
+                'message': 'Invalid account name or password',
+                'data': {}
+            }
 
         # Update the password
-        new_password_hash = generate_password_hash(new_password, method='pbkdf2:sha256', salt_length=10)
+        new_password_hash = generate_password_hash(new_password,
+                                                   method='pbkdf2:sha256',
+                                                   salt_length=10)
         try:
             with diskcache_lock.lock():
-                cur.execute('UPDATE t_account_tab SET password_hash = ?, mtime = ? WHERE account_name = ?', (new_password_hash, int(time.time()), account_name,))
+                cur.execute(
+                    'UPDATE t_account_tab SET password_hash = ?, mtime = ? WHERE account_name = ?',
+                    (
+                        new_password_hash,
+                        int(time.time()),
+                        account_name,
+                    ))
                 conn.commit()
         except Exception as e:
             logger.error(f"Process discache_lock exception: {e}")
-            return {'retcode': -30000, 'message': f'An error occurred: {e}', 'data': {}}
-
-        return {'retcode': 0, 'message': 'Password updated successfully', 'data': {}}
+            return {
+                'retcode': -30000,
+                'message': f'An error occurred: {e}',
+                'data': {}
+            }
+
+        return {
+            'retcode': 0,
+            'message': 'Password updated successfully',
+            'data': {}
+        }
     except Exception as e:
-        return {'retcode': -20001, 'message': f'An error occurred: {e}', 'data': {}}
+        return {
+            'retcode': -20001,
+            'message': f'An error occurred: {e}',
+            'data': {}
+        }
     finally:
         if conn:
             conn.close()

server/app/auth.py

@@ -2,7 +2,6 @@
 from server.logger.logger_config import my_logger as logger
 from server.app.utils.token_helper import TokenHelper
 
-
 auth_bp = Blueprint('auth', __name__, url_prefix='/open_kf_api/auth')
 
 
@@ -11,13 +10,19 @@ def get_token():
     data = request.json
     user_id = data.get('user_id')
     if not user_id:
-        return {'retcode': -20000, 'message': 'user_id is required', 'data': {}}
+        return {
+            'retcode': -20000,
+            'message': 'user_id is required',
+            'data': {}
+        }
 
     try:
         # generate token
         token = TokenHelper.generate_token(user_id)
         logger.success(f"Generate token: '{token}' with user_id: '{user_id}'")
         return {"retcode": 0, "message": "success", "data": {"token": token}}
     except Exception as e:
-        logger.error(f"Generate token with user_id: '{user_id}' is failed, the exception is {e}")
+        logger.error(
+            f"Generate token with user_id: '{user_id}' is failed, the exception is {e}"
+        )
         return {'retcode': -20001, 'message': str(e), 'data': {}}