iatoolkit 0.11.0__py3-none-any.whl → 0.71.2__py3-none-any.whl

iatoolkit/__init__.py

@@ -5,20 +5,18 @@ IAToolkit Package
 # Expose main classes and functions at the top level of the package
 
 # main IAToolkit class
-from .iatoolkit import IAToolkit, current_iatoolkit, create_app
+from .iatoolkit import IAToolkit, create_app, current_iatoolkit
 
 # for registering the client companies
 from .company_registry import register_company
 from .base_company import BaseCompany
-from iatoolkit.repositories.database_manager import DatabaseManager
 
 # --- Services ---
 from iatoolkit.services.query_service import QueryService
-from iatoolkit.services.sql_service import SqlService
 from iatoolkit.services.document_service import DocumentService
 from iatoolkit.services.search_service import SearchService
+from iatoolkit.services.sql_service import SqlService
 from iatoolkit.services.load_documents_service import LoadDocumentsService
-from iatoolkit.services.excel_service import ExcelService
 from iatoolkit.infra.call_service import CallServiceClient
 
 __all__ = [
@@ -27,10 +25,8 @@ __all__ = [
     'current_iatoolkit',
     'register_company',
     'BaseCompany',
-    'DatabaseManager',
     'QueryService',
     'SqlService',
-    'ExcelService',
     'DocumentService',
     'SearchService',
     'LoadDocumentsService',

iatoolkit/base_company.py

@@ -7,10 +7,9 @@
 from abc import ABC, abstractmethod
 from iatoolkit.repositories.profile_repo import ProfileRepo
 from iatoolkit.repositories.llm_query_repo import LLMQueryRepo
-
 from iatoolkit.services.prompt_manager_service import PromptService
 from iatoolkit.repositories.models import Company, Function, PromptCategory
-from iatoolkit import IAToolkit
+from .iatoolkit import IAToolkit
 
 
 class BaseCompany(ABC):
@@ -21,15 +20,16 @@ class BaseCompany(ABC):
         self.llm_query_repo: LLMQueryRepo = injector.get(LLMQueryRepo)
         self.prompt_service: PromptService = injector.get(PromptService)
         self.company: Company | None = None
+        self.company_short_name: str
 
-    def _load_company_by_short_name(self, short_name: str) -> Company:
-        self.company = self.profile_repo.get_company_by_short_name(short_name)
-        return self.company
-
-    def _create_company(self, short_name: str, name: str, branding: dict | None = None) -> Company:
+    def _create_company(self,
+                        short_name: str,
+                        name: str,
+                        parameters: dict | None = None,
+                        ) -> Company:
         company_obj = Company(short_name=short_name,
                               name=name,
-                              branding=branding)
+                              parameters=parameters)
         self.company = self.profile_repo.create_company(company_obj)
         return self.company
 
@@ -69,20 +69,9 @@ class BaseCompany(ABC):
             **kwargs
         )
 
-
-    @abstractmethod
-    # initialize all the database tables  needed
-    def register_company(self):
-        raise NotImplementedError("La subclase debe implementar el método create_company()")
-
     @abstractmethod
     # get context specific for this company
-    def get_company_context(self, **kwargs) -> str:
-        raise NotImplementedError("La subclase debe implementar el método get_company_context()")
-
-    @abstractmethod
-    # get context specific for this company
-    def get_user_info(self, **kwargs) -> str:
+    def get_user_info(self, user_identifier: str) -> dict:
         raise NotImplementedError("La subclase debe implementar el método get_user_info()")
 
     @abstractmethod
@@ -90,15 +79,6 @@ class BaseCompany(ABC):
     def handle_request(self, tag: str, params: dict) -> dict:
         raise NotImplementedError("La subclase debe implementar el método handle_request()")
 
