ragflow-cli 0.26.3__tar.gz → 0.27.0__tar.gz

{ragflow_cli-0.26.3 → ragflow_cli-0.27.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: ragflow-cli
-Version: 0.26.3
+Version: 0.27.0
 Summary: Admin Service's client of [RAGFlow](https://github.com/infiniflow/ragflow). The Admin Service provides user management and system monitoring. 
 Author-email: Lynn <lynn_inf@hotmail.com>
 License: Apache License, Version 2.0
 Requires-Python: <3.14,>=3.13
 Description-Content-Type: text/markdown
 Requires-Dist: requests<3.0.0,>=2.30.0
-Requires-Dist: beartype<1.0.0,>=0.20.0
+Requires-Dist: beartype<1.0.0,>=0.22.9
 Requires-Dist: pycryptodomex>=3.10.0
 Requires-Dist: lark>=1.1.0
 Requires-Dist: requests-toolbelt>=1.0.0
@@ -42,7 +42,7 @@ It consists of a server-side Service and a command-line client (CLI), both imple
    ```bash
    python admin/server/admin_server.py
    ```
-   The service will start and listen for incoming connections from the CLI on the configured port. 
+   The service will start and listen for incoming connections from the CLI on the configured port.
 
 #### Using docker image
 
@@ -62,7 +62,7 @@ It consists of a server-side Service and a command-line client (CLI), both imple
 1.  Ensure the Admin Service is running.
 2.  Install ragflow-cli.
     ```bash
-    pip install ragflow-cli==0.26.3
+    pip install ragflow-cli==0.27.0
     ```
 3.  Launch the CLI client:
     ```bash
@@ -72,9 +72,9 @@ It consists of a server-side Service and a command-line client (CLI), both imple
     The default password is admin.
 
     **Parameters:**
-    
+
     - -h: RAGFlow admin server host address
-    
+
     - -p: RAGFlow admin server port
 
 

{ragflow_cli-0.26.3 → ragflow_cli-0.27.0}/README.md

@@ -28,7 +28,7 @@ It consists of a server-side Service and a command-line client (CLI), both imple
    ```bash
    python admin/server/admin_server.py
    ```
-   The service will start and listen for incoming connections from the CLI on the configured port. 
+   The service will start and listen for incoming connections from the CLI on the configured port.
 
 #### Using docker image
 
@@ -48,7 +48,7 @@ It consists of a server-side Service and a command-line client (CLI), both imple
 1.  Ensure the Admin Service is running.
 2.  Install ragflow-cli.
     ```bash
-    pip install ragflow-cli==0.26.3
+    pip install ragflow-cli==0.27.0
     ```
 3.  Launch the CLI client:
     ```bash
@@ -58,9 +58,9 @@ It consists of a server-side Service and a command-line client (CLI), both imple
     The default password is admin.
 
     **Parameters:**
-    
+
     - -h: RAGFlow admin server host address
-    
+
     - -p: RAGFlow admin server port
 
 

{ragflow_cli-0.26.3 → ragflow_cli-0.27.0}/http_client.py

@@ -25,14 +25,14 @@ import requests
 
 class HttpClient:
     def __init__(
-            self,
-            host: str = "127.0.0.1",
-            port: int = 9381,
-            api_version: str = "v1",
-            api_key: Optional[str] = None,
-            connect_timeout: float = 5.0,
-            read_timeout: float = 60.0,
-            verify_ssl: bool = False,
+        self,
+        host: str = "127.0.0.1",
+        port: int = 9381,
+        api_version: str = "v1",
+        api_key: Optional[str] = None,
+        connect_timeout: float = 5.0,
+        read_timeout: float = 60.0,
+        verify_ssl: bool = False,
     ) -> None:
         self.host = host
         self.port = port
@@ -71,19 +71,19 @@ class HttpClient:
         return headers
 
     def request(
-            self,
-            method: str,
-            path: str,
-            *,
-            use_api_base: bool = True,
-            auth_kind: Optional[str] = "api",
-            headers: Optional[Dict[str, str]] = None,
-            json_body: Optional[Dict[str, Any]] = None,
-            data: Any = None,
-            files: Any = None,
-            params: Optional[Dict[str, Any]] = None,
-            stream: bool = False,
-            iterations: int = 1,
+        self,
+        method: str,
+        path: str,
+        *,
+        use_api_base: bool = True,
+        auth_kind: Optional[str] = "api",
+        headers: Optional[Dict[str, str]] = None,
+        json_body: Optional[Dict[str, Any]] = None,
+        data: Any = None,
+        files: Any = None,
+        params: Optional[Dict[str, Any]] = None,
+        stream: bool = False,
+        iterations: int = 1,
     ) -> requests.Response | dict:
         url = self.build_url(path, use_api_base=use_api_base)
         merged_headers = self._headers(auth_kind, headers)
@@ -144,18 +144,18 @@ class HttpClient:
             # )
 
     def request_json(
-            self,
-            method: str,
-            path: str,
-            *,
-            use_api_base: bool = True,
-            auth_kind: Optional[str] = "api",
-            headers: Optional[Dict[str, str]] = None,
-            json_body: Optional[Dict[str, Any]] = None,
-            data: Any = None,
-            files: Any = None,
-            params: Optional[Dict[str, Any]] = None,
-            stream: bool = False,
+        self,
+        method: str,
+        path: str,
+        *,
+        use_api_base: bool = True,
+        auth_kind: Optional[str] = "api",
+        headers: Optional[Dict[str, str]] = None,
+        json_body: Optional[Dict[str, Any]] = None,
+        data: Any = None,
+        files: Any = None,
+        params: Optional[Dict[str, Any]] = None,
+        stream: bool = False,
     ) -> Dict[str, Any]:
         response = self.request(
             method,

{ragflow_cli-0.26.3 → ragflow_cli-0.27.0}/parser.py

@@ -112,6 +112,8 @@ sql_command: login_user
            | set_license
            | set_license_config
            | show_license
+           | generate_nav_for_dataset
+           | navigation_search
            | check_license
            | benchmark
 
@@ -171,6 +173,9 @@ ENVS: "ENVS"i
 KEY: "KEY"i
 KEYS: "KEYS"i
 GENERATE: "GENERATE"i
+NAVIGATION: "NAVIGATION"i
+MODE: "MODE"i
+TOPK: "TOPK"i
 MODEL: "MODEL"i
 MODELS: "MODELS"i
 PROVIDER: "PROVIDER"i
@@ -194,6 +199,7 @@ SIZE: "SIZE"i
 PARSER: "PARSER"i
 PIPELINE: "PIPELINE"i
 SEARCH: "SEARCH"i
+EXPLORE: "EXPLORE"i
 CURRENT: "CURRENT"i
 LLM: "LLM"i
 VLM: "VLM"i
@@ -336,8 +342,8 @@ reset_default_asr: RESET DEFAULT ASR ";"
 reset_default_tts: RESET DEFAULT TTS ";"
 
 list_user_datasets: LIST DATASETS ";"
-create_user_dataset_with_parser: CREATE DATASET quoted_string WITH EMBEDDING quoted_string PARSER quoted_string ";" 
-create_user_dataset_with_pipeline: CREATE DATASET quoted_string WITH EMBEDDING quoted_string PIPELINE quoted_string ";" 
+create_user_dataset_with_parser: CREATE DATASET quoted_string WITH EMBEDDING quoted_string PARSER quoted_string ";"
+create_user_dataset_with_pipeline: CREATE DATASET quoted_string WITH EMBEDDING quoted_string PIPELINE quoted_string ";"
 drop_user_dataset: DROP DATASET quoted_string ";"
 list_user_dataset_files: LIST FILES OF DATASET quoted_string ";"
 list_user_dataset_documents: LIST DOCUMENTS OF DATASET quoted_string ";"
@@ -373,6 +379,8 @@ create_metadata_table: CREATE METADATA TABLE ";"
 drop_metadata_table: DROP METADATA TABLE ";"
 insert_dataset_from_file: INSERT DATASET FROM FILE quoted_string ";"
 insert_metadata_from_file: INSERT METADATA FROM FILE quoted_string ";"
+generate_nav_for_dataset: GENERATE NAVIGATION OF DATASET quoted_string ";"
+navigation_search: NAVIGATION SEARCH quoted_string IN DATASET quoted_string MODE quoted_string (TOPK NUMBER)? ";"
 update_chunk: UPDATE CHUNK quoted_string OF DATASET quoted_string SET quoted_string ";"
 
 identifier_list: identifier (COMMA identifier)*
@@ -640,15 +648,13 @@ class RAGFlowCLITransformer(Transformer):
         dataset_name = items[2].children[0].strip("'\"")
         embedding = items[5].children[0].strip("'\"")
         parser_type = items[7].children[0].strip("'\"")
-        return {"type": "create_user_dataset", "dataset_name": dataset_name, "embedding": embedding,
-                "parser_type": parser_type}
+        return {"type": "create_user_dataset", "dataset_name": dataset_name, "embedding": embedding, "parser_type": parser_type}
 
     def create_user_dataset_with_pipeline(self, items):
         dataset_name = items[2].children[0].strip("'\"")
         embedding = items[5].children[0].strip("'\"")
         pipeline = items[7].children[0].strip("'\"")
-        return {"type": "create_user_dataset", "dataset_name": dataset_name, "embedding": embedding,
-                "pipeline": pipeline}
+        return {"type": "create_user_dataset", "dataset_name": dataset_name, "embedding": embedding, "pipeline": pipeline}
 
     def drop_user_dataset(self, items):
         dataset_name = items[2].children[0].strip("'\"")
@@ -666,7 +672,7 @@ class RAGFlowCLITransformer(Transformer):
         dataset_names = []
         dataset_names.append(items[4].children[0].strip("'\""))
         for i in range(5, len(items)):
-            if items[i] and hasattr(items[i], 'children') and items[i].children:
+            if items[i] and hasattr(items[i], "children") and items[i].children:
                 dataset_names.append(items[i].children[0].strip("'\""))
         return {"type": "list_user_datasets_metadata", "dataset_names": dataset_names}
 
@@ -675,7 +681,7 @@ class RAGFlowCLITransformer(Transformer):
         doc_ids = []
         if len(items) > 6 and items[6] == "DOCUMENTS":
             for i in range(7, len(items)):
-                if items[i] and hasattr(items[i], 'children') and items[i].children:
+                if items[i] and hasattr(items[i], "children") and items[i].children:
                     doc_id = items[i].children[0].strip("'\"")
                     doc_ids.append(doc_id)
         return {"type": "list_user_documents_metadata_summary", "dataset_name": dataset_name, "document_ids": doc_ids}
@@ -698,17 +704,17 @@ class RAGFlowCLITransformer(Transformer):
         dataset_name = None
         vector_size = None
         for i, item in enumerate(items):
-            if hasattr(item, 'data') and item.data == 'quoted_string':
+            if hasattr(item, "data") and item.data == "quoted_string":
                 dataset_name = item.children[0].strip("'\"")
-            if hasattr(item, 'type') and item.type == 'NUMBER':
-                if i > 0 and items[i-1].type == 'SIZE' and items[i-2].type == 'VECTOR':
+            if hasattr(item, "type") and item.type == "NUMBER":
+                if i > 0 and items[i - 1].type == "SIZE" and items[i - 2].type == "VECTOR":
                     vector_size = int(item)
         return {"type": "create_dataset_table", "dataset_name": dataset_name, "vector_size": vector_size}
 
     def drop_dataset_table(self, items):
         dataset_name = None
         for item in items:
-            if hasattr(item, 'data') and item.data == 'quoted_string':
+            if hasattr(item, "data") and item.data == "quoted_string":
                 dataset_name = item.children[0].strip("'\"")
         return {"type": "drop_dataset_table", "dataset_name": dataset_name}
 
@@ -790,9 +796,38 @@ class RAGFlowCLITransformer(Transformer):
         file_path = items[4].children[0].strip("'\"")
         return {"type": "insert_metadata_from_file", "file_path": file_path}
 
+    def generate_nav_for_dataset(self, items):
+        dataset_id = items[4].children[0].strip("'\"")
+        return {"type": "generate_nav_for_dataset", "dataset_id": dataset_id}
+
+    def navigation_search(self, items):
+        query = items[2].children[0].strip("'\"")
+        dataset_name = items[5].children[0].strip("'\"")
+        mode = items[7].children[0].strip("'\"")
+        topk = None
+        # If TOPK was specified, items will be longer.
+        if len(items) > 9:
+            try:
+                extra = items[8]
+                if hasattr(extra, "data"):
+                    # group wrapper: extra.children = [TOPK, NUMBER]
+                    topk = int(extra.children[1])
+                else:
+                    # flattened: items[8] = TOPK, items[9] = NUMBER
+                    topk = int(items[9])
+            except (ValueError, IndexError):
+                topk = None
+        return {
+            "type": "navigation_search",
+            "query": query,
+            "dataset_id": dataset_name,
+            "mode": mode,
+            "topk": topk,
+        }
+
     def update_chunk(self, items):
         def get_quoted_value(item):
-            if hasattr(item, 'children') and item.children:
+            if hasattr(item, "children") and item.children:
                 return item.children[0].strip("'\"")
             return str(item).strip("'\"")
 
@@ -813,16 +848,16 @@ class RAGFlowCLITransformer(Transformer):
         for i in range(2, len(items)):
             item = items[i]
             # Check for FROM token to stop
-            if hasattr(item, 'type') and item.type == 'FROM':
+            if hasattr(item, "type") and item.type == "FROM":
                 break
-            if hasattr(item, 'children') and item.children:
+            if hasattr(item, "children") and item.children:
                 tag = item.children[0].strip("'\"")
                 tags.append(tag)
         # Find dataset_name: quoted_string after DATASET
         dataset_name = None
         for i, item in enumerate(items):
             # Check if item is a DATASET token
-            if hasattr(item, 'type') and item.type == 'DATASET':
+            if hasattr(item, "type") and item.type == "DATASET":
                 # Next item should be quoted_string
                 dataset_name = items[i + 1].children[0].strip("'\"")
                 break
@@ -835,10 +870,10 @@ class RAGFlowCLITransformer(Transformer):
 
         # Check if it's "REMOVE ALL CHUNKS"
         for item in items:
-            if hasattr(item, 'type') and item.type == 'ALL':
+            if hasattr(item, "type") and item.type == "ALL":
                 # Find doc_id
                 for j, inner_item in enumerate(items):
-                    if hasattr(inner_item, 'type') and inner_item.type == 'DOCUMENT':
+                    if hasattr(inner_item, "type") and inner_item.type == "DOCUMENT":
                         doc_id = items[j + 1].children[0].strip("'\"")
                         return {"type": "remove_chunks", "doc_id": doc_id, "delete_all": True}
 
@@ -846,12 +881,12 @@ class RAGFlowCLITransformer(Transformer):
         chunk_ids = []
         doc_id = None
         for i, item in enumerate(items):
-            if hasattr(item, 'type') and item.type == 'DOCUMENT':
+            if hasattr(item, "type") and item.type == "DOCUMENT":
                 doc_id = items[i + 1].children[0].strip("'\"")
-            elif hasattr(item, 'children') and item.children:
+            elif hasattr(item, "children") and item.children:
                 val = item.children[0].strip("'\"")
                 # Skip if it's "FROM" or "DOCUMENT"
-                if val.upper() in ['FROM', 'DOCUMENT']:
+                if val.upper() in ["FROM", "DOCUMENT"]:
                     continue
                 chunk_ids.append(val)
 

{ragflow_cli-0.26.3 → ragflow_cli-0.27.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ragflow-cli"
-version = "0.26.3"
+version = "0.27.0"
 description = "Admin Service's client of [RAGFlow](https://github.com/infiniflow/ragflow). The Admin Service provides user management and system monitoring. "
 authors = [{ name = "Lynn", email = "lynn_inf@hotmail.com" }]
 license = { text = "Apache License, Version 2.0" }
@@ -8,7 +8,7 @@ readme = "README.md"
 requires-python = ">=3.13,<3.14"
 dependencies = [
     "requests>=2.30.0,<3.0.0",
-    "beartype>=0.20.0,<1.0.0",
+    "beartype>=0.22.9,<1.0.0",
     "pycryptodomex>=3.10.0",
     "lark>=1.1.0",
     "requests-toolbelt>=1.0.0",
@@ -20,6 +20,11 @@ test = [
     "requests>=2.32.3",
 ]
 
+[tool.uv]
+constraint-dependencies = [
+    "urllib3>=2.7.0",
+]
+
 [tool.setuptools]
 py-modules = ["ragflow_cli", "parser", "http_client", "ragflow_client", "user"]
 

{ragflow_cli-0.26.3 → ragflow_cli-0.27.0}/ragflow_cli.egg-info/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: ragflow-cli
-Version: 0.26.3
+Version: 0.27.0
 Summary: Admin Service's client of [RAGFlow](https://github.com/infiniflow/ragflow). The Admin Service provides user management and system monitoring. 
 Author-email: Lynn <lynn_inf@hotmail.com>
 License: Apache License, Version 2.0
 Requires-Python: <3.14,>=3.13
 Description-Content-Type: text/markdown
 Requires-Dist: requests<3.0.0,>=2.30.0
-Requires-Dist: beartype<1.0.0,>=0.20.0
+Requires-Dist: beartype<1.0.0,>=0.22.9
 Requires-Dist: pycryptodomex>=3.10.0
 Requires-Dist: lark>=1.1.0
 Requires-Dist: requests-toolbelt>=1.0.0
@@ -42,7 +42,7 @@ It consists of a server-side Service and a command-line client (CLI), both imple
    ```bash
    python admin/server/admin_server.py
    ```
-   The service will start and listen for incoming connections from the CLI on the configured port. 
+   The service will start and listen for incoming connections from the CLI on the configured port.
 
 #### Using docker image
 
@@ -62,7 +62,7 @@ It consists of a server-side Service and a command-line client (CLI), both imple
 1.  Ensure the Admin Service is running.
 2.  Install ragflow-cli.
     ```bash
-    pip install ragflow-cli==0.26.3
+    pip install ragflow-cli==0.27.0
     ```
 3.  Launch the CLI client:
     ```bash
@@ -72,9 +72,9 @@ It consists of a server-side Service and a command-line client (CLI), both imple
     The default password is admin.
 
     **Parameters:**
-    
+
     - -h: RAGFlow admin server host address
-    
+
     - -p: RAGFlow admin server port
 
 

{ragflow_cli-0.26.3 → ragflow_cli-0.27.0}/ragflow_cli.egg-info/requires.txt

@@ -1,5 +1,5 @@
 requests<3.0.0,>=2.30.0
-beartype<1.0.0,>=0.20.0
+beartype<1.0.0,>=0.22.9
 pycryptodomex>=3.10.0
 lark>=1.1.0
 requests-toolbelt>=1.0.0

{ragflow_cli-0.26.3 → ragflow_cli-0.27.0}/ragflow_cli.py

@@ -36,6 +36,7 @@ from user import login_user
 
 warnings.filterwarnings("ignore", category=getpass.GetPassWarning)
 
+
 def encrypt(input_string):
     pub = "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArq9XTUSeYr2+N1h3Afl/z8Dse/2yD0ZGrKwx+EEEcdsBLca9Ynmx3nIB5obmLlSfmskLpBo0UACBmB5rEjBp2Q2f3AG3Hjd4B+gNCG6BDaawuDlgANIhGnaTLrIqWrrcm4EMzJOnAOI1fgzJRsOOUEfaS318Eq9OVO3apEyCCt0lOQK6PuksduOjVxtltDav+guVAA068NrPYmRNabVKRNLJpL8w4D44sfth5RvZ3q9t+6RTArpEtc5sh5ChzvqPOzKGMXW83C95TxmXqpbK6olN4RevSfVjEAgCydH6HN6OhtOQEcnrU97r9H0iZOWwbw3pVrZiUkuRD1R56Wzs2wIDAQAB\n-----END PUBLIC KEY-----"
     pub_key = RSA.importKey(pub)
@@ -49,9 +50,6 @@ def encode_to_base64(input_string):
     return base64_encoded.decode("utf-8")
 
 
-
-
-
 class RAGFlowCLI(Cmd):
     def __init__(self):
         super().__init__()
@@ -240,9 +238,9 @@ class RAGFlowCLI(Cmd):
             print(r"""
                 ____  ___   ______________                 ________    ____
                / __ \/   | / ____/ ____/ /___ _      __   / ____/ /   /  _/
-              / /_/ / /| |/ / __/ /_  / / __ \ | /| / /  / /   / /    / /  
-             / _, _/ ___ / /_/ / __/ / / /_/ / |/ |/ /  / /___/ /____/ /   
-            /_/ |_/_/  |_\____/_/   /_/\____/|__/|__/   \____/_____/___/   
+              / /_/ / /| |/ / __/ /_  / / __ \ | /| / /  / /   / /    / /
+             / _, _/ ___ / /_/ / __/ / / /_/ / |/ |/ /  / /___/ /____/ /
+            /_/ |_/_/  |_\____/_/   /_/\____/|__/|__/   \____/_____/___/
             """)
             self.cmdloop()
 
@@ -254,15 +252,13 @@ class RAGFlowCLI(Cmd):
             result = self.parse_command(command)
             self.execute_command(result)
 
-
     def parse_connection_args(self, args: List[str]) -> Dict[str, Any]:
         parser = argparse.ArgumentParser(description="RAGFlow CLI Client", add_help=False)
         parser.add_argument("-h", "--host", default="127.0.0.1", help="Admin or RAGFlow service host")
         parser.add_argument("-p", "--port", type=int, default=9381, help="Admin or RAGFlow service port")
         parser.add_argument("-w", "--password", default="admin", type=str, help="Superuser password")
         parser.add_argument("-t", "--type", default="admin", type=str, help="CLI mode, admin or user")
-        parser.add_argument("-u", "--username", default=None,
-                            help="Username (email). In admin mode defaults to admin@ragflow.io, in user mode required.")
+        parser.add_argument("-u", "--username", default=None, help="Username (email). In admin mode defaults to admin@ragflow.io, in user mode required.")
         parser.add_argument("command", nargs="?", help="Single command")
         try:
             parsed_args, remaining_args = parser.parse_known_args(args)
@@ -274,7 +270,7 @@ class RAGFlowCLI(Cmd):
 
             if remaining_args:
                 if remaining_args[0] == "command":
-                    command_str = ' '.join(remaining_args[1:]) + ';'
+                    command_str = " ".join(remaining_args[1:]) + ";"
                     auth = True
                     if remaining_args[1] == "register":
                         auth = False
@@ -282,28 +278,14 @@ class RAGFlowCLI(Cmd):
                         if username is None:
                             print("Error: username (-u) is required in user mode")
                             return {"error": "Username required"}
-                    return {
-                        "host": parsed_args.host,
-                        "port": parsed_args.port,
-                        "password": parsed_args.password,
-                        "type": parsed_args.type,
-                        "username": username,
-                        "command": command_str,
-                        "auth": auth
-                    }
+                    return {"host": parsed_args.host, "port": parsed_args.port, "password": parsed_args.password, "type": parsed_args.type, "username": username, "command": command_str, "auth": auth}
                 else:
                     return {"error": "Invalid command"}
             else:
                 auth = True
                 if username is None:
                     auth = False
-                return {
-                    "host": parsed_args.host,
-                    "port": parsed_args.port,
-                    "type": parsed_args.type,
-                    "username": username,
-                    "auth": auth
-                }
+                return {"host": parsed_args.host, "port": parsed_args.port, "type": parsed_args.type, "username": username, "auth": auth}
         except SystemExit:
             return {"error": "Invalid connection arguments"}
 
@@ -321,6 +303,7 @@ class RAGFlowCLI(Cmd):
         # print(f"Parsed command: {command_dict}")
         run_command(self.ragflow_client, command_dict)
 
+
 def main():
 
     cli = RAGFlowCLI()