waveflowdb-client 0.0.1__py3-none-any.whl

starter.py

@@ -0,0 +1,195 @@
+"""
+run.py
+Simple launcher for Vector Lake SDK (v1.0.0)
+
+Allows you to:
+  - configure client (host, port, key)
+  - call ANY API: add, refresh, chat, match, health, namespace info, etc.
+"""
+
+from waveflowdb-client import Config, VectorLakeClient
+
+
+# -------------------------------------------------------
+# CONFIGURATION (EDIT THIS ONCE)
+# -------------------------------------------------------
+API_KEY = "<<>>"  # visit https://db.agentanalytics.ai/signup
+HOST = "https://waveflow-analytics.com"       # OR "http://localhost"
+VECTOR_LAKE_PATH = "<<>>"       # folder for path-based ingestion
+USER_ID = ""   ## your email id used for registratoin
+NAMESPACE = ""  ## database created via UI 
+
+
+# -------------------------------------------------------
+# INITIALIZE CLIENT
+# -------------------------------------------------------
+def get_client():
+    cfg = Config(
+        api_key=API_KEY,
+        host=HOST,
+        vector_lake_path=VECTOR_LAKE_PATH
+    )
+    return VectorLakeClient(cfg)
+
+
+client = get_client()
+
+
+# -------------------------------------------------------
+# READY-TO-USE ACTION FUNCTIONS
+# -------------------------------------------------------
+
+def run_health():
+    """Health check"""
+    print("\n--- HEALTH CHECK ---")
+    res = client.health_check(USER_ID, NAMESPACE)
+    print(res)
+
+
+def run_add_direct():
+    """Add docs using files_name + files_data"""
+    print("\n--- ADD DOCUMENTS (Direct Payload Mode) ---")
+    res = client.add_documents(
+        user_id=USER_ID,
+        vector_lake_description=NAMESPACE,
+        files_name=["test1.txt", "test2.txt"],
+        files_data=["hello world", "this is test doc 2"]
+    )
+    print(res)
+
+
+def run_add_path():
+    """Add docs by reading actual files from disk"""
+    print("\n--- ADD DOCUMENTS (Disk Path Mode) ---")
+    res = client.add_documents(
+        user_id=USER_ID,
+        vector_lake_description=NAMESPACE
+        # files=[""]   # must exist inside VECTOR_LAKE_PATH
+    )
+    print(res)
+
+
+def run_refresh_direct():
+    """Refresh docs using direct data (no disk read)"""
+    print("\n--- REFRESH DOCUMENTS (Direct Data Mode) ---")
+    res = client.refresh_documents(
+        user_id=USER_ID,
+        vector_lake_description=NAMESPACE,
+        files_name=["test1.txt"],
+        files_data=["UPDATED CONTENT FOR TEST1"]
+    )
+    print(res)
+
+
+def run_refresh_path():
+    """Refresh docs by reading actual files"""
+    print("\n--- REFRESH DOCUMENTS (Path Mode) ---")
+    res = client.refresh_documents(
+        user_id=USER_ID,
+        vector_lake_description=NAMESPACE
+        # files=["file1.pdf"]     # must exist
+    )
+    print(res)
+
+
+def run_chat_static(query):
+    """Chat with stored index"""
+    print("\n--- CHAT (STATIC MODE) ---")
+    res = client.chat_with_docs(
+        query=query,
+        user_id=USER_ID,
+        vector_lake_description=NAMESPACE,
+        pattern="static"
+    )
+    print(res)
+
+
+def run_chat_dynamic(query):
+    """Chat using temporary files (dynamic mode)"""
+    print("\n--- CHAT (DYNAMIC MODE) ---")
+    res = client.chat_with_docs(
+        query=query,
+        user_id=USER_ID,
+        vector_lake_description=NAMESPACE,
+        pattern="dynamic",
+        files_name=["dyn1.txt"],
+        files_data=["This is dynamic content to summarize."]
+    )
+    print(res)
+
+
+def run_match_static(query):
+    """Top matching docs (static mode)"""
+    print("\n--- TOP MATCHING DOCS (STATIC) ---")
+    res = client.get_matching_docs(
+        query=query,
+        user_id=USER_ID,
+        vector_lake_description=NAMESPACE,
+        pattern="static",
+        top_docs=5,
+        threshold=0.1
+    )
+    print(res)
+
+
+def run_match_dynamic(query):
+    """Top matching docs (dynamic mode)"""
+    print("\n--- TOP MATCHING DOCS (DYNAMIC) ---")
+    res = client.get_matching_docs(
+        query=query,
+        user_id=USER_ID,
+        vector_lake_description=NAMESPACE,
+        pattern="dynamic",
+        files_name=["temp.txt"],
+        files_data=["Sample dynamic content"]
+    )
+    print(res)
+
+
+def run_match_with_data(query):
+    """Top matching docs including chunk data"""
+    print("\n--- TOP MATCHING DOCS (WITH DATA) ---")
+    res = client.get_matching_docs(
+        query=query,
+        user_id=USER_ID,
+        vector_lake_description=NAMESPACE,
+        pattern="static",
+        top_docs=5,
+        with_data=True
+    )
+    print(res)
+
+
+def run_namespace_details():
+    """Get namespace information"""
+    print("\n--- GET NAMESPACE DETAILS ---")
+    res = client.get_namespace_details(USER_ID, vector_lake_description=NAMESPACE)
+    print(res)
+
+
+def run_docs_info():
+    """List all stored docs + info"""
+    print("\n--- GET DOCS INFORMATION ---")
+    res = client.get_docs_information(USER_ID, NAMESPACE)
+    print(res)
+
+
+# -------------------------------------------------------
+# MAIN SELECTOR – RUN ANY FUNCTION YOU WANT
+# -------------------------------------------------------
+if __name__ == "__main__":
+    query="<<>>"
+    # --- UNCOMMENT ANY ONE OF THESE TO RUN THAT OPERATION ---
+    # run_health()
+    # run_add_direct()
+    # run_add_path()
+    # run_refresh_direct()
+    # run_refresh_path()
+    # run_chat_static(query)
+    # run_chat_dynamic(query)
+    # run_match_static(query)
+    # run_match_dynamic(query)
+    # run_match_with_data(query)
+    run_namespace_details()
+    # run_docs_info()
+

