update

.idea/.gitignore

@@ -0,0 +1,3 @@
+# Default ignored files
+/shelf/
+/workspace.xml

.idea/ESMA-GPT.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="PyDocumentationSettings">
+    <option name="format" value="PLAIN" />
+    <option name="myDocStringFormat" value="Plain" />
+  </component>
+</module>

.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,171 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="PyPackageRequirementsInspection" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="ignoredPackages">
+        <value>
+          <list size="158">
+            <item index="0" class="java.lang.String" itemvalue="notebook_shim" />
+            <item index="1" class="java.lang.String" itemvalue="pywinpty" />
+            <item index="2" class="java.lang.String" itemvalue="rdt" />
+            <item index="3" class="java.lang.String" itemvalue="sdv" />
+            <item index="4" class="java.lang.String" itemvalue="scikit-learn" />
+            <item index="5" class="java.lang.String" itemvalue="torchvision" />
+            <item index="6" class="java.lang.String" itemvalue="jupyter" />
+            <item index="7" class="java.lang.String" itemvalue="seaborn" />
+            <item index="8" class="java.lang.String" itemvalue="table-evaluator" />
+            <item index="9" class="java.lang.String" itemvalue="jupyter_server_terminals" />
+            <item index="10" class="java.lang.String" itemvalue="torchaudio" />
+            <item index="11" class="java.lang.String" itemvalue="copulas" />
+            <item index="12" class="java.lang.String" itemvalue="notebook" />
+            <item index="13" class="java.lang.String" itemvalue="scipy" />
+            <item index="14" class="java.lang.String" itemvalue="terminado" />
+            <item index="15" class="java.lang.String" itemvalue="nbclassic" />
+            <item index="16" class="java.lang.String" itemvalue="torch" />
+            <item index="17" class="java.lang.String" itemvalue="ctgan" />
+            <item index="18" class="java.lang.String" itemvalue="ray" />
+            <item index="19" class="java.lang.String" itemvalue="dython" />
+            <item index="20" class="java.lang.String" itemvalue="deepecho" />
+            <item index="21" class="java.lang.String" itemvalue="pandas" />
+            <item index="22" class="java.lang.String" itemvalue="jupyter_server" />
+            <item index="23" class="java.lang.String" itemvalue="matplotlib" />
+            <item index="24" class="java.lang.String" itemvalue="statsmodels" />
+            <item index="25" class="java.lang.String" itemvalue="sdmetrics" />
+            <item index="26" class="java.lang.String" itemvalue="tabulate" />
+            <item index="27" class="java.lang.String" itemvalue="PyYAML" />
+            <item index="28" class="java.lang.String" itemvalue="pickleshare" />
+            <item index="29" class="java.lang.String" itemvalue="defusedxml" />
+            <item index="30" class="java.lang.String" itemvalue="executing" />
+            <item index="31" class="java.lang.String" itemvalue="pycparser" />
+            <item index="32" class="java.lang.String" itemvalue="patsy" />
+            <item index="33" class="java.lang.String" itemvalue="ipython-genutils" />
+            <item index="34" class="java.lang.String" itemvalue="Pygments" />
+            <item index="35" class="java.lang.String" itemvalue="bleach" />
+            <item index="36" class="java.lang.String" itemvalue="graphviz" />
+            <item index="37" class="java.lang.String" itemvalue="soupsieve" />
+            <item index="38" class="java.lang.String" itemvalue="jsonschema" />
+            <item index="39" class="java.lang.String" itemvalue="pywin32" />
+            <item index="40" class="java.lang.String" itemvalue="qtconsole" />
+            <item index="41" class="java.lang.String" itemvalue="comm" />
+            <item index="42" class="java.lang.String" itemvalue="jupyterlab-pygments" />
+            <item index="43" class="java.lang.String" itemvalue="click" />
+            <item index="44" class="java.lang.String" itemvalue="ipykernel" />
+            <item index="45" class="java.lang.String" itemvalue="nbconvert" />
+            <item index="46" class="java.lang.String" itemvalue="attrs" />
+            <item index="47" class="java.lang.String" itemvalue="contourpy" />
+            <item index="48" class="java.lang.String" itemvalue="psutil" />
+            <item index="49" class="java.lang.String" itemvalue="jedi" />
+            <item index="50" class="java.lang.String" itemvalue="boto3" />
+            <item index="51" class="java.lang.String" itemvalue="pure-eval" />
+            <item index="52" class="java.lang.String" itemvalue="asttokens" />
+            <item index="53" class="java.lang.String" itemvalue="platformdirs" />
+            <item index="54" class="java.lang.String" itemvalue="msgpack" />
+            <item index="55" class="java.lang.String" itemvalue="idna" />
+            <item index="56" class="java.lang.String" itemvalue="decorator" />
+            <item index="57" class="java.lang.String" itemvalue="networkx" />
+            <item index="58" class="java.lang.String" itemvalue="cffi" />
+            <item index="59" class="java.lang.String" itemvalue="pandocfilters" />
+            <item index="60" class="java.lang.String" itemvalue="numpy" />
+            <item index="61" class="java.lang.String" itemvalue="requests" />
+            <item index="62" class="java.lang.String" itemvalue="jupyter-events" />
+            <item index="63" class="java.lang.String" itemvalue="sniffio" />
+            <item index="64" class="java.lang.String" itemvalue="websocket-client" />
+            <item index="65" class="java.lang.String" itemvalue="pyrsistent" />
+            <item index="66" class="java.lang.String" itemvalue="stack-data" />
+            <item index="67" class="java.lang.String" itemvalue="zipp" />
+            <item index="68" class="java.lang.String" itemvalue="nest-asyncio" />
+            <item index="69" class="java.lang.String" itemvalue="tenacity" />
+            <item index="70" class="java.lang.String" itemvalue="prompt-toolkit" />
+            <item index="71" class="java.lang.String" itemvalue="ipywidgets" />
+            <item index="72" class="java.lang.String" itemvalue="tornado" />
+            <item index="73" class="java.lang.String" itemvalue="botocore" />
+            <item index="74" class="java.lang.String" itemvalue="jsonpointer" />
+            <item index="75" class="java.lang.String" itemvalue="Send2Trash" />
+            <item index="76" class="java.lang.String" itemvalue="plotly" />
+            <item index="77" class="java.lang.String" itemvalue="overrides" />
+            <item index="78" class="java.lang.String" itemvalue="mistune" />
+            <item index="79" class="java.lang.String" itemvalue="importlib-resources" />
+            <item index="80" class="java.lang.String" itemvalue="mpmath" />
+            <item index="81" class="java.lang.String" itemvalue="jupyter-console" />
+            <item index="82" class="java.lang.String" itemvalue="typing_extensions" />
+            <item index="83" class="java.lang.String" itemvalue="debugpy" />
+            <item index="84" class="java.lang.String" itemvalue="tensorboardX" />
+            <item index="85" class="java.lang.String" itemvalue="argon2-cffi" />
+            <item index="86" class="java.lang.String" itemvalue="pytz" />
+            <item index="87" class="java.lang.String" itemvalue="webencodings" />
+            <item index="88" class="java.lang.String" itemvalue="Pillow" />
+            <item index="89" class="java.lang.String" itemvalue="traitlets" />
+            <item index="90" class="java.lang.String" itemvalue="protobuf" />
+            <item index="91" class="java.lang.String" itemvalue="rfc3339-validator" />
+            <item index="92" class="java.lang.String" itemvalue="joblib" />
+            <item index="93" class="java.lang.String" itemvalue="threadpoolctl" />
+            <item index="94" class="java.lang.String" itemvalue="arrow" />
+            <item index="95" class="java.lang.String" itemvalue="python-dateutil" />
+            <item index="96" class="java.lang.String" itemvalue="nbclient" />
+            <item index="97" class="java.lang.String" itemvalue="QtPy" />
+            <item index="98" class="java.lang.String" itemvalue="cycler" />
+            <item index="99" class="java.lang.String" itemvalue="MarkupSafe" />
+            <item index="100" class="java.lang.String" itemvalue="tinycss2" />
+            <item index="101" class="java.lang.String" itemvalue="frozenlist" />
+            <item index="102" class="java.lang.String" itemvalue="python-json-logger" />
+            <item index="103" class="java.lang.String" itemvalue="filelock" />
+            <item index="104" class="java.lang.String" itemvalue="Faker" />
+            <item index="105" class="java.lang.String" itemvalue="jupyterlab-widgets" />
+            <item index="106" class="java.lang.String" itemvalue="pyzmq" />
+            <item index="107" class="java.lang.String" itemvalue="certifi" />
+            <item index="108" class="java.lang.String" itemvalue="anyio" />
+            <item index="109" class="java.lang.String" itemvalue="pyparsing" />
+            <item index="110" class="java.lang.String" itemvalue="sympy" />
+            <item index="111" class="java.lang.String" itemvalue="beautifulsoup4" />
+            <item index="112" class="java.lang.String" itemvalue="isoduration" />
+            <item index="113" class="java.lang.String" itemvalue="fqdn" />
+            <item index="114" class="java.lang.String" itemvalue="jupyter_client" />
+            <item index="115" class="java.lang.String" itemvalue="kiwisolver" />
+            <item index="116" class="java.lang.String" itemvalue="fonttools" />
+            <item index="117" class="java.lang.String" itemvalue="backcall" />
+            <item index="118" class="java.lang.String" itemvalue="widgetsnbextension" />
+            <item index="119" class="java.lang.String" itemvalue="argon2-cffi-bindings" />
+            <item index="120" class="java.lang.String" itemvalue="virtualenv" />
+            <item index="121" class="java.lang.String" itemvalue="charset-normalizer" />
+            <item index="122" class="java.lang.String" itemvalue="distlib" />
+            <item index="123" class="java.lang.String" itemvalue="torchsummary" />
+            <item index="124" class="java.lang.String" itemvalue="matplotlib-inline" />
+            <item index="125" class="java.lang.String" itemvalue="webcolors" />
+            <item index="126" class="java.lang.String" itemvalue="cloudpickle" />
+            <item index="127" class="java.lang.String" itemvalue="wcwidth" />
+            <item index="128" class="java.lang.String" itemvalue="jupyter_core" />
+            <item index="129" class="java.lang.String" itemvalue="importlib-metadata" />
+            <item index="130" class="java.lang.String" itemvalue="Jinja2" />
+            <item index="131" class="java.lang.String" itemvalue="rfc3986-validator" />
+            <item index="132" class="java.lang.String" itemvalue="uri-template" />
+            <item index="133" class="java.lang.String" itemvalue="urllib3" />
+            <item index="134" class="java.lang.String" itemvalue="six" />
+            <item index="135" class="java.lang.String" itemvalue="parso" />
+            <item index="136" class="java.lang.String" itemvalue="nbformat" />
+            <item index="137" class="java.lang.String" itemvalue="tzdata" />
+            <item index="138" class="java.lang.String" itemvalue="ipython" />
+            <item index="139" class="java.lang.String" itemvalue="packaging" />
+            <item index="140" class="java.lang.String" itemvalue="fastjsonschema" />
+            <item index="141" class="java.lang.String" itemvalue="prometheus-client" />
+            <item index="142" class="java.lang.String" itemvalue="jmespath" />
+            <item index="143" class="java.lang.String" itemvalue="tqdm" />
+            <item index="144" class="java.lang.String" itemvalue="s3transfer" />
+            <item index="145" class="java.lang.String" itemvalue="colorama" />
+            <item index="146" class="java.lang.String" itemvalue="grpcio" />
+            <item index="147" class="java.lang.String" itemvalue="aiosignal" />
+            <item index="148" class="java.lang.String" itemvalue="tiktoken" />
+            <item index="149" class="java.lang.String" itemvalue="openai" />
+            <item index="150" class="java.lang.String" itemvalue="PyMuPDF" />
+            <item index="151" class="java.lang.String" itemvalue="gradio" />
+            <item index="152" class="java.lang.String" itemvalue="gradio_client" />
+            <item index="153" class="java.lang.String" itemvalue="faiss-cpu" />
+            <item index="154" class="java.lang.String" itemvalue="python-dotenv" />
+            <item index="155" class="java.lang.String" itemvalue="sentence-transformers" />
+            <item index="156" class="java.lang.String" itemvalue="datasets" />
+            <item index="157" class="java.lang.String" itemvalue="altair" />
+          </list>
+        </value>
+      </option>
+    </inspection_tool>
+  </profile>
+</component>

.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/ESMA-GPT.iml" filepath="$PROJECT_DIR$/.idea/ESMA-GPT.iml" />
+    </modules>
+  </component>
+</project>

.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

app.py

@@ -85,6 +85,12 @@ with gr.Blocks(title=CFG_APP.BOT_NAME, css="assets/style.css", theme=theme) as d
         """
     
     ### 📃 Inputs and functionalities
+    **Query Embedding's mode** : You have the choice between two embeddings mode for your query : 
+    - **Hypothetical Document Embedding (HyDE)**: This method uses LLM to generate an answer to your question. This answer will contain some keyswords and pattern which will be used to retrieve similar document's passages.
+    
+    - **Reformulation** : This method uses LLM to reformulate your query. This may include rephrasing the question, defining acronyms, and other techniques to clarify or simplify the user's query to obtain more accurate and relevant answers. 
+
+    \n
     
     In its initial release, Version 0, ESMA-GPT uses the subsequent 13 documents as the basis for its answers:
     \n