-    @abstractmethod
-    # get context specific for the query
-    def start_execution(self):
-        raise NotImplementedError("La subclase debe implementar el método start_execution()")
-
-    @abstractmethod
-    # get context specific for the query
-    def get_metadata_from_filename(self, filename: str) -> dict:
-        raise NotImplementedError("La subclase debe implementar el método get_query_context()")
 
     def register_cli_commands(self, app):
         """

iatoolkit/cli_commands.py

@@ -5,7 +5,7 @@
 
 import click
 import logging
-from iatoolkit import IAToolkit
+from .iatoolkit import IAToolkit
 from iatoolkit.services.profile_service import ProfileService
 
 def register_core_commands(app):

iatoolkit/common/routes.py

@@ -3,80 +3,106 @@
 #
 # IAToolkit is open source software.
 
-from flask import render_template, redirect, flash, url_for,send_from_directory, current_app, abort
-from iatoolkit.common.session_manager import SessionManager
+from flask import render_template, redirect, url_for,send_from_directory, current_app, abort
 from flask import jsonify
-from iatoolkit.views.history_view import HistoryView
-import os
-
-
-def logout(company_short_name: str):
-    SessionManager.clear()
-    flash("Has cerrado sesión correctamente", "info")
-    if company_short_name:
-        return redirect(url_for('login', company_short_name=company_short_name))
-    else:
-        return redirect(url_for('home'))
 
 
 # this function register all the views
 def register_views(injector, app):
 
-    from iatoolkit.views.llmquery_view import LLMQueryView
-    from iatoolkit.views.tasks_view import TaskView
-    from iatoolkit.views.tasks_review_view import TaskReviewView
-    from iatoolkit.views.home_view import HomeView
-    from iatoolkit.views.chat_view import ChatView
-    from iatoolkit.views.login_view import LoginView
-    from iatoolkit.views.external_chat_login_view import ExternalChatLoginView
+    from iatoolkit.views.index_view import IndexView
+    from iatoolkit.views.init_context_api_view import InitContextApiView
+    from iatoolkit.views.llmquery_api_view import LLMQueryApiView
+    from iatoolkit.views.tasks_api_view import TaskApiView
+    from iatoolkit.views.tasks_review_api_view import TaskReviewApiView
+    from iatoolkit.views.login_simulation_view import LoginSimulationView
     from iatoolkit.views.signup_view import SignupView
     from iatoolkit.views.verify_user_view import VerifyAccountView
     from iatoolkit.views.forgot_password_view import ForgotPasswordView
     from iatoolkit.views.change_password_view import ChangePasswordView
-    from iatoolkit.views.file_store_view import FileStoreView
-    from iatoolkit.views.user_feedback_view import UserFeedbackView
-    from iatoolkit.views.prompt_view import PromptView
-    from iatoolkit.views.chat_token_request_view import ChatTokenRequestView
-    from iatoolkit.views.external_login_view import ExternalLoginView
-    from iatoolkit.views.download_file_view import DownloadFileView
-
-    app.add_url_rule('/', view_func=HomeView.as_view('home'))
+    from iatoolkit.views.file_store_api_view import FileStoreApiView
+    from iatoolkit.views.user_feedback_api_view import UserFeedbackApiView
+    from iatoolkit.views.prompt_api_view import PromptApiView
+    from iatoolkit.views.history_api_view import HistoryApiView
+    from iatoolkit.views.help_content_api_view import HelpContentApiView
+    from iatoolkit.views.profile_api_view import UserLanguageApiView  # <-- Importa la nueva vista
+    from iatoolkit.views.embedding_api_view import EmbeddingApiView
+    from iatoolkit.views.login_view import LoginView, FinalizeContextView
+    from iatoolkit.views.external_login_view import ExternalLoginView, RedeemTokenApiView
+    from iatoolkit.views.logout_api_view import LogoutApiView
+    from iatoolkit.views.home_view import HomeView
 
-    # main chat for iatoolkit front
-    app.add_url_rule('/<company_short_name>/chat', view_func=ChatView.as_view('chat'))
+    # iatoolkit home page
+    app.add_url_rule('/', view_func=IndexView.as_view('index'))
 
-    # front if the company internal portal
-    app.add_url_rule('/<company_short_name>/chat_login', view_func=ExternalChatLoginView.as_view('external_chat_login'))
-    app.add_url_rule('/<company_short_name>/external_login/<external_user_id>', view_func=ExternalLoginView.as_view('external_login'))
-    app.add_url_rule('/auth/chat_token', view_func=ChatTokenRequestView.as_view('chat-token'))
+    # company home view
+    app.add_url_rule('/<company_short_name>/home', view_func=HomeView.as_view('home'))
 
-    # main pages for the iatoolkit frontend
+    # login for the iatoolkit integrated frontend
     app.add_url_rule('/<company_short_name>/login', view_func=LoginView.as_view('login'))
+
+    # this is the login for external users
+    app.add_url_rule('/<company_short_name>/external_login',
+                     view_func=ExternalLoginView.as_view('external_login'))
+
+    # this endpoint is called when onboarding_shell finish the context load
+    app.add_url_rule(
+        '/<company_short_name>/finalize',
+        view_func=FinalizeContextView.as_view('finalize_no_token')
+    )
+
+    app.add_url_rule(
+        '/<company_short_name>/finalize/<token>',
+        view_func=FinalizeContextView.as_view('finalize_with_token')
+    )
+
+    app.add_url_rule(
+        '/api/profile/language',
+        view_func=UserLanguageApiView.as_view('user_language_api')
+    )
+
+    # logout
+    app.add_url_rule('/<company_short_name>/api/logout',
+                     view_func=LogoutApiView.as_view('logout'))
+
+    # this endpoint is called by the JS for changing the token for a session
+    app.add_url_rule('/<string:company_short_name>/api/redeem_token',
+                     view_func = RedeemTokenApiView.as_view('redeem_token'))
+
+    # init (reset) the company context
+    app.add_url_rule('/<company_short_name>/api/init-context',
+                     view_func=InitContextApiView.as_view('init-context'),
+                     methods=['POST', 'OPTIONS'])
+
+    # register new user, account verification and forgot password
     app.add_url_rule('/<company_short_name>/signup',view_func=SignupView.as_view('signup'))
-    app.add_url_rule('/<company_short_name>/logout', 'logout', logout)
-    app.add_url_rule('/logout', 'logout', logout)
     app.add_url_rule('/<company_short_name>/verify/<token>', view_func=VerifyAccountView.as_view('verify_account'))
     app.add_url_rule('/<company_short_name>/forgot-password', view_func=ForgotPasswordView.as_view('forgot_password'))
     app.add_url_rule('/<company_short_name>/change-password/<token>', view_func=ChangePasswordView.as_view('change_password'))
 
-    # this are backend endpoints mainly
-    app.add_url_rule('/<company_short_name>/llm_query', view_func=LLMQueryView.as_view('llm_query'))
-    app.add_url_rule('/<company_short_name>/feedback', view_func=UserFeedbackView.as_view('feedback'))
-    app.add_url_rule('/<company_short_name>/prompts', view_func=PromptView.as_view('prompt'))
-    app.add_url_rule('/<company_short_name>/history', view_func=HistoryView.as_view('history'))
-    app.add_url_rule('/tasks', view_func=TaskView.as_view('tasks'))
-    app.add_url_rule('/tasks/review/<int:task_id>', view_func=TaskReviewView.as_view('tasks-review'))
-    app.add_url_rule('/load', view_func=FileStoreView.as_view('load'))
+    # main chat query, used by the JS in the browser (with credentials)
+    # can be used also for executing iatoolkit prompts
+    app.add_url_rule('/<company_short_name>/api/llm_query', view_func=LLMQueryApiView.as_view('llm_query_api'))
 
-    app.add_url_rule(
-        '/about',  # URL de la ruta
-        view_func=lambda: render_template('about.html'))
+    # open the promt directory
+    app.add_url_rule('/<company_short_name>/api/prompts', view_func=PromptApiView.as_view('prompt'))
 
-    app.add_url_rule('/version', 'version',
-                     lambda: jsonify({"version": app.config['VERSION']}))
+    # toolbar buttons
+    app.add_url_rule('/<company_short_name>/api/feedback', view_func=UserFeedbackApiView.as_view('feedback'))
+    app.add_url_rule('/<company_short_name>/api/history', view_func=HistoryApiView.as_view('history'))
+    app.add_url_rule('/<company_short_name>/api/help-content', view_func=HelpContentApiView.as_view('help-content'))
+
+    # tasks management endpoints: create task, and review answer
+    app.add_url_rule('/tasks', view_func=TaskApiView.as_view('tasks'))
+    app.add_url_rule('/tasks/review/<int:task_id>', view_func=TaskReviewApiView.as_view('tasks-review'))
+
+    # this endpoint is for upload documents into the vector store (api-key)
+    app.add_url_rule('/api/load', view_func=FileStoreApiView.as_view('load_api'))
+
+    # this endpoint is for generating embeddings for a given text
+    app.add_url_rule('/<company_short_name>/api/embedding',
+                     view_func=EmbeddingApiView.as_view('embedding_api'))
 
-    app.add_url_rule('/<company_short_name>/<external_user_id>/download-file/<path:filename>',
-                     view_func=DownloadFileView.as_view('download-file'))
 
     @app.route('/download/<path:filename>')
     def download_file(filename):
@@ -99,3 +125,21 @@ def register_views(injector, app):
         except FileNotFoundError:
             abort(404)
 
+    # login testing
+    app.add_url_rule('/<company_short_name>/login_test',
+                     view_func=LoginSimulationView.as_view('login_test'))
+
+    app.add_url_rule(
+        '/about',  # URL de la ruta
+        view_func=lambda: render_template('about.html'))
+
+    app.add_url_rule('/version', 'version',
+                     lambda: jsonify({"iatoolkit_version": current_app.config.get('VERSION', 'N/A')}))
+
+
+    # hacer que la raíz '/' vaya al home de iatoolkit
+    @app.route('/')
+    def root_redirect():
+        return redirect(url_for('index'))
+
+

iatoolkit/common/session_manager.py

@@ -3,8 +3,9 @@
 #
 # IAToolkit is open source software.
 
-from flask import session
+# This is the Flask connected session manager for IAToolkit
 
+from flask import session
 
 class SessionManager:
     @staticmethod

iatoolkit/common/util.py

@@ -9,7 +9,6 @@ from iatoolkit.common.exceptions import IAToolkitException
 from injector import inject
 import os
 from jinja2 import Environment, FileSystemLoader
-from iatoolkit.common.session_manager import SessionManager
 from datetime import datetime, date
 from decimal import Decimal
 import yaml
@@ -22,30 +21,8 @@ class Utility:
     def __init__(self):
         self.encryption_key = os.getenv('FERNET_KEY')
 
-    @staticmethod
-    def resolve_user_identifier(external_user_id: str = None, local_user_id: int = 0) -> tuple[str, bool]:
-        """
-        Resuelve un identificador único de usuario desde external_user_id o local_user_id.
-
-        Lógica:
-        - Si external_user_id existe y no está vacío: usar external_user_id
-        - Si no, y local_user_id > 0: obtener email de la sesión actual y retornarlo como ID
-        - Si ninguno: retornar string vacío
-
-        """
-        if external_user_id and external_user_id.strip():
-            return external_user_id.strip(), False
-        elif local_user_id and local_user_id > 0:
-            # get the user information from the session
-            user_data = SessionManager.get('user')
-            if user_data:
-                return user_data.get('email', ''), True
-
-        return "", False
-
     def render_prompt_from_template(self,
                                     template_pathname: str,
-                                    query: str = None,
                                     client_data: dict = {},
                                     **kwargs) -> str:
 
@@ -58,8 +35,6 @@ class Utility:
             env = Environment(loader=FileSystemLoader(template_dir))
             template = env.get_template(template_file)
 
-            kwargs["query"] = query
-
             # add all the keys in client_data to kwargs
             kwargs.update(client_data)
 
@@ -74,7 +49,6 @@ class Utility:
     def render_prompt_from_string(self,
                                   template_string: str,
                                   searchpath: str | list[str] = None,
-                                  query: str = None,
                                   client_data: dict = {},
                                   **kwargs) -> str:
         """
