Merge pull request #148 from ttt246/feature/update_watch_ui_134

feature(#134): build APIs for implement search contact functionality on Apple Watch

.gitignore

@@ -1,3 +1,4 @@
 /Brain/firebase_cred.json
 /.idea
 Brain/firebase_cred.json
+Brain/logs

Brain/logs/activity.log

@@ -1,82 +0,0 @@
-2023-06-11 01:39:05,597 ERROR sendNotification 
-2023-06-11 03:49:04,950 DEBUG  Chat with AI on model : gpt-3.5-turbo
-2023-06-11 03:49:04,950 DEBUG  ------------ CONTEXT SENT TO AI ---------------
-2023-06-11 03:49:04,950 DEBUG  System: You are a helpful assistant.
-2023-06-11 03:49:04,950 DEBUG  
-2023-06-11 03:49:04,950 DEBUG  User: Who won the world series in 2020?
-2023-06-11 03:49:04,950 DEBUG  
-2023-06-11 03:49:04,950 DEBUG  Assistant: The Los Angeles Dodgers won the World Series in 2020.
-2023-06-11 03:49:04,950 DEBUG  
-2023-06-11 03:49:04,950 DEBUG  User: Where was it played?
-2023-06-11 03:49:04,951 DEBUG  
-2023-06-11 03:49:04,951 DEBUG  ----------- END OF CONTEXT ----------------
-2023-06-11 03:49:14,350 WARNING API Rate Limit Reached. Waiting 10 seconds... Error: 
-2023-06-11 03:49:34,004 DEBUG  Chat with AI on model : gpt-3.5-turbo
-2023-06-11 03:49:34,004 DEBUG  ------------ CONTEXT SENT TO AI ---------------
-2023-06-11 03:49:34,004 DEBUG  System: You are a helpful assistant.
-2023-06-11 03:49:34,004 DEBUG  
-2023-06-11 03:49:34,004 DEBUG  User: Who won the world series in 2020?
-2023-06-11 03:49:34,004 DEBUG  
-2023-06-11 03:49:34,004 DEBUG  Assistant: The Los Angeles Dodgers won the World Series in 2020.
-2023-06-11 03:49:34,004 DEBUG  
-2023-06-11 03:49:34,004 DEBUG  User: Where was it played?
-2023-06-11 03:49:34,004 DEBUG  
-2023-06-11 03:49:34,004 DEBUG  ----------- END OF CONTEXT ----------------
-2023-06-11 03:50:02,195 DEBUG  Chat with AI on model : gpt-3.5-turbo
-2023-06-11 03:50:02,196 DEBUG  ------------ CONTEXT SENT TO AI ---------------
-2023-06-11 03:50:02,196 DEBUG  System: You are a helpful assistant.
-2023-06-11 03:50:02,196 DEBUG  
-2023-06-11 03:50:02,196 DEBUG  User: Who won the world series in 2020?
-2023-06-11 03:50:02,197 DEBUG  
-2023-06-11 03:50:02,197 DEBUG  Assistant: The Los Angeles Dodgers won the World Series in 2020.
-2023-06-11 03:50:02,197 DEBUG  
-2023-06-11 03:50:02,197 DEBUG  User: Where was it played?
-2023-06-11 03:50:02,197 DEBUG  
-2023-06-11 03:50:02,197 DEBUG  ----------- END OF CONTEXT ----------------
-2023-06-11 03:52:01,682 WARNING API Rate Limit Reached. Waiting 10 seconds... Error: 
-2023-06-11 03:52:04,881 DEBUG  Chat with AI on model : gpt-3.5-turbo
-2023-06-11 03:52:04,882 DEBUG  ------------ CONTEXT SENT TO AI ---------------
-2023-06-11 03:52:04,882 DEBUG  System: You are a helpful assistant.
-2023-06-11 03:52:04,882 DEBUG  
-2023-06-11 03:52:04,882 DEBUG  User: Who won the world series in 2020?
-2023-06-11 03:52:04,883 DEBUG  
-2023-06-11 03:52:04,883 DEBUG  Assistant: The Los Angeles Dodgers won the World Series in 2020.
-2023-06-11 03:52:04,883 DEBUG  
-2023-06-11 03:52:04,884 DEBUG  User: Where was it played?
-2023-06-11 03:52:04,884 DEBUG  
-2023-06-11 03:52:04,884 DEBUG  ----------- END OF CONTEXT ----------------
-2023-06-11 03:59:41,875 DEBUG  Chat with AI on model : gpt-3.5-turbo
-2023-06-11 03:59:41,876 DEBUG  ------------ CONTEXT SENT TO AI ---------------
-2023-06-11 03:59:41,876 DEBUG  System: You are a helpful assistant.
-2023-06-11 03:59:41,876 DEBUG  
-2023-06-11 03:59:41,876 DEBUG  User: Who won the world series in 2020?
-2023-06-11 03:59:41,876 DEBUG  
-2023-06-11 03:59:41,876 DEBUG  Assistant: The Los Angeles Dodgers won the World Series in 2020.
-2023-06-11 03:59:41,876 DEBUG  
-2023-06-11 03:59:41,876 DEBUG  User: Where was it played?
-2023-06-11 03:59:41,876 DEBUG  
-2023-06-11 03:59:41,876 DEBUG  ----------- END OF CONTEXT ----------------
-2023-06-12 17:08:50,779 DEBUG  Chat with AI on model : gpt-3.5-turbo
-2023-06-12 17:08:50,780 DEBUG  ------------ CONTEXT SENT TO AI ---------------
-2023-06-12 17:08:50,780 DEBUG  System: You are a helpful assistant.
-2023-06-12 17:08:50,780 DEBUG  
-2023-06-12 17:08:50,780 DEBUG  User: Who won the world series in 2020?
-2023-06-12 17:08:50,780 DEBUG  
-2023-06-12 17:08:50,780 DEBUG  Assistant: The Los Angeles Dodgers won the World Series in 2020.
-2023-06-12 17:08:50,780 DEBUG  
-2023-06-12 17:08:50,780 DEBUG  User: Where was it played?
-2023-06-12 17:08:50,780 DEBUG  
-2023-06-12 17:08:50,780 DEBUG  ----------- END OF CONTEXT ----------------
-2023-06-16 14:22:55,555 ERROR sendNotification json parsing or get completion error
-2023-06-16 14:23:59,508 ERROR sendNotification json parsing or get completion error
-2023-06-16 15:58:51,640 DEBUG  Chat with AI on model : gpt-3.5-turbo
-2023-06-16 15:58:51,641 DEBUG  ------------ CONTEXT SENT TO AI ---------------
-2023-06-16 15:58:51,641 DEBUG  System: You are a helpful assistant.
-2023-06-16 15:58:51,642 DEBUG  
-2023-06-16 15:58:51,642 DEBUG  User: Who won the world series in 2020?
-2023-06-16 15:58:51,642 DEBUG  
-2023-06-16 15:58:51,642 DEBUG  Assistant: The Los Angeles Dodgers won the World Series in 2020.
-2023-06-16 15:58:51,642 DEBUG  
-2023-06-16 15:58:51,642 DEBUG  User: Where was it played?
-2023-06-16 15:58:51,642 DEBUG  
-2023-06-16 15:58:51,642 DEBUG  ----------- END OF CONTEXT ----------------

Brain/src/common/assembler.py

@@ -69,3 +69,18 @@ class Assembler:
 
     def to_req_model(self, basic_req: BasicReq.Confs) -> ReqModel:
         return ReqModel(basic_req.to_json())
+
+    """mapping data from a ContactModel into json
+    {
+        "contactId": int,
+        "displayName": string,
+        "phoneNumbers": [string]
+    }
+    """
+
+    def to_contact_result_format(self, contact: ContactModel) -> Any:
+        return {
+            "contactId": contact.contact_id,
+            "displayName": contact.display_name,
+            "phoneNumbers": contact.phone_numbers,
+        }

Brain/src/model/requests/request_model.py

@@ -215,3 +215,10 @@ class AutoTaskDelete(BasicReq):
         reference_link: str
 
     data: Body
+
+
+"""endpoint : /contact/get_by_ids"""
+
+
+class GetContactsByIds(BasicReq):
+    contactIds: list[str]

Brain/src/router/api.py

@@ -19,6 +19,7 @@ from Brain.src.model.requests.request_model import (
     ClientInfo,
     get_client_info,
     AutoTaskDelete,
+    GetContactsByIds,
 )
 from Brain.src.rising_plugin.risingplugin import (
     getCompletion,
@@ -90,7 +91,9 @@ def construct_blueprint_api() -> APIRouter:
 
         # check contact querying
         try:
-            contacts_service = ContactsService(setting=setting)
+            contacts_service = ContactsService(
+                firebase_app=firebase_app, setting=setting
+            )
             if result["program"] == ProgramType.AUTO_TASK:
                 auto_task_service = AutoTaskService()
                 result["content"] = auto_task_service.ask_task_with_autogpt(
@@ -413,7 +416,9 @@ def construct_blueprint_api() -> APIRouter:
             for contact in data.contacts:
                 contacts.append(assembler.to_contact_model(contact))
             # train contact
-            contacts_service = ContactsService(setting=setting)
+            contacts_service = ContactsService(
+                firebase_app=firebase_app, setting=setting
+            )
             contacts_service.train(uuid, contacts)
         except Exception as e:
             if isinstance(e, BrainException):
@@ -444,7 +449,9 @@ def construct_blueprint_api() -> APIRouter:
 
             # parsing contacts
             # train contact
-            contacts_service = ContactsService(setting=setting)
+            contacts_service = ContactsService(
+                firebase_app=firebase_app, setting=setting
+            )
             contacts_service.delete_all(uuid)
         except Exception as e:
             if isinstance(e, BrainException):
@@ -492,4 +499,36 @@ def construct_blueprint_api() -> APIRouter:
             200, "Deleted data from real-time database of firebase", ""
         )
 
+    """@generator.request_body(
+            {
+                "token": "String",
+                "uuid": "String",
+                "contactIds": [
+                    String
+                ]
+            }
+        )
+
+        @generator.response(
+            status_code=200, schema={"message": "message", "result": "test_result"}
+        )
+
+        """
+
+    @router.post("/contacts/get_by_ids")
+    def get_contacts_by_ids(data: GetContactsByIds):
+        try:
+            setting, firebase_app = firebase_admin_with_setting(data)
+        except BrainException as ex:
+            return ex.get_response_exp()
+
+        token: str = setting.token
+        uuid: str = setting.uuid
+
+        result = ContactsService(
+            firebase_app=firebase_app, setting=setting
+        ).get_contacts_by_ids(uuid=uuid, contactIds=data.contactIds)
+
+        return assembler.to_response(200, "Success to get contacts by uuid", result)
+
     return router

Brain/src/service/contact_service.py

@@ -1,6 +1,8 @@
 """service to manage contacts"""
 from typing import List, Any
 
+
+from Brain.src.common.assembler import Assembler
 from Brain.src.model.req_model import ReqModel
 from Brain.src.rising_plugin.csv_embed import get_embed
 from Brain.src.rising_plugin.pinecone_engine import (
@@ -15,10 +17,18 @@ from Brain.src.rising_plugin.pinecone_engine import (
 from Brain.src.common.utils import PINECONE_INDEX_NAME
 from Brain.src.model.contact_model import ContactModel, ContactStatus
 
+import firebase_admin
+from firebase_admin import firestore
+
 
 class ContactsService:
-    def __init__(self, setting: ReqModel):
+    db: Any
+    phones_ref: Any
+
+    def __init__(self, firebase_app: firebase_admin.App, setting: ReqModel):
+        self.firebase_app = firebase_app
         self.setting = setting
+        self.init_firestore()
 
     """train contacts (getting embedding) and update pinecone with embeddings by contact_id
     train datatype:
@@ -28,7 +38,9 @@ class ContactsService:
     def train(self, uuid: str, contacts: List[ContactModel]) -> None:
         # getting index namespaceof pinecone
         pinecone_namespace = self.get_pinecone_index_namespace(uuid)
+
         for contact in contacts:
+            # Save the data
             # generate key and values for pinecone data
             key = contact.contact_id
             value = f"{contact.display_name}, {contact.get_str_phones()}"
@@ -42,12 +54,14 @@ class ContactsService:
                     value=vectoring_values,
                     setting=self.setting,
                 )
+                self.create_one_contact(uuid=uuid, contact=contact)
             elif contact.status == ContactStatus.DELETED:
                 delete_pinecone(
                     namespace=pinecone_namespace,
                     key=key,
                     setting=self.setting,
                 )
+                self.delete_one_contact(uuid=uuid, contact=contact)
             elif contact.status == ContactStatus.UPDATED:
                 update_pinecone(
                     namespace=pinecone_namespace,
@@ -55,6 +69,7 @@ class ContactsService:
                     value=vectoring_values,
                     setting=self.setting,
                 )
+                self.update_one_contact(uuid=uuid, contact=contact)
 
     """"query contact with search text
     response: list of contactId as index key of pinecone"""
@@ -85,3 +100,54 @@ class ContactsService:
 
     def get_pinecone_index_namespace(self, uuid: str) -> str:
         return get_pinecone_index_namespace(f"{uuid}-contacts")
+
+    """init firestore to save user's contacts"""
+
+    def init_firestore(self):
+        self.db = firestore.client(app=self.firebase_app)
+        self.phones_ref = self.db.collection("phones")
+
+    """create a contact into document which name is uuid in phone collections in firestore"""
+
+    def create_one_contact(self, uuid: str, contact: ContactModel):
+        assembler = Assembler()
+        data = assembler.to_contact_result_format(contact)
+        phones_doc_ref = self.phones_ref.document(uuid)
+        contacts_doc_ref = phones_doc_ref.collection("contacts").document(
+            contact.contact_id
+        )
+        contacts_doc_ref.set(data)
+
+    """update a contact into document which name is uuid in phone collections in firestore"""
+
+    def update_one_contact(self, uuid: str, contact: ContactModel):
+        assembler = Assembler()
+        data = assembler.to_contact_result_format(contact)
+        phones_doc_ref = self.phones_ref.document(uuid)
+        contacts_doc_ref = phones_doc_ref.collection("contacts").document(
+            contact.contact_id
+        )
+        contacts_doc_ref.update(data)
+
+    """delete a contact into document which name is uuid in phone collections in firestore"""
+
+    def delete_one_contact(self, uuid: str, contact: ContactModel):
+        phones_doc_ref = self.phones_ref.document(uuid)
+        contacts_doc_ref = phones_doc_ref.collection("contacts").document(
+            contact.contact_id
+        )
+        contacts_doc_ref.delete()
+
+    def get_contacts_by_ids(self, uuid: str, contactIds: list[str]) -> []:
+        phones_doc_ref = self.phones_ref.document(uuid)
+        contacts_ref = phones_doc_ref.collection("contacts")
+
+        # Retrieve all documents in the 'contacts' sub-collection
+        contacts = contacts_ref.where("contactId", "in", contactIds).stream()
+
+        result = []
+        # Iterate through the documents and print out their data
+        for contact in contacts:
+            result.append(contact.to_dict())
+
+        return result