iatoolkit 0.3.9__py3-none-any.whl → 0.107.4__py3-none-any.whl

iatoolkit/locales/en.yaml

@@ -0,0 +1,222 @@
+# Language: English
+ui:
+  login_widget:
+    title: "Sign In"
+    welcome_message: "Enter your credentials or register to access this platform."
+    email_placeholder: "Email address"
+    password_placeholder: "Password"
+    login_button: "Login"
+    forgot_password_link: "Forgot your password?"
+    no_account_prompt: "Don't have an account?"
+    signup_link: "Sign Up"
+
+  signup:
+    title: "Create an Account"
+    subtitle: "Start your journey with us today."
+    first_name_label: "First Name"
+    last_name_label: "Last Name"
+    email_label: "Email Address"
+    password_label: "Password"
+    confirm_password_label: "Confirm Password"
+    signup_button: "Create Account"
+    already_have_account: "Already have an account?"
+    login_link: "Log In"
+    disclaimer: "🔒We value your privacy. Your data will be used exclusively for the operation of the platform."
+
+  forgot_password:
+    title: "Recover Password"
+    subtitle: "Enter your email address and we will send you a link to reset your password."
+    submit_button: "Send Recovery Link"
+    back_to_login: "Back to Login"
+
+  change_password:
+    title: "Create New Password"
+    subtitle: "You are changing the password for <strong>{email}</strong>."
+    temp_code_label: "Temporary Code"
+    temp_code_placeholder: "Check your email"
+    new_password_label: "New Password"
+    password_instructions: "Must contain at least 8 characters, an uppercase letter, a lowercase letter, a number, and a special character."
+    confirm_password_label: "Confirm New Password"
+    save_button: "Save Password"
+    back_to_home: "Back to home"
+
+  chat:
+    welcome_message: "Hello! How can I help you today?"
+    input_placeholder: "Type here..."
+    prompts_available: "Available prompts"
+    init_context: "Initializing the context ..."
+
+  admin:
+    resources: "Resources"
+    configuration: "Configuration"
+    prompts: "Prompts"
+    schemas: "Schemas"
+    context: "Context"
+    files: "Files"
+    users: "Users"
+    select_file: "Select a file for editing"
+    select_category: "Select a category"
+    editing: "Editing"
+    no_file_selected: "No file selected"
+    new: "New"
+    confirm: "Confirm"
+    cancel: "Cancel"
+    new_file: "New file"
+    delete_file: "Delete file"
+    save_file: "Save"
+    credentials: "Email and password required for login."
+    saved_ok: "Saved successfully"
+    deleted_ok: "Deleted successfully"
+    user_manager: "User management"
+    admin_page_title: "Admin access"
+    load_configuration: "Save configuration"
+    goto_chat: "Go to chat"
+    logout: "Close session"
+
+  tooltips:
+    history: "History of my queries"
+    reload_context: "Force Context Reload"
+    feedback: "Your feedback is very important"
+    usage_guide: "Usage Guide"
+    onboarding: "How to ask better questions"
+    logout: "Log out"
+    preferences: "Preferences"
+    use_prompt_assistant: "Use Prompt Assistant"
+    attach_files: "Attach files"
+    view_attached_files: "View attached files"
+    send: "Send"
+    stop: "Stop"
+
+  modals:
+    files_title: "Uploaded Files"
+    feedback_title: "Your Opinion is Important"
+    feedback_prompt: "How useful was the assistant's response?"
+    feedback_comment_label: "Your feedback helps us improve:"
+    feedback_comment_placeholder: "Write your opinion, suggestions, or comments here..."
+    history_title: "Query History"
+    history_table_date: "Date"
+    history_table_query: "Query"
+    loading_history: "Loading history..."
+    no_history_found: "No query history found."
+    help_title: "AI Assistant User Guide"
+
+  buttons:
+    cancel: "Close"
+    send: "Send"
+    stop: "Stop"
+
+errors:
+  company_not_found: "The company {company_short_name} does not exist."
+  timeout: "timeout expired."
+  auth:
+    invalid_password: "The provided password is incorrect."
+    user_not_found: "A user with that email address was not found."
+    invalid_or_expired_token: "Invalid or expired token."
+    session_creation_failed: "Could not create user session."
+    authentication_required: "Authentication required. No session cookie or API Key provided."
+    invalid_api_key: "Invalid or inactive API Key."
+    no_user_identifier_api: "No user_identifier provided for API call."
+    no_company_permissions: "Do not have permissions to admin this company."
+  templates:
+    company_not_found: "Company not found."
+    home_template_not_found: "The home page template for the company '{company_short_name}' is not configured."
+    template_not_found: "Template not found: '{template_name}'."
+    processing_error: "An error occurred while processing the custom home page template: {error}"
+  general:
+    unexpected_error: "An unexpected error has occurred. Please contact support."
+    unsupported_language: "The selected language is not supported."
+  signup:
+    company_not_found: "The company {company_short_name} does not exist."
+    incorrect_password_for_existing_user: "The password for the user {email} is incorrect."
+    user_already_registered: "The user with email '{email}' already exists in this company."
+    password_mismatch: "The passwords do not match. Please try again."
+  change_password:
+    token_expired: "The password change link has expired. Please request a new one."
+    password_mismatch: "The passwords do not match. Please try again."
+    invalid_temp_code: "The temporary code is not valid. Please check it or request a new one."
+  forgot_password:
+    user_not_registered: "The user with email {email} is not registered."
+  verification:
+    token_expired: "The verification link has expired. Please contact support if you need a new one."
+    user_not_found: "The user you are trying to verify does not exist."
+  validation:
+    password_too_short: "Password must be at least 8 characters long."
+    password_no_uppercase: "Password must contain at least one uppercase letter."
+    password_no_lowercase: "Password must contain at least one lowercase letter."
+    password_no_digit: "Password must contain at least one number."
+    password_no_special_char: "Password must contain at least one special character."
+
+  services:
+    no_text_file: "The file is not text or the encoding is not UTF-8"
+    no_output_file: "Missing output file name"
+    no_data_for_excel: "Missing data or it is not a list of dictionaries"
+    no_download_directory: "Temporary directory for saving Excel files is not configured"
+    cannot_create_excel: "Could not create the Excel file"
+    invalid_filename: "Invalid filename"
+    file_not_exist: "File not found"
+    path_is_not_a_file: "The path does not correspond to a file"
+    file_validation_error: "Error validating file"
+    user_not_authorized: "user is not authorized for this company"
+    account_not_verified: "Your account has not been verified. Please check your email."
+    missing_response_id: "Can not found 'previous_response_id' for '{company_short_name}/{user_identifier}'. Reinit context"
+    context_rebuild_failed: "Company context rebuild failed."
+    cannot_read_excel: "Cannot read Excel file"
+    cannot_read_csv: "Cannot read CSV file"
+
+api_responses:
+  context_reloaded_success: "The context has been successfully reloaded."
+
+services:
+  mail_sent: "Email sent successfully."
+  start_query: "Hello, what can I help you with today?"
+  mail_change_password: "mail sent for password change"
+
+
+flash_messages:
+  password_changed_success: "Your password has been successfully reset. You can now log in."
+  login_required: "Please log in to continue."
+  signup_success: "Registration successful. Please check your email to verify your account."
+  signup_success_no_verification: "Registration successful."
+  user_associated_success: "Existing user successfully associated with the new company."
+  account_verified_success: "Your account has been successfully verified. Welcome!"
+  forgot_password_success: "If your email is registered, you will receive a link to reset your password."
+
+# Keys specifically for JavaScript
+js_messages:
+  feedback_sent_success_title: "Feedback Sent"
+  feedback_sent_success_body: "Thank you for your feedback!"
+  feedback_sent_error: "Could not send feedback, please try again."
+  feedback_rating_error: "Please rate the assistant using the stars."
+  feedback_comment_error: "Please write your comment before sending."
+  context_reloaded: "Context has been reloaded."
+  error_loading_history: "An error occurred while loading the history."
+  request_aborted: "The response generation has been stopped."
+  processing_error: "An error occurred while processing the request."
+  server_comm_error: "Server communication error ({status}). Please try again later."
+  network_error: "A network error occurred. Please try again in a few moments."
+  unknown_server_error: "Unknown server error."
+  loading: "Loading..."
+  reload_init: "init reloading context in background..."
+  no_history_found: "No query history found."
+  example: "Example:"
+  show_reasoning: "Show reasoning"
+  unsaved: "Modified (unsaved)"
+  select_file: "Select a file from the list"
+  no_file_selected: "No file selected"
+  select_company: "Select company"
+  delete_ok: "File deleted successfully"
+  not_saved: 'Could not save'
+  saved_ok: "Saved successfully"
+  invalid_file_name: "Invalid filename. Use only letters, numbers, underscores, hyphens, and dots."
+  config_loaded: "Configuration loaded successfully."
+  config_load_error: "Error loading configuration."
+  search_placeholder: "Search users..."
+  showing: "Showing"
+  records: "Records"
+  db_user: "User"
+  db_role: "Role"
+  db_verified: "Verified"
+  db_created: "Created"
+  db_last_access: "Last access"
+
+

