Merge pull request #54 from epsilla-cloud/dev

add Epsilla RAG support

Author: eric-epsilla

README.md

@@ -1,26 +1,31 @@
-# Epsilla Python SDK
+<p align="center">
+    <img width="275" alt="Epsilla Logo" src="https://epsilla-misc.s3.amazonaws.com/epsilla-horizontal.png">
+</p>
 
-Welcome to Python SDK for Epsilla Vector Database! 
-https://pypi.org/project/pyepsilla/#history
+<p align="center">
+    <b>Python Client for <a href="https://github.com/epsilla-cloud/vectordb">Epsilla</a> Vector Database</b>
+</p>
 
-## Installation
-```shell
-pip3 install pyepsilla
-```
-or
+<hr />
+
+Welcome to Python SDK for Epsilla Vector Database!
+- <a href="https://epsilla-inc.gitbook.io/epsilladb/vector-database/connect-to-a-database">QuickStart</a>
+- <a href="https://pypi.org/project/pyepsilla/#history">Release History</a>
+
+## Install pyepsilla
 ```shell
 pip3 install --upgrade pyepsilla
 ```
 
-## Documentation
+## Connect to Epsilla Vector Database
 
-### 1.1 Run epsilla vectordb on localhost
+#### Run epsilla vectordb on localhost
 ```shell
 docker pull epsilla/vectordb
 docker run -d -p 8888:8888 epsilla/vectordb
 ```
 
-### 1.2 Use pyepsilla to connect to and interact with local vector database
+#### Use pyepsilla to connect to and interact with local vector database
 
 ```python
 from pyepsilla import vectordb
@@ -76,46 +81,65 @@ status_code, response = client.query(
 )
 print(response)
 
-
-
 ## delete records by primary_keys (and filter)
-# status_code, response =  client.delete(table_name="MyTable", ids=[3])
 status_code, response =  client.delete(table_name="MyTable", primary_keys=[3, 4])
-# status_code, response =  client.delete(table_name="MyTable", filter="Doc <> 'San Francisco'")
+status_code, response =  client.delete(table_name="MyTable", filter="Doc <> 'San Francisco'")
 print(response)
 
 
 ## drop a table
-#client.drop_table("MyTable")
+client.drop_table("MyTable")
 
 ## unload a database from memory
-#client.unload_db("MyDB")
+client.unload_db("MyDB")
 ```
 
 
+## Connect to Epsilla Cloud
 
-### 2 Run epsilla vectordb on epsilla cloud
+#### Register and create vectordb on Epsilla Cloud
+https://cloud.epsilla.com
 
+#### Use Epsilla Cloud module to connect with the vectordb
+Please check <a href="https://github.com/epsilla-cloud/epsilla-python-client/blob/main/examples/hello_epsilla_cloud.py">example</a> for detail.
 ```python3
-
 from pyepsilla import cloud
 
 # Connect to Epsilla Cloud
-client = cloud.Client(project_id="32ef3a3f-****-****-****-************", api_key="epsilla*****")
+client = cloud.Client(project_id="32ef3a3f-****-****-****-************", api_key="eps_**********")
 
 # Connect to Vectordb
 db = client.vectordb(db_id="df7431d0-****-****-****-************")
-
 ```
-Please check https://github.com/epsilla-cloud/epsilla-python-client/blob/main/examples/hello_epsilla_cloud.py for detail.
 
 
+## Connect to Epsilla RAG
+
+The resp will contains answer as well as contexts, like {"answer": "****", "contexts": ['context1','context2', ...]}
+
+```python3
+from pyepsilla import cloud
+
+# Connect to Epsilla RAG
+client = cloud.RAG(
+    project_id="ce07c6fc-****-****-b7bd-b7819f22bcff",
+    api_key="eps_**********",
+    ragapp_id="153a5a49-****-****-b2b8-496451eda8b5",
+    conversation_id="6fa22a6a-****-****-b1c3-5c795d0f45ef",
+)
+
+# Start a new conversation with RAG
+client.start_new_conversation()
+resp = client.query("What's RAG?")
+
+print("[INFO] response is", resp)
+```
 
 
 ## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/epsilla-cloud/epsilla-python-client/
+Bug reports and pull requests are welcome on GitHub at [here](https://github.com/epsilla-cloud/epsilla-python-client)
 
-If you have any question or problem, please join our discord https://discord.com/invite/cDaY2CxZc5
+If you have any question or problem, please join our [discord](https://discord.com/invite/cDaY2CxZc5)
 
-## We love your <a href="https://forms.gle/z73ra1sGBxH9wiUR8">Feedback</a>!
+We love your <a href="https://forms.gle/z73ra1sGBxH9wiUR8">Feedback</a>!
 

examples/hello_epsilla.py

@@ -16,7 +16,7 @@
 # client = vectordb.Client(protocol='https', host='demo.epsilla.com', port='443')
 
 # Load DB with path
-## pay attention to change db_path to persistent volume for production environment
+# pay attention to change db_path to persistent volume for production environment
 status_code, response = client.load_db(db_name="MyDB", db_path="/data/epsilla_demo")
 print(response)
 

examples/hello_epsilla_cloud.py

@@ -6,18 +6,16 @@
 # 2. create a table with schema in db
 # 3. get the api key with project id, run this program
 
-import sys
-
 from pyepsilla import cloud
 
 # Connect to Epsilla Cloud
 client = cloud.Client(
-    project_id="7a68814c-f839-4a67-9ec6-93c027c865e6",
+    project_id="7a68814c-f839-4a67-9ec6-93c027c865e0",
     api_key="epsilla-cloud-api-key",
 )
 
 # Connect to Vectordb
-db = client.vectordb(db_id="6accafb1-476d-43b0-aa64-12ebfbf7442d")
+db = client.vectordb(db_id="6accafb1-476d-43b0-aa64-12ebfbf7441d")
 
 
 # Create a table with schema

examples/hello_epsilla_rag.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+# -*- coding:utf-8 -*-
+
+# Try this simple example for epsilla rag
+# 1. create client to connect to epsilla rag
+# 2. launch a new converstation with epsilla rag
+# 3. send a query and wait the response from epsilla ragg
+
+from pyepsilla import cloud
+
+# Connect to Epsilla RAG
+client = cloud.RAG(
+    project_id="**********",
+    api_key="eps_**********",
+    ragapp_id="**********",
+    conversation_id="**********",
+)
+
+# Start a new conversation with RAG
+client.start_new_conversation()
+resp = client.query("What's RAG?")
+
+print(f"[INFO] response is {resp}")