waveflowdb_client-0.0.1.dist-info/METADATA

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: waveflowdb-client
+Version: 0.0.1
+Summary: VectorLake SDK — Deterministic backend engine powering agent workflows
+Author-email: "agentanalytics.ai" <nitin@agentanalytics.ai>
+License: MIT License
+        
+        Copyright (c) 2025 agentanalytics.ai
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://agentanalytics.ai
+Project-URL: Documentation, https://www.agentanalytics.ai/docs/waveflow-db
+Keywords: vector db,VECTOR QUERY LANGUAGE,waveflow,agentanalytics,VQL
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: numpy
+Requires-Dist: tqdm
+Dynamic: license-file
+
+# WaveflowDB SDK Starter
+
+A lightweight launcher script for interacting with **WaveflowDB** and
+performing **WaveQL (VQL) brace-based semantic retrieval**.
+
+This starter project demonstrates how to:
+
+-   Configure and initialize a Vector Lake client\
+-   Ingest documents (direct or path-based)\
+-   Refresh documents\
+-   Run semantic chat (static + dynamic)\
+-   Retrieve matching documents\
+-   Query namespaces\
+-   Use WaveQL-style logical filtering for agentic retrieval
+
+------------------------------------------------------------------------
+
+## 📌 Overview
+
+Vector Lake is an unstructured semantic data platform enabling:
+
+-   Natural-language structured filtering through **WaveQL (VQL)**
+-   Hybrid ranking (Filter + Semantic)
+-   Zero-schema ingestion (no JSON schemas required)
+-   SQL-like logical joins on raw text
+-   Automatic semantic fallback when filters fail
+
+The included `starter.py` file provides ready-to-run function wrappers
+to interact with the Vector Lake API.
+
+------------------------------------------------------------------------
+
+## 🚀 Getting Started
+
+### 1. Install Dependencies
+
+``` bash
+pip install waveflowdb-client
+```
+
+### 2. Configure API Credentials
+
+Edit the top section of `starter.py`:
+
+``` python
+API_KEY = "<<>>"                 
+HOST = "https://waveflow-analytics.com"
+VECTOR_LAKE_PATH = "<<>>"        
+USER_ID = ""                     
+NAMESPACE = ""                   
+```
+
+------------------------------------------------------------------------
+
+## 🧠 Using WaveQL (VQL) Queries
+
+WaveQL enables natural language filtering using **brace-based logical
+groups**:
+
+    {clinical trials or observational studies} {type 2 diabetes} {India}
+
+### Key Rules
+
+✔ Each `{}` is a logical filter group\
+✔ Groups combine with implicit AND\
+✔ Use `AND`, `OR`, `()` inside braces\
+✔ Multi-word phrases **must** use parentheses when operators are used
+
+Examples:
+
+  -------------------------------------------------------------------------------------
+  Correct                                     Incorrect
+  ------------------------------------------- -----------------------------------------
+  `{(machine learning) or (deep learning)}`   `{machine learning or deep learning}`
+
+  `{(product manager) or (data scientist)}`   `{product manager or Delhi}`
+  -------------------------------------------------------------------------------------
+
+WaveQL supports **three-tier hybrid ranking**:
+
+1.  Tier 1 -- Filter + Semantic match (best)\
+2.  Tier 2 -- Filter-only match\
+3.  Tier 3 -- Semantic-only fallback
+
+------------------------------------------------------------------------
+
+## 🧪 Using the Starter Script
+
+The script exposes multiple ready-to-run functions.
+
+### Run Health Check
+
+``` python
+run_health()
+```
+
+### Add Documents
+
+``` python
+run_add_direct()
+run_add_path()
+```
+
+### Refresh Documents
+
+``` python
+run_refresh_direct()
+run_refresh_path()
+```
+
+### Chat With Documents
+
+``` python
+run_chat_static("your question")
+run_chat_dynamic("summarize this")
+```
+
+### Retrieve Matching Documents
+
+``` python
+run_match_static("your query")
+run_match_dynamic("your query")
+run_match_with_data("your query")
+```
+
+### Namespace & Document Inspection
+
+``` python
+run_namespace_details()
+run_docs_info()
+```
+
+------------------------------------------------------------------------
+
+## 🧩 Example WaveQL Queries
+
+-   `{diabetes} {(clinical trial)} {India}`
+-   `{(product manager)} {Python} {Delhi}`
+-   `{genomics} {cancer}`
+-   `{(supply chain)} {pharma}`
+
+
+## 📝 Tips & Best Practices
+
+### Do:
+
+-   Use 1--2 keywords per brace\
+-   Wrap multi-word phrases in `()` when using OR/AND\
+-   Keep groups domain-consistent
+
+### Don't:
+
+-   Use long multi-word phrases\
+-   Mix unrelated domains\
+-   Forget parentheses for multi-word logic
+
+------------------------------------------------------------------------
+
+## 📧 Support
+
+For API or platform support, visit:
+
+**https://db.agentanalytics.ai**

waveflowdb_client-0.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+starter.py,sha256=mbwb1CbEozPDgBdiPtNNRiCPXBiahCIPshe0V4jO5go,5525
+waveflowdb_client-0.0.1.dist-info/licenses/LICENSE,sha256=ucHS8iYA8ycWtgf7vHWD0woCRcE0rO2oQXtIC0Dsrmc,1095
+waveflowdb_client-0.0.1.dist-info/METADATA,sha256=JUVM5uhBThwqKj7fpm4eO22kabH4QZLIdeIGfw4XUOc,5984
+waveflowdb_client-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+waveflowdb_client-0.0.1.dist-info/top_level.txt,sha256=L8uYzGYpotBBtN1yYI1MlAoHxXnGMHqtmXZdhWqa8ko,8
+waveflowdb_client-0.0.1.dist-info/RECORD,,

waveflowdb_client-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

waveflowdb_client-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 agentanalytics.ai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

waveflowdb_client-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+starter