iatoolkit/locales/es.yaml

@@ -0,0 +1,225 @@
+# locales/es.yaml
+ui:
+  login_widget:
+    title: "Iniciar Sesión"
+    welcome_message: "Ingresa tus credenciales o registrate para acceder a la plataforma."
+    email_placeholder: "Correo electrónico"
+    login_button: "Acceder"
+    forgot_password_link: "¿Olvidaste tu contraseña?"
+    no_account_prompt: "¿No tienes una cuenta?"
+    signup_link: "Regístrate"
+
+  signup:
+    title: "Crear una Cuenta"
+    subtitle: "Comienza tu viaje con nosotros hoy."
+    first_name_label: "Nombre"
+    last_name_label: "Apellido"
+    email_label: "Correo Electrónico"
+    password_label: "Contraseña"
+    confirm_password_label: "Confirmar Contraseña"
+    signup_button: "Crear Cuenta"
+    already_have_account: "¿Ya tienes una cuenta?"
+    login_link: "Inicia Sesión"
+    disclaimer: "🔒 Valoramos tu privacidad. Tus datos se usarán exclusivamente para el funcionamiento de la plataforma."
+
+  forgot_password:
+    title: "Recuperar Contraseña"
+    subtitle: "Ingresa tu correo electrónico y te enviaremos un enlace para restablecer tu contraseña."
+    submit_button: "Enviar Enlace de Recuperación"
+    back_to_login: "Volver a Iniciar Sesión"
+
+  change_password:
+    title: "Crear Nueva Contraseña"
+    subtitle: "Estás cambiando la contraseña para <strong>{email}</strong>."
+    temp_code_label: "Código Temporal"
+    temp_code_placeholder: "Revisa tu correo electrónico"
+    new_password_label: "Nueva Contraseña"
+    password_instructions: "Debe contener al menos 8 caracteres, mayúscula, minúscula, número y un carácter especial."
+    confirm_password_label: "Confirmar Nueva Contraseña"
+    save_button: "Guardar Contraseña"
+    back_to_home: "Volver al inicio"
+
+  chat:
+    welcome_message: "¡Hola! ¿En qué te puedo ayudar hoy?"
+    input_placeholder: "Escribe aquí..."
+    prompts_available: "Prompts disponibles"
+    init_context: "Inicializando el contexto de la IA ..."
+
+  admin:
+    resources: "Recursos"
+    configuration: "Configuración"
+    prompts: "Prompts"
+    schemas: "Schemas"
+    context: "Contexto"
+    files: "Archivos"
+    users: "Usuarios"
+    select_file: "Seleccione un archivo a editar"
+    select_categpry: "Seleccione una categoría"
+    editing: "Editando"
+    no_file_selected: "Seleccione un archivo"
+    new: "Nuevo"
+    confirm: "Confirmar"
+    cancel: "Cancelar"
+    new_file: "Nuevo archivo"
+    delete_file: "Borrar archivo"
+    save_file: "Guardar"
+    credentials: "Email y password son requeridos."
+    saved_ok: "Guardado correctamente"
+    deleted_ok: "Eliminado correctamente"
+    company: "Empresa"
+    admin_page_title: "Acceso de administración"
+    user_manager: "Administración de usuarios"
+    load_configuration: "Guardar configuración"
+    goto_chat: "Ir al chat"
+    logout: "Cerrar sesión"
+
+
+  tooltips:
+    history: "Historial con mis consultas"
+    reload_context: "Forzar Recarga de Contexto"
+    feedback: "Tu feedback es muy importante"
+    usage_guide: "Guía de Uso"
+    onboarding: "Cómo preguntar mejor"
+    preferences: "Preferencias"
+    logout: "Cerrar sesión"
+    use_prompt_assistant: "Usar Asistente de Prompts"
+    attach_files: "Adjuntar archivos"
+    view_attached_files: "Ver archivos adjuntos"
+  modals:
+    files_title: "Archivos Cargados"
+    feedback_title: "Tu Opinión es Importante"
+    feedback_prompt: "¿Qué tan útil fue la respuesta del asistente?"
+    feedback_comment_label: "Tu comentario nos ayuda a mejorar:"
+    feedback_comment_placeholder: "Escribe aquí tu opinión, sugerencias o comentarios..."
+    history_title: "Historial de Consultas"
+    history_table_date: "Fecha"
+    history_table_query: "Consulta"
+    loading_history: "Cargando historial..."
+    no_history_found: "No se encontró historial de consultas."
+    help_title: "Guía de uso del Asistente IA"
+
+  buttons:
+    cancel: "Cerrar"
+    send: "Enviar"
+    stop: "Detener"
+
+errors:
+  company_not_found: "La empresa {company_short_name} no existe."
+  timeout: "El tiempo de espera ha expirado."
+
+
+  auth:
+    invalid_password: "La contraseña proporcionada es incorrecta."
+    user_not_found: "No se encontró un usuario con ese correo."
+    invalid_or_expired_token: "Token inválido o expirado."
+    session_creation_failed: "No se pudo crear la sesión del usuario."
+    authentication_required: "Autenticación requerida. No se proporcionó cookie de sesión o clave de API."
+    invalid_api_key: "Clave de API inválida o inactiva."
+    no_user_identifier_api: "No se proporcionó user_identifier para la llamada a la API."
+    no_company_permissions: "No tiene permisos para administrar esta empresa."
+
+  templates:
+    company_not_found: "Empresa no encontrada."
+    home_template_not_found: "La plantilla de la página de inicio para la empresa '{company_short_name}' no está configurada."
+    processing_error: "Error al procesar el template: {error}"
+    template_not_found: "No se encontro el template: '{template_name}'."
+
+  general:
+    unexpected_error: "Ha ocurrido un error inesperado: {error}."
+    unsupported_language: "El idioma seleccionado no es válido."
+  signup:
+    company_not_found: "La empresa {company_short_name} no existe."
+    incorrect_password_for_existing_user: "La contraseña para el usuario {email} es incorrecta."
+    user_already_registered: "El usuario con email '{email}' ya existe en esta empresa."
+    password_mismatch: "Las contraseñas no coinciden. Por favor, inténtalo de nuevo."
+  change_password:
+    token_expired: "El enlace de cambio de contraseña ha expirado. Por favor, solicita uno nuevo."
+    password_mismatch: "Las contraseñas no coinciden. Por favor, inténtalo nuevamente."
+    invalid_temp_code: "El código temporal no es válido. Por favor, verifica o solicita uno nuevo."
+  forgot_password:
+    user_not_registered: "El usuario con correo {email} no está registrado."
+  verification:
+    token_expired: "El enlace de verificación ha expirado. Por favor, contacta a soporte si necesitas uno nuevo."
+    user_not_found: "El usuario que intentas verificar no existe."
+  validation:
+    password_too_short: "La contraseña debe tener al menos 8 caracteres."
+    password_no_uppercase: "La contraseña debe tener al menos una letra mayúscula."
+    password_no_lowercase: "La contraseña debe tener al menos una letra minúscula."
+    password_no_digit: "La contraseña debe tener al menos un número."
+    password_no_special_char: "La contraseña debe tener al menos un carácter especial."
+
+  services:
+    no_text_file: "El archivo no es texto o la codificación no es UTF-8"
+    no_output_file: "falta el nombre del archivo de salida"
+    no_data_for_excel: "faltan los datos  o no es una lista de diccionarios"
+    no_download_directory: "no esta configurado el directorio temporal para guardar excels"
+    cannot_create_excel: "no se pudo crear el archivo excel"
+    invalid_filename: "Nombre de archivo inválido"
+    file_not_exist : "Archivo no encontrado"
+    path_is_not_a_file : "La ruta no corresponde a un archivo"
+    file_validation_error : "Error validando archivo"
+    user_not_authorized: "Usuario no esta autorizado para esta empresa"
+    account_not_verified: "Tu cuenta no ha sido verificada. Por favor, revisa tu correo."
+    missing_response_id: "No se encontró 'previous_response_id' para '{company_short_name}/{user_identifier}'. Reinicia el contexto."
+    context_rebuild_failed: "No se pudo reconstruir el contexto de la empresa."
+    cannot_read_excel: "No se pudo leer el archivo excel"
+    cannot_read_csv: "No se pudo leer el archivo CSV"
+
+
+api_responses:
+  context_reloaded_success: "El contexto se ha recargado con éxito."
+
+services:
+  mail_sent: "mail enviado exitosamente."
+  start_query: "Hola, cual es tu pregunta?"
+  mail_change_password: "se envio mail para cambio de clave"
+
+flash_messages:
+  password_changed_success: "Tu contraseña ha sido restablecida exitosamente. Ahora puedes iniciar sesión."
+  signup_success: "Registro exitoso. Por favor, revisa tu correo para verificar tu cuenta."
+  signup_success_no_verification: "Registro exitoso."
+  user_associated_success: "Usuario existente asociado exitosamente a la nueva empresa."
+  account_verified_success: "Tu cuenta ha sido verificada exitosamente. ¡Bienvenido!"
+  forgot_password_success: "Si tu correo está registrado, recibirás un enlace para restablecer tu contraseña."
+
+# Claves específicas para JavaScript
+js_messages:
+  feedback_sent_success_title: "Feedback Enviado"
+  feedback_sent_success_body: "¡Gracias por tu comentario!"
+  feedback_sent_error: "No se pudo enviar el feedback, por favor intente nuevamente."
+  feedback_rating_error: "Por favor, califica al asistente con las estrellas."
+  feedback_comment_error: "Por favor, escribe tu comentario antes de enviar."
+  context_reloaded: "El contexto ha sido recargado."
+  error_loading_history: "Ocurrió un error al cargar el historial."
+  request_aborted: "La generación de la respuesta ha sido detenida."
+  processing_error: "Ocurrió un error al procesar la solicitud."
+  server_comm_error: "Error de comunicación con el servidor ({status}). Por favor, intente de nuevo más tarde."
+  network_error: "Ocurrió un error de red. Por favor, inténtalo de nuevo en unos momentos."
+  unknown_server_error: "Error desconocido del servidor."
+  loading: "Cargando..."
+  reload_init: "Iniciando recarga de contexto en segundo plano..."
+  no_history_found: "No existe historial de consultas."
+  example: "Ejemplo:"
+  show_reasoning: "Ver razonamiento"
+  unsaved: "Modificado (no guardado)"
+  select_file: "Seleccione un archivo de la lista"
+  no_file_selected: "No hay archivo seleccionado"
+  select_company: "Seleccione empresa"
+  delete_ok: "Archivo eliminado correctamente"
+  not_saved: 'No puede guardar'
+  invalid_file_name: "Nombre de archivo no válido. Usa solo letras, números, guiones bajos, guiones y puntos."
+  config_loaded: "Configuración cargada correctamente."
+  config_load_error: "Error cargando confguración."
+  search_placeholder: "Buscar usuarios..."
+  showing: "Mostrando"
+  records: "Registros"
+  db_user: "Usuario"
+  db_role: "Rol"
+  db_verified: "Verificado"
+  db_created: "Ingreso"
+  db_last_access: "ultimo acceso"
+
+
+
+
+