@@ -97,7 +71,6 @@ class Utility:
             env = Environment(loader=loader)
             template = env.from_string(template_string)
 
-            kwargs["query"] = query
             kwargs.update(client_data)
 
             prompt = template.render(**kwargs)
@@ -108,6 +81,23 @@ class Utility:
                                f'No se pudo renderizar el template desde el string, error: {str(e)}') from e
 
 
+    def get_company_template(self, company_short_name: str, template_name: str) -> str:
+        # 1. get the path to the company specific template
+        template_path = os.path.join(os.getcwd(), f'companies/{company_short_name}/templates/{template_name}')
+        if not os.path.exists(template_path):
+            return None
+
+        # 2. read the file
+        try:
+            with open(template_path, 'r') as f:
+                template_string = f.read()
+
+            return template_string
+        except Exception as e:
+            logging.exception(e)
+            return None
+
+
     def serialize(self, obj):
         if isinstance(obj, datetime) or isinstance(obj, date):
             return obj.isoformat()

iatoolkit/company_registry.py

@@ -31,10 +31,9 @@ class CompanyRegistry:
 
                     # save the created instance in the registry
                     self._company_instances[company_key] = company_instance
-                    logging.info(f"company '{company_key}' instantiated")
 
                 except Exception as e:
-                    logging.error(f"Error instanciando empresa {company_key}: {e}")
+                    logging.error(f"Error while creating company instance for {company_key}: {e}")
                     logging.exception(e)
                     raise