chATLAS_Frontend 1.0.0__tar.gz

chatlas_frontend-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

chatlas_frontend-1.0.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: chATLAS_Frontend
+Version: 1.0.0
+Summary: Code to run the frontend app
+License-Expression: Apache-2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: chatlas-chains>=0.2.0
+Requires-Dist: chatlas-embed>=0.1.19
+Requires-Dist: flask
+Requires-Dist: authlib
+Requires-Dist: markdown
+Requires-Dist: sqlalchemy
+Requires-Dist: markupsafe
+Requires-Dist: psutil
+Requires-Dist: matplotlib
+Requires-Dist: seaborn
+Dynamic: license-file
+
+# chATLAS
+Welcome to the repository for the frontend of chATLAS: An AI assistant for the ATLAS collaboration
+
+Main app (more stable): https://chatlas-flask-chatlas.app.cern.ch
+
+Staging area (contains newer features, less stable): https://chatlas-staging-chatlas.app.cern.ch
+
+If you want to install the app for development work, follow the instructions below:
+
+## Requirements
+You will need to set the following environment variables for the app to run
+```bash
+export CHATLAS_OPENAI_KEY=... # Feel free to use a personal OpenAI API key here
+export CHATLAS_DB_PASSWORD=...
+export CHATLAS_EMBEDDING_MODEL_PATH=...
+export CHATLAS_GROQ_KEY=...
+export CHATLAS_GROQ_BASE_URL=http://cs-513-ml003:3000 # this will change if not on CERN network, see below
+```
+
+Reach out to the developers by [email](atlas-comp-ml-chatlas-developers@cern.ch) or on [mattermost](https://mattermost.web.cern.ch/ml-atlas/channels/chatlas-ai-assistant-development) to get setup.
+
+If running locally (not on lxplus), you'll need a local copy of the embedding model, see [these instructions](#getting-the-embedding-model)
+
+## Environment creation
+
+Move to the directory containing this file and run:
+
+```bash
+uv sync
+```
+
+## Running the app
+
+0. Ensure you have the [venv](#environment-creation) and necessary [environment variables](#requirements)
+```bash
+export CHATLAS_OPENAI_KEY=...
+export CHATLAS_DB_PASSWORD=...
+export CHATLAS_EMBEDDING_MODEL_PATH=...
+export CHATLAS_GROQ_KEY=...
+export CHATLAS_PORT_FORWARDING=1
+```
+
+We recommend putting this into a `.env` file in the root directory of the project. Then you can load in the environment variables from the file with:
+```
+set -a
+source .env
+set +a
+```
+
+1. Setup port forwarding for the DBOD instances
+
+**note** If you are connected to the CERN network, skip this step
+
+```bash
+# forward the all DBs
+ssh -N \
+  -L 6624:dbod-chatlas.cern.ch:6624 \
+  -L 6606:dbod-chatlas-cds.cern.ch:6606 \
+  -L 3000:cs-513-ml003:3000 \
+  "$LXPLUS_USERNAME"@lxplus.cern.ch
+```
+
+2. Launch
+
+```bash
+uv run --env-file .env chATLAS_Frontend/launch.py --local-mode --db-host cern-prod --port-forwarding
+```
+
+3. Viewing the output
+
+After launching, you should get some terminal output like " * Running on http://127.0.0.1:5000"
+
+If running locally, just open this link
+
+If on lxplus, you need to port-forward the address to your local machine. Note the lxplus node you are on and run:
+
+```bash
+ssh -L 5000:127.0.0.1:5000 <USERNAME>@lxplus<NUMBER>.cern.ch
+```
+
+# Getting the Embedding Model
+
+The embedding model is now stored on EOS. To run locally you need to download the embedding model:
+
+```shell
+scp <USERNAME>@lxplus.cern.ch:/eos/atlas/atlascerngroupdisk/phys-mlf/Chatlas/multi-qa-mpnet-base-dot-v1-ATLAS-TALK <LOCAL PATH TO STORE MODEL>
+```
+
+Then export environment variable:
+
+```shell
+export CHATLAS_EMBEDDING_MODEL_PATH = <LOCAL PATH TO STORE MODEL>
+```
+
+## Updating the environment
+
+Edit [`pyproject.toml`](pyproject.toml) and run `uv sync` to update the lockfile

chatlas_frontend-1.0.0/README.md

@@ -0,0 +1,97 @@
+# chATLAS
+Welcome to the repository for the frontend of chATLAS: An AI assistant for the ATLAS collaboration
+
+Main app (more stable): https://chatlas-flask-chatlas.app.cern.ch
+
+Staging area (contains newer features, less stable): https://chatlas-staging-chatlas.app.cern.ch
+
+If you want to install the app for development work, follow the instructions below:
+
+## Requirements
+You will need to set the following environment variables for the app to run
+```bash
+export CHATLAS_OPENAI_KEY=... # Feel free to use a personal OpenAI API key here
+export CHATLAS_DB_PASSWORD=...
+export CHATLAS_EMBEDDING_MODEL_PATH=...
+export CHATLAS_GROQ_KEY=...
+export CHATLAS_GROQ_BASE_URL=http://cs-513-ml003:3000 # this will change if not on CERN network, see below
+```
+
+Reach out to the developers by [email](atlas-comp-ml-chatlas-developers@cern.ch) or on [mattermost](https://mattermost.web.cern.ch/ml-atlas/channels/chatlas-ai-assistant-development) to get setup.
+
+If running locally (not on lxplus), you'll need a local copy of the embedding model, see [these instructions](#getting-the-embedding-model)
+
+## Environment creation
+
+Move to the directory containing this file and run:
+
+```bash
+uv sync
+```
+
+## Running the app
+
+0. Ensure you have the [venv](#environment-creation) and necessary [environment variables](#requirements)
+```bash
+export CHATLAS_OPENAI_KEY=...
+export CHATLAS_DB_PASSWORD=...
+export CHATLAS_EMBEDDING_MODEL_PATH=...
+export CHATLAS_GROQ_KEY=...
+export CHATLAS_PORT_FORWARDING=1
+```
+
+We recommend putting this into a `.env` file in the root directory of the project. Then you can load in the environment variables from the file with:
+```
+set -a
+source .env
+set +a
+```
+
+1. Setup port forwarding for the DBOD instances
+
+**note** If you are connected to the CERN network, skip this step
+
+```bash
+# forward the all DBs
+ssh -N \
+  -L 6624:dbod-chatlas.cern.ch:6624 \
+  -L 6606:dbod-chatlas-cds.cern.ch:6606 \
+  -L 3000:cs-513-ml003:3000 \
+  "$LXPLUS_USERNAME"@lxplus.cern.ch
+```
+
+2. Launch
+
+```bash
+uv run --env-file .env chATLAS_Frontend/launch.py --local-mode --db-host cern-prod --port-forwarding
+```
+
+3. Viewing the output
+
+After launching, you should get some terminal output like " * Running on http://127.0.0.1:5000"
+
+If running locally, just open this link
+
+If on lxplus, you need to port-forward the address to your local machine. Note the lxplus node you are on and run:
+
+```bash
+ssh -L 5000:127.0.0.1:5000 <USERNAME>@lxplus<NUMBER>.cern.ch
+```
+
+# Getting the Embedding Model
+
+The embedding model is now stored on EOS. To run locally you need to download the embedding model:
+
+```shell
+scp <USERNAME>@lxplus.cern.ch:/eos/atlas/atlascerngroupdisk/phys-mlf/Chatlas/multi-qa-mpnet-base-dot-v1-ATLAS-TALK <LOCAL PATH TO STORE MODEL>
+```
+
+Then export environment variable:
+
+```shell
+export CHATLAS_EMBEDDING_MODEL_PATH = <LOCAL PATH TO STORE MODEL>
+```
+
+## Updating the environment
+
+Edit [`pyproject.toml`](pyproject.toml) and run `uv sync` to update the lockfile

chatlas_frontend-1.0.0/chATLAS_Frontend/frontend/auth.py

@@ -0,0 +1,38 @@
+import os
+
+from authlib.integrations.flask_client import OAuth
+from flask import redirect, session, url_for
+
+oauth = OAuth()
+
+
+def set_oauth(app):
+    CLIENT_ID = os.getenv("CLIENT_ID") or os.getenv("sso_clientID")  # noqa: SIM112
+    CLIENT_SECRET = os.getenv("CLIENT_SECRET") or os.getenv("sso_clientSecret")  # noqa: SIM112
+    CERN_SSO = "https://auth.cern.ch/auth/realms/cern/.well-known/openid-configuration"
+
+    oauth.init_app(app)
+
+    oauth.register(
+        name="cern",
+        server_metadata_url=CERN_SSO,
+        client_id=CLIENT_ID,
+        client_secret=CLIENT_SECRET,
+        client_kwargs={"scope": "openid email profile"},
+    )
+
+
+def login():
+    redirect_uri = url_for("auth_route", _external=True, _scheme="https")
+    return oauth.cern.authorize_redirect(redirect_uri)
+
+
+def auth():
+    token = oauth.cern.authorize_access_token()
+    session["user"] = token["userinfo"]
+    return redirect("/")
+
+
+def logout():
+    session.pop("user", None)
+    return redirect("/")

chatlas_frontend-1.0.0/chATLAS_Frontend/frontend/chat_processing.py

@@ -0,0 +1,63 @@
+from collections.abc import Mapping
+
+from flask import jsonify
+
+from chATLAS_Frontend.frontend.chat_request import build_chat_request_mattermost
+from chATLAS_Frontend.frontend.html_generation import parse_answer
+from chATLAS_Frontend.frontend.processing import call_chain
+from chATLAS_Frontend.frontend.settings import get_env_settings
+
+
+def process_mattermost(input_request_str: str, user_id: str | None = None):
+    """
+    Process the Mattermost slash-command request through the ChatRequest pipeline.
+
+    Args:
+        input_request_str: Raw text passed to the slash command.
+        user_id: Optional user ID from Mattermost request payload.
+    """
+    env = get_env_settings()
+    session_like: Mapping[str, str] = {"user_id": user_id} if user_id else {}
+
+    try:
+        chat_request = build_chat_request_mattermost(input_request_str, session=session_like, env=env)
+        answer, sources = call_chain(chat_request, log_results=True)
+    except Exception as e:
+        return jsonify({"response_type": "in_channel", "text": f"caught_error_render_error_box\n\nError: {e!s}"})
+
+    if answer is None:
+        return jsonify({"response_type": "in_channel", "text": "No answer returned."})
+
+    try:
+        bot_answer, bot_citations = parse_answer(answer)
+    except Exception as e:
+        return jsonify(
+            {"response_type": "in_channel", "text": f"caught_error_render_error_box\n\nError in parse_answer: {e!s}"}
+        )
+
+    try:
+        md_used_links = get_links_to_used_sources(bot_citations, sources) or ["No sources used."]
+    except Exception:
+        md_used_links = ["Error extracting links."]
+
+    final_response = f"** /chatlas {input_request_str}**\n\n {bot_answer}\n\n Used Sources: \n " + "\n".join(
+        md_used_links
+    )
+    return jsonify({"response_type": "in_channel", "text": final_response})
+
+
+def get_links_to_used_sources(bot_citations, all_sources):
+    """
+    A helper function for mattermost endpoint which extracts the URL for each used source and puts link in md format
+
+    Returns: List[str] - List of md links to used sources
+    """
+    # Create a mapping of name to url from all_sources
+    source_map = {source.metadata.get("name"): source.metadata.get("url") for source in all_sources}
+
+    # Generate markdown links for citations that exist in the source map
+    return [
+        f"[{citation['name']}]({source_map[citation['name']]})"
+        for citation in bot_citations
+        if citation["name"] in source_map
+    ]