iatoolkit/repositories/__init__.py

@@ -0,0 +1,5 @@
+# Copyright (c) 2024 Fernando Libedinsky
+# Product: IAToolkit
+#
+# IAToolkit is open source software.
+

iatoolkit/repositories/database_manager.py

@@ -0,0 +1,187 @@
+# Copyright (c) 2024 Fernando Libedinsky
+# Product: IAToolkit
+#
+# IAToolkit is open source software.
+
+# database_manager.py
+from sqlalchemy import create_engine, event, inspect, text
+from sqlalchemy.orm import sessionmaker, scoped_session
+from sqlalchemy.engine.url import make_url
+from iatoolkit.repositories.models import Base
+from injector import inject
+from pgvector.psycopg2 import register_vector
+from iatoolkit.common.interfaces.database_provider import DatabaseProvider
+
+
+class DatabaseManager(DatabaseProvider):
+    @inject
+    def __init__(self,
+                 database_url: str,
+                 schema: str | None = None,
+                 register_pgvector: bool = True):
+        """
+        Inicializa el gestor de la base de datos.
+        :param database_url: URL de la base de datos.
+        :param schema: Esquema por defecto para la conexión (search_path).
+        :param echo: Si True, habilita logs de SQL.
+        """
+
+        self.schema = schema
+
+        # FIX HEROKU: replace postgres:// by postgresql:// for compatibility with SQLAlchemy 1.4+
+        if database_url and database_url.startswith("postgres://"):
+            database_url = database_url.replace("postgres://", "postgresql://", 1)
+
+        self.url = make_url(database_url)
+
+        if database_url.startswith('sqlite'):
+            self._engine = create_engine(database_url, echo=False)
+        else:
+            self._engine = create_engine(
+                database_url,
+                echo=False,
+                pool_size=10,  # per worker
+                max_overflow=20,
+                pool_timeout=30,
+                pool_recycle=1800,
+                pool_pre_ping=True,
+                future=True,
+            )
+        self.SessionFactory = sessionmaker(bind=self._engine,
+                                           autoflush=False,
+                                           autocommit=False,
+                                           expire_on_commit=False)
+        self.scoped_session = scoped_session(self.SessionFactory)
+
+        # Register pgvector for each new connection
+        backend = self.url.get_backend_name()
+        if backend == 'postgresql' or backend == 'postgres':
+            if register_pgvector:
+                event.listen(self._engine, 'connect', self.on_connect)
+
+            # if there is a schema, configure the search_path for each connection
+            if self.schema:
+                event.listen(self._engine, 'checkout', self.set_search_path)
+
+    def set_search_path(self, dbapi_connection, connection_record, connection_proxy):
+        # Configure the search_path for this connection
+        cursor = dbapi_connection.cursor()
+
+        # The defined schema is first, and then public by default
+        try:
+            cursor.execute(f"SET search_path TO {self.schema}, public")
+            cursor.close()
+
+            # commit for persist the change in the session
+            dbapi_connection.commit()
+        except Exception:
+            # if failed, rollback to avoid invalidating the connection
+            dbapi_connection.rollback()
+
+    @staticmethod
+    def on_connect(dbapi_connection, connection_record):
+        """
+        Esta función se ejecuta cada vez que se establece una conexión.
+        dbapi_connection es la conexión psycopg2 real.
+        """
+        register_vector(dbapi_connection)
+
+    def get_session(self):
+        return self.scoped_session()
+
+    def get_connection(self):
+        return self._engine.connect()
+
+    def create_all(self):
+        # if there is a schema defined, make sure it exists before creating tables
+        backend = self.url.get_backend_name()
+        if self.schema and (backend == 'postgresql' or backend == 'postgres'):
+            with self._engine.begin() as conn:
+                conn.execute(text(f"CREATE SCHEMA IF NOT EXISTS {self.schema}"))
+
+        Base.metadata.create_all(self._engine)
+
+    def drop_all(self):
+        Base.metadata.drop_all(self._engine)
+
+    def remove_session(self):
+        self.scoped_session.remove()
+
+    # -- execution methods ----
+
+    def execute_query(self, query: str, commit: bool = False) -> list[dict] | dict:
+        """
+        Implementation for Direct SQLAlchemy connection.
+        """
+        session = self.get_session()
+        result = session.execute(text(query))
+
+        if commit:
+            session.commit()
+
+        if result.returns_rows:
+            # Convert SQLAlchemy rows to list of dicts immediately
+            cols = result.keys()
+            return [dict(zip(cols, row)) for row in result.fetchall()]
+
+        return {'rowcount': result.rowcount}
+
+    def commit(self):
+        self.get_session().commit()
+
+    def rollback(self):
+        self.get_session().rollback()
+
+    # -- schema methods ----
+    def get_all_table_names(self) -> list[str]:
+        # Returns a list of all table names in the database
+        inspector = inspect(self._engine)
+        return inspector.get_table_names(schema=self.schema)
+
+    def get_table_schema(self,
+                         table_name: str,
+                         db_schema: str,
+                         schema_object_name: str | None = None,
+                         exclude_columns: list[str] | None = None) -> str:
+        inspector = inspect(self._engine)
+
+        # search the table in the specified schema
+        if table_name not in inspector.get_table_names(schema=db_schema):
+            raise RuntimeError(f"Table '{table_name}' does not exist in database schema '{db_schema}'.")
+
+        if exclude_columns is None:
+            exclude_columns = []
+
+        # get all the table columns
+        columns = inspector.get_columns(table_name, schema=db_schema)
+
+        # construct a json dictionary with the table definition
+        json_dict = {
+            "table": table_name,
+            "description": "",
+            "fields": []
+        }
+
+        if schema_object_name:
+            json_dict["description"] += (
+                f"The meaning of each field in this table is detailed in the **`{schema_object_name}`** object."
+            )
+
+        if db_schema:
+            json_dict["schema"] = db_schema
+            json_dict["description"] += f"It belongs to the **`{db_schema}`** schema."
+
+        # now add every column to the json dictionary
+        for col in columns:
+            name = col["name"]
+
+            # omit the excluded columns.
+            if name in exclude_columns:
+                continue
+
+            json_dict["fields"].append({
+                "name": name,
+                "type": str(col["type"]),
+            })
+
+        return "\n\n" + str(json_dict)

iatoolkit/repositories/document_repo.py

@@ -0,0 +1,33 @@
+# Copyright (c) 2024 Fernando Libedinsky
+# Product: IAToolkit
+#
+# IAToolkit is open source software.
+
+from iatoolkit.repositories.models import Document
+from injector import inject
+from iatoolkit.repositories.database_manager import DatabaseManager
+from iatoolkit.common.exceptions import IAToolkitException
+
+
+class DocumentRepo:
+    @inject
+    def __init__(self, db_manager: DatabaseManager):
+        self.session = db_manager.get_session()
+
+    def insert(self,new_document: Document):
+        self.session.add(new_document)
+        self.session.commit()
+        return new_document
+
+    def get(self, company_id, filename: str ) -> Document:
+        if not company_id or not filename:
+            raise IAToolkitException(IAToolkitException.ErrorType.PARAM_NOT_FILLED,
+                               'missing company_id or filename')
+
+        return self.session.query(Document).filter_by(company_id=company_id, filename=filename).first()
+
+    def get_by_id(self, document_id: int) -> Document:
+        if not document_id:
+            return None
+
+        return self.session.query(Document).filter_by(id=document_id).first()